@avalanche-sdk/client
Version:
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
32 lines • 1.2 kB
TypeScript
import { Chain, Transport } from "viem";
import { AvalancheCoreClient as Client } from "../../clients/createAvalancheCoreClient.js";
import { GetAtomicTxParameters, GetAtomicTxReturnType } from "./types/getAtomicTx.js";
/**
* Get the atomic transaction by its ID.
*
* - Docs: https://build.avax.network/docs/api-reference/c-chain/api#avaxgetatomictx
*
* @param client - The client to use. {@link AvalancheCoreClient}
* @param params - The parameters to use. {@link GetAtomicTxParameters}
* @returns The atomic transaction. {@link GetAtomicTxReturnType}
*
* @example
* ```ts
* import { createAvalancheCoreClient } from '@avalanche-sdk/client'
* import { avalanche } from '@avalanche-sdk/client/chains'
*
* const client = createAvalancheCoreClient({
* chain: avalanche,
* transport: {
* type: "http",
* url: "<url>",
* },
* })
*
* const tx = await getAtomicTx(client, {
* txID: "2QouvMUbQ6oy7yQ9tLvL3L8tGQG2QK1wJ1q1wJ1q1wJ1q1wJ1q1wJ1q1wJ1"
* })
* ```
*/
export declare function getAtomicTx<chain extends Chain | undefined>(client: Client<Transport, chain>, params: GetAtomicTxParameters): Promise<GetAtomicTxReturnType>;
//# sourceMappingURL=getAtomicTx.d.ts.map