@avalanche-sdk/client/dist/clients/createCChainClient.d.ts

A TypeScript SDK for interacting with the Avalanche network through JSON-RPC APIs. This SDK provides a comprehensive set of tools to interact with all Avalanche chains (P-Chain, X-Chain, C-Chain) and various APIs, including wallet functionality for transa

import { Account, Address, Chain, ParseAccount, Prettify, RpcSchema, Transport } from "viem";
import { CChainRpcSchema } from "../methods/cChain/cChainRpcSchema.js";
import { AvalancheCoreClient, CreateAvalancheCoreClientErrorType } from "./createAvalancheCoreClient.js";
import { CChainActions } from "./decorators/cChain.js";
import { AvalancheClientConfig } from "./types/createAvalancheClient.js";
export type CChainClientConfig<transport extends Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = undefined, raw extends boolean = false> = Prettify<AvalancheClientConfig<transport, chain, accountOrAddress, rpcSchema, raw>>;
export type CChainClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | undefined = undefined, rpcSchema extends RpcSchema | undefined = undefined> = Prettify<AvalancheCoreClient<transport, chain, accountOrAddress, rpcSchema extends RpcSchema ? [...CChainRpcSchema, ...rpcSchema] : CChainRpcSchema, CChainActions>>;
export type CreateCChainClientErrorType = CreateAvalancheCoreClientErrorType;
/**
 * Creates a C-Chain (Contract Chain) Client with a given transport configured for a Chain.
 *
 * The C-Chain Client is an interface to interact with the Avalanche Contract Chain through Avalanche-specific JSON-RPC API methods.
 * The Contract Chain is an instance of the Ethereum Virtual Machine (EVM) that supports:
 * - Cross-chain operations (import/export)
 * - Atomic transactions
 * - UTXO management
 * - Dynamic fee calculations
 *
 * @param parameters - {@link CChainClientConfig}
 * @returns A C-Chain Client. {@link CChainClient}
 *
 * @example
 * ```ts
 * import { createCChainClient} from '@avalanche-sdk/client'
 * import { avalanche } from '@avalanche-sdk/client/chains'
 *
 * const client = createCChainClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "http",
 *   },
 * })
 *
 * // Get atomic transaction
 * const atomicTx = await client.getAtomicTx({ txID: '0x...' })
 * ```
 */
export declare function createCChainClient<transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = undefined, raw extends boolean = false>(parameters: CChainClientConfig<transport, chain, accountOrAddress, rpcSchema, raw>): CChainClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema>;
//# sourceMappingURL=createCChainClient.d.ts.map