@avalanche-sdk/client/src/methods/cChain/types/getAtomicTxStatus.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 { RequestErrorType } from "viem/utils";
import { CChainAtomicTxStatus } from "./common.js";

/**
 * The parameters for the `avax.getAtomicTxStatus` method.
 *
 * @param txID - The ID of the atomic transaction. It should be in cb58 format.
 */
export type GetAtomicTxStatusParameters = {
  txID: string;
};

/**
 * The return type for the `avax.getAtomicTxStatus` method.
 *
 * @param status - The status of the atomic transaction. {@link CChainAtomicTxStatus}
 * @param blockHeight - The height of the block which the transaction was included in.
 */
export type GetAtomicTxStatusReturnType = {
  status: CChainAtomicTxStatus;
  blockHeight: string;
};

export type GetAtomicTxStatusErrorType = RequestErrorType;

export type GetAtomicTxStatusMethod = {
  Method: "avax.getAtomicTxStatus";
  Parameters: GetAtomicTxStatusParameters;
  ReturnType: GetAtomicTxStatusReturnType;
};