@thruputchain/client
    Preparing search index...

    Interface ThruputClient

    Native RPC methods plus workflows that never sign, replace or repeat writes.

    interface ThruputClient {
        dev_fundAccount: (
            request: {
                clientNonce: Uint8Array;
                faucet: RpcBase58_ContractAddress;
                rawAmount: bigint;
                recipient: RpcBase58_ContractAddress;
            },
            options?: TransportRequestOptions,
        ) => Promise<RpcFundingSubmission>;
        dev_getPendingTransactionCount: (
            request?: {},
            options?: TransportRequestOptions,
        ) => Promise<RpcPendingTransactionCount>;
        discovery: RpcDiscovery;
        faucet_requestAirdrop: (
            request: {
                clientNonce: Uint8Array;
                recipient: RpcBase58_ContractAddress;
            },
            options?: TransportRequestOptions,
        ) => Promise<RpcAirdropAttempt>;
        getBalance: (
            request: { address: RpcBase58_ContractAddress },
            options?: TransportRequestOptions,
        ) => Promise<RpcBalanceResult>;
        getBlockByHeight: (
            request: { blockHeight: bigint },
            options?: TransportRequestOptions,
        ) => Promise<RpcBlockInfo | null>;
        getChainConfig: (
            request?: {},
            options?: TransportRequestOptions,
        ) => Promise<RpcChainConfig>;
        getChainTip: (
            request?: {},
            options?: TransportRequestOptions,
        ) => Promise<RpcChainTip>;
        getEvents: (
            request: { filters: RpcEventFilter[]; limit?: number } & (
                | { cursor?: undefined; start: RpcHistoryStart }
                | { cursor: string; start?: undefined }
            ),
            options?: TransportRequestOptions,
        ) => Promise<RpcEventPage>;
        getNetworkInfo: (
            request?: {},
            options?: TransportRequestOptions,
        ) => Promise<RpcNetworkInfo>;
        getRegisteredAuth: (
            request: { address: RpcBase58_ContractAddress },
            options?: TransportRequestOptions,
        ) => Promise<RpcRegisteredAuthResult>;
        getServerLimits: (
            request?: {},
            options?: TransportRequestOptions,
        ) => Promise<RpcServerLimits>;
        getStorage: (
            request: { address: RpcBase58_ContractAddress; key: Uint8Array },
            options?: TransportRequestOptions,
        ) => Promise<RpcStorageResult>;
        getTransactionReceipt: (
            request: { transactionHash: RpcBase58_SHA256Hash },
            options?: TransportRequestOptions,
        ) => Promise<RpcTransactionReceipt | null>;
        getTransactionsByBlock: (
            request: { blockHeight: bigint; limit?: number } & (
                | { cursor?: undefined; start: RpcBlockStart }
                | { cursor: string; start?: undefined }
            ),
            options?: TransportRequestOptions,
        ) => Promise<RpcTransactionRefPage>;
        getTransactionsByRootAddress: (
            request: { address: RpcBase58_ContractAddress; limit?: number } & (
                | { cursor?: undefined; start: RpcHistoryStart }
                | { cursor: string; start?: undefined }
            ),
            options?: TransportRequestOptions,
        ) => Promise<RpcTransactionRefPage>;
        getTransactionStatus: (
            request: { transactionHash: RpcBase58_SHA256Hash },
            options?: TransportRequestOptions,
        ) => Promise<RpcTransactionStatus>;
        getVersionInfo: (
            request?: {},
            options?: TransportRequestOptions,
        ) => Promise<RpcVersionInfo>;
        sendTransaction: (
            request: { signedTransaction: Uint8Array },
            options?: TransportRequestOptions,
        ) => Promise<RpcSendTransactionResult>;
        simulateInvocation: (
            request: {
                address: RpcBase58_ContractAddress;
                assumedAuth?: RpcAssumedAuth;
                calldata: Uint8Array;
                caller?: RpcBase58_ContractAddress;
                entrypoint: Uint8Array;
                gasLimit?: bigint;
                minStateBlockHeight?: bigint;
            },
            options?: TransportRequestOptions,
        ) => Promise<RpcSimulationResult>;
        simulateInvocations: (
            request: { invocations: RpcInvocation[]; minStateBlockHeight?: bigint },
            options?: TransportRequestOptions,
        ) => Promise<RpcSimulationResults>;
        getContractEvents<TName extends string, TTopics, TFields, TFilter>(
            query: ContractEventQuery<TName, TTopics, TFields, TFilter>,
            options?: TransportRequestOptions,
        ): Promise<ContractEventPage<TName, TTopics, TFields>>;
        iterateEventPages(
            query: { filters: RpcEventFilter[]; limit?: number } & {
                cursor?: undefined;
                start: RpcHistoryStart;
            },
            options?: TransportRequestOptions,
        ): AsyncGenerator<RpcEventPage, HistoryCompletion, unknown>;
        iterateTransactionsByBlock(
            query: { blockHeight: bigint; limit?: number } & {
                cursor?: undefined;
                start: RpcBlockStart;
            },
            options?: TransportRequestOptions,
        ): AsyncGenerator<RpcTransactionRefPage, void, unknown>;
        iterateTransactionsByRootAddress(
            query: { address: RpcBase58_ContractAddress; limit?: number } & {
                cursor?: undefined;
                start: RpcHistoryStart;
            },
            options?: TransportRequestOptions,
        ): AsyncGenerator<RpcTransactionRefPage, HistoryCompletion, unknown>;
        readViews<
            const TCalls extends readonly ContractViewRequest<unknown, unknown>[],
        >(
            request: ReadViewsRequest<TCalls>,
            options?: TransportRequestOptions,
        ): Promise<ReadViewsResponse<TCalls>>;
        refreshDiscovery(options?: TransportRequestOptions): Promise<RpcDiscovery>;
        requestAirdrop(
            options: RequestAirdropOptions,
        ): Promise<
            {
                attemptStatus: "succeeded";
                blockHeight: bigint;
                execution: RpcAirdropExecution;
                rawAmount: bigint;
                recipient: RpcBase58_ContractAddress;
                transactionHash: RpcBase58_SHA256Hash;
            },
        >;
        requestAirdropAttempt(
            request: {
                clientNonce: Uint8Array;
                recipient: RpcBase58_ContractAddress;
            },
            options?: TransportRequestOptions,
        ): Promise<RpcAirdropAttempt>;
        requireMethods(methods: readonly (keyof RpcRequests)[]): void;
        waitForCommitment(
            transactionHash: Uint8Array,
            options?: WaitForTransactionReceiptOptions,
        ): Promise<KnownCommitment>;
        waitForTransactionReceipt(
            transactionHash: Uint8Array,
            options?: WaitForTransactionReceiptOptions,
        ): Promise<RpcTransactionReceipt>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    dev_fundAccount dev_getPendingTransactionCount discovery faucet_requestAirdrop getBalance getBlockByHeight getChainConfig getChainTip getEvents getNetworkInfo getRegisteredAuth getServerLimits getStorage getTransactionReceipt getTransactionsByBlock getTransactionsByRootAddress getTransactionStatus getVersionInfo sendTransaction simulateInvocation simulateInvocations

    Methods

    getContractEvents iterateEventPages iterateTransactionsByBlock iterateTransactionsByRootAddress readViews refreshDiscovery requestAirdrop requestAirdropAttempt requireMethods waitForCommitment waitForTransactionReceipt

    Properties

    dev_fundAccount: (
        request: {
            clientNonce: Uint8Array;
            faucet: RpcBase58_ContractAddress;
            rawAmount: bigint;
            recipient: RpcBase58_ContractAddress;
        },
        options?: TransportRequestOptions,
    ) => Promise<RpcFundingSubmission>
    dev_getPendingTransactionCount: (
        request?: {},
        options?: TransportRequestOptions,
    ) => Promise<RpcPendingTransactionCount>
    discovery: RpcDiscovery

    Copy of the last explicitly refreshed, validated discovery snapshot.

    faucet_requestAirdrop: (
        request: {
            clientNonce: Uint8Array;
            recipient: RpcBase58_ContractAddress;
        },
        options?: TransportRequestOptions,
    ) => Promise<RpcAirdropAttempt>
    getBalance: (
        request: { address: RpcBase58_ContractAddress },
        options?: TransportRequestOptions,
    ) => Promise<RpcBalanceResult>
    getBlockByHeight: (
        request: { blockHeight: bigint },
        options?: TransportRequestOptions,
    ) => Promise<RpcBlockInfo | null>
    getChainConfig: (
        request?: {},
        options?: TransportRequestOptions,
    ) => Promise<RpcChainConfig>
    getChainTip: (
        request?: {},
        options?: TransportRequestOptions,
    ) => Promise<RpcChainTip>
    getEvents: (
        request: { filters: RpcEventFilter[]; limit?: number } & (
            | { cursor?: undefined; start: RpcHistoryStart }
            | { cursor: string; start?: undefined }
        ),
        options?: TransportRequestOptions,
    ) => Promise<RpcEventPage>
    getNetworkInfo: (
        request?: {},
        options?: TransportRequestOptions,
    ) => Promise<RpcNetworkInfo>
    getRegisteredAuth: (
        request: { address: RpcBase58_ContractAddress },
        options?: TransportRequestOptions,
    ) => Promise<RpcRegisteredAuthResult>
    getServerLimits: (
        request?: {},
        options?: TransportRequestOptions,
    ) => Promise<RpcServerLimits>
    getStorage: (
        request: { address: RpcBase58_ContractAddress; key: Uint8Array },
        options?: TransportRequestOptions,
    ) => Promise<RpcStorageResult>
    getTransactionReceipt: (
        request: { transactionHash: RpcBase58_SHA256Hash },
        options?: TransportRequestOptions,
    ) => Promise<RpcTransactionReceipt | null>
    getTransactionsByBlock: (
        request: { blockHeight: bigint; limit?: number } & (
            | { cursor?: undefined; start: RpcBlockStart }
            | { cursor: string; start?: undefined }
        ),
        options?: TransportRequestOptions,
    ) => Promise<RpcTransactionRefPage>
    getTransactionsByRootAddress: (
        request: { address: RpcBase58_ContractAddress; limit?: number } & (
            | { cursor?: undefined; start: RpcHistoryStart }
            | { cursor: string; start?: undefined }
        ),
        options?: TransportRequestOptions,
    ) => Promise<RpcTransactionRefPage>
    getTransactionStatus: (
        request: { transactionHash: RpcBase58_SHA256Hash },
        options?: TransportRequestOptions,
    ) => Promise<RpcTransactionStatus>
    getVersionInfo: (
        request?: {},
        options?: TransportRequestOptions,
    ) => Promise<RpcVersionInfo>
    sendTransaction: (
        request: { signedTransaction: Uint8Array },
        options?: TransportRequestOptions,
    ) => Promise<RpcSendTransactionResult>
    simulateInvocation: (
        request: {
            address: RpcBase58_ContractAddress;
            assumedAuth?: RpcAssumedAuth;
            calldata: Uint8Array;
            caller?: RpcBase58_ContractAddress;
            entrypoint: Uint8Array;
            gasLimit?: bigint;
            minStateBlockHeight?: bigint;
        },
        options?: TransportRequestOptions,
    ) => Promise<RpcSimulationResult>
    simulateInvocations: (
        request: { invocations: RpcInvocation[]; minStateBlockHeight?: bigint },
        options?: TransportRequestOptions,
    ) => Promise<RpcSimulationResults>

    Methods

    • Check the configured methods before composing a multi-call workflow.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods