Skip to main content

SignerOpenLink

@ckb-ccc/core • Docs

@ckb-ccc/core / ccc / SignerOpenLink

Class: SignerOpenLink

An abstract class representing a generic signer. This class provides methods to connect, get addresses, and sign transactions.

Extends​

  • SignerDummy

Constructors​

new SignerOpenLink(client, type, link): SignerOpenLink

Parameters​

• client: Client

• type: SignerType

• link: string

Returns​

SignerOpenLink

Overrides​

SignerDummy.constructor

Source​

signer/dummy/openLink.ts:6

Properties​

client_​

protected client_: Client

Inherited from​

SignerDummy.client_

Source​

signer/signer/index.ts:40

private readonly link: string

Source​

signer/dummy/openLink.ts:9

type​

readonly type: SignerType

Inherited from​

SignerDummy.type

Source​

signer/dummy/dummy.ts:12

Accessors​

client​

get client(): Client

Returns​

Client

Source​

signer/signer/index.ts:45

signType​

get signType(): SignerSignType

Returns​

SignerSignType

Source​

signer/dummy/dummy.ts:6

Methods​

connect()​

connect(): Promise<void>

Connects to the signer.

Returns​

Promise<void>

A promise that resolves when the connection is complete.

Overrides​

SignerDummy.connect

Source​

signer/dummy/openLink.ts:14

disconnect()​

disconnect(): Promise<void>

Disconnects to the signer.

Returns​

Promise<void>

A promise that resolves when disconnected.

Inherited from​

SignerDummy.disconnect

Source​

signer/signer/index.ts:96

getAddressObjs()​

getAddressObjs(): Promise<Address[]>

Gets an array of Address objects associated with the signer.

Returns​

Promise<Address[]>

A promise that resolves to an array of Address objects.

Inherited from​

SignerDummy.getAddressObjs

Source​

signer/dummy/dummy.ts:25

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​

SignerDummy.getAddresses

Source​

signer/signer/index.ts:153

getBalance()​

getBalance(): Promise<bigint>

Gets balance of all addresses

Returns​

Promise<bigint>

A promise that resolves to the balance

Inherited from​

SignerDummy.getBalance

Source​

signer/signer/index.ts:164

getIdentity()​

getIdentity(): Promise<string>

Gets the identity for verifying signature, usually it's address

Returns​

Promise<string>

A promise that resolves to a string representing the identity

Inherited from​

SignerDummy.getIdentity

Source​

signer/signer/index.ts:117

getInternalAddress()​

getInternalAddress(): Promise<string>

Gets the internal address associated with the signer.

Returns​

Promise<string>

A promise that resolves to a string representing the internal address.

Inherited from​

SignerDummy.getInternalAddress

Source​

signer/dummy/dummy.ts:21

getRecommendedAddress()​

getRecommendedAddress(preference?): Promise<string>

Gets the recommended address for the signer as a string.

Parameters​

• preference?: unknown

Optional preference parameter.

Returns​

Promise<string>

A promise that resolves to the recommended address as a string.

Inherited from​

SignerDummy.getRecommendedAddress

Source​

signer/signer/index.ts:144

getRecommendedAddressObj()​

getRecommendedAddressObj(_preference?): Promise<Address>

Gets the recommended Address object for the signer.

Parameters​

• _preference?: unknown

Optional preference parameter.

Returns​

Promise<Address>

A promise that resolves to the recommended Address object.

Inherited from​

SignerDummy.getRecommendedAddressObj

Source​

signer/signer/index.ts:134

isConnected()​

isConnected(): Promise<boolean>

Check if the signer is connected.

Returns​

Promise<boolean>

A promise that resolves the connection status.

Inherited from​

SignerDummy.isConnected

Source​

signer/dummy/dummy.ts:17

prepareTransaction()​

prepareTransaction(_): Promise<Transaction>

prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.

Parameters​

• _: TransactionLike

The transaction to prepare, represented as a TransactionLike object.

Returns​

Promise<Transaction>

A promise that resolves to the prepared Transaction object.

Inherited from​

SignerDummy.prepareTransaction

Throws​

Will throw an error if not implemented.

Source​

signer/signer/index.ts:262

replaceClient()​

replaceClient(client): Promise<void>

Replace the current client.

Parameters​

• client: Client

Returns​

Promise<void>

Inherited from​

SignerDummy.replaceClient

Source​

signer/signer/index.ts:80

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​

SignerDummy.sendTransaction

Source​

signer/signer/index.ts:240

signMessage()​

signMessage(message): Promise<Signature>

Signs a message.

Parameters​

• message: BytesLike

Returns​

Promise<Signature>

A promise that resolves to the signature info.

Inherited from​

SignerDummy.signMessage

Throws​

Will throw an error if not implemented.

Source​

signer/signer/index.ts:177

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.

Inherited from​

SignerDummy.signMessageRaw

Throws​

Will throw an error if not implemented.

Source​

signer/signer/index.ts:192

signOnlyTransaction()​

signOnlyTransaction(_): Promise<Transaction>

Signs a transaction without preparing information for it. This method is not implemented and should be overridden by subclasses.

Parameters​

• _: TransactionLike

The transaction to sign, represented as a TransactionLike object.

Returns​

Promise<Transaction>

A promise that resolves to the signed Transaction object.

Inherited from​

SignerDummy.signOnlyTransaction

Throws​

Will throw an error if not implemented.

Source​

signer/signer/index.ts:273

signTransaction()​

signTransaction(tx): 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​

SignerDummy.signTransaction

Source​

signer/signer/index.ts:250

verifyMessage()​

verifyMessage(message, signature): Promise<boolean>

Verify a signature.

Parameters​

• message: BytesLike

• signature: string | Signature

Returns​

Promise<boolean>

A promise that resolves to the verification result.

Inherited from​

SignerDummy.verifyMessage

Throws​

Will throw an error if not implemented.

Source​

signer/signer/index.ts:204

verifyMessageRaw()​

verifyMessageRaw(_0, _1): Promise<boolean>

Verify a string signature. This method is not implemented and should be overridden by subclasses.

Parameters​

• _0: BytesLike

The original message.

• _1: string

The signature to verify.

Returns​

Promise<boolean>

A promise that resolves to the verification result.

Inherited from​

SignerDummy.verifyMessageRaw

Throws​

Will throw an error if not implemented.

Source​

signer/signer/index.ts:230

verifyMessage()​

static verifyMessage(message, signature): Promise<boolean>

Parameters​

• message: BytesLike

• signature: Signature

Returns​

Promise<boolean>

Inherited from​

SignerDummy.verifyMessage

Source​

signer/signer/index.ts:49