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

    Interface ProvisionedClaimSecret

    A claim key together with the preimage it claims with. pkScript and address are excluded: a claim leg funds nothing, so it names no refund destination.

    interface ProvisionedClaimSecret {
        descriptor: string;
        mustPersistPreimage: boolean;
        paymentHash: Uint8Array;
        preimage: Uint8Array;
        preimageSalt?: Uint8Array<ArrayBufferLike>;
        pubkey: Uint8Array;
    }

    Hierarchy

    Index

    Properties

    descriptor: string

    The wallet descriptor it came from. Public — persist it with the artifact; contractSigner resolves it back to a signer.

    mustPersistPreimage: boolean

    Persist preimage with the artifact: this wallet cannot re-derive it. True when the caller supplied P, or when the signer cannot sign deterministically. When false the preimage re-derives from the seed — given preimageSalt, where there is one — and nothing secret needs to be stored.

    paymentHash: Uint8Array

    sha256(preimage) — what the contract commits to.

    preimage: Uint8Array
    preimageSalt?: Uint8Array<ArrayBufferLike>

    The salt preimage was derived from, when it came from the salted arm. Public — the opposite of preimage above: persist it with the artifact in the clear, because without it a wallet holding the seed still cannot re-derive P.

    Absent on the other two arms: an HD child descriptor already names one artifact, and a stored preimage needs no derivation input.

    pubkey: Uint8Array

    x-only pubkey to bind into the covenant.