Class Signer

constructor

• new Signer(
      client: Client,
      provider: UniSatA.Provider,
      preferredNetworks?: NetworkPreference[],
  ): UniSat.Signer

  Creates an instance of Signer.

  Parameters

  • client: Client

    The client instance.
  • provider: UniSatA.Provider

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

  Returns UniSat.Signer

Readonlyprovider

_getNetworkToChange

• _getNetworkToChange(): Promise<undefined | string>

  Returns Promise<undefined | string>

ensureNetwork

• ensureNetwork(): Promise<void>

  Ensure the BTC network is the same as CKB network.

  Returns Promise<void>

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.

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?: SignPsbtOptions): Promise<`0x${string}`>

  Signs a PSBT using UniSat wallet.

  Parameters

  • psbtHex: BytesLike

    The hex string of PSBT to sign.
  • Optionaloptions: SignPsbtOptions

    Options for signing the PSBT

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

  A promise that resolves to the signed PSBT as a Hex string

broadcastPsbt

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

  Broadcasts a signed PSBT to the Bitcoin network.

  Parameters

  • psbtHex: BytesLike

    The hex string (without 0x prefix) of signed PSBT to broadcast.
  • Optional_options: SignPsbtOptions

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

  A promise that resolves to the transaction ID (without 0x prefix)