superstack-wallet-sdk 0.5.8 → 0.5.10

package/dist/index.d.ts

@@ -223,6 +223,8 @@ interface DeBridgeDlnCreateTxRequest {
     srcChainPriorityLevel?: string | null;
 }
 type BuildTransactionRequest = {
+    wallet_address?: string | null;
+} & ({
     type: "HyperbeatVaultApprove";
     data: {
         vault_id: VaultId;
@@ -267,11 +269,248 @@ type BuildTransactionRequest = {
     data: {
         request: DeBridgeDlnCreateTxRequest;
     };
-};
+});
 interface BuildTransactionResponse {
     raw_transaction: string;
     metadata?: any;
 }
+declare enum LighterOrderSide {
+    Buy = "buy",
+    Sell = "sell"
+}
+declare enum LighterOrderType {
+    Limit = "limit",
+    Market = "market",
+    StopLoss = "stop_loss",
+    StopLossLimit = "stop_loss_limit",
+    TakeProfit = "take_profit",
+    TakeProfitLimit = "take_profit_limit",
+    Twap = "twap",
+    TwapSub = "twap_sub"
+}
+declare enum LighterTimeInForce {
+    ImmediateOrCancel = "immediate_or_cancel",
+    GoodTillTime = "good_till_time",
+    PostOnly = "post_only"
+}
+declare enum LighterMarginMode {
+    Cross = "cross",
+    Isolated = "isolated"
+}
+declare enum LighterGroupingType {
+    Default = "default",
+    OneTriggersTheOther = "one_triggers_the_other",
+    OneCancelsTheOther = "one_cancels_the_other",
+    OneTriggersAOneCancelsTheOther = "one_triggers_a_one_cancels_the_other"
+}
+interface LighterTxContext {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+}
+interface LighterOrderParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    market_index: number;
+    client_order_index?: number | null;
+    base_amount: number;
+    price?: number | null;
+    side: LighterOrderSide;
+    order_type: LighterOrderType;
+    time_in_force?: LighterTimeInForce | null;
+    reduce_only?: boolean;
+    trigger_price?: number | null;
+    order_expiry_ms?: number | null;
+}
+interface LighterLeverageParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    market_index: number;
+    leverage: number;
+    margin_mode: LighterMarginMode;
+}
+interface LighterWithdrawParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    usdc_amount: number;
+}
+interface LighterCreateSubAccountParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+}
+interface LighterGroupedOrderEntry {
+    market_index: number;
+    client_order_index?: number | null;
+    base_amount: number;
+    price?: number | null;
+    side: LighterOrderSide;
+    order_type: LighterOrderType;
+    time_in_force?: LighterTimeInForce | null;
+    reduce_only?: boolean;
+    trigger_price?: number | null;
+    order_expiry_ms?: number | null;
+}
+interface LighterGroupedOrdersParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    grouping_type: LighterGroupingType;
+    orders: LighterGroupedOrderEntry[];
+}
+interface LighterGeneralTransferParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    to_account_index: number;
+    usdc_amount: number;
+    fee?: number;
+    memo_hex?: string | null;
+}
+interface LighterCancelOrderParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    market_index: number;
+    index: number;
+}
+interface LighterCancelAllOrdersParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    time_in_force: LighterTimeInForce;
+    time: number;
+}
+type LighterBuildTransactionRequest = {
+    wallet_address?: string | null;
+} & ({
+    type: "Order";
+    data: LighterOrderParams;
+} | {
+    type: "UpdateLeverage";
+    data: LighterLeverageParams;
+} | {
+    type: "Withdraw";
+    data: LighterWithdrawParams;
+} | {
+    type: "CreateSubAccount";
+    data: LighterCreateSubAccountParams;
+} | {
+    type: "Transfer";
+    data: LighterGeneralTransferParams;
+} | {
+    type: "GroupedOrders";
+    data: LighterGroupedOrdersParams;
+} | {
+    type: "CancelOrder";
+    data: LighterCancelOrderParams;
+} | {
+    type: "CancelAllOrders";
+    data: LighterCancelAllOrdersParams;
+});
+interface LighterBuildTransactionResponse {
+    tx_type: number;
+    tx_info: string;
+    tx_hash?: string | null;
+    hash: string;
+}
+interface LighterAuthRequest {
+    wallet_address?: string | null;
+    expires_in_ms?: number | null;
+    account_index: number;
+}
+interface LighterAuthResponse {
+    auth: string;
+    expires_at: number;
+}
+interface LighterChangeKeyRequest {
+    wallet_address?: string | null;
+    account_index: number;
+}
+interface LighterChangeKeyResponse {
+    account_index: number;
+    public_key: string;
+}
+interface ExchangeSignature {
+    r: string;
+    s: string;
+    v: number;
+}
+interface ExchangePayload {
+    action: any;
+    nonce: number;
+    signature: ExchangeSignature;
+    vaultAddress?: string | null;
+    expiresAfter?: number | null;
+}
+interface ExchangeResponse {
+    payload: ExchangePayload;
+}
+interface ExchangeRequest {
+    action: any;
+    vaultAddress?: string | null;
+    expiresAfter?: number | null;
+    isMainnet?: boolean | null;
+    walletAddress?: string | null;
+}
+interface ExportInitRequest {
+    user_nonce: string;
+    account_index?: number;
+}
+interface ExportInitResponse {
+    server_nonce: string;
+}
+interface ExportFinishRequest {
+    user_nonce?: string;
+    server_nonce?: string;
+    account_index?: number;
+    is_export: boolean;
+}
+interface ExportWallet {
+    network: Network;
+    wallet_set: string;
+    address: string;
+    private_key: string;
+}
+interface ExportWalletResponse {
+    user_id: string;
+    wallets: ExportWallet[];
+}
+interface CloseInitRequest {
+    user_nonce: string;
+}
+interface CloseInitResponse {
+    server_nonce: string;
+}
+interface CloseFinishRequest {
+    user_nonce: string;
+    server_nonce: string;
+}
+interface CloseFinishResponse {
+    user_id: string;
+    is_closed: boolean;
+}
 
 interface PhantomWalletAdapterConfig {
 }
