@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
37 lines • 1.48 kB
TypeScript
import { AvalancheWalletCoreClient } from "../../clients/createAvalancheWalletCoreClient.js";
import { SignXPTransactionParameters, SignXPTransactionReturnType } from "./types/signXPTransaction.js";
/**
* Formats an XP address with the chain alias prefix
* @param chainAlias - The chain alias (X or P)
* @param address - The XP address
* @returns The formatted address with chain alias prefix
*/
export declare function formatChainAddress(chainAlias: "X" | "P" | "C", address: string): string;
/**
* Sign an XP transaction
* @param client - The client to use {@link AvalancheWalletCoreClient}
* @param params - The parameters for the transaction {@link SignXPTransactionParameters}
* @returns The signed transaction {@link SignXPTransactionReturnType}
*
* @example
*
* import { createWalletCoreClient, http } from '@avalanche-sdk/client'
* import { avalanche } from '@avalanche-sdk/client/chains'
* import { signXPTransaction } from '@avalanche-sdk/client/methods/wallet'
*
* const client = createWalletCoreClient({
* chain: avalanche,
* transport: {
* type: "custom",
* provider: window.avalanche!,
* },
* })
*
* const signedTx = await signXPTransaction(client, {
* txOrTxHex: "0x...",
* chainAlias: "P",
* utxos: [],
* })
*/
export declare function signXPTransaction(client: AvalancheWalletCoreClient, params: SignXPTransactionParameters): Promise<SignXPTransactionReturnType>;
//# sourceMappingURL=signXPTransaction.d.ts.map