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

    Interface ArkProvider

    interface ArkProvider {
        confirmRegistration(intentId: string): Promise<void>;
        deleteIntent(intent: SignedIntent<DeleteMessage>): Promise<void>;
        finalizeTx(arkTxid: string, finalCheckpointTxs: string[]): Promise<void>;
        getEventStream(
            signal: AbortSignal,
            topics: string[],
        ): AsyncIterableIterator<SettlementEvent>;
        getInfo(): Promise<ArkInfo>;
        getPendingTxs(
            intent: SignedIntent<GetPendingTxMessage>,
        ): Promise<PendingTx[]>;
        getTransactionsStream(
            signal: AbortSignal,
        ): AsyncIterableIterator<
            { arkTx?: TxNotification; commitmentTx?: TxNotification },
        >;
        registerIntent(intent: SignedIntent<RegisterMessage>): Promise<string>;
        submitSignedForfeitTxs(
            signedForfeitTxs: string[],
            signedCommitmentTx?: string,
        ): Promise<void>;
        submitTreeNonces(
            batchId: string,
            pubkey: string,
            nonces: TreeNonces,
        ): Promise<void>;
        submitTreeSignatures(
            batchId: string,
            pubkey: string,
            signatures: TreePartialSigs,
        ): Promise<void>;
        submitTx(
            signedArkTx: string,
            checkpointTxs: string[],
        ): Promise<
            { arkTxid: string; finalArkTx: string; signedCheckpointTxs: string[] },
        >;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • intentId: string

      Returns Promise<void>

    • Parameters

      • arkTxid: string
      • finalCheckpointTxs: string[]

      Returns Promise<void>

    • Parameters

      • signedForfeitTxs: string[]
      • OptionalsignedCommitmentTx: string

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      • signedArkTx: string
      • checkpointTxs: string[]

      Returns Promise<{ arkTxid: string; finalArkTx: string; signedCheckpointTxs: string[] }>