IAirdropERC1155
Thirdweb's Airdrop contracts provide a lightweight and easy to use mechanism to drop tokens. AirdropERC1155 contract is an airdrop contract for ERC1155 tokens. It follows a push mechanism for transfer of tokens to intended recipients.
Methods
addAirdropRecipients
function addAirdropRecipients(IAirdropERC1155.AirdropContent[] _contents) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _contents | IAirdropERC1155.AirdropContent[] | undefined |
airdrop
function airdrop(uint256 paymentsToProcess) external nonpayable
Lets contract-owner set up an airdrop of ERC1155 tokens to a list of addresses.
The token-owner should approve target tokens to Airdrop contract, which acts as operator for the tokens.
Parameters
| Name | Type | Description |
|---|---|---|
| paymentsToProcess | uint256 | The number of airdrop payments to process. |
getAllAirdropPayments
function getAllAirdropPayments() external view returns (struct IAirdropERC1155.AirdropContent[] contents)
Returns all airdrop payments set up -- pending, processed or failed.
Returns
| Name | Type | Description |
|---|---|---|
| contents | IAirdropERC1155.AirdropContent[] | undefined |
getAllAirdropPaymentsFailed
function getAllAirdropPaymentsFailed() external view returns (struct IAirdropERC1155.AirdropContent[] contents)
Returns all pending airdrop failed.
Returns
| Name | Type | Description |
|---|---|---|
| contents | IAirdropERC1155.AirdropContent[] | undefined |
getAllAirdropPaymentsPending
function getAllAirdropPaymentsPending() external view returns (struct IAirdropERC1155.AirdropContent[] contents)
Returns all pending airdrop payments.
Returns
| Name | Type | Description |
|---|---|---|
| contents | IAirdropERC1155.AirdropContent[] | undefined |
getAllAirdropPaymentsProcessed
function getAllAirdropPaymentsProcessed() external view returns (struct IAirdropERC1155.AirdropContent[] contents)
Returns all pending airdrop processed.
Returns
| Name | Type | Description |
|---|---|---|
| contents | IAirdropERC1155.AirdropContent[] | undefined |
Events
AirdropPayment
event AirdropPayment(address indexed recipient, IAirdropERC1155.AirdropContent content)
Emitted when an airdrop payment is made to a recipient.
Parameters
| Name | Type | Description |
|---|---|---|
recipient indexed | address | undefined |
| content | IAirdropERC1155.AirdropContent | undefined |
RecipientsAdded
event RecipientsAdded(IAirdropERC1155.AirdropContent[] _contents)
Emitted when airdrop recipients are uploaded to the contract.
Parameters
| Name | Type | Description |
|---|---|---|
| _contents | IAirdropERC1155.AirdropContent[] | undefined |