References
Erc1155

Erc1155

Standard ERC1155 NFT functions

Basic functionality for a ERC1155 contract that handles IPFS storage for you.

Example


const contract = await sdk.getContract("{{contract_address}}");
await contract.erc1155.transfer(walletAddress, tokenId, quantity);


class Erc1155<
    T extends DropERC1155 | TokenERC1155 | BaseERC1155 =
      | BaseERC1155
      | BaseSignatureMintERC1155,
  >
  implements UpdateableNetwork, DetectableFeature {}

Defined in


function constructor(
  contractWrapper: ContractWrapper<T>,
  storage: ThirdwebStorage<IpfsUploadBatchOptions>,
  chainId: number,
): Erc1155<T>;

Parameters

Type


let contractWrapper: ContractWrapper<T>;

Type


let storage: ThirdwebStorage<IpfsUploadBatchOptions>;

Type


let chainId: number;

Returns


let returnType: Erc1155<T>;

Methods

Defined in

Get NFT balance for the currently connected wallet


function balance(tokenId: BigNumberish): Promise<BigNumber>;

Parameters

Type


let tokenId: BigNumberish;

Returns


let returnType: Promise<BigNumber>;

Defined in

Get NFT balance of a specific wallet

Get a wallets NFT balance (number of NFTs in this contract owned by the wallet).

Example


// Address of the wallet to check NFT balance
const walletAddress = "{{wallet_address}}";
const tokenId = 0; // Id of the NFT to check
const balance = await contract.erc1155.balanceOf(
  walletAddress,
  tokenId,
);


function balanceOf(
  address: string,
  tokenId: BigNumberish,
): Promise<BigNumber>;

Parameters

Type


let address: string;

Type


let tokenId: BigNumberish;

Returns


let returnType: Promise<BigNumber>;

Defined in

Get a single NFT

Example


const tokenId = 0;
const nft = await contract.erc1155.get(tokenId);


function get(tokenId: BigNumberish): Promise<NFT>;

Parameters

the tokenId of the NFT to retrieve

Type


let tokenId: BigNumberish;

Returns


let returnType: Promise<NFT>;

The NFT metadata

Defined in


function getAddress(): string;

Returns


let returnType: string;

Defined in

Get all NFTs

Get all the data associated with every NFT in this contract.

By default, returns the first 100 NFTs, use queryParams to fetch more.

Example


const nfts = await contract.erc1155.getAll();


function getAll(queryParams?: {
  count?: number;
  start?: number;
}): Promise<Array<NFT>>;

Parameters

optional filtering to only fetch a subset of results.

Type


let queryParams: { count?: number; start?: number };

Returns


let returnType: Promise<Array<NFT>>;

The NFT metadata for all NFTs queried.

Defined in

Deprecated

Use contract.erc1155.claim.prepare(...args) instead

Construct a claim transaction without executing it. This is useful for estimating the gas cost of a claim transaction, overriding transaction options and having fine grained control over the transaction execution.


function getClaimTransaction(
  destinationAddress: string,
  tokenId: BigNumberish,
  quantity: BigNumberish,
  options?: ClaimOptions,
): Promise<
  Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>
>;

Parameters

Address you want to send the token to

Type


let destinationAddress: string;

Id of the token you want to claim

Type


let tokenId: BigNumberish;

Quantity of the tokens you want to claim

Type


let quantity: BigNumberish;

Optional claim verification data (e.g. price, currency, etc...)

Type


let options: ClaimOptions;

Returns


let returnType: Promise<
  Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>
>;

Defined in

Deprecated

Use contract.erc1155.mint.prepare(...args) instead

Construct a mint transaction without executing it. This is useful for estimating the gas cost of a mint transaction, overriding transaction options and having fine grained control over the transaction execution.


function getMintTransaction(receiver: string, metadataWithSupply: { metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; name: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodNumber]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<..., ...>, Array<...>, Array<...>>, ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodObject<{  }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodEffects<ZodString, string, string>, ZodString]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<..., ...>, Array<...>, Array<...>>, ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodObject<{  }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<BigNumber, ZodTypeDef, BigNumber>, ZodType<BN, ZodTypeDef, BN>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }) : Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

Parameters

