Keeta LogoKeeta Logo@keetanetwork/keetanet-client
    Preparing search index...

    Interface UserClientConfig

    interface UserClientConfig {
        account?: GenericAccount;
        client: Client;
        generateFeeBlock?: (
            staple: VoteStaple,
            options?: UserClientOptions,
        ) => Promise<Block>;
        network: bigint;
        networkAlias: "main" | "staging" | "test" | "dev";
        publishAidURL?: string;
        signer: null | Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>;
        usePublishAid?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Paccount? Pclient PgenerateFeeBlock? Pnetwork PnetworkAlias PpublishAidURL? Psigner PusePublishAid?

    Properties

    account?: GenericAccount

    The account to use for the user client, if this is not supplied then the signer will be used (if available) otherwise this there will be no account and some operations may not be available.

    client: Client

    The Client to use for interacting with the KeetaNet network

    generateFeeBlock?: (
        staple: VoteStaple,
        options?: UserClientOptions,
    ) => Promise<Block>

    Client provided function to compute the fee block associated with any transactions

    network: bigint

    The network to use for this instance of the UserClient

    networkAlias: "main" | "staging" | "test" | "dev"

    The network alias to use for this instance of the UserClient

    publishAidURL?: string

    If using the publish aid (see ['usePublishAid']) the URL to use.

    The default depends on the network configuration.

    signer: null | Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>

    Account to use to sign blocks for this instance of the UserClient If this is null then no account will be used and some operations may not be available.

    usePublishAid?: boolean

    Use the "publish aid" service to publish blocks.

    This service handles requesting short votes and permanent votes and publishing to the network. This can reduce latency for clients far away from representatives because they only need to wait for a single response instead of multiple round-trips.

    The default is false.

    Settings

    Member Visibility

    On This Page

    Properties