Polkadot Apps
    Preparing search index...

    Interface ChainClientConfig<TChains>

    Configuration for createChainClient.

    Provide named chain descriptors and their RPC endpoints. TypeScript enforces that rpcs has the same keys as chains.

    import { createChainClient } from "@polkadot-apps/chain-client";
    import { paseo_asset_hub } from "@polkadot-apps/descriptors/paseo-asset-hub";
    import { bulletin } from "@polkadot-apps/descriptors/bulletin";

    const client = await createChainClient({
        chains: { assetHub: paseo_asset_hub, bulletin },
        rpcs: {
            assetHub: ["wss://sys.ibp.network/asset-hub-paseo"],
            bulletin: ["wss://paseo-bulletin-rpc.polkadot.io"],
        },
    });
    interface ChainClientConfig<
        TChains extends
            Record<string, ChainDefinition> = Record<string, ChainDefinition>,
    > {
        chains: TChains;
        meta?: { [K in string
        | number
        | symbol]?: Omit<ChainMeta, "rpcs"> };
        rpcs: { [K in string | number | symbol]: readonly string[] };
    }

    Type Parameters

    • TChains extends Record<string, ChainDefinition> = Record<string, ChainDefinition>

      Record mapping user-chosen chain names to PAPI descriptors.

    Index

    Properties

    chains meta? rpcs

    Properties

    chains: TChains

    Named chain descriptors (PAPI ChainDefinition objects).

    meta?: { [K in string | number | symbol]?: Omit<ChainMeta, "rpcs"> }

    Optional per-chain connection metadata (lightclient specs, mode overrides).

    rpcs: { [K in string | number | symbol]: readonly string[] }

    RPC endpoints per chain name. Must have an entry for each key in chains.

    Settings

    Member Visibility

    On This Page

    Properties