Class SignerBtc`Abstract`

An abstract class extending the Signer class for Bitcoin-like signing operations. This class provides methods to get Bitcoin account, public key, and internal address, as well as signing transactions.

Hierarchy (View Summary)

Signer
- SignerBtc

Constructors

constructor

new SignerBtc(client_: Client): SignerBtc
Parameters
- client_: Client
Returns SignerBtc
Inherited from Signer.constructor
- Defined in signer/signer/index.ts:82

Properties

`Protected`client_

client_: Client

Accessors

type

get type(): SignerType
Returns SignerType
Overrides Signer.type
- Defined in signer/btc/signerBtc.ts:17

signType

get signType(): SignerSignType
Returns SignerSignType
Overrides Signer.signType
- Defined in signer/btc/signerBtc.ts:21

client

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

Methods

`Abstract`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.
- Defined in signer/btc/signerBtc.ts:30

`Abstract`getBtcPublicKey

getBtcPublicKey(): Promise<BytesLike>
Gets the Bitcoin public key associated with the signer.

Returns Promise<BytesLike>
A promise that resolves to a HexLike value representing the Bitcoin public key.
- Defined in signer/btc/signerBtc.ts:37

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.
Overrides Signer.getInternalAddress
- Defined in signer/btc/signerBtc.ts:44

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
Overrides Signer.getIdentity
- Defined in signer/btc/signerBtc.ts:53

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.
Overrides Signer.getAddressObjs
- Defined in signer/btc/signerBtc.ts:62

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.
Overrides Signer.prepareTransaction
- Defined in signer/btc/signerBtc.ts:81

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.
Overrides Signer.signOnlyTransaction
- Defined in signer/btc/signerBtc.ts:95

matchNetworkPreference

matchNetworkPreference(
preferences: NetworkPreference[],
currentNetwork: undefined | string,
): undefined | NetworkPreference
Parameters
- preferences: NetworkPreference[]
- currentNetwork: undefined | string
Returns undefined | NetworkPreference
Inherited from Signer.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 Signer.verifyMessage
- Defined in signer/signer/index.ts:114

`Static`fromSignature

fromSignature(
    _client: Client,
    _signature: Signature,
    _message?: null | BytesLike,
    ..._addresses: (string | string[])[],
): Promise<undefined | Signer>
Parameters
- _client: Client
- _signature: Signature
- Optional_message: null | BytesLike
- ..._addresses: (string | string[])[]
Returns Promise<undefined | Signer>
Inherited from Signer.fromSignature
- Defined in signer/signer/index.ts:160

`Abstract`connect

connect(): Promise<void>
Connects to the signer.

Returns Promise<void>
A promise that resolves when the connection is complete.
Inherited from Signer.connect
- Defined in signer/signer/index.ts:176

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 Signer.onReplaced
- Defined in signer/signer/index.ts:183

disconnect

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

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

`Abstract`isConnected

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

Returns Promise<boolean>
A promise that resolves the connection status.
Inherited from Signer.isConnected
- Defined in signer/signer/index.ts:199

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 Signer.getRecommendedAddressObj
- Defined in signer/signer/index.ts:230

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 Signer.getRecommendedAddress
- Defined in signer/signer/index.ts:240

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 Signer.getAddresses
- Defined in signer/signer/index.ts:249

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 Signer.findCellsOnChain
- Defined in signer/signer/index.ts:264

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 Signer.findCells
- Defined in signer/signer/index.ts:293

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 Signer.findTransactions
- Defined in signer/signer/index.ts:322
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 Signer.findTransactions
- Defined in signer/signer/index.ts:333
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 Signer.findTransactions
- Defined in signer/signer/index.ts:344

getBalance

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

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

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 Signer.signMessage
- Defined in signer/signer/index.ts:403

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 Signer.signMessageRaw
- Defined in signer/signer/index.ts:418

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 Signer.verifyMessage
- Defined in signer/signer/index.ts:430

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 Signer.sendTransaction
- Defined in signer/signer/index.ts:458

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 Signer.signTransaction
- Defined in signer/signer/index.ts:468

Class SignerBtcAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignerBtc

Properties

Protectedclient_

Accessors

type

Returns SignerType

signType

Returns SignerSignType

client

Returns Client

Methods

AbstractgetBtcAccount

Returns Promise<string>

AbstractgetBtcPublicKey

Returns Promise<BytesLike>

getInternalAddress

Returns Promise<string>

getIdentity

Returns Promise<string>

getAddressObjs

Returns Promise<Address[]>

prepareTransaction

Parameters

Returns Promise<Transaction>

signOnlyTransaction

Parameters

Returns Promise<Transaction>

matchNetworkPreference

Parameters

Returns undefined | NetworkPreference

StaticverifyMessage

Parameters

Returns Promise<boolean>

StaticfromSignature

Parameters

Returns Promise<undefined | Signer>

Abstractconnect

Returns Promise<void>

onReplaced

Parameters

Returns () => void

disconnect

Returns Promise<void>

AbstractisConnected

Returns Promise<boolean>

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

Parameters

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

Parameters

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

Parameters

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 }[]; },>

getBalance

Returns Promise<bigint>

signMessage

Parameters

Class SignerBtc`Abstract`

`Protected`client_

`Abstract`getBtcAccount

`Abstract`getBtcPublicKey

`Static`verifyMessage

`Static`fromSignature

`Abstract`connect

`Abstract`isConnected

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 }[];
},
>