Hook for claiming an NFT from a smart contract.
Available to use on smart contracts that implement a
Claimable interface, and follow either the
A mutation object to claim a NFT to the wallet specified in the params
The mutation function takes an object as argument with below properties:
The wallet address to mint the NFT(s) to.
useAddress hook to get the currently connected wallet address.
The number of NFTs you wish to claim.
With ERC721 contracts, this represents the number of unique tokens you wish to claim.
With ERC1155 contracts, this represents the quantity of the specific
tokenIdyou wish to claim.
For ERC1155 contracts, you must specify a specific
tokenId to claim.
ClaimOptions object to override the default behaviour of the hook.
There are three options available:
checkERC20Allowance- Whether to check the ERC20 allowance of the sender, defaults to true.
currencyAddress- The currency to pay for each token claimed, defaults to
NATIVE_TOKEN_ADDRESSfor native currency.
pricePerToken- The price to pay for each token claimed. Not relevant when using claim conditions.