Class SignerBtc

constructor

• new SignerBtc(
      client: Client,
      provider: UtxoGlobalA.Provider,
      preferredNetworks?: NetworkPreference[],
  ): UtxoGlobal.SignerBtc

  Parameters

  • client: Client
  • provider: UtxoGlobalA.Provider
  • preferredNetworks: NetworkPreference[] = ...

  Returns UtxoGlobal.SignerBtc

Readonlyprovider

getBtcAccount

• getBtcAccount(): Promise<string>

  Gets the Bitcoin account associated with the signer.

  Returns Promise<string>

  A promise that resolves to a string representing the Bitcoin account.

getBtcPublicKey

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

  Gets the Bitcoin public key associated with the signer.

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

  A promise that resolves to a HexLike value representing the Bitcoin public key.

ensureNetwork

• ensureNetwork(): Promise<void>

  Ensure the BTC network is the same as CKB network.

  Returns Promise<void>

_getNetworkToChange

• _getNetworkToChange(): Promise<undefined | string>

  Returns Promise<undefined | string>

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

connect

• connect(): Promise<void>

  Connects to the signer.

  Returns Promise<void>

  A promise that resolves when the connection is complete.

isConnected

• isConnected(): Promise<boolean>

  Check if the signer is connected.

  Returns Promise<boolean>

  A promise that resolves the connection status.

signMessageRaw

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

  Signs a message and returns signature only. This method is not implemented and should be overridden by subclasses.

  Parameters

  • message: BytesLike

  Returns Promise<string>

  A promise that resolves to the signature as a string.

  Throws

  Will throw an error if not implemented.

signPsbt

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

  Signs a PSBT using UTXO Global wallet.

  Parameters

  • _psbtHex: BytesLike
  • Optional_options: SignPsbtOptions

  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
  • Optional_options: SignPsbtOptions

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

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

  Todo

  Implement PSBT broadcasting with UTXO Global