@@ -524,10 +763,116 @@ declare class WalletClient {
     }): Promise<BuildTransactionResponse>;
     /**
      * Build a transaction using the server-side build transaction API
-     * @param request Build transaction request
+     * @param request Build transaction request (with optional wallet_address field)
+     * @param walletAddress Optional wallet address (will be added to request if provided)
      * @returns Build transaction response with raw transaction
      */
     buildTransaction(request: BuildTransactionRequest, walletAddress?: string): Promise<BuildTransactionResponse>;
+    /**
+     * Initialize the export process by generating a server nonce
+     * @param accountIndex Optional account index to export (defaults to 0)
+     * @returns Server nonce for verification
+     */
+    exportInit(accountIndex?: number): Promise<ExportInitResponse>;
+    /**
+     * Finalize the export process and retrieve wallet private keys
+     * @param params Export parameters including nonces and account index
+     * @returns Exported wallet information with private keys
+     */
+    exportFinal(params: {
+        userNonce: string;
+        serverNonce: string;
+        accountIndex?: number;
+        isExport?: boolean;
+    }): Promise<ExportWalletResponse>;
+    /**
+     * Retrieve previously exported wallet information
+     * @param accountIndex Optional account index (defaults to 0)
+     * @returns Previously exported wallet information
+     */
+    getExportedWallets(accountIndex?: number): Promise<ExportWalletResponse>;
+    /**
+     * Initialize the account closure process
+     * @returns Server nonce for verification
+     */
+    closeInit(): Promise<CloseInitResponse>;
+    /**
+     * Finalize the account closure process and permanently delete the account
+     * @param params Close parameters including nonces
+     * @returns Confirmation that the account was closed
+     */
+    closeFinal(params: {
+        userNonce: string;
+        serverNonce: string;
+    }): Promise<CloseFinishResponse>;
+    /**
+     * Raw v1 sign API - Sign a message with user's wallet
+     * @param params Sign parameters including network, address, and message
+     * @returns Signature string
+     */
+    signV1(params: {
+        network: Network;
+        address: string;
+        message: string;
+    }): Promise<string>;
+    /**
+     * Raw v2 sign API - Sign a transaction (Solana or Ethereum EIP712) with user's wallet
+     * @param params Sign parameters including network, address, and transaction
+     * @returns Signature string
+     */
+    signV2(params: {
+        network: Network;
+        address: string;
+        tx: {
+            Solana?: string;
+            EthereumEip712?: Record<string, unknown>;
+        };
+    }): Promise<string>;
+    /**
+     * Raw v3 sign API - Sign a Solana transaction with user's wallet
+     * Note: v3 sign API only supports Solana transactions
+     * @param params Sign parameters including network, address, and Solana transaction
+     * @returns Signature string
+     */
+    signV3(params: {
+        network: Network;
+        address: string;
+        tx: {
+            Solana: string;
+        };
+    }): Promise<string>;
+    /**
+     * Build a Lighter transaction using the server-side build transaction API
+     * @param request Lighter build transaction request (with optional wallet_address field)
+     * @param walletAddress Optional wallet address (will be added to request if provided)
+     * @returns Lighter build transaction response with transaction details
+     */
+    lighterBuildTransaction(request: LighterBuildTransactionRequest, walletAddress?: string): Promise<LighterBuildTransactionResponse>;
+    /**
+     * Generate a Lighter authentication token
+     * @param params Auth parameters including account_index and optional wallet_address and expires_in_ms
+     * @returns Lighter auth response with token and expiration
+     */
+    lighterAuth(params: {
+        lighter_account_index: number;
+        wallet_address?: string | null;
+        expires_in_ms?: number | null;
+    }): Promise<LighterAuthResponse>;
+    /**
+     * Rotate/change the Lighter L2 key for an account
+     * @param params Change key parameters including account_index and optional wallet_address
+     * @returns Lighter change key response with new public key
+     */
+    lighterChangeKey(params: {
+        lighter_account_index: number;
+        wallet_address?: string | null;
+    }): Promise<LighterChangeKeyResponse>;
+    /**
+     * Sign and build a Hyperliquid exchange transaction
+     * @param request Exchange request with action and optional parameters
+     * @returns Exchange response with signed payload
+     */
+    exchange(request: ExchangeRequest): Promise<ExchangeResponse>;
 }
 type SignTransactionReturnType<serializer extends viem.SerializeTransactionFn<viem.TransactionSerializable> = viem.SerializeTransactionFn<viem.TransactionSerializable>, transaction extends Parameters<serializer>[0] = Parameters<serializer>[0]> = viem.TransactionSerialized<viem.GetTransactionType<transaction>>;
 
