Class Signer

constructor

• new Signer(client, provider, preferredNetworks?): Xverse.Signer

• Creates an instance of Signer.

  Parameters

  • client: Client

    The client instance.
  • provider: BtcProvider

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

  Returns Xverse.Signer

Readonlyprovider

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)

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

  Parameters

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

      • Returns void

  Returns (() => void)

  A function for unregister

  • • (): void

    • Returns void

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): 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.