Class Signer

constructor

• new Signer(
      client: Client,
      provider: BtcProvider,
      preferredNetworks?: NetworkPreference[],
  ): Xverse.Signer

  Creates an instance of Signer.

  Parameters

  • client: Client

    The client instance.
  • provider: BtcProvider

    The provider instance.
  • preferredNetworks: NetworkPreference[] = ...

  Returns Xverse.Signer

Readonlyprovider

supportsSingleCallSignAndBroadcast

• get supportsSingleCallSignAndBroadcast(): boolean

  Whether the wallet supports a single call to sign + broadcast (combined flow). Default false; override in implementations like Xverse/JoyID.

  Returns boolean

assertAddress

• assertAddress(): Promise<
      {
          address: string;
          publicKey: string;
          purpose: AddressPurpose;
          addressType: AddressType;
      },
  >

  Returns Promise<
      {
          address: string;
          publicKey: string;
          purpose: AddressPurpose;
          addressType: AddressType;
      },
  >

getBtcAccount

• getBtcAccount(): Promise<string>

  Gets the Bitcoin account address.

  Returns Promise<string>

  A promise that resolves to the Bitcoin account address.

getBtcPublicKey

• getBtcPublicKey(): Promise<`0x${string}`>

  Gets the Bitcoin public key.

  Returns Promise<`0x${string}`>

  A promise that resolves to the Bitcoin public key.

connect

• connect(): Promise<void>

  Connects to the provider by requesting accounts.

  Returns Promise<void>

  A promise that resolves when the connection is established.

disconnect

• disconnect(): Promise<void>

  Disconnects to the signer.

  Returns Promise<void>

  A promise that resolves when the signer is disconnected.

onReplaced

• onReplaced(listener: () => void): () => void

  Register a listener to be called when this signer is replaced.

  Parameters

  • listener: () => void

  Returns () => void

  A function for unregister

isConnected

• isConnected(): Promise<boolean>

  Checks if the signer is connected.

  Returns Promise<boolean>

  A promise that resolves to true if connected, false otherwise.

signMessageRaw

• signMessageRaw(message: BytesLike): Promise<string>

  Signs a raw message with the Bitcoin account.

  Parameters

  • message: BytesLike

    The message to sign.

  Returns Promise<string>

  A promise that resolves to the signed message.

signPsbt

• signPsbt(psbtHex: string, options?: SignPsbtOptions): Promise<string>

  Signs a PSBT using Xverse wallet.

  Parameters

  • psbtHex: string

    The hex string of PSBT to sign
  • Optionaloptions: SignPsbtOptions

    Options for signing the PSBT

  Returns Promise<string>

  A promise that resolves to the signed PSBT hex string

  Remarks

  Xverse accepts:

  • psbt: A string representing the PSBT to sign, encoded in base64
  • signInputs: A Record<string, number[]> where:
    • keys are the addresses to use for signing
    • values are the indexes of the inputs to sign with each address

  Xverse returns:

  • psbt: The base64 encoded signed PSBT

  See

  https://docs.xverse.app/sats-connect/bitcoin-methods/signpsbt

pushPsbt

• pushPsbt(psbtHex: string, options?: SignPsbtOptions): Promise<string>

  Signs and broadcasts a PSBT using Xverse wallet (single popup).

  Parameters

  • psbtHex: string

    The hex string of PSBT to sign and broadcast
  • Optionaloptions: SignPsbtOptions

    Options for signing the PSBT

  Returns Promise<string>

  A promise that resolves to SignPsbtResult:

  • psbt: base64 encoded signed PSBT
  • txid: transaction id (only when broadcast succeeds)

  Remarks

  Xverse accepts:

  • psbt: base64 encoded PSBT
  • signInputs: Record<address, number[]> input indexes to sign
  • broadcast: set to true to broadcast

  See

  https://docs.xverse.app/sats-connect/bitcoin-methods/signpsbt