Class SignerBtcPublicKeyReadonly

A class extending SignerBtc that provides read-only access to a Bitcoin public key and account. This class does not support signing operations.

Hierarchy (View Summary)

SignerBtc
- SignerBtcPublicKeyReadonly

Constructors

constructor

new SignerBtcPublicKeyReadonly(
    client: Client,
    account: string,
    publicKey: BytesLike,
): SignerBtcPublicKeyReadonly
Creates an instance of SignerBtcPublicKeyReadonly.
Parameters
- client: Client
  The client instance used for communication.
- account: string
  The Bitcoin account associated with the signer.
- publicKey: BytesLike
  The public key associated with the signer.
Returns SignerBtcPublicKeyReadonly
Overrides SignerBtc.constructor
- Defined in signer/btc/signerBtcPublicKeyReadonly.ts:21

Properties

`Protected`client_

client_: Client

Accessors

type

get type(): SignerType
Returns SignerType
Inherited from SignerBtc.type
- Defined in signer/btc/signerBtc.ts:18

signType

get signType(): SignerSignType
Returns SignerSignType
Inherited from SignerBtc.signType
- Defined in signer/btc/signerBtc.ts:22

supportsSingleCallSignAndBroadcast

get supportsSingleCallSignAndBroadcast(): boolean
Whether the wallet supports a single call to sign + broadcast (combined flow). Default false; override in implementations like Xverse/JoyID.

Returns boolean
Inherited from SignerBtc.supportsSingleCallSignAndBroadcast
- Defined in signer/btc/signerBtc.ts:30

client

get client(): Client
Returns Client
Inherited from SignerBtc.client
- Defined in signer/signer/index.ts:87

Methods

signAndPushPsbt

signAndPushPsbt(psbtHex: string, options?: SignPsbtOptions): Promise<string>
Sign and broadcast a PSBT in one call when supported, otherwise falls back to sign then push. Prefer this over manual sign+push to avoid double popups.
Parameters
- psbtHex: string
- Optionaloptions: SignPsbtOptions
Returns Promise<string>
Inherited from SignerBtc.signAndPushPsbt
- Defined in signer/btc/signerBtc.ts:38

getInternalAddress

getInternalAddress(): Promise<string>
Gets the internal address, which is the Bitcoin account in this case.

Returns Promise<string>
A promise that resolves to a string representing the internal address.
Inherited from SignerBtc.getInternalAddress
- Defined in signer/btc/signerBtc.ts:71

getIdentity

getIdentity(): Promise<string>
Gets the identity, which is the Bitcoin public key in this case.

Returns Promise<string>
A promise that resolves to a string representing the identity
Inherited from SignerBtc.getIdentity
- Defined in signer/btc/signerBtc.ts:80

getAddressObjs

getAddressObjs(): Promise<Address[]>
Gets an array of Address objects representing the known script addresses for the signer.

Returns Promise<Address[]>
A promise that resolves to an array of Address objects.
Inherited from SignerBtc.getAddressObjs
- Defined in signer/btc/signerBtc.ts:89

prepareTransaction

prepareTransaction(txLike: TransactionLike): Promise<Transaction>
prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.
Parameters
- txLike: TransactionLike
  The transaction to prepare, represented as a TransactionLike object.
Returns Promise<Transaction>
A promise that resolves to the prepared Transaction object.
Inherited from SignerBtc.prepareTransaction
- Defined in signer/btc/signerBtc.ts:108

signOnlyTransaction

signOnlyTransaction(txLike: TransactionLike): Promise<Transaction>
Signs a transaction without modifying it.
Parameters
- txLike: TransactionLike
  The transaction to sign, represented as a TransactionLike object.
Returns Promise<Transaction>
A promise that resolves to a signed Transaction object.
Inherited from SignerBtc.signOnlyTransaction
- Defined in signer/btc/signerBtc.ts:122

connect

connect(): Promise<void>
Connects to the client. This implementation does nothing as the class is read-only.

Returns Promise<void>
A promise that resolves when the connection is complete.
Overrides SignerBtc.connect
- Defined in signer/btc/signerBtcPublicKeyReadonly.ts:36

isConnected

isConnected(): Promise<boolean>
Check if the signer is connected.

Returns Promise<boolean>
A promise that resolves the connection status.
Overrides SignerBtc.isConnected
- Defined in signer/btc/signerBtcPublicKeyReadonly.ts:43

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.
Example
```
const account = await signer.getBtcAccount(); // Outputs the Bitcoin account
```
Overrides SignerBtc.getBtcAccount
- Defined in signer/btc/signerBtcPublicKeyReadonly.ts:57

getBtcPublicKey

getBtcPublicKey(): Promise<`0x${string}`>
Gets the Bitcoin public key associated with the signer.

