Class BitcoinSigner

constructor

• new BitcoinSigner(
      client: Client,
      providers: Record<string, BitcoinProvider>,
      preferredNetworks?: NetworkPreference[],
  ): Okx.BitcoinSigner

  Creates an instance of Signer.

  Parameters

  • client: Client

    The client instance.
  • providers: Record<string, BitcoinProvider>

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

    All preferred networks

  Returns Okx.BitcoinSigner

Readonlyproviders

provider

• get provider(): BitcoinProvider

  Returns BitcoinProvider

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: string, options?: SignPsbtOptions): Promise<string>

  Signs a PSBT using OKX 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

pushPsbt

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

  Broadcasts a signed PSBT to the Bitcoin network.

  Parameters

  • psbtHex: string

    The hex string of signed PSBT to broadcast
  • Optional_options: SignPsbtOptions

  Returns Promise<string>

  A promise that resolves to the transaction ID