Address you want to send the token to

Type


let receiver: string;

The metadata of the NFT you want to mint

Type


let metadataWithSupply: { metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; name: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodNumber]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<..., ...>, Array<...>, Array<...>>, ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodObject<{  }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodEffects<ZodString, string, string>, ZodString]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<..., ...>, Array<...>, Array<...>>, ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodObject<{  }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<BigNumber, ZodTypeDef, BigNumber>, ZodType<BN, ZodTypeDef, BN>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }

Returns


let returnType: Promise<
  Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>
>;

Defined in

Get all NFTs owned by a specific wallet

Get all the data associated with the NFTs owned by a specific wallet.

Example


// Address of the wallet to get the NFTs of
const address = "{{wallet_address}}";
const nfts = await contract.erc1155.getOwned(address);


function getOwned(
  walletAddress?: string,
  queryParams?: { count?: number; start?: number },
): Promise<Array<NFT>>;

Parameters

Type


let walletAddress: string;

Type


let queryParams: { count?: number; start?: number };

Returns


let returnType: Promise<Array<NFT>>;

The NFT metadata for all NFTs in the contract.

Defined in

Get whether this wallet has approved transfers from the given operator


function isApproved(
  address: string,
  operator: string,
): Promise<boolean>;

Parameters

the wallet address

Type


let address: string;

the operator address

Type


let operator: string;

Returns


let returnType: Promise<boolean>;

Defined in

Get the total supply of a specific NFT

This is not the sum of supply of all NFTs in the contract.


function totalCirculatingSupply(
  tokenId: BigNumberish,
): Promise<BigNumber>;

Parameters

Type


let tokenId: BigNumberish;

Returns


let returnType: Promise<BigNumber>;

The total number of NFTs minted in this contract

Defined in

Get the total number of NFTs minted

This returns the total number of NFTs minted in this contract, not the total supply of a given token.

Example


const count = await contract.erc1155.totalCount();
console.log(count);


function totalCount(): Promise<BigNumber>;

Returns


let returnType: Promise<BigNumber>;

The total number of NFTs minted in this contract

Defined in

Get the total supply of a specific token

Example


const tokenId = 0;
const nft = await contract.erc1155.totalSupply(tokenId);


function totalSupply(tokenId: BigNumberish): Promise<BigNumber>;

Parameters

The token ID to get the total supply of

Type


let tokenId: BigNumberish;

Returns


let returnType: Promise<BigNumber>;

The total supply

Defined in


function airdrop(
  tokenId: BigNumberish,
  addresses:
    | Array<string>
    | Array<{ address: string; quantity?: string | number }>,
  fromAddress: string,
  data: BytesLike,
): Promise<TResult>;

Parameters

Type


let tokenId: BigNumberish;

Type


let addresses:
  | Array<string>
  | Array<{ address: string; quantity?: string | number }>;

Type


let fromAddress: string;

Type


let data: BytesLike;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling airdrop.prepare() with same arguments. Learn more

Defined in


function burn(
  tokenId: BigNumberish,
  amount: BigNumberish,
): Promise<TResult>;

Parameters

Type


let tokenId: BigNumberish;

Type


let amount: BigNumberish;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling burn.prepare() with same arguments. Learn more

Defined in


function burnBatch(
  tokenIds: Array<BigNumberish>,
  amounts: Array<BigNumberish>,
): Promise<TResult>;

Parameters

Type


let tokenIds: Array<BigNumberish>;

Type


let amounts: Array<BigNumberish>;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling burnBatch.prepare() with same arguments. Learn more

Defined in


function burnBatchFrom(
  account: string,
  tokenIds: Array<BigNumberish>,
  amounts: Array<BigNumberish>,
): Promise<TResult>;

Parameters

Type


let account: string;

Type


let tokenIds: Array<BigNumberish>;

Type


let amounts: Array<BigNumberish>;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling burnBatchFrom.prepare() with same arguments. Learn more

Defined in


function burnFrom(
  account: string,
  tokenId: BigNumberish,
  amount: BigNumberish,
): Promise<TResult>;

Parameters

Type


let account: string;

Type


let tokenId: BigNumberish;

Type