Returns Promise<`0x${string}`>
A promise that resolves to a Hex string representing the Bitcoin public key.
Example
```
const publicKey = await signer.getBtcPublicKey(); // Outputs the Bitcoin public key
```
Overrides SignerBtc.getBtcPublicKey
- Defined in signer/btc/signerBtcPublicKeyReadonly.ts:71

signPsbt

signPsbt(_: string, __?: SignPsbtOptions): Promise<string>
Signs a Partially Signed Bitcoin Transaction (PSBT).
Parameters
- _: string
  The hex string of PSBT to sign
- Optional__: SignPsbtOptions
  Options for signing the PSBT
Returns Promise<string>
A promise that resolves to the signed PSBT hex string
Overrides SignerBtc.signPsbt
- Defined in signer/btc/signerBtcPublicKeyReadonly.ts:75

pushPsbt

pushPsbt(_: string, __?: SignPsbtOptions): Promise<string>
Pushes a PSBT to the Bitcoin network.

For wallets that support a single call for signing and broadcasting (where supportsSingleCallSignAndBroadcast is true), this method takes an unsigned PSBT, signs it, and broadcasts it. For other wallets, this method takes a signed PSBT and only broadcasts it.
Parameters
- _: string
  The hex string of the PSBT to push. Can be signed or unsigned depending on the wallet's capabilities.
- Optional__: SignPsbtOptions
  Options for signing the PSBT. Only used by wallets that perform signing in this step.
Returns Promise<string>
A promise that resolves to the transaction ID.
Overrides SignerBtc.pushPsbt
- Defined in signer/btc/signerBtcPublicKeyReadonly.ts:79

matchNetworkPreference

matchNetworkPreference(
preferences: NetworkPreference[],
currentNetwork: undefined | string,
): undefined | NetworkPreference
Parameters
- preferences: NetworkPreference[]
- currentNetwork: undefined | string
Returns undefined | NetworkPreference
Inherited from SignerBtc.matchNetworkPreference
- Defined in signer/signer/index.ts:93

`Static`verifyMessage

verifyMessage(message: BytesLike, signature: Signature): Promise<boolean>
Parameters
- message: BytesLike
- signature: Signature
Returns Promise<boolean>
Inherited from SignerBtc.verifyMessage
- Defined in signer/signer/index.ts:114

onReplaced

onReplaced(_: () => void): () => void
Register a listener to be called when this signer is replaced.
Parameters
- _: () => void
Returns () => void
A function for unregister
Inherited from SignerBtc.onReplaced
- Defined in signer/signer/index.ts:172

disconnect

disconnect(): Promise<void>
Disconnects to the signer.

Returns Promise<void>
A promise that resolves when the signer is disconnected.
Inherited from SignerBtc.disconnect
- Defined in signer/signer/index.ts:181

getRecommendedAddressObj

getRecommendedAddressObj(_preference?: unknown): Promise<Address>
Gets the recommended Address object for the signer.
Parameters
- Optional_preference: unknown
  Optional preference parameter.
Returns Promise<Address>
A promise that resolves to the recommended Address object.
Inherited from SignerBtc.getRecommendedAddressObj
- Defined in signer/signer/index.ts:219

getRecommendedAddress

getRecommendedAddress(preference?: unknown): Promise<string>
Gets the recommended address for the signer as a string.
Parameters
- Optionalpreference: unknown
  Optional preference parameter.
Returns Promise<string>
A promise that resolves to the recommended address as a string.
Inherited from SignerBtc.getRecommendedAddress
- Defined in signer/signer/index.ts:229

getAddresses

getAddresses(): Promise<string[]>
Gets an array of addresses associated with the signer as strings.

Returns Promise<string[]>
A promise that resolves to an array of addresses as strings.
Inherited from SignerBtc.getAddresses
- Defined in signer/signer/index.ts:238

findCellsOnChain

