Class Signer

constructor

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

  Creates an instance of Signer.

  Parameters

  • client: Client

    The client instance.

  • provider: BtcProvider

    The provider instance.

  • Optional_preferredNetworks: NetworkPreference[]
  • Optionalnetwork: WalletNetworkName

  Returns Xverse.Signer

Readonlyprovider

Optional Readonlynetwork

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: BytesLike,
      options?: SignPsbtOptionsLike,
  ): Promise<`0x${string}`>

  Signs a PSBT using Xverse wallet.

  Parameters

  • psbtHex: BytesLike

    The hex string of PSBT to sign.

  • Optionaloptions: SignPsbtOptionsLike

    Options for signing the PSBT

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

  A promise that resolves to the signed PSBT as a 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, which is not finalized

  Xverse has no equivalent of autoFinalized, so when it is enabled the requested inputs are finalized locally after signing. sighashTypes is checked locally against new or replaced signatures; the RPC cannot pass it to Xverse. disableTweakSigner is not supported and is ignored. Transaction, prevout, and signature-policy checks also run when autoFinalized is false. Wallet-added final scripts are rejected.

  See

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

broadcastPsbt

• broadcastPsbt(
      _psbtHex: BytesLike,
      _options?: SignPsbtOptionsLike,
  ): Promise<`0x${string}`>

  Broadcasts a PSBT to the Bitcoin network.

  Parameters

  • _psbtHex: BytesLike
  • Optional_options: SignPsbtOptionsLike

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

  Remarks

  Xverse does not support broadcasting a signed PSBT directly. It only supports "Sign and Broadcast" as a single atomic operation via signAndBroadcastPsbt.

signAndBroadcastPsbt

• signAndBroadcastPsbt(
      psbtHex: BytesLike,
      options?: SignPsbtOptionsLike,
  ): Promise<`0x${string}`>

  Sign and broadcast a PSBT.

  Parameters

  • psbtHex: BytesLike

    The hex string of PSBT to sign and broadcast.

  • Optionaloptions: SignPsbtOptionsLike

    Options for signing the PSBT.

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

  A promise that resolves to the transaction ID as a Hex string.