@veridex/sdk 1.0.0-beta.9 → 1.1.0

package/dist/payload.d.ts

@@ -1,125 +0,0 @@
-import { ActionPayload, TransferAction, BridgeAction, ExecuteAction } from './types.js';
-
-/**
- * Veridex Protocol SDK - Payload Encoding/Decoding Utilities
- */
-
-/**
- * Encode a transfer action payload
- * Format: [actionType(1)] [token(32)] [recipient(32)] [amount(32)]
- */
-declare function encodeTransferAction(token: string, recipient: string, amount: bigint): string;
-/**
- * Encode a bridge action payload
- * Format: [actionType(1)] [token(32)] [amount(32)] [targetChain(2)] [recipient(32)]
- */
-declare function encodeBridgeAction(token: string, amount: bigint, targetChain: number, recipient: string): string;
-/**
- * Encode an execute action payload (arbitrary contract call)
- * Format: [actionType(1)] [target(32)] [value(32)] [dataLength(2)] [data(variable)]
- */
-declare function encodeExecuteAction(target: string, value: bigint, data: string): string;
-/**
- * Encode a config action payload
- * Format: [actionType(1)] [configType(1)] [configData(variable)]
- */
-declare function encodeConfigAction(configType: number, configData: string): string;
-/**
- * Encode the full Veridex message payload that gets published via Wormhole
- * Format: [version(1)] [userKeyHash(32)] [targetChain(2)] [nonce(32)] [pubKeyX(32)] [pubKeyY(32)] [actionPayload]
- */
-declare function encodeVeridexPayload(userKeyHash: string, targetChain: number, nonce: bigint, publicKeyX: bigint, publicKeyY: bigint, actionPayload: string): string;
-/**
- * Decode an action payload to determine its type and contents
- */
-declare function decodeActionPayload(payload: string): ActionPayload;
-/**
- * Decode a transfer action payload
- */
-declare function decodeTransferAction(payload: string): TransferAction;
-/**
- * Decode a bridge action payload
- */
-declare function decodeBridgeAction(payload: string): BridgeAction;
-/**
- * Decode an execute action payload
- */
-declare function decodeExecuteAction(payload: string): ExecuteAction;
-/**
- * Encode a Solana-compatible transfer action
- * Solana uses: [actionType(1)] [amount(8 LE)] [recipient(32)]
- */
-declare function encodeSolanaTransferAction(amount: bigint, recipient: string): string;
-/**
- * Encode an Aptos-compatible transfer action
- * Aptos uses: [actionType(1)] [amount(8 LE)] [recipient(32)]
- */
-declare function encodeAptosTransferAction(amount: bigint, recipient: string): string;
-/**
- * Encode a Sui-compatible transfer action
- * Sui uses: [actionType(1)] [amount(8 LE)] [recipient(32)]
- */
-declare function encodeSuiTransferAction(amount: bigint, recipient: string): string;
-/**
- * Pad an address to 32 bytes (Wormhole standard)
- * Supports both EVM addresses (0x...) and Solana addresses (base58)
- */
-declare function padTo32Bytes(address: string): string;
-/**
- * Trim a 32-byte hex to a 20-byte EVM address
- */
-declare function trimTo20Bytes(hex32: string): string;
-/**
- * Convert a Solana public key (base58) to bytes32
- * @deprecated Use padTo32Bytes instead, which now handles both EVM and Solana addresses
- */
-declare function solanaAddressToBytes32(base58Address: string): string;
-/**
- * Format an amount with decimals for display
- */
-declare function formatAmount(amount: bigint, decimals?: number): string;
-/**
- * Parse an amount string with decimals to bigint
- */
-declare function parseAmount(amountStr: string, decimals?: number): bigint;
-/**
- * Generate a unique nonce for a transaction
- */
-declare function generateNonce(): bigint;
-/**
- * Create a message hash for signing (used in authenticateRawAndDispatch)
- */
-declare function createMessageHash(targetChain: number, actionPayload: string, nonce: bigint): string;
-/**
- * Create the challenge bytes for gasless dispatch (matches Hub's authenticateAndDispatch)
- *
- * The Hub contract passes raw packed bytes to WebAuthn.verify():
- * abi.encodePacked(targetChain, actionPayload, userNonce, hubChainId)
- *
- * The WebAuthn library then base64url-encodes these bytes to match against clientDataJSON.
- * We do NOT hash here - the challenge is the raw packed bytes.
- *
- * @param targetChain - Wormhole chain ID of the destination
- * @param actionPayload - The action payload (hex string)
- * @param nonce - User's current nonce
- * @param hubChainId - Wormhole chain ID of the Hub (e.g., 30 for Base)
- * @returns The packed bytes as hex string (NOT hashed)
- */
-declare function createGaslessMessageHash(targetChain: number, actionPayload: string, nonce: bigint, hubChainId: number): string;
-/**
- * Build the challenge bytes for WebAuthn signing (gasless flow)
- * Returns raw packed bytes that match what the Hub contract expects
- *
- * @param targetChain - Wormhole chain ID of the destination
- * @param actionPayload - The action payload (hex string)
- * @param nonce - User's current nonce
- * @param hubChainId - Wormhole chain ID of the Hub
- * @returns Challenge bytes for WebAuthn signing (raw packed, not hashed)
- */
-declare function buildGaslessChallenge(targetChain: number, actionPayload: string, nonce: bigint, hubChainId: number): Uint8Array;
-/**
- * Build the challenge bytes for WebAuthn signing
- */
-declare function buildChallenge(userKeyHash: string, targetChain: number, nonce: bigint, actionPayload: string): Uint8Array;
-
-export { buildChallenge, buildGaslessChallenge, createGaslessMessageHash, createMessageHash, decodeActionPayload, decodeBridgeAction, decodeExecuteAction, decodeTransferAction, encodeAptosTransferAction, encodeBridgeAction, encodeConfigAction, encodeExecuteAction, encodeSolanaTransferAction, encodeSuiTransferAction, encodeTransferAction, encodeVeridexPayload, formatAmount, generateNonce, padTo32Bytes, parseAmount, solanaAddressToBytes32, trimTo20Bytes };

package/dist/queries/index.d.ts

@@ -1,148 +0,0 @@
-import { QueryRequest as QueryRequest$1, QueryResponse as QueryResponse$1 } from '@wormhole-foundation/wormhole-query-sdk';
-
-type QueryNetwork = 'mainnet' | 'testnet';
-/**
- * Configuration for calling the Wormhole Query Proxy.
- *
- * `apiKey` is required for hosted Query Proxy access.
- * `endpoint` may be overridden for custom proxy deployments.
- */
-interface QueryConfig {
-    apiKey: string;
-    endpoint?: string;
-    timeoutMs?: number;
-}
-/**
- * Re-exported Wormhole Query SDK types (type-only).
- * These map directly to the request/response shapes expected by the Query Proxy.
- */
-type QueryRequest = QueryRequest$1;
-type QueryResponse = QueryResponse$1;
-type QueryOperationType = 'hubState' | 'portfolio';
-interface HubStateQuery {
-    type: 'hubState';
-    wormholeChainId: number;
-    hubAddress: string;
-}
-interface PortfolioQuery {
-    type: 'portfolio';
-    walletAddress: string;
-    wormholeChainIds: readonly number[];
-}
-type QueryOperation = HubStateQuery | PortfolioQuery;
-
-declare const WORMHOLE_QUERY_PROXY_URLS: {
-    readonly mainnet: "https://query.wormhole.com/v1/query";
-    readonly testnet: "https://testnet.query.wormhole.com/v1/query";
-};
-/**
- * Wormhole Query Proxy rate limit: 6 queries per second.
- * SDK callers should throttle requests accordingly.
- */
-declare const WORMHOLE_QUERY_RATE_LIMIT_PER_SECOND = 6;
-/**
- * Convenience set of Wormhole chain IDs commonly supported by Queries.
- * This is not an exhaustive list of all Wormhole chains.
- */
-declare const WORMHOLE_QUERY_CHAIN_IDS: {
-    readonly ETHEREUM: 2;
-    readonly POLYGON: 5;
-    readonly ARBITRUM: 23;
-    readonly OPTIMISM: 24;
-    readonly BASE: 30;
-};
-
-type QueryHubStateNetwork = 'testnet' | 'mainnet';
-type QueryHubStateOptions = {
-    /** Max response age in seconds (default: 60). */
-    maxAge?: number;
-    network?: QueryHubStateNetwork;
-    /** Maximum attempts including the first try (default: 4). */
-    maxAttempts?: number;
-};
-type HubStateResult = {
-    nonce: bigint;
-    isRegistered: boolean;
-    blockTime: number;
-    proof: Uint8Array;
-    /** Last action hash (Issue #9/#10 - for action-hash binding) */
-    lastActionHash?: string;
-};
-type QueryHubStateErrorCode = 'INVALID_ARGUMENT' | 'UNSUPPORTED_NETWORK' | 'MISSING_HUB_ADDRESS' | 'PROXY_HTTP_ERROR' | 'PROXY_RESPONSE_INVALID' | 'ATTESTATION_STALE' | 'QUERY_RESPONSE_INVALID';
-declare class QueryHubStateError extends Error {
-    code: QueryHubStateErrorCode;
-    cause?: unknown;
-    constructor(code: QueryHubStateErrorCode, message: string, cause?: unknown);
-}
-/** * Fetch Guardian-attested Hub state directly from the Wormhole Query Proxy.
- *
- * Client-side only: this avoids relayer API costs and produces a Guardian-signed proof
- * that can be forwarded to the relayer for on-chain verification/submission.
- */
-declare function queryHubState(userKeyHash: string, apiKey: string, options?: QueryHubStateOptions): Promise<HubStateResult>;
-
-type QueryPortfolioNetwork = 'testnet' | 'mainnet';
-type QueryPortfolioOptions = {
-    /** Max response age in seconds (default: 60). */
-    maxAge?: number;
-    network?: QueryPortfolioNetwork;
-    /** Maximum attempts including the first try (default: 4). */
-    maxAttempts?: number;
-    /** Cache TTL in ms (default: 30_000). */
-    cacheTtlMs?: number;
-    /** Request timeout in ms (default: 15_000 for testnet, 10_000 for mainnet). */
-    timeout?: number;
-    /** Override Query Proxy endpoint. */
-    endpoint?: string;
-    /** Override per-chain RPC URLs used for block tag lookups. */
-    rpcUrls?: Record<number, string>;
-    /** Override derived vault addresses for specific Wormhole chain IDs. */
-    vaultAddresses?: Record<number, string>;
-    /** Override token lists (ERC20 only) for specific Wormhole chain IDs. */
-    evmTokenAddresses?: Record<number, string[]>;
-    /** Additional Solana accounts to include in the Solana account query (base58). */
-    solanaAccounts?: string[];
-    /** Optional USD prices by symbol/address for aggregation (e.g. { USDC: 1 }). */
-    pricesUsd?: Record<string, number>;
-};
-type PortfolioBalance = {
-    assetId: string;
-    amount: bigint;
-    decimals?: number;
-    symbol?: string;
-    usdValue?: number;
-};
-type PortfolioChainErrorCode = 'UNSUPPORTED_CHAIN' | 'MISSING_VAULT' | 'MISSING_TOKENS' | 'ATTESTATION_STALE' | 'DECODE_ERROR';
-type PortfolioChainResult = {
-    wormholeChainId: number;
-    chainName?: string;
-    vaultAddress?: string;
-    blockTime?: number;
-    balances: PortfolioBalance[];
-    error?: {
-        code: PortfolioChainErrorCode;
-        message: string;
-    };
-};
-type PortfolioResult = {
-    proof: Uint8Array;
-    totalUsd?: number;
-    chains: PortfolioChainResult[];
-};
-type QueryPortfolioErrorCode = 'INVALID_ARGUMENT' | 'NETWORK_ERROR' | 'PROXY_HTTP_ERROR' | 'PROXY_RESPONSE_INVALID' | 'QUERY_RESPONSE_INVALID';
-declare class QueryPortfolioError extends Error {
-    code: QueryPortfolioErrorCode;
-    cause?: unknown;
-    constructor(code: QueryPortfolioErrorCode, message: string, cause?: unknown);
-}
-/**
- * Fetch Guardian-attested vault balances across multiple chains in one Query Proxy request.
- *
- * Notes:
- * - EVM balances are ERC20-only via `eth_call` (native ETH is not queryable via this query type).
- * - Solana balance uses lamports of the Veridex vault PDA (plus optional extra accounts).
- * - Aptos is included only if/when Wormhole Queries adds Aptos query types (currently returned as unsupported).
- */
-declare function queryPortfolio(userKeyHash: string, apiKey: string, options?: QueryPortfolioOptions): Promise<PortfolioResult>;
-
-export { type HubStateQuery, type HubStateResult, type PortfolioBalance, type PortfolioChainErrorCode, type PortfolioChainResult, type PortfolioQuery, type PortfolioResult, type QueryConfig, QueryHubStateError, type QueryHubStateErrorCode, type QueryHubStateNetwork, type QueryHubStateOptions, type QueryNetwork, type QueryOperation, type QueryOperationType, QueryPortfolioError, type QueryPortfolioErrorCode, type QueryPortfolioNetwork, type QueryPortfolioOptions, type QueryRequest, type QueryResponse, WORMHOLE_QUERY_CHAIN_IDS, WORMHOLE_QUERY_PROXY_URLS, WORMHOLE_QUERY_RATE_LIMIT_PER_SECOND, queryHubState, queryPortfolio };