GenericProvider

Interface that all provider adapters must implement for read-only chain access.

Interface that all provider adapters must implement for read-only chain access. You only need this if you are building a custom provider -- otherwise use ViemProvider, EthersProvider, or the wagmi createConfig which builds one internally.

Import

import type { GenericProvider } from "@zama-fhe/sdk";

Definition

interface GenericProvider {
  getChainId(): Promise<number>;
  readContract(config: ReadContractConfig): Promise<unknown>;
  waitForTransactionReceipt(hash: Hex): Promise<TransactionReceipt>;
  getBlockTimestamp(): Promise<bigint>;
}

Usage with createConfig

Pass a custom provider to the generic createConfig from @zama-fhe/sdk:

import { createConfig, ZamaSDK, memoryStorage } from "@zama-fhe/sdk";
import { node } from "@zama-fhe/sdk/node";
import { sepolia } from "@zama-fhe/sdk/chains";

const config = createConfig({
  chains: [sepolia],
  provider: myCustomProvider,
  storage: memoryStorage,
  relayers: { [sepolia.id]: node() },
});
const sdk = new ZamaSDK(config);

Implementing a custom provider

import type { GenericProvider } from "@zama-fhe/sdk";

class MyProvider implements GenericProvider {
  async getChainId() {
    /* ... */
  }
  async readContract(config) {
    /* ... */
  }
  async waitForTransactionReceipt(hash) {
    /* ... */
  }
  async getBlockTimestamp() {
    /* ... */
  }
}

Methods

getChainId

getChainId(): Promise<number>

Return the chain ID this provider is connected to.

readContract

readContract(config: ReadContractConfig): Promise<unknown>

Execute a read-only contract call. ReadContractConfig contains address, abi, functionName, and args.

waitForTransactionReceipt

waitForTransactionReceipt(hash: Hex): Promise<TransactionReceipt>

Poll for a transaction receipt by hash.

getBlockTimestamp

getBlockTimestamp(): Promise<bigint>

Return the timestamp of the latest block.

Related

• ViemProvider -- viem implementation

• EthersProvider -- ethers implementation

• GenericSigner -- wallet authority interface

• Configuration guide -- full setup walkthrough