Balances and assets

Use client = createArksatClient(provider). Example variables are supplied by the application.

getBalance

BTC values are integer sats. available is spendable; total includes other holdings. Parameters

// No parameters

Returns

Promise<ArksatBalance>

Example

const balance = await client.getBalance()

getAssets

Returns held assets. rawAmount is exact; use displayAmountText for exact display. Parameters

// No parameters

Returns

Promise<ArksatAssetBalance[]>

Example

const assets = await client.getAssets()

getAssetDetails

Searches current holdings. Null does not indicate global nonexistence. Parameters

{ assetId: string }

Returns

Promise<ArksatAssetBalance | null>

Example

const asset = await client.getAssetDetails({ assetId })

getAssetMetadata

Returns metadata, supply, and optional control-asset information. Parameters

{ assetId: string }

Returns

Promise<ArksatAssetDetails>

Example

const metadata = await client.getAssetMetadata({ assetId })

Units

Token transaction amounts are atomic-unit strings. Check metadataPending and verified decimals before accepting decimal input. Amounts. Errors · Type definitions

Wallet methods

Events and utilities

Types

Balances and assets

getBalance

getAssets

getAssetDetails

getAssetMetadata

Units

​getBalance

​getAssets

​getAssetDetails

​getAssetMetadata

​Units

getBalance

getAssets

getAssetDetails

getAssetMetadata

Units