let amount: BigNumberish;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling burnFrom.prepare() with same arguments. Learn more

Defined in


function claim(
  tokenId: BigNumberish,
  quantity: BigNumberish,
  options: ClaimOptions,
): Promise<TResult>;

Parameters

Type


let tokenId: BigNumberish;

Type


let quantity: BigNumberish;

Type


let options: ClaimOptions;

Returns


let returnType: Promise<TResult>;

Receipt for the transaction

Preparable

You can also prepare the transaction without executing it by calling claim.prepare() with same arguments. Learn more

Defined in


function claimTo(
  destinationAddress: string,
  tokenId: BigNumberish,
  quantity: BigNumberish,
  options: ClaimOptions,
): Promise<TResult>;

Parameters

Type


let destinationAddress: string;

Type


let tokenId: BigNumberish;

Type


let quantity: BigNumberish;

Type


let options: ClaimOptions;

Returns


let returnType: Promise<TResult>;

Receipt for the transaction

Preparable

You can also prepare the transaction without executing it by calling claimTo.prepare() with same arguments. Learn more

Defined in


function lazyMint(metadatas: Array<string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; name: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<..., ..., ...>, ZodType<..., ..., ...>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">)>, options: { onProgress: (event: UploadProgressEvent) => void }) : Promise<TResult>

Parameters

Type


let metadatas: Array<string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; name: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<..., ..., ...>, ZodType<..., ..., ...>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">)>

Type


let options: { onProgress: (event: UploadProgressEvent) => void };

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling lazyMint.prepare() with same arguments. Learn more

Defined in


function mint(metadataWithSupply: { metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; name: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<..., ..., ...>, ZodType<..., ..., ...>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }) : Promise<TResult>

Parameters

Type


let metadataWithSupply: { metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; name: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<..., ..., ...>, ZodType<..., ..., ...>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling mint.prepare() with same arguments. Learn more

Defined in


function mintAdditionalSupply(
  tokenId: BigNumberish,
  additionalSupply: BigNumberish,
): Promise<TResult>;

Parameters

Type


let tokenId: BigNumberish;

Type


let additionalSupply: BigNumberish;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling mintAdditionalSupply.prepare() with same arguments. Learn more

Defined in


function mintAdditionalSupplyTo(
  receiver: string,
  tokenId: BigNumberish,
  additionalSupply: BigNumberish,
): Promise<TResult>;

Parameters

Type


let receiver: string;

Type


let tokenId: BigNumberish;

Type


let additionalSupply: BigNumberish;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling mintAdditionalSupplyTo.prepare() with same arguments. Learn more

Defined in


function mintBatch(metadataWithSupply: Array<{ metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<...>>>; description: ZodNullable<ZodOptional<ZodNullable<...>>>; image: ZodOptional<ZodNullable<ZodUnion<...>>>; name: ZodNullable<ZodOptional<ZodUnion<...>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<...>>>; background_color: ZodNullable<ZodOptional<ZodUnion<...>>>; external_url: ZodOptional<ZodNullable<ZodUnion<...>>>; properties: ZodNullable<ZodOptional<ZodUnion<...>>> }>, ZodUnion<[ZodEffects<ZodUnion<[..., ..., ...]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }>) : Promise<TResult>

Parameters

Type


let metadataWithSupply: Array<{ metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<...>>>; description: ZodNullable<ZodOptional<ZodNullable<...>>>; image: ZodOptional<ZodNullable<ZodUnion<...>>>; name: ZodNullable<ZodOptional<ZodUnion<...>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<...>>>; background_color: ZodNullable<ZodOptional<ZodUnion<...>>>; external_url: ZodOptional<ZodNullable<ZodUnion<...>>>; properties: ZodNullable<ZodOptional<ZodUnion<...>>> }>, ZodUnion<[ZodEffects<ZodUnion<[..., ..., ...]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }>

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling mintBatch.prepare() with same arguments. Learn more

Defined in


function mintBatchTo(receiver: string, metadataWithSupply: Array<{ metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<...>>>; description: ZodNullable<ZodOptional<ZodNullable<...>>>; image: ZodOptional<ZodNullable<ZodUnion<...>>>; name: ZodNullable<ZodOptional<ZodUnion<...>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<...>>>; background_color: ZodNullable<ZodOptional<ZodUnion<...>>>; external_url: ZodOptional<ZodNullable<ZodUnion<...>>>; properties: ZodNullable<ZodOptional<ZodUnion<...>>> }>, ZodUnion<[ZodEffects<ZodUnion<[..., ..., ...]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }>) : Promise<TResult>

Parameters

Type


let receiver: string;

Type


let metadataWithSupply: Array<{ metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<...>>>; description: ZodNullable<ZodOptional<ZodNullable<...>>>; image: ZodOptional<ZodNullable<ZodUnion<...>>>; name: ZodNullable<ZodOptional<ZodUnion<...>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<...>>>; background_color: ZodNullable<ZodOptional<ZodUnion<...>>>; external_url: ZodOptional<ZodNullable<ZodUnion<...>>>; properties: ZodNullable<ZodOptional<ZodUnion<...>>> }>, ZodUnion<[ZodEffects<ZodUnion<[..., ..., ...]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }>

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling mintBatchTo.prepare() with same arguments. Learn more

Defined in


function mintTo(receiver: string, metadataWithSupply: { metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; name: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<..., ..., ...>, ZodType<..., ..., ...>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }) : Promise<TResult>

Parameters

Type


let receiver: string;

Type


let metadataWithSupply: { metadata: string | (objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; name: ZodNullable<ZodOptional<ZodUnion<[..., ...]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[..., ..., ...]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<..., ..., ...>, ZodType<..., ..., ...>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">); supply: string | number | bigint | (BigNumber) }

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling mintTo.prepare() with same arguments. Learn more

Defined in


function setApprovalForAll(
  operator: string,
  approved: boolean,
): Promise<TResult>;

Parameters

Type


let operator: string;

Type


let approved: boolean;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling setApprovalForAll.prepare() with same arguments. Learn more

Defined in


function transfer(
  to: string,
  tokenId: BigNumberish,
  amount: BigNumberish,
  data: BytesLike,
): Promise<TResult>;

Parameters

Type


let to: string;

Type


let tokenId: BigNumberish;

Type


let amount: BigNumberish;

Type


let data: BytesLike;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling transfer.prepare() with same arguments. Learn more

Defined in


function transferBatch(
  to: string,
  tokenIds: Array<BigNumberish>,
  amounts: Array<BigNumberish>,
  fromAddress: string,
  data: BytesLike,
): Promise<TResult>;

Parameters

Type


let to: string;

Type


let tokenIds: Array<BigNumberish>;

Type


let amounts: Array<BigNumberish>;

Type


let fromAddress: string;

Type


let data: BytesLike;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling transferBatch.prepare() with same arguments. Learn more

Defined in


function transferFrom(
  from: string,
  to: string,
  tokenId: BigNumberish,
  amount: BigNumberish,
  data: BytesLike,
): Promise<TResult>;

Parameters

Type


let from: string;

Type


let to: string;

Type


let tokenId: BigNumberish;

Type


let amount: BigNumberish;

Type


let data: BytesLike;

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling transferFrom.prepare() with same arguments. Learn more

Defined in


function updateMetadata(tokenId: BigNumberish, metadata: objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; name: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodNumber]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<..., ...>, Array<...>, Array<...>>, ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodObject<{  }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodEffects<ZodString, string, string>, ZodString]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<..., ...>, Array<...>, Array<...>>, ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodObject<{  }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<BigNumber, ZodTypeDef, BigNumber>, ZodType<BN, ZodTypeDef, BN>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">) : Promise<TResult>

Parameters

Type


let tokenId: BigNumberish;

Type


let metadata: objectInputType<extendShape<{ animation_url: ZodNullable<ZodOptional<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; description: ZodNullable<ZodOptional<ZodNullable<ZodString>>>; image: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; name: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodNumber]>>> }, { attributes: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<..., ...>, Array<...>, Array<...>>, ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodObject<{  }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>>>; background_color: ZodNullable<ZodOptional<ZodUnion<[ZodString, ZodEffects<ZodString, string, string>, ZodString]>>>; external_url: ZodOptional<ZodNullable<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>>; properties: ZodNullable<ZodOptional<ZodUnion<[ZodEffects<ZodArray<..., ...>, Array<...>, Array<...>>, ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodObject<{  }, "strip", ZodUnion<...>, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>>> }>, ZodUnion<[ZodEffects<ZodUnion<[ZodBigInt, ZodType<BigNumber, ZodTypeDef, BigNumber>, ZodType<BN, ZodTypeDef, BN>]>, string, bigint | (BN) | (BigNumber)>, ZodUnknown]>, "strip">

Returns


let returnType: Promise<TResult>;

Preparable

You can also prepare the transaction without executing it by calling updateMetadata.prepare() with same arguments. Learn more

Properties

Defined in


let featureName: "ERC1155";

Accessors

Defined in


let chainId: number;

Defined in

Configure claim conditions

Define who can claim NFTs in the collection, when and how many.


let claimConditions: DropErc1155ClaimConditions<BaseClaimConditionERC1155>;

Example


const presaleStartTime = new Date();
const publicSaleStartTime = new Date(Date.now() + 60 * 60 * 24 * 1000);
const claimConditions = [
  {
    startTime: presaleStartTime, // start the presale now
    maxClaimableSupply: 2, // limit how many mints for this presale
    price: 0.01, // presale price
    snapshot: ['0x...', '0x...'], // limit minting to only certain addresses
  },
  {
    startTime: publicSaleStartTime, // 24h after presale, start public sale
    price: 0.08, // public sale price
  }
]);
await contract.erc1155.claimConditions.set(tokenId, claimConditions);

Defined in

Mint delayed reveal NFTs

Create a batch of encrypted NFTs that can be revealed at a later time.


let revealer: DelayedReveal<BaseDelayedRevealERC1155>;

Example


// the real NFTs, these will be encrypted until you reveal them
const realNFTs = [
  {
    name: "Common NFT #1",
    description: "Common NFT, one of many.",
    image: fs.readFileSync("path/to/image.png"),
  },
  {
    name: "Super Rare NFT #2",
    description: "You got a Super Rare NFT!",
    image: fs.readFileSync("path/to/image.png"),
  },
];
// A placeholder NFT that people will get immediately in their wallet, and will be converted to the real NFT at reveal time
const placeholderNFT = {
  name: "Hidden NFT",
  description: "Will be revealed next week!",
};
// Create and encrypt the NFTs
await contract.erc1155.drop.revealer.createDelayedRevealBatch(
  placeholderNFT,
  realNFTs,
  "my secret password",
);
// Whenever you're ready, reveal your NFTs at any time
const batchId = 0; // the batch to reveal
await contract.erc1155.revealer.reveal(batchId, "my secret password");

Defined in

Mint with signature

Generate dynamic NFTs with your own signature, and let others mint them using that signature.


let signature: Erc1155SignatureMintable;

Example


// see how to craft a payload to sign in the `contract.erc1155.signature.generate()` documentation
const signedPayload = contract.erc1155.signature().generate(payload);
 
// now anyone can mint the NFT
const tx = contract.erc1155.signature.mint(signedPayload);
const receipt = tx.receipt; // the mint transaction receipt
const mintedId = tx.id; // the id of the NFT minted

Was this page helpful?

Need help?
Visit our support site
Watch our
Video Tutorials
View our
Changelog

Subscribe for the latest dev updates

Erc1155

Example

Signature

Constructor

Signature

Parameters

contractWrapper

Type

storage

Type

chainId

Type

Returns

Return Type

Methods

balance

Signature

Parameters

tokenId

Type

Returns

Return Type

balanceOf

Example

Signature

Parameters

address

Type

tokenId

Type

Returns

Return Type

get

Example

Signature

Parameters

tokenId

Type

Returns

Return Type

getAddress

Signature

Returns

Return Type

getAll

Example

Signature

Parameters

queryParams

Type

Returns

Return Type

getClaimTransaction

Signature

Parameters

destinationAddress

Type

tokenId

Type

quantity

Type

options

Type

Returns

Return Type

getMintTransaction

Signature

Parameters

receiver

Type

metadataWithSupply

Type

Returns

Return Type

getOwned

Example

Signature

Parameters

walletAddress

Type