Class Snip20

An abstract fungible token.

Hierarchy

Client
- Snip20

Implements

TokenFungible

Constructors

constructor

new Snip20(options?): Snip20
Parameters
- options: Partial<Client> = {}
Returns Snip20
Inherited from Client.constructor
- Defined in agent/agent-client.ts:53

Properties

`Optional` address

address?: string

Address of the contract on the chain.

`Optional` agent

agent?: Agent

Agent that will interact with the contract.

`Optional` codeHash

codeHash?: string

Code hash confirming the contract's integrity.

`Optional` codeId

codeId?: string

Code ID for the contract's code.

decimals

decimals: null | number = null

The decimal precision of the token.

`Optional` fee

fee?: IFee

Default fee for all contract transactions.

fees

fees: Record<string, IFee> = {}

Default fee for specific transactions.

log

log: Console = ...

name

name: null | string = null

The full name of the token.

symbol

symbol: null | string = null

The market symbol of the token.

totalSupply

totalSupply: null | string = null

The total supply of the token.

Accessors

asContractCode

get asContractCode(): ContractCode
The contract template represented in factory format ({code_id, code_hash})

Returns ContractCode
Inherited from Client.asContractCode
- Defined in agent/agent-client.ts:70

asContractLink

get asContractLink(): ContractLink
The contract represented in ICC format ({address, code_hash})

Returns ContractLink
Inherited from Client.asContractLink
- Defined in agent/agent-client.ts:66

asDescriptor

get asDescriptor(): CustomToken
Returns CustomToken
self as plain CustomToken with a hidden (from serialization!) client property pointing to this.
- Defined in connect/scrt/scrt-token.ts:52

chain

get chain(): undefined | Chain
The chain on which this contract exists.

Returns undefined | Chain
Inherited from Client.chain
- Defined in agent/agent-client.ts:62

id

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

Returns string
Implementation of TokenFungible.id
- Defined in connect/scrt/scrt-token.ts:47

vk

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

Returns ViewingKeyClient
- Defined in connect/scrt/scrt-token.ts:49

Methods

addMinters

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

batchSend

batchSend(actions): Promise<unknown>
Parameters
- actions: SendAction[]
Returns Promise<unknown>
- Defined in connect/scrt/scrt-token.ts:156

batchSendFrom

batchSendFrom(actions): Promise<unknown>
Parameters
- actions: SendFromAction[]
Returns Promise<unknown>
- Defined in connect/scrt/scrt-token.ts:158

batchTransfer

batchTransfer(actions): Promise<unknown>
Parameters
- actions: TransferAction[]
Returns Promise<unknown>
- Defined in connect/scrt/scrt-token.ts:152

batchTransferFrom

batchTransferFrom(actions): Promise<unknown>
Parameters
- actions: TransferFromAction[]
Returns Promise<unknown>
- Defined in connect/scrt/scrt-token.ts:154

burn

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

changeAdmin

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

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 connect/scrt/scrt-token.ts:118

decreaseAllowance

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

deposit

deposit(nativeTokens): Promise<unknown>
Deposit native tokens into the contract.
Parameters
- nativeTokens: ICoin[]
Returns Promise<unknown>
- Defined in connect/scrt/scrt-token.ts:106

execute

execute(msg, opt?): Promise<unknown>
Execute a transaction on the specified contract as the specified Agent.
Parameters
- msg: Message
- opt: ExecOpts = {}
Returns Promise<unknown>
Inherited from Client.execute
- Defined in agent/agent-client.ts:85

fetchCodeHash

fetchCodeHash(expected?): Promise<Snip20>
Fetch code hash from address.
Parameters
- expected: undefined | string = ...
Returns Promise<Snip20>
Promise
Inherited from Client.fetchCodeHash
- Defined in agent/agent-client.ts:75

fetchMetadata

fetchMetadata(): Promise<Snip20>
Returns Promise<Snip20>
- Defined in connect/scrt/scrt-token.ts:61

getAllowance

getAllowance(owner, spender, key): Promise<Allowance>
Get the current allowance from owner to spender
Parameters
- owner: string
- spender: string
- key: string
Returns Promise<Allowance>
- Defined in connect/scrt/scrt-token.ts:112

