Class CkbSigner

Class representing a CKB signer that extends Signer

Hierarchy (view full)

ccc.Signer
- CkbSigner

Index

Constructors

constructor

new CkbSigner(client, name, icon, _appUri?, _aggregatorUri?, connectionsRepo?): CkbSigner
Creates an instance of CkbSigner.
Parameters
- client: Client
  The client instance.
- name: string
  The name of the signer.
- icon: string
  The icon URL of the signer.
- Optional_appUri: string
  The application URI.
- Optional_aggregatorUri: string
  The aggregator URI.
- connectionsRepo: ConnectionsRepo = ...
  The connections repository.
Returns CkbSigner
Overrides Signer.constructor
- Defined in ckb/index.ts:56

Accessors

type

get type(): SignerType
Gets the signer type.

Returns SignerType
The type of the signer.
Overrides ccc.Signer.type
- Defined in ckb/index.ts:20

signType

get signType(): SignerSignType
Gets the sign type.

Returns SignerSignType
The sign type.
Overrides ccc.Signer.signType
- Defined in ckb/index.ts:28

Methods

connect

connect(): Promise<void>
Connects to the provider by requesting authentication.

Returns Promise<void>
A promise that resolves when the connection is established.
Overrides Signer.connect
- Defined in ckb/index.ts:101

disconnect

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

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

isConnected

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

Returns Promise<boolean>
A promise that resolves to true if connected, false otherwise.
Overrides Signer.isConnected
- Defined in ckb/index.ts:128

getInternalAddress

getInternalAddress(): Promise<string>
Gets the internal address.

Returns Promise<string>
A promise that resolves to the internal address.
Overrides Signer.getInternalAddress
- Defined in ckb/index.ts:140

getIdentity

getIdentity(): Promise<string>
Gets the identity of the signer.

Returns Promise<string>
A promise that resolves to the identity.
Overrides Signer.getIdentity
- Defined in ckb/index.ts:148

getAddressObj

getAddressObj(): Promise<Address>
Gets the address object.

Returns Promise<Address>
A promise that resolves to the address object.
- Defined in ckb/index.ts:160

getAddressObjs

getAddressObjs(): Promise<Address[]>
Gets the address objects.

Returns Promise<Address[]>
A promise that resolves to an array of address objects.
Overrides Signer.getAddressObjs
- Defined in ckb/index.ts:171

prepareTransaction

prepareTransaction(txLike): Promise<ccc.Transaction>
Prepares a transaction.
Parameters
- txLike: TransactionLike
  The transaction-like object.
Returns Promise<ccc.Transaction>
A promise that resolves to the prepared transaction.
Overrides Signer.prepareTransaction
- Defined in ckb/index.ts:180

signOnlyTransaction

signOnlyTransaction(txLike): Promise<ccc.Transaction>
Signs a transaction.
Parameters
- txLike: TransactionLike
  The transaction-like object.
Returns Promise<ccc.Transaction>
A promise that resolves to the signed transaction.
Overrides Signer.signOnlyTransaction
- Defined in ckb/index.ts:254

signMessageRaw

signMessageRaw(message): Promise<string>
Signs a raw message with the account.
Parameters
- message: BytesLike
  The message to sign.
Returns Promise<string>
A promise that resolves to the signed message.
Overrides Signer.signMessageRaw
- Defined in ckb/index.ts:307

Class CkbSigner

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CkbSigner

Accessors

type

Returns SignerType

signType

Returns SignerSignType

Methods

connect

Returns Promise<void>

disconnect

Returns Promise<void>

isConnected

Returns Promise<boolean>

getInternalAddress

Returns Promise<string>

getIdentity

Returns Promise<string>

getAddressObj

Returns Promise<Address>

getAddressObjs

Returns Promise<Address[]>

prepareTransaction

Parameters

Returns Promise<ccc.Transaction>

signOnlyTransaction

Parameters

Returns Promise<ccc.Transaction>

signMessageRaw

Parameters

Returns Promise<string>

Settings

On This Page