Class Erc1155Burnable

Hierarchy

  • Erc1155Burnable

Implements

  • DetectableFeature

Constructors

constructor

Properties

batch batchFrom contractWrapper featureName from tokens

Constructors

constructor

Properties

batch

batch: {
    prepare: ((...args) => Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>);
    (...args): Promise<TResult>;
} = ...

Type declaration

    • (...args): Promise<TResult>

    • Burn a batch of NFTs

      Parameters

      • Rest ...args: [tokenIds: BigNumberish[], amounts: BigNumberish[]]

      Returns Promise<TResult>

      Remarks

      Burn the batch NFTs from the connected wallet

      Example

      // The token IDs to burn NFTs of
      const tokenIds = [0, 1];
      // The amounts of each NFT you want to burn
      const amounts = [2, 2];

      const result = await contract.edition.burn.batch(tokenIds, amounts);
  • prepare: ((...args) => Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>)
      • (...args): Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

      • Parameters

        • Rest ...args: [tokenIds: BigNumberish[], amounts: BigNumberish[]]

        Returns Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

batchFrom

batchFrom: {
    prepare: ((...args) => Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>);
    (...args): Promise<TResult>;
} = ...

Type declaration

    • (...args): Promise<TResult>

    • Burn a batch of NFTs

      Parameters

      • Rest ...args: [account: string, tokenIds: BigNumberish[], amounts: BigNumberish[]]

      Returns Promise<TResult>

      Remarks

      Burn the batch NFTs from the specified wallet

      Example

      // The address of the wallet to burn NFTS from
      const account = "0x...";
      // The token IDs to burn NFTs of
      const tokenIds = [0, 1];
      // The amounts of each NFT you want to burn
      const amounts = [2, 2];

      const result = await contract.edition.burn.batchFrom(account, tokenIds, amounts);
  • prepare: ((...args) => Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>)
      • (...args): Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

      • Parameters

        • Rest ...args: [account: string, tokenIds: BigNumberish[], amounts: BigNumberish[]]

        Returns Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

Private contractWrapper

contractWrapper: ContractWrapper<IBurnableERC1155>

featureName

featureName: "ERC1155Burnable" = FEATURE_EDITION_BURNABLE.name

from

from: {
    prepare: ((...args) => Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>);
    (...args): Promise<TResult>;
} = ...

Type declaration

    • (...args): Promise<TResult>

    • Burn a specified amount of a NFTs

      Parameters

      • Rest ...args: [account: string, tokenId: BigNumberish, amount: BigNumberish]

      Returns Promise<TResult>

      Remarks

      Burn the specified NFTs from a specified wallet

      Example

      // The address of the wallet to burn NFTS from
      const account = "0x...";
      // The token ID to burn NFTs of
      const tokenId = 0;
      // The amount of this NFT you want to burn
      const amount = 2;

      const result = await contract.edition.burn.from(account, tokenId, amount);
  • prepare: ((...args) => Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>)
      • (...args): Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

      • Parameters

        • Rest ...args: [account: string, tokenId: BigNumberish, amount: BigNumberish]

        Returns Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

tokens

tokens: {
    prepare: ((...args) => Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>);
    (...args): Promise<TResult>;
} = ...

Type declaration

    • (...args): Promise<TResult>

    • Burn a specified amount of a NFTs

      Parameters

      • Rest ...args: [tokenId: BigNumberish, amount: BigNumberish]

      Returns Promise<TResult>

      Remarks

      Burn the specified NFTs from the connected wallet

      Example

      // The token ID to burn NFTs of
      const tokenId = 0;
      // The amount of the NFT you want to burn
      const amount = 2;

      const result = await contract.edition.burn.tokens(tokenId, amount);
  • prepare: ((...args) => Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>)
      • (...args): Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

      • Parameters

        • Rest ...args: [tokenId: BigNumberish, amount: BigNumberish]

        Returns Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc