Class SignerCkb

constructor

• new SignerCkb(client: Client, provider: UtxoGlobalA.Provider): SignerCkb

  Parameters

  • client: Client
  • provider: UtxoGlobalA.Provider

  Returns SignerCkb

Readonlyprovider

type

• get type(): SignerType

  Returns SignerType

signType

• get signType(): SignerSignType

  Gets the sign type.

  Returns SignerSignType

  The sign type.

ckbNetwork

• get ckbNetwork(): string

  Returns string

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.

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

getAddressObj

• getAddressObj(): Promise<Address>

  Returns Promise<Address>

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.

getAccount

• getAccount(): Promise<string>

  Returns Promise<string>

getPublicKey

• getPublicKey(): Promise<`0x${string}`>

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

connect

• connect(): Promise<void>

  Connects to the signer.

  Returns Promise<void>

  A promise that resolves when the connection is complete.

onReplaced

• onReplaced(listener: () => void): () => void

  Register a listener to be called when this signer is replaced.

  Parameters

  • listener: () => void

  Returns () => void

  A function for unregister

isConnected

• isConnected(): Promise<boolean>

  Check if the signer is connected.

  Returns Promise<boolean>

  A promise that resolves the connection status.

signMessageRaw

• signMessageRaw(message: BytesLike): Promise<string>

  Signs a message and returns signature only. This method is not implemented and should be overridden by subclasses.

  Parameters

  • message: BytesLike

  Returns Promise<string>

  A promise that resolves to the signature as a string.

  Throws

  Will throw an error if not implemented.

signOnlyTransaction

• signOnlyTransaction(txLike: TransactionLike): Promise<Transaction>

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

  Parameters

  • txLike: TransactionLike

  Returns Promise<Transaction>

  A promise that resolves to the signed Transaction object.

  Throws

  Will throw an error if not implemented.

prepareTransaction

• prepareTransaction(txLike: TransactionLike): Promise<Transaction>

  Prepares a transaction before signing. This method can be overridden by subclasses to perform any necessary steps, such as adding cell dependencies or witnesses, before the transaction is signed. The default implementation converts the TransactionLike object to a Transaction object without modification.

  Parameters

  • txLike: TransactionLike

  Returns Promise<Transaction>

  A promise that resolves to the prepared Transaction object.

  Remarks

  Note that this default implementation does not add any cell dependencies or dummy witnesses. This may lead to an underestimation of transaction size and fees if used with methods like Transaction.completeFee. Subclasses for signers that are intended to sign transactions should override this method to perform necessary preparations.