Update EIP-5725: Move to Last Call

Merged by EIP-Bot.

Author: DeFiFoFum

EIPS/eip-5725.md

@@ -1,8 +1,10 @@
 # EIP-5725: Transferrable Vesting NFT - Reference Implementation
+
 This repository serves as a reference implementation for **EIP-5725 Transferrable Vesting NFT Standard**. A Non-Fungible Token (NFT) standard used to vest ERC-20 tokens over a vesting release curve.
 
 ## Contents
+
 - [EIP-5725 Specification](./contracts/IERC5725.sol): Interface and definitions for the EIP-5725 specification.
-- [ERC-5725 Implementation (abstract)](./contracts/ERC5725.sol): ERC-5725 contract which can be extended to implement the specification. 
+- [ERC-5725 Implementation (abstract)](./contracts/ERC5725.sol): ERC-5725 contract which can be extended to implement the specification.
 - [VestingNFT Implementation](./contracts/reference/LinearVestingNFT.sol): Full ERC-5725 implementation using cliff vesting curve.
-- [LinearVestingNFT Implementation](./contracts/reference/VestingNFT.sol): Full ERC-5725 implementation using linear vesting curve.
+- [LinearVestingNFT Implementation](./contracts/reference/VestingNFT.sol): Full ERC-5725 implementation using linear vesting curve.

assets/eip-5725/README.md

