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

    Interface ArkadeInfo

    The Arkade server's advertised configuration — the /v1/info response.

    Naming/placement vs the NArk reference (AGENTS.md asks divergences to be noted): NArk calls this ArkServerInfo, reads it via GetServerInfoAsync on the transport, and caches it in a dedicated CachingClientTransport. This SDK names it for the product (ArkadeInfo, per #734) and hangs the read off the wallet (getArkadeInfo()), because here the wallet is the one object every consumer already holds and — in the service-worker model — the only side that has a transport at all; the page has no provider to hang it on. The CachingClientTransport-style memo lives at this layer instead, as CachingArkProvider.

    interface ArkadeInfo {
        boardingExitDelay: bigint;
        checkpointTapscript: string;
        deprecatedSigners: DeprecatedSigner[];
        digest: string;
        dust: bigint;
        fees: FeeInfo;
        forfeitAddress: string;
        forfeitPubkey: string;
        maxOpReturnOutputs?: bigint;
        maxTxWeight?: bigint;
        network: string;
        scheduledSession?: ScheduledSession;
        serviceStatus: ServiceStatus;
        sessionDuration: bigint;
        signerPubkey: string;
        unilateralExitDelay: bigint;
        utxoMaxAmount: bigint;
        utxoMinAmount: bigint;
        version: string;
        vtxoMaxAmount: bigint;
        vtxoMinAmount: bigint;
        vtxoTreeExpiry?: bigint;
    }
    Index

    Properties

    boardingExitDelay checkpointTapscript deprecatedSigners digest dust fees forfeitAddress forfeitPubkey maxOpReturnOutputs? maxTxWeight? network scheduledSession? serviceStatus sessionDuration signerPubkey unilateralExitDelay utxoMaxAmount utxoMinAmount version vtxoMaxAmount vtxoMinAmount vtxoTreeExpiry?

    Properties

    boardingExitDelay: bigint
    checkpointTapscript: string
    deprecatedSigners: DeprecatedSigner[]
    digest: string
    dust: bigint
    fees: FeeInfo
    forfeitAddress: string
    forfeitPubkey: string
    maxOpReturnOutputs?: bigint

    Maximum OP_RETURN outputs the server accepts per transaction.

    undefined when not advertised — a server that omits the field and one that sends 0 both mean "no limit stated". Never 0n, which would read as a server that forbids them outright.

    maxTxWeight?: bigint

    Weight budget an ark transaction must stay under; the server answers TX_TOO_LARGE past it.

    undefined when not advertised — a server that omits the field and one that sends 0 both mean "no limit stated". Never 0n, which would read as a server that accepts no transaction at all.

    network: string
    scheduledSession?: ScheduledSession
    serviceStatus: ServiceStatus
    sessionDuration: bigint
    signerPubkey: string
    unilateralExitDelay: bigint
    utxoMaxAmount: bigint

    Maximum boarding input amount.

    -1 means unlimited, while 0 disables boarding.

    utxoMinAmount: bigint
    version: string
    vtxoMaxAmount: bigint

    Maximum virtual output amount.

    -1 means unlimited.

    vtxoMinAmount: bigint
    vtxoTreeExpiry?: bigint

    Sweep delay the operator advertises for the shared batch output. undefined when not advertised — never coerce to 0n, which would satisfy any floor comparison.

    Settings

    Member Visibility

    On This Page

    Properties