T402 API Reference - v2.8.0
    Preparing search index...

    Interface FacilitatorBtcSigner

    Facilitator BTC signer interface for verify and settle operations

    interface FacilitatorBtcSigner {
        getAddresses(): readonly string[];
        verifyPsbt(
            params: {
                signedPsbt: string;
                expectedPayTo: string;
                expectedAmount: string;
            },
        ): Promise<{ valid: boolean; reason?: string; payer?: string }>;
        broadcastPsbt(signedPsbt: string): Promise<string>;
        waitForConfirmation(
            txId: string,
            confirmations?: number,
        ): Promise<
            {
                confirmed: boolean;
                txId: string;
                blockHash?: string;
                confirmations: number;
            },
        >;
    }
    Index

    Methods

    getAddresses verifyPsbt broadcastPsbt waitForConfirmation

    Methods

    • Verify a signed PSBT Checks that outputs match expected values and signatures are valid

      Parameters

      • params: { signedPsbt: string; expectedPayTo: string; expectedAmount: string }

        Verification parameters

      Returns Promise<{ valid: boolean; reason?: string; payer?: string }>

      Verification result

    • Wait for a transaction to be confirmed

      Parameters

      • txId: string

        Transaction ID

      • Optionalconfirmations: number

        Number of confirmations to wait for

      Returns Promise<
          {
              confirmed: boolean;
              txId: string;
              blockHash?: string;
              confirmations: number;
          },
      >

      Confirmation result

    Settings

    Member Visibility

    On This Page

    Methods