erc721s v0.0.1

About The Project

The goal of ERC721S is to provide a fully ERC721A compatible standart for minting NFTs that are either statically or dynamically pegged to a a stable asset.

Stablepunkz Labs is not liable for any outcomes as a result of using ERC721S. DYOR.

Docs

Coming soon

Upgradeable Version

Coming soon

Installation

npm install --save-dev erc721s

Usage

Once installed, you can use the contracts in the library by importing them:

pragma solidity ^0.8.4;

import "erc721s/contracts/ERC721s.sol";

contract Stablepunkz is ERC721S {
    constructor() ERC721A("Stablepunkz", "SPUNKZ") {}

    function pegToAsset(bytes32 asset) {
        _pegToAsset(asset)
    }

    function mint(uint256 quantity) external payable {
        // `_mint`'s second argument now takes in a `quantity`, not a `tokenId`.
        _mint(msg.sender, quantity);
    }
}

Roadmap

• Improve general repo and code quality (workflows, comments, etc.)
• Add more documentation on benefits of using ERC721S
• Maintain full test coverage

See the open issues for a full list of proposed features (and known issues).

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

Running tests locally

1. npm install
2. npm run test

License

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

Contact

• Timo Sarkar (creator & maintainer) - @timosar