@avalanche-sdk/client/src/methods/xChain/types/getTxStatus.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 { XChainTransactionStatus } from "./common.js";

/**
 * The parameters for the `avm.getTxStatus` method.
 *
 * @property txID - The ID of the transaction to get the status of.
 * @property includeReason - Whether to include the reason for the status.
 */
export type GetTxStatusParameters = {
  txID: string;
  includeReason?: boolean | true;
};

/**
 * The return type for the `avm.getTxStatus` method.
 *
 * @property status - The status of the transaction.
 * @property reason - The reason for the status.
 */
export type GetTxStatusReturnType = {
  status: XChainTransactionStatus;
  reason?: string;
};

export type GetTxStatusErrorType = RequestErrorType;

export type GetTxStatusMethod = {
  Method: "avm.getTxStatus";
  Parameters: GetTxStatusParameters;
  ReturnType: GetTxStatusReturnType;
};