About The Project

@bitbytebin/onchain is a collection of contracts and examples for creating onchain metadata and images

Getting Started

Installation

1. Install with npm or yarn

npm install @bitbytebin/onchain

or

yarn add @bitbytebin/onchain

Usage

Checkout the reference ERC721oc for a basic usage example

Or the OnChainTraits contract the ERC721oc inherits

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Dev notes

Build

1. Clone the repo

   git clone https://github.com/BitByteBin/onchain.git

2. Install NPM packages

   npm install

Hardhat Tasks

• $ npx hardhat <command>
• (hh) $ hh <command>

check               -- Check whatever you need
clean               -- Clears the cache and deletes all artifacts
compile             -- Compiles the entire project, building all artifacts
console             -- Opens a hardhat console
coverage            -- Generates a code coverage report for tests
docgen              -- Generate NatSpec documentation automatically on compilation
dodoc               -- Generates NatSpec documentation for the project
flatten             -- Flattens and prints contracts and their dependencies. If no file is passed, all the contracts in the project will be flattened.
help                -- Prints this message
markup              -- Generate markups for compiled contracts
mkdocs              -- runs mkdocs build to generate docs site based off docs markup
node                -- Starts a JSON-RPC server on top of Hardhat Network
run                 -- Runs a user-defined script after compiling the project
test                -- Runs mocha tests
typechain           -- Generate Typechain typings for compiled contracts
verify              -- Verifies a contract on Etherscan or Sourcify
watch               -- Start the file watcher
gas-reporter:merge

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

BitByteBin - @BitByteBin

0xStabby - @0xStabby

Project Link: https://github.com/BitByteBin/onchain