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

    Interface ArkIntent

    interface ArkIntent {
        batchId?: string;
        cancellationReason?: string;
        commitmentTransactionId?: string;
        createdAt: number;
        deleteProof: string;
        deleteProofMessage: string;
        intentId?: string;
        intentTxId: string;
        intentVtxos: Outpoint[];
        partialForfeits: string[];
        registerProof: string;
        registerProofMessage: string;
        signerDescriptor?: string;
        state: ArkIntentState;
        updatedAt: number;
        validFrom?: number;
        validUntil?: number;
    }
    Index

    Properties

    batchId? cancellationReason? commitmentTransactionId? createdAt deleteProof deleteProofMessage intentId? intentTxId intentVtxos partialForfeits registerProof registerProofMessage signerDescriptor? state updatedAt validFrom? validUntil?

    Properties

    batchId?: string
    cancellationReason?: string
    commitmentTransactionId?: string
    createdAt: number
    deleteProof: string

    hex PSBT.

    deleteProofMessage: string
    intentId?: string

    Server-assigned batch intent id. Unique when present: saving a different intentTxId that reuses a live intentId is rejected (NArk parity). Absent until the intent is registered with arkd.

    intentTxId: string

    Intent proof tx id. Primary key.

    intentVtxos: Outpoint[]

    Input VTXOs locked by this intent.

    partialForfeits: string[]
    registerProof: string

    hex PSBT.

    registerProofMessage: string

    canonical JSON signed by the register proof.

    signerDescriptor?: string
    state: ArkIntentState
    updatedAt: number
    validFrom?: number
    validUntil?: number

    Settings

    Member Visibility

    On This Page

    Properties