findCellsOnChain(
    filter: ClientIndexerSearchKeyFilterLike,
    withData?: null | boolean,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<Cell>
Find cells of this signer
Parameters
- filter: ClientIndexerSearchKeyFilterLike
  The filter for the search key.
- OptionalwithData: null | boolean
  Whether to include cell data in the response.
- Optionalorder: "asc" | "desc"
  The order of the returned cells, can be "asc" or "desc".
- Optionallimit: number
  The maximum number of cells for every querying chunk.
Returns AsyncGenerator<Cell>
A async generator that yields all matching cells
Inherited from SignerBtc.findCellsOnChain
- Defined in signer/signer/index.ts:253

findCells

findCells(
    filter: ClientCollectableSearchKeyFilterLike,
    withData?: null | boolean,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<Cell>
Find cells of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalwithData: null | boolean
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<Cell>
A async generator that yields all matches cells
Inherited from SignerBtc.findCells
- Defined in signer/signer/index.ts:282

findTransactions

findTransactions(
    filter: ClientCollectableSearchKeyFilterLike,
    groupByTransaction?: null | false,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    },
>
Find transactions of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalgroupByTransaction: null | false
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    },
>
A async generator that yields all matches transactions
Inherited from SignerBtc.findTransactions
- Defined in signer/signer/index.ts:311
findTransactions(
    filter: ClientCollectableSearchKeyFilterLike,
    groupByTransaction: true,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
Find transactions of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- groupByTransaction: true
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
A async generator that yields all matches transactions
Inherited from SignerBtc.findTransactions
- Defined in signer/signer/index.ts:322
findTransactions(
    filter: ClientCollectableSearchKeyFilterLike,
    groupByTransaction?: null | boolean,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    }
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
Find transactions of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalgroupByTransaction: null | boolean
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    }
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
A async generator that yields all matches transactions
Inherited from SignerBtc.findTransactions
- Defined in signer/signer/index.ts:333

getBalance

getBalance(): Promise<bigint>
Gets balance of all addresses

Returns Promise<bigint>
A promise that resolves to the balance
Inherited from SignerBtc.getBalance
- Defined in signer/signer/index.ts:379

signMessage

signMessage(message: BytesLike): Promise<Signature>
Signs a message.
Parameters
- message: BytesLike
  The message to sign, as a string or BytesLike object.
Returns Promise<Signature>
A promise that resolves to the signature info.

Throws
Will throw an error if not implemented.
Inherited from SignerBtc.signMessage
- Defined in signer/signer/index.ts:392

signMessageRaw

signMessageRaw(_: BytesLike): Promise<string>
Signs a message and returns signature only. This method is not implemented and should be overridden by subclasses.
Parameters
- _: BytesLike
  The message to sign, as a string or BytesLike object.
Returns Promise<string>
A promise that resolves to the signature as a string.

Throws
Will throw an error if not implemented.
Inherited from SignerBtc.signMessageRaw
- Defined in signer/signer/index.ts:407

verifyMessage

verifyMessage(
message: BytesLike,
signature: string | Signature,
): Promise<boolean>
Verify a signature.
Parameters
- message: BytesLike
  The original message.
- signature: string | Signature
  The signature to verify.
Returns Promise<boolean>
A promise that resolves to the verification result.

Throws
Will throw an error if not implemented.
Inherited from SignerBtc.verifyMessage
- Defined in signer/signer/index.ts:419

sendTransaction

sendTransaction(tx: TransactionLike): Promise<`0x${string}`>
Sends a transaction after signing it.
Parameters
- tx: TransactionLike
  The transaction to send, represented as a TransactionLike object.
Returns Promise<`0x${string}`>
A promise that resolves to the transaction hash as a Hex string.
Inherited from SignerBtc.sendTransaction
- Defined in signer/signer/index.ts:447

signTransaction

signTransaction(tx: TransactionLike): Promise<Transaction>
Signs a transaction.
Parameters
- tx: TransactionLike
  The transaction to sign, represented as a TransactionLike object.
Returns Promise<Transaction>
A promise that resolves to the signed Transaction object.
Inherited from SignerBtc.signTransaction
- Defined in signer/signer/index.ts:457

Class SignerBtcPublicKeyReadonly

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignerBtcPublicKeyReadonly

Properties

Protectedclient_

Accessors

type

Returns SignerType

signType

Returns SignerSignType

supportsSingleCallSignAndBroadcast

Returns boolean

client

Returns Client

Methods

signAndPushPsbt

Parameters

Returns Promise<string>

getInternalAddress

Returns Promise<string>

getIdentity

Returns Promise<string>

getAddressObjs

Returns Promise<Address[]>

prepareTransaction

Parameters

Returns Promise<Transaction>

signOnlyTransaction

Parameters

Returns Promise<Transaction>

connect

Returns Promise<void>

isConnected

Returns Promise<boolean>

getBtcAccount

Returns Promise<string>

Example

getBtcPublicKey

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

Example

signPsbt

Parameters

Returns Promise<string>

pushPsbt

Parameters

Returns Promise<string>

matchNetworkPreference

Parameters

Returns undefined | NetworkPreference

StaticverifyMessage

Parameters

Returns Promise<boolean>

onReplaced

Parameters

Returns () => void

disconnect

Returns Promise<void>

getRecommendedAddressObj

Parameters

Returns Promise<Address>

getRecommendedAddress

Parameters

Returns Promise<string>

getAddresses

Returns Promise<string[]>

findCellsOnChain

Parameters

Returns AsyncGenerator<Cell>

findCells

Parameters

Returns AsyncGenerator<Cell>

findTransactions

`Protected`client_

`Static`verifyMessage

Returns AsyncGenerator<
{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
},
>

Returns AsyncGenerator<
{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: { isInput: boolean; cellIndex: bigint }[];
},
>

Returns AsyncGenerator<
| {
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
}
| {
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: { isInput: boolean; cellIndex: bigint }[];
},
>