@arkade-os/sdk Documentation - v0.4.36
    Preparing search index...

    Interface VirtualCoin

    Virtual output data.

    • Coin
    • VirtualStatus
    interface VirtualCoin {
        arkTxId?: string;
        assets?: Asset[];
        createdAt: Date;
        isSpent?: boolean;
        isUnrolled: boolean;
        script: string;
        settledBy?: string;
        spentBy?: string;
        status: Status;
        txid: string;
        value: number;
        virtualStatus: VirtualStatus;
        vout: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    arkTxId? assets? createdAt isSpent? isUnrolled script settledBy? spentBy? status txid value virtualStatus vout

    Properties

    arkTxId?: string

    ID of the offchain Arkade transaction that spent the above checkpoint output, if applicable.

    assets?: Asset[]

    Assets carried by this virtual output, if any.

    createdAt: Date

    Creation time of the virtual output.

    isSpent?: boolean

    Whether this virtual output is already spent (boolean helper for spentBy). This is not set to true if the virtual output is unrolled or swept, only when it's spent offchain.

    isUnrolled: boolean

    Whether this virtual output has been broadcasted onchain via an unroll (unilateral exit).

    script: string

    The scriptPubKey (hex) locking this virtual output, as returned by the indexer.

    settledBy?: string

    ID of the onchain commitment transaction that settled this output, if applicable.

    spentBy?: string

    ID of the offchain checkpoint transaction that spent this output, if applicable.

    status: Status

    Onchain output status

    txid: string

    Transaction ID where the output was created

    value: number

    Value of the output in satoshis

    virtualStatus: VirtualStatus

    Virtual output status

    vout: number

    Transaction output index for this output

    Settings

    Member Visibility

    On This Page

    Properties