@@ -12,8 +12,13 @@ abstract contract ERC5725 is IERC5725, ERC721 {
     using SafeERC20 for IERC20;
 
     /// @dev mapping for claimed payouts
-    mapping(uint256 => uint256) /*tokenId*/ /*claimed*/
-        internal _payoutClaimed;
+    mapping(uint256 => uint256) /*tokenId*/ /*claimed*/ internal _payoutClaimed;
+
+    /// @dev Mapping from token ID to approved tokenId operator
+    mapping(uint256 => address) private _tokenIdApprovals;
+
+    /// @dev Mapping from owner to operator approvals
+    mapping(address => mapping(address => bool)) /* owner */ /*(operator, isApproved)*/ internal _operatorApprovals;
 
     /**
      * @notice Checks if the tokenId exists and its valid
@@ -28,7 +33,8 @@ abstract contract ERC5725 is IERC5725, ERC721 {
      * @dev See {IERC5725}.
      */
     function claim(uint256 tokenId) external override(IERC5725) validToken(tokenId) {
-        require(ownerOf(tokenId) == msg.sender, "Not owner of NFT");
+        require(isApprovedClaimOrOwner(msg.sender, tokenId), "ERC5725: not owner or operator");
+
         uint256 amountClaimed = claimablePayout(tokenId);
         require(amountClaimed > 0, "ERC5725: No pending payout");
 
@@ -38,6 +44,26 @@ abstract contract ERC5725 is IERC5725, ERC721 {
         IERC20(payoutToken(tokenId)).safeTransfer(msg.sender, amountClaimed);
     }
 
+    /**
+     * @dev See {IERC5725}.
+     */
+    function setClaimApprovalForAll(address operator, bool approved) external override(IERC5725) {
+        _setClaimApprovalForAll(operator, approved);
+        emit ClaimApprovalForAll(msg.sender, operator, approved);
+    }
+
+    /**
+     * @dev See {IERC5725}.
+     */
+    function setClaimApproval(
+        address operator,
+        bool approved,
+        uint256 tokenId
+    ) external override(IERC5725) validToken(tokenId) {
+        _setClaimApproval(operator, tokenId);
+        emit ClaimApproval(msg.sender, operator, tokenId, approved);
+    }
+
     /**
      * @dev See {IERC5725}.
      */
@@ -48,62 +74,44 @@ abstract contract ERC5725 is IERC5725, ERC721 {
     /**
      * @dev See {IERC5725}.
      */
-    function vestedPayoutAtTime(uint256 tokenId, uint256 timestamp)
-        public
-        view
-        virtual
-        override(IERC5725)
-        returns (uint256 payout);
+    function vestedPayoutAtTime(
+        uint256 tokenId,
+        uint256 timestamp
+    ) public view virtual override(IERC5725) returns (uint256 payout);
 
     /**
      * @dev See {IERC5725}.
      */
-    function vestingPayout(uint256 tokenId)
-        public
-        view
-        override(IERC5725)
-        validToken(tokenId)
-        returns (uint256 payout)
-    {
+    function vestingPayout(
+        uint256 tokenId
+    ) public view override(IERC5725) validToken(tokenId) returns (uint256 payout) {
         return _payout(tokenId) - vestedPayout(tokenId);
     }
 
     /**
      * @dev See {IERC5725}.
      */
-    function claimablePayout(uint256 tokenId)
-        public
-        view
-        override(IERC5725)
-        validToken(tokenId)
-        returns (uint256 payout)
-    {
+    function claimablePayout(
+        uint256 tokenId
+    ) public view override(IERC5725) validToken(tokenId) returns (uint256 payout) {
         return vestedPayout(tokenId) - _payoutClaimed[tokenId];
     }
 
     /**
      * @dev See {IERC5725}.
      */
-    function claimedPayout(uint256 tokenId)
-        public
-        view
-        override(IERC5725)
-        validToken(tokenId)
-        returns (uint256 payout)
-    {
+    function claimedPayout(
+        uint256 tokenId
+    ) public view override(IERC5725) validToken(tokenId) returns (uint256 payout) {
         return _payoutClaimed[tokenId];
     }
 
     /**
      * @dev See {IERC5725}.
      */
-    function vestingPeriod(uint256 tokenId)
-        public
-        view
-        override(IERC5725)
-        validToken(tokenId)
-        returns (uint256 vestingStart, uint256 vestingEnd)
-    {
+    function vestingPeriod(
+        uint256 tokenId
+    ) public view override(IERC5725) validToken(tokenId) returns (uint256 vestingStart, uint256 vestingEnd) {
         return (_startTime(tokenId), _endTime(tokenId));
     }
 
@@ -116,18 +124,81 @@ abstract contract ERC5725 is IERC5725, ERC721 {
 
     /**
      * @dev See {IERC165-supportsInterface}.
-     * IERC5725 interfaceId = 0x7c89676d
-     */
-    function supportsInterface(bytes4 interfaceId)
-        public
-        view
-        virtual
-        override(ERC721, IERC165)
-        returns (bool supported)
-    {
+     * IERC5725 interfaceId = 0xbd3a202b
+     */
+    function supportsInterface(
+        bytes4 interfaceId
+    ) public view virtual override(ERC721, IERC165) returns (bool supported) {
         return interfaceId == type(IERC5725).interfaceId || super.supportsInterface(interfaceId);
     }
 
+    /**
+     * @dev See {IERC5725}.
+     */
+    function getClaimApproved(uint256 tokenId) public view returns (address operator) {
+        return _tokenIdApprovals[tokenId];
+    }
+
+    /**
+     * @dev Returns true if `owner` has set `operator` to manage all `tokenId`s.
+     * @param owner The owner allowing `operator` to manage all `tokenId`s.
+     * @param operator The address who is given permission to spend tokens on behalf of the `owner`.
+     */
+    function isClaimApprovedForAll(address owner, address operator) public view returns (bool isClaimApproved) {
+        return _operatorApprovals[owner][operator];
+    }
+
+    /**
+     * @dev Public view which returns true if the operator has permission to claim for `tokenId`
+     * @notice To remove permissions, set operator to zero address.
+     *
+     * @param operator The address that has permission for a `tokenId`.
+     * @param tokenId The NFT `tokenId`.
+     */
+    function isApprovedClaimOrOwner(address operator, uint256 tokenId) public view virtual returns (bool) {
+        address owner = ownerOf(tokenId);
+        return (operator == owner || isClaimApprovedForAll(owner, operator) || getClaimApproved(tokenId) == operator);
+    }
+
+    /**
+     * @dev Internal function to set the operator status for a given owner to manage all `tokenId`s.
+     * @notice To remove permissions, set approved to false.
+     *
+     * @param operator The address who is given permission to spend vested tokens.
+     * @param approved The approved status.
+     */
+    function _setClaimApprovalForAll(address operator, bool approved) internal virtual {
+        _operatorApprovals[msg.sender][operator] = approved;
+    }
+
+    /**
+     * @dev Internal function to set the operator status for a given tokenId.
+     * @notice To remove permissions, set operator to zero address.
+     *
+     * @param operator The address who is given permission to spend vested tokens.
+     * @param tokenId The NFT `tokenId`.
+     */
+    function _setClaimApproval(address operator, uint256 tokenId) internal virtual {
+        require(ownerOf(tokenId) == msg.sender, "ERC5725: not owner of tokenId");
+        _tokenIdApprovals[tokenId] = operator;
+    }
+
+    /**
+     * @dev Internal function to hook into {IERC721-_afterTokenTransfer}, when a token is being transferred.
+     * Removes permissions to _tokenIdApprovals[tokenId] when the tokenId is transferred, burnt, but not on mint.
+     *
+     * @param from The address from which the tokens are being transferred.
+     * @param to The address to which the tokens are being transferred.
+     * @param firstTokenId The first tokenId in the batch that is being transferred.
+     * @param batchSize The number of tokens being transferred in this batch.
+     */
+    function _beforeTokenTransfer(address from, address to, uint256 firstTokenId, uint256 batchSize) internal override {
+        super._beforeTokenTransfer(from, to, firstTokenId, batchSize);
+        if (from != address(0)) {
+            delete _tokenIdApprovals[firstTokenId];
+        }
+    }
+
     /**
      * @dev Internal function to get the payout token of a given vesting NFT
      *