@@ -784,5 +1129,5 @@ declare function useCoinbaseOnramp(): {
     getCoinbaseOnrampUrl: (amount: number, blockchain?: "solana" | "ethereum", redirectUrl?: string) => Promise<string>;
 };
 
-export { ACCESS_TOKEN_KEY, BACKUP_WALLET_INFO, BACKUP_WALLET_TYPE_KEY, Network, STORAGE_STATE_KEY, SWITCHED_ACCOUNT_ADDRESS, SocialType, Storage, VaultId, WALLET_TYPE_KEY, WalletClient, WalletProvider, WalletProviderBackup, WalletType, injectStyles, isVersionedTransaction, theme, useActiveWallet, useCoinbaseOnramp, useConnect, useLoginModal, useWallet, useWalletBackup, useWalletBackupStatus, useWalletStatus };
-export type { AccountInfo, ApiResponse, BuildTransactionRequest, BuildTransactionResponse, CoinbaseOnrampRequest, DeBridgeDlnCreateTxRequest, IModalManager, LoginModalProps, LoginType, MiddleAccount, MiddleAccountRequest, MultiAccountRequest, OrderState, SignMessageResponse, SignRequestV1, SignRequestV2, SignRequestV3, SignTransactionResponse, SignTransactionReturnType, Social, SocialInfo, SubAccountInfo, SupportedTransactionVersions, TransactionOrVersionedTransaction, TransferRequest, UnsignedTxV2, UnsignedTxV3, UserSession, Wallet, WalletInfo, WalletProviderConfig };
+export { ACCESS_TOKEN_KEY, BACKUP_WALLET_INFO, BACKUP_WALLET_TYPE_KEY, LighterGroupingType, LighterMarginMode, LighterOrderSide, LighterOrderType, LighterTimeInForce, Network, STORAGE_STATE_KEY, SWITCHED_ACCOUNT_ADDRESS, SocialType, Storage, VaultId, WALLET_TYPE_KEY, WalletClient, WalletProvider, WalletProviderBackup, WalletType, injectStyles, isVersionedTransaction, theme, useActiveWallet, useCoinbaseOnramp, useConnect, useLoginModal, useWallet, useWalletBackup, useWalletBackupStatus, useWalletStatus };
+export type { AccountInfo, ApiResponse, BuildTransactionRequest, BuildTransactionResponse, CloseFinishRequest, CloseFinishResponse, CloseInitRequest, CloseInitResponse, CoinbaseOnrampRequest, DeBridgeDlnCreateTxRequest, ExchangePayload, ExchangeRequest, ExchangeResponse, ExchangeSignature, ExportFinishRequest, ExportInitRequest, ExportInitResponse, ExportWallet, ExportWalletResponse, IModalManager, LighterAuthRequest, LighterAuthResponse, LighterBuildTransactionRequest, LighterBuildTransactionResponse, LighterCancelAllOrdersParams, LighterCancelOrderParams, LighterChangeKeyRequest, LighterChangeKeyResponse, LighterCreateSubAccountParams, LighterGeneralTransferParams, LighterGroupedOrderEntry, LighterGroupedOrdersParams, LighterLeverageParams, LighterOrderParams, LighterTxContext, LighterWithdrawParams, LoginModalProps, LoginType, MiddleAccount, MiddleAccountRequest, MultiAccountRequest, OrderState, SignMessageResponse, SignRequestV1, SignRequestV2, SignRequestV3, SignTransactionResponse, SignTransactionReturnType, Social, SocialInfo, SubAccountInfo, SupportedTransactionVersions, TransactionOrVersionedTransaction, TransferRequest, UnsignedTxV2, UnsignedTxV3, UserSession, Wallet, WalletInfo, WalletProviderConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "superstack-wallet-sdk",
-  "version": "0.5.8",
+  "version": "0.5.10",
   "description": "A wallet SDK for superstack",
   "type": "module",
   "main": "dist/index.cjs",