Class SignerCkbPrivateKey

ReadonlypublicKey

type

• get type(): SignerType

• Returns SignerType

signType

• get signType(): SignerSignType

• Returns SignerSignType

client

• get client(): Client

• Returns Client

connect

• connect(): Promise<void>

• Connects to the signer.

  Returns Promise<void>

  A promise that resolves when the connection is complete.

isConnected

• isConnected(): Promise<boolean>

• Check if the signer is connected.

  Returns Promise<boolean>

  A promise that resolves the connection status.

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

getAddressObjSecp256k1

• getAddressObjSecp256k1(): Promise<ccc.Address>

• Returns Promise<ccc.Address>

getRecommendedAddressObj

• getRecommendedAddressObj(_preference?): Promise<ccc.Address>

• Gets the recommended Address object for the signer.

  Parameters

  • Optional_preference: unknown

    Optional preference parameter.

  Returns Promise<ccc.Address>

  A promise that resolves to the recommended Address object.

getAddressObjs

• getAddressObjs(): Promise<ccc.Address[]>

• Gets an array of Address objects associated with the signer.

  Returns Promise<ccc.Address[]>

  A promise that resolves to an array of Address objects.

getRelatedScripts

• getRelatedScripts(txLike): Promise<{
      script: Script;
      cellDeps: CellDepInfo[];
  }[]>

• Parameters

  • txLike: TransactionLike

  Returns Promise<{
      script: Script;
      cellDeps: CellDepInfo[];
  }[]>

prepareTransaction

• prepareTransaction(txLike): Promise<Transaction>

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

  Parameters

  • txLike: TransactionLike

  Returns Promise<Transaction>

  A promise that resolves to the prepared Transaction object.

  Throws

  Will throw an error if not implemented.

matchNetworkPreference

• matchNetworkPreference(preferences, currentNetwork): undefined | NetworkPreference

• Parameters

  • preferences: NetworkPreference[]
  • currentNetwork: undefined | string

  Returns undefined | NetworkPreference

StaticverifyMessage

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

• Parameters

  • message: BytesLike
  • signature: Signature

  Returns Promise<boolean>

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

disconnect

• disconnect(): Promise<void>

• Disconnects to the signer.

  Returns Promise<void>

  A promise that resolves when the signer is disconnected.

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.

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.

findCellsOnChain

• findCellsOnChain(filter, withData?, order?, limit?): AsyncGenerator<Cell, any, any>

• 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, any, any>

  A async generator that yields all matching cells

findCells

• findCells(filter, withData?, order?, limit?): AsyncGenerator<Cell, any, any>

• Find cells of this signer

  Parameters

  • filter: ClientCollectableSearchKeyFilterLike
  • OptionalwithData: null | boolean
  • Optionalorder: "asc" | "desc"
  • Optionallimit: number

  Returns AsyncGenerator<Cell, any, any>

  A async generator that yields all matches cells

findTransactions

• findTransactions(filter, groupByTransaction?, order?, limit?): AsyncGenerator<{
      txHash: `0x${string}`;
      blockNumber: bigint;
      txIndex: bigint;
      isInput: boolean;
      cellIndex: bigint;
  }, any, any>

• 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;
  }, any, any>

  A async generator that yields all matches transactions
• findTransactions(filter, groupByTransaction, order?, limit?): AsyncGenerator<{
      txHash: `0x${string}`;
      blockNumber: bigint;
      txIndex: bigint;
      cells: {
          isInput: boolean;
          cellIndex: bigint;
      }[];
  }, any, any>

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

  A async generator that yields all matches transactions
• findTransactions(filter, groupByTransaction?, order?, limit?): AsyncGenerator<{
      txHash: `0x${string}`;
      blockNumber: bigint;
      txIndex: bigint;
      isInput: boolean;
      cellIndex: bigint;
  } | {
      txHash: `0x${string}`;
      blockNumber: bigint;
      txIndex: bigint;
      cells: {
          isInput: boolean;
          cellIndex: bigint;
      }[];
  }, any, any>

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

  A async generator that yields all matches transactions

getBalance

• getBalance(): Promise<bigint>

• Gets balance of all addresses

  Returns Promise<bigint>

  A promise that resolves to the balance

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.

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.

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.

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.