Skip to main content

AirdropERC1155Claimable

Methods

airdropTokenAddress

function airdropTokenAddress() external view returns (address)

address of token being airdropped.

Returns

NameTypeDescription
_0addressundefined

availableAmount

function availableAmount(uint256) external view returns (uint256)

number tokens available to claim for a tokenId.

Parameters

NameTypeDescription
_0uint256undefined

Returns

NameTypeDescription
_0uint256undefined

claim

function claim(address _receiver, uint256 _quantity, uint256 _tokenId, bytes32[] _proofs, uint256 _proofMaxQuantityForWallet) external nonpayable

Lets an account claim a given quantity of ERC1155 tokens.

Parameters

NameTypeDescription
_receiveraddressThe receiver of the tokens to claim.
_quantityuint256The quantity of tokens to claim.
_tokenIduint256Token Id to claim.
_proofsbytes32[]The proof of the claimer's inclusion in the merkle root allowlist of the claim conditions that apply.
_proofMaxQuantityForWalletuint256The maximum number of tokens an address included in an allowlist can claim.

contractType

function contractType() external pure returns (bytes32)

Returns the type of the contract.

Returns

NameTypeDescription
_0bytes32undefined

contractVersion

function contractVersion() external pure returns (uint8)

Returns the version of the contract.

Returns

NameTypeDescription
_0uint8undefined

expirationTimestamp

function expirationTimestamp() external view returns (uint256)

airdrop expiration timestamp.

Returns

NameTypeDescription
_0uint256undefined

initialize

function initialize(address _defaultAdmin, address[] _trustedForwarders, address _tokenOwner, address _airdropTokenAddress, uint256[] _tokenIds, uint256[] _availableAmounts, uint256 _expirationTimestamp, uint256[] _maxWalletClaimCount, bytes32[] _merkleRoot) external nonpayable

Initializes the contract, like a constructor.

Parameters

NameTypeDescription
_defaultAdminaddressundefined
_trustedForwardersaddress[]undefined
_tokenOwneraddressundefined
_airdropTokenAddressaddressundefined
_tokenIdsuint256[]undefined
_availableAmountsuint256[]undefined
_expirationTimestampuint256undefined
_maxWalletClaimCountuint256[]undefined
_merkleRootbytes32[]undefined

isTrustedForwarder

function isTrustedForwarder(address forwarder) external view returns (bool)

Parameters

NameTypeDescription
forwarderaddressundefined

Returns

NameTypeDescription
_0boolundefined

maxWalletClaimCount

function maxWalletClaimCount(uint256) external view returns (uint256)

general claim limit for a tokenId if claimer not in allowlist.

Parameters

NameTypeDescription
_0uint256undefined

Returns

NameTypeDescription
_0uint256undefined

merkleRoot

function merkleRoot(uint256) external view returns (bytes32)

mapping of tokenId to merkle root of the allowlist of addresses eligible to claim.

Parameters

NameTypeDescription
_0uint256undefined

Returns

NameTypeDescription
_0bytes32undefined

multicall

function multicall(bytes[] data) external nonpayable returns (bytes[] results)

Receives and executes a batch of function calls on this contract.

Parameters

NameTypeDescription
databytes[]undefined

Returns

NameTypeDescription
resultsbytes[]undefined

owner

function owner() external view returns (address)

Returns the owner of the contract.

Returns

NameTypeDescription
_0addressundefined

setOwner

function setOwner(address _newOwner) external nonpayable

Lets an authorized wallet set a new owner for the contract.

Parameters

NameTypeDescription
_newOwneraddressThe address to set as the new owner of the contract.

supplyClaimedByWallet

function supplyClaimedByWallet(uint256, address) external view returns (uint256)

Mapping from tokenId and claimer address to total number of tokens claimed.

Parameters

NameTypeDescription
_0uint256undefined
_1addressundefined

Returns

NameTypeDescription
_0uint256undefined

tokenIds

function tokenIds(uint256) external view returns (uint256)

list of tokens to airdrop.

Parameters

NameTypeDescription
_0uint256undefined

Returns

NameTypeDescription
_0uint256undefined

tokenOwner

function tokenOwner() external view returns (address)

address of owner of tokens being airdropped.

Returns

NameTypeDescription
_0addressundefined

verifyClaim

function verifyClaim(address _claimer, uint256 _quantity, uint256 _tokenId, bytes32[] _proofs, uint256 _proofMaxQuantityForWallet) external view

Checks a request to claim tokens against the active claim condition's criteria.

Parameters

NameTypeDescription
_claimeraddressundefined
_quantityuint256undefined
_tokenIduint256undefined
_proofsbytes32[]undefined
_proofMaxQuantityForWalletuint256undefined

Events

Initialized

event Initialized(uint8 version)

Parameters

NameTypeDescription
versionuint8undefined

OwnerUpdated

event OwnerUpdated(address indexed prevOwner, address indexed newOwner)

Parameters

NameTypeDescription
prevOwner indexedaddressundefined
newOwner indexedaddressundefined

TokensClaimed

event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed tokenId, uint256 quantityClaimed)

Parameters

NameTypeDescription
claimer indexedaddressundefined
receiver indexedaddressundefined
tokenId indexeduint256undefined
quantityClaimeduint256undefined