@1001-digital/erc721-extensions 中文文档教程

Question

ERC721 Contract Extensions

OpenZeppelin ERC721 基础合约的一组可组合扩展。

Available Extensions

WithContractMetaData.sol

直接从您的智能合约中链接到您收藏的合约元数据。

建立在 Ownable 之上，并允许合同所有者即使在部署后也可以更改合同元数据。

确保 URL 链接到适当的 JSON 文件。

contract Token is ERC721, WithContractMetadata {
  constructor()
    ERC721("Token", "LT")
    WithContractMetadata("ipfs://0123456789123456789123456789123456789123456789/metadata.json")
  {}
}

要更改合约元数据 URI，请以合约所有者身份调用 setContractURI(string uri)。

WithIPFSMetaData.sol

处理指向托管在 IPFS 上的元数据文件的链接，并遵循这样做的最佳实践：

• Projects have to embed the Content ID hash in the contract right from the start
• Project owners can never change the CID
• Tokens link to an ipfs://-URL to be independent of particular IPFS Gateways.
• Tokens wrap a folder with a metadata.json file (and pot. all the assets of the token).

注意：在公开销售完成之前，您不应该发布元数据。
这是为了防止人们试图狙击稀有标记（稀有性可以通过遍历所有元数据文件并查看特征和属性分布得出）。 尽管这样做非常昂贵（以汽油费计），但它有可能成为不良做法。

contract CleanToken is ERC721, WithIPFSMetaData {
  constructor()
    ERC721("CleanToken", "CT")
    WithIPFSMetaData("0123456789123456789123456789123456789123456789")
  {}
}

WithIPFSMetadataAndPreviewMetadata.sol

TODO

WithTransferTimeLock.sol

为了防止在公开销售代币后立即出现攻击向量，此扩展添加了一个时间锁在首次销售后转移 12 小时。 这让所有买家有足够的时间来熟悉他们的代币和整个收藏，以及物品的稀有性。

或者：从一开始就发布没有 tokenID 的整个收藏/或至少发布所有稀有度统计信息。

TODO

WithLimitedSupply.sol

限制代币供应的简单代币跟踪器。

要跟踪代币供应并获取下一个可用的代币 ID，请在创建新代币时调用 nextToken()。

contract RareToken is ERC721, WithLimitedSupply {
  constructor()
    ERC721("RareToken", "RT")
    WithLimitedSupply(1000) // Max. 1k NFTs available
  {}

  function mint () external ensureAvailability() {
    uint256 newTokenId = nextToken(); // Create a new token ID

    // ...
  }
}

内部的 nextToken() 方法不会自动检查令牌是否可用，但 WithLimitedSupply 提供了 ensureAvailability 修饰符，您可以将其附加到您的铸造函数。 如果您在同一笔交易中实施铸造多个令牌，您应该使用 ensureAvailabilityFor(amount) 修饰符检查可用性。

有两个合约以此为基础：LinearlyAssigned，它添加了从特定数字启动令牌跟踪器的选项；RandomlyAssigned，它支持半随机令牌 ID 分配。

LinearlyAssigned.sol

用最大供应量和起始索引实例化它：（

contract RareToken is ERC721, LinarlyAssigned {
  constructor()
    ERC721("RareToken", "RT")
    LinarlyAssigned(1000, 1) // Max. 1k NFTs available; Start counting from 1 (instead of 0)
  {}

  function mint () external ensureAvailability() {
    uint256 newTokenId = nextToken(); // Create a new token ID

    // ...
  }
}

RandomlyAssigned.sol

半）随机*从薄荷上的固定集合大小分配代币 ID。

contract RandomToken is ERC721, RandomlyAssigned {
  constructor()
    ERC721("RandomToken", "RT")
    RandomlyAssigned(1000, 1) // Max. 1k NFTs available; Start counting from 1 (instead of 0)
  {}

  function mint () external ensureAvailability() {
    uint256 newTokenId = nextToken(); // Create a new random token ID

    // ...
  }
}

*) 我们无法在链上创建适当的随机数。 但这已经足够好了，如果你在公开销售期间隐藏你的元数据并且对 NFT 项目来说不是太有价值（pot.exploit 会花费大量的 gas，因此在经济上不可行为“正常”NFT 收藏做盈利). 如果您想要真正的随机分配，请查看 Chainlink。

WithSaleStart.sol

使合同所有者能够设置和更新公开销售日期的扩展。

这建立在 Ownable 扩展之上，因此只有合同部署者可以通过 setSaleStart(uint256 time) 更改销售开始时间。 此外，为了忠于 NFT 的无信任精神，在初始销售开始后无法更改销售开始。

要在您的项目中使用它，请调用 afterSaleStart / beforeSaleStart 修饰符。

contract MyToken is ERC721, WithSaleStart {
  constructor()
    ERC721("MyToken", "MT")
    WithSaleStart(1735686000)
  {}

  function claim () external afterSaleStart {
    // ...
  }
}

LimitedTokensPerWallet.sol

限制外部钱包可以持有的代币数量。

contract LimitedToken is ERC721, LimitedTokensPerWallet {
  constructor()
    ERC721("LimitedToken", "LT")
    LimitedTokensPerWallet(3) // Only allow three tokens per wallet
  {}

  // Mint & Transfer limits are taken care of by the library.
}

OnePerWallet.sol

LimitedTokensPerWallet 的更极端版本，它只允许在外部钱包地址中持有一个令牌。

要在您的项目中使用它，只需扩展合同即可。 如果您需要更多控制权，请调用 onePerWallet 修饰符。

contract OneForAllToken is ERC721, OnePerWallet {
  constructor()
    ERC721("OneForAllToken", "OFA")
  {}

  // Mints and Transfer limites are taken care of by the library.
}

上面的代码不会阻止人们通过单独的智能合约铸造多个代币——它只检查外部拥有的账户（带有私钥的钱包）。 如果您想考虑到这一点，请在您的 mint 函数上另外激活 onePerAccount 修饰符。

WithMarketOffers.sol

实施一个简单的基于报价的市场。 代币所有者可以选择通过内置市场出售它们。

只需扩展 WithMarketOffers.sol 合同即可完成这项工作。

WithFees.sol

旨在抽象出当前费用标准的复杂性。

contract SharedUpsideToken is ERC721, WithFees {
  constructor()
    ERC721("SharedUpsideToken", "SUP")
    // 500 Basis Points (5%) of secondary sales 
    // should go to the given beneficiary address
    WithFees(0xe11Da9560b51f8918295edC5ab9c0a90E9ADa20B, 500)
  {}

  function supportsInterface(bytes4 interfaceId) public view override(WithFees, ERC721) returns (bool) {
    return WithFees.supportsInterface(interfaceId);
  }
}

WithWithdrawals.sol

一个实现取款功能的简单助手。

只需以合约所有者的身份调用withdraw。

Installation

1. In your project run npm install @1001-digital/erc721-extensions
2. Within your project, import the extensions you want to use like import "@1001-digital/erc721-extensions/contracts/WithIPFSMetaData.sol";

Local Development

该项目使用 Hardhat 开发环境。 要在本地进行设置，请克隆此存储库并运行 npm install。

注意：如果你的系统全局安装了 hh，你可以将 npm run 换成 hh。

• Run the test suite: npm run test
• Spin up a local development blockchain: npm run node

Thank You

如果您有任何改进建议、反馈或错误报告，请随时添加问题，或通过 Twitter @jwahdatehagh 或电子邮件 jalil@1001.digital。