Token<ChainIdentifier>
type Token<ChainIdentifier> = object;
Defined in: atomiq-sdk/src/types/Token.ts:6
Type for all token types (BTC or smart chain)
Type Parameters
| Type Parameter | Default type |
|---|---|
ChainIdentifier extends string | string |
Properties
address
address: string;
Defined in: atomiq-sdk/src/types/Token.ts:32
Address of the token contract, or "" for Bitcoin
chain
chain: "SC" | "BTC";
Defined in: atomiq-sdk/src/types/Token.ts:38
Legacy chain identifier distinguishing between Smart Chain and Bitcoin tokens
chainId
chainId: ChainIdentifier | "BITCOIN" | "LIGHTNING";
Defined in: atomiq-sdk/src/types/Token.ts:10
Chain identifier for the token's chain
decimals
decimals: number;
Defined in: atomiq-sdk/src/types/Token.ts:23
Actual decimal places of the tokens
displayDecimals?
optional displayDecimals: number;
Defined in: atomiq-sdk/src/types/Token.ts:27
The decimal places that should be rendered and displayed to the user
equals()
equals: (other) => boolean;
Defined in: atomiq-sdk/src/types/Token.ts:48
Equality check between tokens
Parameters
| Parameter | Type |
|---|---|
other | Token |
Returns
boolean
lightning?
optional lightning: boolean;
Defined in: atomiq-sdk/src/types/Token.ts:42
Legacy lightning flag, determines whether a Bitcoin token is an Lightning or on-chain one
name
name: string;
Defined in: atomiq-sdk/src/types/Token.ts:19
Full name of the token
ticker
ticker: string;
Defined in: atomiq-sdk/src/types/Token.ts:15
Ticker of the token
toString()
toString: () => string;
Defined in: atomiq-sdk/src/types/Token.ts:52
Returns the
Returns
string