getBalance

getBalance(address, key): Promise<string>
Parameters
- address: string
- key: string
Returns Promise<string>
- Defined in connect/scrt/scrt-token.ts:75

getFee

getFee(msg?): undefined | IFee
Get the recommended fee for a specific transaction.
Parameters
- Optional msg: string | Record<string, unknown>
Returns undefined | IFee
Inherited from Client.getFee
- Defined in agent/agent-client.ts:91

getTokenInfo

getTokenInfo(): Promise<TokenInfo>
Returns Promise<TokenInfo>
- Defined in connect/scrt/scrt-token.ts:70

increaseAllowance

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

isCustom

isCustom(): boolean
Returns boolean
true
Implementation of TokenFungible.isCustom
- Defined in connect/scrt/scrt-token.ts:57

isFungible

isFungible(): boolean
Returns boolean
true
Implementation of TokenFungible.isFungible
- Defined in connect/scrt/scrt-token.ts:55

isNative

isNative(): boolean
Returns boolean
false
Implementation of TokenFungible.isNative
- Defined in connect/scrt/scrt-token.ts:59

mint

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

query

query<U>(msg): Promise<U>
Execute a query on the specified contract as the specified Agent.
Type Parameters
- U
Parameters
- msg: Message
Returns Promise<U>
Inherited from Client.query
- Defined in agent/agent-client.ts:81

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 connect/scrt/scrt-token.ts:109

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 connect/scrt/scrt-token.ts:138

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 connect/scrt/scrt-token.ts:146

setMinters

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

transfer

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

transferFrom

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

`Protected` validate

validate(kind, expected, actual): void
Throw if fetched metadata differs from configured.
Parameters
- kind: string
- expected: any
- actual: any
Returns void
Inherited from Client.validate
- Defined in agent/agent-client.ts:122

withAgent

withAgent(agent?): Snip20
Parameters
- agent: undefined | Agent = ...
Returns Snip20
a copy of this Client that will execute the transactions as a different Agent.
Inherited from Client.withAgent
- Defined in agent/agent-client.ts:115

withFee

withFee(fee): Snip20
Use the specified fee for all transactions by this Client.
Parameters
- fee: IFee
Returns Snip20
Inherited from Client.withFee
- Defined in agent/agent-client.ts:104

withFees

withFees(fees): Snip20
Use the specified fee table for all subsequent transactions by this Client.
Parameters
- fees: Record<string, IFee>
Returns Snip20
Inherited from Client.withFees
- Defined in agent/agent-client.ts:110

`Static` fromDescriptor

fromDescriptor(descriptor, agent?): Snip20
Create a SNIP20 token client from a CustomToken descriptor.
Parameters
- descriptor: CustomToken
- Optional agent: Agent
Returns Snip20
- Defined in connect/scrt/scrt-token.ts:29

`Static` init

init(name, symbol, decimals, admin, config?, balances?): Snip20InitMsg
Create a SNIP20 init message.
Parameters
- name: string
- symbol: string
- decimals: number
- admin: string | {
  address: string;
  }
- config: Partial<Snip20InitConfig> = {}
- balances: {
  address: string;
  amount: string;
  }[] = []
Returns Snip20InitMsg
- Defined in connect/scrt/scrt-token.ts:32

Class Snip20

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Partial<Client> = {}

Returns Snip20

Properties

Optional address

Optional agent

Optional codeHash

Optional codeId

decimals

Optional fee

fees

log

meta

name

symbol

totalSupply

Accessors

asContractCode

Returns ContractCode

asContractLink

Returns ContractLink

asDescriptor

Returns CustomToken

chain

Returns undefined | Chain

id

Returns string

vk

Returns ViewingKeyClient

Methods

addMinters

Parameters

minters: string[]

Returns Promise<unknown>

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>

`Optional` address

`Optional` agent

`Optional` codeHash

`Optional` codeId

`Optional` fee

`Optional` memo: string

`Optional` msg: string | Record<string, unknown>

`Optional` denom: string

`Optional` callback: string | object