Class Erc20Burnable

Hierarchy

  • Erc20Burnable

Implements

  • DetectableFeature

Constructors

constructor

Properties

contractWrapper erc20 featureName from tokens

Constructors

constructor

Properties

Private contractWrapper

contractWrapper: ContractWrapper<IBurnableERC20>

Private erc20

erc20: Erc20<BaseERC20 | BaseSignatureMintERC20>

featureName

featureName: "ERC20Burnable" = FEATURE_TOKEN_BURNABLE.name

from

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

Type declaration

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

    • Burn Tokens

      Parameters

      • Rest ...args: [holder: string, amount: string | number]

      Returns Promise<TResult>

      Remarks

      Burn tokens held by the specified wallet

      Example

      // Address of the wallet sending the tokens
      const holderAddress = "{{wallet_address}}";

      // The amount of this token you want to burn
      const amount = 1.2;

      await contract.token.burn.from(holderAddress, amount);
  • prepare: ((...args) => Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>)
      • (...args): Promise<Transaction<Omit<TransactionResultWithMetadata<unknown>, "data">>>

      • Parameters

        • Rest ...args: [holder: string, amount: string | number]

        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 Tokens

      Parameters

      • Rest ...args: [amount: string | number]

      Returns Promise<TResult>

      Remarks

      Burn tokens held by the connected wallet

      Example

      // The amount of this token you want to burn
      const amount = 1.2;

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

      • Parameters

        • Rest ...args: [amount: string | number]

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc