CCC Docs
    Preparing search index...

    Class CkbSigner

    Class representing a CKB signer that extends Signer

    Hierarchy

    • Signer
      • CkbSigner
    Index

    Constructors

    constructor

    Accessors

    type signType

    Methods

    connect disconnect isConnected getInternalAddress getIdentity getAddressObj getAddressObjs prepareTransaction signOnlyTransaction signMessageRaw

    Constructors

    • 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

    Accessors

    • get type(): SignerType

      Gets the signer type.

      Returns SignerType

      The type of the signer.

    • get signType(): SignerSignType

      Gets the sign type.

      Returns SignerSignType

      The sign type.

    Methods

    • Connects to the provider by requesting authentication.

      Returns Promise<void>

      A promise that resolves when the connection is established.

    • Disconnects to the signer.

      Returns Promise<void>

      A promise that resolves when the signer is disconnected.

    • Checks if the signer is connected.

      Returns Promise<boolean>

      A promise that resolves to true if connected, false otherwise.

    • Gets the internal address.

      Returns Promise<string>

      A promise that resolves to the internal address.

    • Gets the identity of the signer.

      Returns Promise<string>

      A promise that resolves to the identity.

    • Gets the address object.

      Returns Promise<Address>

      A promise that resolves to the address object.

    • Gets the address objects.

      Returns Promise<Address[]>

      A promise that resolves to an array of address objects.

    • Prepares a transaction.

      Parameters

      • txLike: TransactionLike

        The transaction-like object.

      Returns Promise<Transaction>

      A promise that resolves to the prepared transaction.

    • Signs a transaction.

      Parameters

      • txLike: TransactionLike

        The transaction-like object.

      Returns Promise<Transaction>

      A promise that resolves to the signed transaction.

    • 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.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods