@avalanche-sdk/client/src/methods/wallet/types/sendXPTransaction.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 { PChainOwner, UnsignedTx } from "@avalabs/avalanchejs";
import { Address } from "viem";
import { RequestErrorType } from "viem/utils";
import { AvalancheAccount } from "../../../accounts/avalancheAccount.js";

/**
 * The parameters for the sendXPTransaction method
 * @property tx - The transaction to send, either a hex string or an UnsignedTx object. `string` or {@link UnsignedTx}
 * @property chainAlias - The chain to send the transaction to. `"X" | "P" | "C"`
 * @property account - Optional, the account to use for the transaction. {@link AvalancheAccount} or {@link Address}
 * @property accountIndex - Optional, the account index to use for the transaction from custom transport (eg: core extension). `number`
 * @property externalIndices - Optional, the external indices to use for the transaction. `number[]`
 * @property internalIndices - Optional, the internal indices to use for the transaction. `number[]`
 * @property utxoIds - Optional, the utxo ids to use for the transaction. `string[]`
 * @property feeTolerance - Optional, the fee tolerance to use for the transaction. `number`
 * @property subnetAuth - Optional, the subnet auth to use for the transaction. `number[]`
 * @property subnetOwners - Optional, the subnet owners to use for the transaction. {@link PChainOwner}
 * @property disableOwners - Optional, the disable owners to use for the transaction. {@link PChainOwner}
 * @property disableAuth - Optional, the disable auth to use for the transaction. `number[]`
 */
export type SendXPTransactionParameters = {
  account?: AvalancheAccount | Address | undefined;
  tx: string | UnsignedTx;
  chainAlias: "X" | "P" | "C";
  externalIndices?: number[] | undefined;
  internalIndices?: number[] | undefined;
  utxoIds?: string[] | undefined;
  feeTolerance?: number | undefined;
  subnetAuth?: number[] | undefined;
  subnetOwners?: PChainOwner | undefined;
  disableOwners?: PChainOwner | undefined;
  disableAuth?: number[] | undefined;
};

/**
 * The return type for the sendXPTransaction method
 * @property txHash - The hash of the transaction `string`
 * @property chainAlias - The chain alias `"X" | "P" | "C"`
 */
export type SendXPTransactionReturnType = {
  txHash: string;
  chainAlias: "X" | "P" | "C";
};

export type SendXPTransactionErrorType = RequestErrorType;

export type SendXPTransactionMethod = {
  Method: "avalanche_sendTransaction";
  Parameters: Omit<SendXPTransactionParameters, "account">;
  ReturnType: SendXPTransactionReturnType;
};