ApeSwap

Ethereum Improvement Proposal 5725: Transferable Vesting NFTs is an EIP created to offer a standardized Non-Fungible Token (NFT) API to enable vesting ERC-20 tokens over a vesting release curve. Read on to learn more about how to implement EIP-5725 for your own use cases, and feel free to reach out to ApeTastic, coauthor of the EIP, on Telegram at &#64;Ape_tastic with any questions.<h3 id="strong-following-the-specification-strong">Following the Specification</h3>After reading through EIP-5725, the main section you will focus on during integration will be the <a href="https://eips.ethereum.org/EIPS/eip-5725#specification" rel="noopener noreferrer nofollow">EIP-5725 specification</a>.The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.During the integration process, take some time to read carefully through the <a href="https://docs.soliditylang.org/en/v0.8.19/natspec-format.html" rel="noopener noreferrer nofollow">natspec</a> comments of the <a href="https://eips.ethereum.org/EIPS/eip-5725#specification" rel="noopener noreferrer nofollow">EIP-5725 specification</a> to ensure you are implementing the functions the correct way. The key words above help define how the functions should work, given different inputs.<h3 id="strong-ierc5725-sol-on-github-strong">IERC5725.sol on GitHub</h3>A usable <a href="https://github.com/ApeSwapFinance/eip-5725-vesting-nft-implementation/blob/main/contracts/IERC5725.sol" rel="noopener noreferrer nofollow">IERC5725.sol</a> is stored publicly on the GitHub ERC-5725 reference implementation. This can be used as the base for ERC-5725 NFTs.Follow along below for how to use this interface to create your own ERC-5725 NFTs.Implementing an ERC-5725 Contract<h3 id="strong-obtain-the-base-contracts-strong">Obtain the Base Contracts</h3>The simplest way to get started is to head to the <a href="https://github.com/ApeSwapFinance/eip-5725-vesting-nft-implementation" rel="noopener noreferrer nofollow">EIP-5725 Reference Implementation</a> GitHub repository and click the button <a href="https://github.com/ApeSwapFinance/eip-5725-vesting-nft-implementation/generate" rel="noopener noreferrer nofollow">Use this template</a> to quickly create a copy of the code under your own GitHub profile.<img src="https://miro.medium.com/v2/resize:fit:1400/0*3osspHjzqTirWSXl" />Click “<a href="https://github.com/ApeSwapFinance/eip-5725-vesting-nft-implementation/generate" rel="noopener noreferrer nofollow">Use this template</a>” to copy the reference codeOtherwise, you can use git clone to copy the code locally, or even download the code in .ZIP files under the &lt;&gt; Code drop down.$ git clone git&#64;github.com:ApeSwapFinance/eip-5725-vesting-nft-implementation.git$ cd eip-5725-vesting-nft-implementationUse git clone to pull the reference codeExtending ERC5725.sol: Easily Create Vesting NFTs<a href="https://github.com/ApeSwapFinance/eip-5725-vesting-nft-implementation/blob/main/contracts/ERC5725.sol" rel="noopener noreferrer nofollow">ERC5725.sol</a> is a valid IERC-5725 implementation which can be used as a base to quickly create Vesting NFTs.// To WriteERC5725.sol is an abstract contract. To be able to implement ERC5725.sol you will need to import it into a parent contract and override 5 virtual functions:<ul><li>vestedPayoutAtTime: Total amount of vested tokens at the provided timestamp for a given tokenId. This number also includes vested tokens which have been claimed.</li><li>_payoutToken: Payout token of a given tokenId.</li><li>_payout: The total payout of a given tokenId.</li><li>_startTime: The unix timestamp of when vesting starts for a given tokenId.</li><li>_endTime: The unix timestamp of when vesting ends for a given tokenId.</li></ul>Full ERC5725 Implementation// To WriteTwo contracts are fully implemented in the <a href="https://github.com/ApeSwapFinance/eip-5725-vesting-nft-implementation/tree/main/contracts/referencehttps://github.com/ApeSwapFinance/eip-5725-vesting-nft-implementation/tree/main/contracts/reference" rel="noopener noreferrer nofollow">reference</a> directory: LinearVestingNFT and VestingNFT.Example <a href="https://github.com/ApeSwapFinance/eip-5725-vesting-nft-implementation/blob/main/contracts/reference/LinearVestingNFT.sol" rel="noopener noreferrer nofollow">LinearVestingNFT</a><ul><li>Extend ERC5725 by importing it: contract LinearVestingNFT is ERC5725</li><li>It can be seen in this implementation that the five virtual functions above are implemented in this contact with override specifiers</li><li>vestedPayoutAtTime is the central place to be able to change the vesting curve. In this case, it first checks that the _cliff has passed, otherwise it will linearly release tokens between the _startTime and _endTime</li></ul>Implement Your Own!// To Write<ul><li>ERC5725.sol is a great starting place to easily get off the ground with Vesting NFTs.</li><li>Use the reference implementations shared above as a guide to easily implement your own!</li></ul>Resources<ul><li><a href="https://eips.ethereum.org/EIPS/eip-5725" rel="noopener noreferrer nofollow">Official Ethereum EIP-5725</a></li><li><a href="https://github.com/ApeSwapFinance/eip-5725-vesting-nft-implementation" rel="noopener noreferrer nofollow">ERC-5725 Reference Implementation (GitHub Template)</a></li><li><a href="https://ethereum-magicians.org/t/eip-5725-transferable-vesting-nft/11099" rel="noopener noreferrer nofollow">Ethereum Magicians EIP-5725 Forum Discussion</a></li></ul>

Understanding and Developing an ERC-5725 Contract

Table of Contents

ApeSwap

Other articles published on Apr 17, 2023

Massive Shido AMA w/ CEO Thursday 2pm UTC!

Ukrainian grain ban triggers EU warning to Poland and Hungary

SWAP COMPETITION - “ TOP 10 " FINISHED

Investors Flock to TMS Network (TMSN) Over Stacks (STX) and Fantom (FTM) Amid Increasing Crypto S...

Nigerian app drivers’ union threatens million-man protest over Bolt and Uber’s plot to have their...

See the 8 most anticipated movies of Q2 2023

Join our free newsletter for daily crypto updates!