Class SignerAbstract

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

Hierarchy (view full)

Constructors

constructor

Properties

client_

Accessors

type signType client

Methods

matchNetworkPreference verifyMessage connect onReplaced disconnect isConnected getInternalAddress getIdentity getAddressObjs getRecommendedAddressObj getRecommendedAddress getAddresses findCells findTransactions getBalance signMessage signMessageRaw verifyMessage sendTransaction signTransaction prepareTransaction signOnlyTransaction

Constructors

constructor

Properties

Protectedclient_

client_: Client

Accessors

Abstracttype

AbstractsignType

client

Methods

matchNetworkPreference

StaticverifyMessage

Abstractconnect

  • connect(): Promise<void>

  • Connects to the signer.

    Returns Promise<void>

    A promise that resolves when the connection is complete.

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.

AbstractisConnected

  • isConnected(): Promise<boolean>

  • Check if the signer is connected.

    Returns Promise<boolean>

    A promise that resolves the connection status.

AbstractgetInternalAddress

  • 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

AbstractgetAddressObjs

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.

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.

findCells

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

  • Find cells of this signer

    Parameters

    Returns AsyncGenerator<Cell, any, unknown>

    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, unknown>

  • Find transactions of this signer

    Parameters

    Returns AsyncGenerator<{
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    }, any, unknown>

    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, unknown>

  • Find transactions of this signer

    Parameters

    Returns AsyncGenerator<{
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: {
            isInput: boolean;
            cellIndex: bigint;
        }[];
    }, any, unknown>

    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, unknown>

  • Find transactions of this signer

    Parameters

    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, unknown>

    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.

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.

    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

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.

    Throws

    Will throw an error if not implemented.

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.

    Throws

    Will throw an error if not implemented.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods