Class Snip20

An abstract fungible token.

Hierarchy

Contract
- Snip20

Implements

Fungible

Constructors

constructor

new Snip20(properties): Snip20
Parameters
- properties: string | Partial<Contract>
Returns Snip20
Inherited from Contract.constructor
- Defined in agent/connect.ts:545

Properties

`Optional` connection

connection?: Connection

decimals

decimals: number = null

The decimal precision of the token.

`Optional` instance

instance?: {
address?: string;
codeHash?: string;
}

Type declaration

Optional address?: string
Optional codeHash?: string

log

log: Console

name

name: string = null

The full name of the token.

symbol

symbol: string = null

The market symbol of the token.

totalSupply

totalSupply: string = null

The total supply of the token.

Accessors

asDescriptor

get asDescriptor(): Custom
Returns Custom
self as plain Token.Custom with a hidden (from serialization!) client property pointing to this.
- Defined in scrt/snip-20.ts:65

id

get id(): string
Get a comparable token ID.

Returns string
Implementation of Token.Fungible.id
- Defined in scrt/snip-20.ts:54

vk

get vk(): ViewingKeyClient
Get a client to the Viewing Key API.

Returns ViewingKeyClient
- Defined in scrt/snip-20.ts:59

Methods

addMinters

addMinters(minters): Promise<unknown>
Add addresses to be minters
Parameters
- minters: string[]
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:115

amount

amount(amount): Amount
Parameters
- amount: string
Returns Amount
Implementation of Fungible.amount
- Defined in scrt/snip-20.ts:201

batchSend

batchSend(actions): Promise<unknown>
Parameters
- actions: SendAction[]
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:195

batchSendFrom

batchSendFrom(actions): Promise<unknown>
Parameters
- actions: SendFromAction[]
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:198

batchTransfer

batchTransfer(actions): Promise<unknown>
Parameters
- actions: TransferAction[]
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:189

batchTransferFrom

batchTransferFrom(actions): Promise<unknown>
Parameters
- actions: TransferFromAction[]
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:192

burn

burn(amount, memo?): Promise<unknown>
Burn SNIP20 tokens
Parameters
- amount: string | number | bigint
- Optional memo: string
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:129

changeAdmin

changeAdmin(address): Promise<unknown>
Change the admin of the token, who can set the minters
Parameters
- address: string
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:107

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>
- Defined in scrt/snip-20.ts:148

decreaseAllowance

decreaseAllowance(amount, spender): Promise<unknown>
Decrease allowance to spender
Parameters
- amount: string | number | bigint
- spender: string
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:161

deposit

deposit(nativeToken): Promise<unknown>
Deposit native tokens into the contract.
Parameters
- nativeToken: ICoin[]
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:133

execute

execute(message, options?): Promise<unknown>
Execute a transaction on the specified instance as the specified Connection.
Parameters
- message: Message
- options: {
      execFee?: IFee;
      execMemo?: string;
      execSend?: ICoin[];
  } = {}
  - Optional execFee?: IFee
  - Optional execMemo?: string
  - Optional execSend?: ICoin[]
Returns Promise<unknown>
Inherited from Contract.execute
- Defined in agent/connect.ts:568

fetchMetadata

fetchMetadata(): Promise<Snip20>
Returns Promise<Snip20>
- Defined in scrt/snip-20.ts:76

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>
- Defined in scrt/snip-20.ts:141

getBalance

getBalance(address, key): Promise<string>
Parameters
- address: string
- key: string
Returns Promise<string>
- Defined in scrt/snip-20.ts:96

getTokenInfo

getTokenInfo(): Promise<Snip20TokenInfo>
Returns Promise<Snip20TokenInfo>
- Defined in scrt/snip-20.ts:91

increaseAllowance

increaseAllowance(amount, spender): Promise<unknown>
Increase allowance to spender
Parameters
- amount: string | number | bigint
- spender: string
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:152

isCustom

isCustom(): boolean
Returns boolean
true
Implementation of Fungible.isCustom
- Defined in scrt/snip-20.ts:72

isFungible

isFungible(): boolean
Returns boolean
true
Implementation of Fungible.isFungible
- Defined in scrt/snip-20.ts:70

isNative

isNative(): boolean
Returns boolean
false
Implementation of Fungible.isNative
- Defined in scrt/snip-20.ts:74

mint

mint(amount, recipient?): Promise<unknown>
Mint SNIP20 tokens
Parameters
- amount: string | number | bigint
- recipient: string = ...
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:119

query

query<Q>(message): Promise<Q>
Execute a query on the specified instance as the specified Connection.
Type Parameters
- Q
Parameters
- message: Message
Returns Promise<Q>
Inherited from Contract.query
- Defined in agent/connect.ts:556

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>
- Defined in scrt/snip-20.ts:137

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>
- Defined in scrt/snip-20.ts:173

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>
- Defined in scrt/snip-20.ts:182

setMinters

setMinters(minters): Promise<unknown>
Set specific addresses to be minters, remove all others
Parameters
- minters: string[]
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:111

transfer

transfer(amount, recipient): Promise<unknown>
Transfer tokens to address
Parameters
- amount: string | number | bigint
- recipient: string
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:165

transferFrom

transferFrom(owner, recipient, amount, memo?): Promise<unknown>
Parameters
- owner: string
- recipient: string
- amount: string
- Optional memo: string
Returns Promise<unknown>
- Defined in scrt/snip-20.ts:168

`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
- Defined in scrt/snip-20.ts:22

Class Snip20

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

properties: string | Partial<Contract>

Returns Snip20

Properties

Optional connection

decimals

Optional instance

Type declaration

Optional address?: string

Optional codeHash?: string

log

name

symbol

totalSupply

Accessors

asDescriptor

Returns Custom

id

Returns string

vk

Returns ViewingKeyClient

Methods

addMinters

Parameters

minters: string[]

Returns Promise<unknown>

amount

Parameters

amount: string

Returns Amount

batchSend

Parameters

actions: SendAction[]

Returns Promise<unknown>

batchSendFrom

Parameters

actions: SendFromAction[]

Returns Promise<unknown>

batchTransfer

Parameters

actions: TransferAction[]

Returns Promise<unknown>

batchTransferFrom

Parameters

actions: TransferFromAction[]

Returns Promise<unknown>

burn

Parameters

amount: string | number | bigint

Optional memo: string

Returns Promise<unknown>

changeAdmin

Parameters

address: string

Returns Promise<unknown>

checkAllowance

Parameters

spender: string

owner: string

key: string

Returns Promise<unknown>

decreaseAllowance

Parameters

amount: string | number | bigint

spender: string

Returns Promise<unknown>

deposit

Parameters

nativeToken: ICoin[]

Returns Promise<unknown>

`Optional` connection

`Optional` instance

`Optional` address?: string

`Optional` codeHash?: string

`Optional` memo: string

options: {
execFee?: IFee;
execMemo?: string;
execSend?: ICoin[];
} = {}

`Optional` execFee?: IFee

`Optional` execMemo?: string

`Optional` execSend?: ICoin[]

`Optional` denom: string

`Optional` callback: string | object

`Optional` hash: string

`Optional` msg: string

`Optional` memo: string