Transfers and swap funding

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

sendToAddress

amount is a positive integer in sats. Requires user approval. Parameters

{ address: string; amount: number }

Returns

Promise<{ txid: string }>

Example

const { txid } = await client.sendToAddress({ address, amount: 1000 })

Each asset has assetId and atomic-unit amount. bitcoinAmount is BTC sent in sats, not a fee. Parameters

{ address: string; assets: ArksatAssetTransfer[]; bitcoinAmount?: number }

Returns

Promise<{ txid: string }>

Example

const { txid } = await client.sendAsset({ address, assets: [{ assetId, amount: '100' }] })

Submits swap funding; does not fetch quotes or complete an entire swap. Wallet Swap is testnet only. Parameters

ArksatSwapFundingParams

Returns

Promise<{ txid: string }>

Example

const { txid } = await client.sendSwapFunding(fundingParams)

Field	Type	Description
address	string	Recipient
assets	ArksatAssetTransfer[]	Atomic-unit amounts
bitcoinAmount	number	Integer sats
extension	`{ type: number; payload: string }`	Protocol extension
timingId	string, optional	Diagnostic correlation
expectedAddress / expectedNetwork / expectedSessionId	optional	Session guards

Check activity before retrying a timed-out submission. Transfer guide. Errors · Type definitions