@arkade-os/sdk Documentation - v0.5.0-rc.11
    Preparing search index...

    Interface Recipient

    Recipient accepted by IWallet.send.

    IWallet.send

    interface Recipient {
        address: string;
        amount?: number;
        assets?: Asset[];
        extensions?: { payload: Uint8Array; type: number }[];
        tapTree?: Bytes;
    }
    Index

    Properties

    address: string
    amount?: number

    BTC amount in satoshis.

    Dust amount (330).

    assets?: Asset[]

    Assets to send to the same recipient (assetId & amount)

    extensions?: { payload: Uint8Array; type: number }[]
    tapTree?: Bytes

    The recipient contract's tapleaf set (VtxoScript.encode form), published on this output's PSBT_OUT_TAP_TREE so its spending paths are recoverable from the transaction alone — an address commits only to the output key.

    Refused unless it derives the recipient address's taproot key, and it must come from VtxoScript.encode(): leaf depths are ignored on read and the tree is rebuilt in arkd's canonical shape, so a tree from another encoder is refused even where it commits to the same address.