@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
38 lines • 1.6 kB
TypeScript
import { AvalancheWalletCoreClient } from "../../../clients/createAvalancheWalletCoreClient.js";
import { PrepareBaseTxnParameters, PrepareBaseTxnReturnType } from "./types/prepareBaseTxn.js";
/**
* Prepares a base transaction for the X-chain.
*
* @see https://build.avax.network/docs/api-reference/x-chain/txn-format#unsigned-basetx
*
* @param client - The client to use for the transaction. {@link AvalancheWalletCoreClient}
* @param params - The parameters for the transaction. {@link PrepareBaseTxnParameters}
* @returns The unsigned transaction. {@link PrepareBaseTxnReturnType}
*
* @example
* ```ts
* import { prepareBaseTxn } from "@avalanche-sdk/client/methods/wallet/xChain";
* import { privateKeyToAvalancheAccount } from "@avalanche-sdk/client/accounts";
* import { avalanche } from "@avalanche-sdk/client/chains";
* import { avaxToNanoAvax } from "@avalanche-sdk/client/utils";
*
* const account = privateKeyToAvalancheAccount(privateKeyForTest);
* const walletClient = new AvalancheWalletCoreClient({
* chain: avalanche,
* transport: {
* url: "https://api.avax.network/ext/bc/C/rpc",
* },
* account,
* });
*
* const xChainBaseTxnRequest = await prepareBaseTxn(walletClient, {
* outputs: [
* {
* amount: avaxToNanoAvax(0.0001), // 0.0001 AVAX = 100_000 nAVAX
* to: "P-fuji19fc97zn3mzmwr827j4d3n45refkksgms4y2yzz",
* },
* ],
* });
*/
export declare function prepareBaseTxn(client: AvalancheWalletCoreClient, params: PrepareBaseTxnParameters): Promise<PrepareBaseTxnReturnType>;
//# sourceMappingURL=prepareBaseTxn.d.ts.map