Class Snip20

decimals

Optional instance

name

symbol

totalSupply

asDescriptor

• get asDescriptor(): Custom

• Returns Custom

  self as plain Token.Custom with a hidden (from serialization!) client property pointing to this.

id

• get id(): string

• Get a comparable token ID.

  Returns string

vk

• get vk(): ViewingKeyClient

• Get a client to the Viewing Key API.

  Returns ViewingKeyClient

addMinters

• addMinters(minters): Promise<unknown>

• Add addresses to be minters

  Parameters

  • minters: string[]

  Returns Promise<unknown>

amount

• amount(amount): Amount

• Parameters

  • amount: string

  Returns Amount

batchSend

• batchSend(actions): Promise<unknown>

• Parameters

  • actions: SendAction[]

  Returns Promise<unknown>

batchSendFrom

• batchSendFrom(actions): Promise<unknown>

• Parameters

  • actions: SendFromAction[]

  Returns Promise<unknown>

batchTransfer

• batchTransfer(actions): Promise<unknown>

• Parameters

  • actions: TransferAction[]

  Returns Promise<unknown>

batchTransferFrom

• batchTransferFrom(actions): Promise<unknown>

• Parameters

  • actions: TransferFromAction[]

  Returns Promise<unknown>

burn

• burn(amount, memo?): Promise<unknown>

• Burn SNIP20 tokens

  Parameters

  • amount: string | number | bigint

  • Optional memo: string

  Returns Promise<unknown>

changeAdmin

• changeAdmin(address): Promise<unknown>

• Change the admin of the token, who can set the minters

  Parameters

  • address: string

  Returns Promise<unknown>

checkAllowance

• checkAllowance(spender, owner, key): Promise<unknown>

• Check the current allowance from owner to spender.

  Parameters

  • spender: string

  • owner: string

  • key: string

  Returns Promise<unknown>

decreaseAllowance

• decreaseAllowance(amount, spender): Promise<unknown>

• Decrease allowance to spender

  Parameters

  • amount: string | number | bigint

  • spender: string

  Returns Promise<unknown>

deposit

• deposit(nativeToken): Promise<unknown>

• Deposit native tokens into the contract.

  Parameters

  • nativeToken: ICoin[]

  Returns Promise<unknown>

fetchMetadata

• fetchMetadata(): Promise<Snip20>

• Returns Promise<Snip20>

getAllowance

• getAllowance(owner, spender, key): Promise<Snip20Allowance>

• Get the current allowance from owner to spender

  Parameters

  • owner: string

  • spender: string

  • key: string

  Returns Promise<Snip20Allowance>

getBalance

• getBalance(address, key): Promise<string>

• Parameters

  • address: string

  • key: string

  Returns Promise<string>

getTokenInfo

• getTokenInfo(): Promise<Snip20TokenInfo>

• Returns Promise<Snip20TokenInfo>

increaseAllowance

• increaseAllowance(amount, spender): Promise<unknown>

• Increase allowance to spender

  Parameters

  • amount: string | number | bigint

  • spender: string

  Returns Promise<unknown>

isCustom

• isCustom(): boolean

• Returns boolean

  true

isFungible

• isFungible(): boolean

• Returns boolean

  true

isNative

• isNative(): boolean

• Returns boolean

  false

mint

• mint(amount, recipient?): Promise<unknown>

• Mint SNIP20 tokens

  Parameters

  • amount: string | number | bigint

  • recipient: string = ...

  Returns Promise<unknown>

redeem

• redeem(amount, denom?): Promise<unknown>

• Redeem an amount of a native token from the contract.

  Parameters

  • amount: string | number | bigint

  • Optional denom: string

  Returns Promise<unknown>

send

• send(amount, recipient, callback?): Promise<unknown>

• Send tokens to address. Same as transfer but allows for receive callback.

  Parameters

  • amount: string | number | bigint

  • recipient: string

  • Optional callback: string | object

  Returns Promise<unknown>

sendFrom

• sendFrom(owner, amount, recipient, hash?, msg?, memo?): Promise<unknown>

• Parameters

  • owner: string

  • amount: string

  • recipient: String

  • Optional hash: string

  • Optional msg: string

  • Optional memo: string

  Returns Promise<unknown>

setMinters

• setMinters(minters): Promise<unknown>

• Set specific addresses to be minters, remove all others

  Parameters

  • minters: string[]

  Returns Promise<unknown>

transfer

• transfer(amount, recipient): Promise<unknown>

• Transfer tokens to address

  Parameters

  • amount: string | number | bigint

  • recipient: string

  Returns Promise<unknown>

transferFrom

• transferFrom(owner, recipient, amount, memo?): Promise<unknown>

• Parameters

  • owner: string

  • recipient: string

  • amount: string

  • Optional memo: string

  Returns Promise<unknown>

Static init

• init(__namedParameters): Snip20InitMsg

• Create a SNIP20 init message.

  Parameters

  • __namedParameters: {
        admin: string | {
            address: string;
        };
        balances?: {
            address: string;
            amount: string;
        }[];
        config?: Partial<Snip20InitConfig>;
        decimals: number;
        name?: string;
        prngSeed?: string;
        symbol: string;
    }

    • admin: string | {
          address: string;
      }

    • Optional balances?: {
          address: string;
          amount: string;
      }[]

    • Optional config?: Partial<Snip20InitConfig>

    • decimals: number

    • Optional name?: string

    • Optional prngSeed?: string

    • symbol: string

  Returns Snip20InitMsg