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 full)

ccc.SignerBtc
- SignerBtcPublicKeyReadonly

Constructors

constructor

new SignerBtcPublicKeyReadonly(client, account, publicKey): 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:20

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

client

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

Methods

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:45

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:54

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:63

prepareTransaction

prepareTransaction(txLike): Promise<ccc.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<ccc.Transaction>
A promise that resolves to the prepared Transaction object.
Inherited from SignerBtc.prepareTransaction
- Defined in signer/btc/signerBtc.ts:82

signOnlyTransaction

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

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:35

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:42

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:56

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:70

matchNetworkPreference

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

`Static`verifyMessage

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

onReplaced

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

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:166

getRecommendedAddressObj

getRecommendedAddressObj(_preference?): 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:204

getRecommendedAddress

getRecommendedAddress(preference?): 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:214

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:223

findCells

findCells(filter, withData?): AsyncGenerator<Cell, any, unknown>
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalwithData: null | boolean
Returns AsyncGenerator<Cell, any, unknown>
Inherited from SignerBtc.findCells
- Defined in signer/signer/index.ts:229

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:252

signMessage

signMessage(message): 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:265

signMessageRaw

signMessageRaw(_): 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:280

verifyMessage

verifyMessage(message, 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:292

sendTransaction

sendTransaction(tx): 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:320

signTransaction

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

Class SignerBtcPublicKeyReadonly

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignerBtcPublicKeyReadonly

Properties

Protectedclient_

Accessors

type

Returns SignerType

signType

Returns SignerSignType

client

Returns Client

Methods

getInternalAddress

Returns Promise<string>

getIdentity

Returns Promise<string>

getAddressObjs

Returns Promise<Address[]>

prepareTransaction

Parameters

Returns Promise<ccc.Transaction>

signOnlyTransaction

Parameters

Returns Promise<ccc.Transaction>

connect

Returns Promise<void>

isConnected

Returns Promise<boolean>

getBtcAccount

Returns Promise<string>

Example

getBtcPublicKey

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

Example

matchNetworkPreference

Parameters

Returns undefined | NetworkPreference

StaticverifyMessage

Parameters

Returns Promise<boolean>

onReplaced

Parameters

Returns void

Returns (() => void)

Returns void

disconnect

Returns Promise<void>

getRecommendedAddressObj

Parameters

Returns Promise<Address>

getRecommendedAddress

Parameters

Returns Promise<string>

getAddresses

Returns Promise<string[]>

findCells

Parameters

Returns AsyncGenerator<Cell, any, unknown>

getBalance

Returns Promise<bigint>

signMessage

Parameters

Returns Promise<Signature>

Throws

signMessageRaw

Parameters

Returns Promise<string>

Throws

verifyMessage

Parameters

Returns Promise<boolean>

`Protected`client_

`Static`verifyMessage