Add user ability to unlock with authorized deposit #82
Conversation
| /// only the admin account can add or remove receivers - in the future, a ReceiverProvider resource could | ||
| /// be added to provide this capability to separate authorized accounts. | ||
| /// | ||
| access(all) resource ReceiverCollector { |
There was a problem hiding this comment.
New admin resource to store authorized deposit handlers - this allows separating concerns with the existing Admin resource, and it's also not possible to add new fields into the existing Admin resource (not a valid change for contract update).
The resource is meant to be stored at a specific path in the admin account storage to allow certain methods to be accessible publicly via borrowAdminReceiverCollectorPublic.
| /// | ||
| /// Receivers are entities that can receive locked NFTs and deposit them using a specific deposit method | ||
| /// | ||
| access(all) struct Receiver { |
There was a problem hiding this comment.
New struct meant to organize how deposit handlers are stored in the admin's ReceiverCollector resource
|
|
||
| /// Interface for depositing NFTs to authorized receivers | ||
| /// | ||
| access(all) struct interface IAuthorizedDepositHandler { |
There was a problem hiding this comment.
New struct interface to ensure a valid deposit method to be used for the receiver in unlockWithAuthorizedDeposit is defined
Note: It is not possible to store functions (original approach).
|
|
||
| /// Expire lock if the locked NFT is eligible for force unlock and deposit by authorized receiver | ||
| /// | ||
| access(contract) fun expireLock(id: UInt64, nftType: Type) { |
There was a problem hiding this comment.
expireLock definition is moved at the contract level (with access(contract)) in order to be called from unlockWithAuthorizedDeposit, if authorized
| /// additional function parameters may be required by the receiver's deposit method and are passed in the | ||
| /// passThruParams map. | ||
| /// | ||
| access(Operate) fun unlockWithAuthorizedDeposit( |
There was a problem hiding this comment.
unlock a locked NFT if an authorized deposit method has been defined (e.g., deposit into escrow leaderboard) - no need for admin intervention
| @@ -231,6 +232,22 @@ access(all) contract Escrow { | |||
| } | |||
| } | |||
|
|
|||
| // Handler for depositing NFTs to the Escrow Collection, used by the NFTLocker contract. | |||
| access(all) struct DepositHandler: NFTLocker.IAuthorizedDepositHandler { | |||
There was a problem hiding this comment.
Deposit handler definition to unlock a locked NFT and add into escrow leaderboard
|
|
||
| /// This transaction creates a new ReceiverCollector resource and adds a new receiver to it with a deposit method that adds an NFT to an escrow leaderboard. | ||
| /// | ||
| transaction() { |
There was a problem hiding this comment.
Admin tx to set up escrow leaderboard receiver
|
|
||
| /// This transaction unlocks the NFT with provided ID and adds to an escrow leaderboard, unlocking them if necessary. | ||
| /// | ||
| transaction(leaderboardName: String, nftID: UInt64) { |
There was a problem hiding this comment.
User transaction to unlock a locked NFT and directly add into escrow leaderboard
| @@ -123,52 +277,93 @@ access(all) contract NFTLocker { | |||
| access(all) view fun getIDs(nftType: Type): [UInt64]? | |||
| access(Operate) fun lock(token: @{NonFungibleToken.NFT}, duration: UInt64) | |||
| access(Operate) fun unlock(id: UInt64, nftType: Type): @{NonFungibleToken.NFT} | |||
| access(Operate) fun unlockWithAuthorizedDeposit( | |||
| ?? panic("Could not borrow a reference to the public leaderboard collection") | ||
|
|
||
| // Add the NFT to the escrow leaderboard | ||
| escrowCollectionPublic.addEntryToLeaderboard(nft: <-nft, leaderboardName: leaderboardName, ownerAddress: ownerAddress) |
Changes:
NFTLockercontract to support the ability to force unlock an NFT with authorized deposit in a generic mannerEscrowcontract to define an interface-conforming deposit handler forNFTLockerThe changes are purely additive, they are not intended to affect any existing on-chain setup.