superstack-wallet-sdk 0.5.6 → 0.5.8

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import react__default, { ReactNode } from 'react';
 type SupportedTransactionVersions = ReadonlySet<TransactionVersion> | null | undefined;
 type TransactionOrVersionedTransaction<S extends SupportedTransactionVersions> = S extends null | undefined ? Transaction : Transaction | VersionedTransaction;
 declare function isVersionedTransaction(transaction: Transaction | VersionedTransaction): transaction is VersionedTransaction;
-type LoginType = "TwitterOAuth" | "GoogleOAuth" | "Phantom" | "Okx" | "Email" | "Phone" | "Telegram" | "TelegramOAuth" | "MetaMask" | "Rabby" | "Coinbase" | "WalletConnect";
+type LoginType = "Email" | "Phone" | "TwitterOAuth" | "GoogleOAuth" | "Telegram" | "TelegramOAuth" | "Apple" | "Phantom" | "Okx" | "MetaMask" | "Rabby" | "Coinbase" | "WalletConnect";
 declare enum Network {
     Solana = "Solana",
     Ethereum = "Ethereum"
@@ -17,12 +17,10 @@ declare enum WalletType {
     Embedded = "Embedded"
 }
 declare enum SocialType {
-    Email = "Email",
     Google = "Google",
     Twitter = "Twitter",
-    Phantom = "Phantom",
-    Phone = "Phone",
-    Okx = "Okx"
+    Telegram = "Telegram",
+    Apple = "Apple"
 }
 type Social = {
     [key in SocialType]: string;
@@ -43,36 +41,72 @@ interface Wallet {
     address: string;
     network: Network;
     wallet_type: WalletType;
-    wallet_set: "Main" | "Forward-0" | string;
+    wallet_set: "Main" | `Forward-${number}` | `Secondary-${number}` | `SecondaryForward-${number}-${number}`;
+    account_index: number;
+    is_enabled: boolean;
 }
 interface WalletInfo {
-    account_info: AccountInfo;
     id: string;
-    is_exported: boolean;
     wallets: Wallet[];
     social_links: Social[];
     social_infos: SocialInfo[];
+    account_info: AccountInfo;
+    created_at: number;
+    is_exported: boolean;
     access_token?: string;
 }
+interface SubAccountInfo {
+    account_index: number;
+    secondary_index: number;
+    name?: string;
+    created_at: number;
+    is_exported: boolean;
+    is_enabled: boolean;
+}
 interface AccountInfo {
     name: string | null;
+    sub_accounts: SubAccountInfo[];
 }
+type MultiAccountRequest = {
+    type: "Create";
+    data: {
+        name?: string | null;
+    };
+} | {
+    type: "Enable";
+    data: {
+        index: number;
+    };
+} | {
+    type: "Disable";
+    data: {
+        index: number;
+    };
+};
 interface SignRequestV1 {
+    user_id: string;
+    network: string;
     address: string;
-    userId: string;
     message: string;
-    network: string;
-    requestId: string;
 }
-interface UnsignedTx {
+interface UnsignedTxV2 {
     Solana?: string;
     EthereumEip712?: Record<string, unknown>;
 }
 interface SignRequestV2 {
+    user_id: string;
+    network: string;
     address: string;
+    tx: UnsignedTxV2;
+}
+interface UnsignedTxV3 {
+    Solana?: string;
+}
+interface SignRequestV3 {
     user_id: string;
     network: string;
-    tx: UnsignedTx;
+    address: string;
+    tx: UnsignedTxV3;
 }
 interface UserSession {
     id: string;
@@ -138,13 +172,13 @@ interface OrderState {
 }
 interface TransferRequest {
     user_id: string;
+    network: Network;
+    chain_id: number;
     from: string;
     to: string;
     amount: string;
     decimals: number;
     token?: string;
-    network: Network;
-    chain_id: number;
 }
 declare enum VaultId {
     HyperbeatUltraHype = "HyperbeatUltraHype",
@@ -236,138 +270,7 @@ type BuildTransactionRequest = {
 };
 interface BuildTransactionResponse {
     raw_transaction: string;
-}
-type BigDecimalString = string;
-declare enum BorrowedAsset {
-    HypercorePerpsUSDC = "HypercorePerpsUSDC"
-}
-declare enum CollateralAsset {
-    HypercoreSpotBTC = "HypercoreSpotBTC"
-}
-declare enum CrossMarginPositionStatus {
-    Open = "Open",
-    Closed = "Closed",
-    PartiallyLiquidated = "PartiallyLiquidated",
-    AllLiquidated = "AllLiquidated"
-}
-declare enum CrossMarginOperationType {
-    Borrow = "Borrow",
-    Repay = "Repay",
-    AddMargin = "AddMargin",
-    RemoveMargin = "RemoveMargin",
-    Liquidation = "Liquidation"
-}
-interface CollateralAssetInfo {
-    amount: BigDecimalString;
-    contribution?: number;
-    liquidation_price?: number;
-}
-interface CrossMarginBorrowQuoteRequest {
-    collateral_assets: Partial<Record<CollateralAsset, BigDecimalString>>;
-}
-interface CrossMarginBorrowQuoteResponse {
-    quote_id: string;
-    collateral_asset_infos: Record<CollateralAsset, CollateralAssetInfo>;
-    total_collateral_value: number;
-    borrowed_asset: BorrowedAsset;
-    max_borrowed_amount: BigDecimalString;
-    max_borrowed_value: number;
-    created_at: number;
-    expires_at: number;
-}
-interface CrossMarginBorrowRequest {
-    network: Network;
-    address: string;
-    quote_id: string;
-    collateral_assets: Partial<Record<CollateralAsset, BigDecimalString>>;
-    borrowed_asset: BorrowedAsset;
-    borrowed_amount: BigDecimalString;
-}
-interface CrossMarginBorrowResponse {
-    position_id: string;
-}
-interface CrossMarginRepayQuoteRequest {
-    position_id: string;
-}
-interface CrossMarginRepayQuoteResponse {
-    quote_id: string;
-    repay_asset: BorrowedAsset;
-    borrowed_amount: BigDecimalString;
-    interest_cost: BigDecimalString;
-    repay_amount: BigDecimalString;
-    created_at: number;
-    expires_at: number;
-}
-interface CrossMarginRepayRequest {
-    position_id: string;
-    quote_id: string;
-    repay_asset: BorrowedAsset;
-    repay_amount: BigDecimalString;
-}
-interface CrossMarginRepayResponse {
-    position_id: string;
-}
-interface CrossMarginAdjustMarginRequest {
-    position_id: string;
-    is_add_margin: boolean;
-    collateral_assets: Partial<Record<CollateralAsset, BigDecimalString>>;
-}
-interface CrossMarginAdjustMarginResponse {
-    position_id: string;
-}
-interface BorrowedAssetGeneralInfo {
-    interest_rate_hourly: number;
-    interest_rate_annual: number;
-    available_amount: number;
-    max_borrowable_amount: number;
-}
-interface CollateralAssetGeneralInfo {
-    liquidation_threshold: number;
-    h_vol: number;
-    price: number;
-}
-interface CrossMarginGeneralInfoResponse {
-    collateral_info: Record<CollateralAsset, CollateralAssetGeneralInfo>;
-    borrowed_info: Record<BorrowedAsset, BorrowedAssetGeneralInfo>;
-}
-interface UserOpenPositionInfo {
-    position_id: string;
-    collateral_assets: Record<CollateralAsset, CollateralAssetInfo>;
-    borrowed_asset: BorrowedAsset;
-    borrowed_amount: BigDecimalString;
-    created_at: number;
-    updated_at: number;
-    current_ltv: number;
-    margin_call_ltv: number;
-    liquidation_ltv: number;
-    interest_cost: number;
-}
-interface UserOpenPositionsResponse {
-    positions: UserOpenPositionInfo[];
-}
-interface UserClosedPositionInfo {
-    position_id: string;
-    collateral_assets: Record<CollateralAsset, CollateralAssetInfo>;
-    borrowed_asset: BorrowedAsset;
-    borrowed_amount: BigDecimalString;
-    created_at: number;
-    closed_at: number;
-    interest_cost: number;
-    status: CrossMarginPositionStatus;
-    repaid_amount?: number;
-}
-interface UserOperationInfo {
-    position_id: string;
-    operation_id: string;
-    created_at: number;
-    finished_at: number;
-    operation_type: CrossMarginOperationType;
-    amount: BigDecimalString;
-    symbol: string;
-}
-interface UserHistoryResponse {
-    positions: UserClosedPositionInfo[];
-    operations: UserOperationInfo[];
+    metadata?: any;
 }
 
 interface PhantomWalletAdapterConfig {
@@ -454,8 +357,44 @@ declare class WalletClient {
     get social_links(): Social[] | null;
     reconnect(isBackup?: boolean): Promise<WalletInfo | null>;
     connectPhantom(): Promise<WalletInfo | null>;
-    updateAccountName(name: string): Promise<any>;
+    updateAccountName(name: string, accountIndex?: number): Promise<WalletInfo>;
+    /**
+     * Create, enable, or disable a sub-account
+     * @param request Multi-account request with type and data
+     * @returns Updated wallet info
+     */
+    manageMultiAccount(request: MultiAccountRequest): Promise<WalletInfo>;
+    /**
+     * Create a new sub-account
+     * @param name Optional name for the sub-account
+     * @returns Updated wallet info
+     */
+    createSubAccount(name?: string | null): Promise<WalletInfo>;
+    /**
+     * Enable a sub-account by index
+     * @param index Account index to enable
+     * @returns Updated wallet info
+     */
+    enableSubAccount(index: number): Promise<WalletInfo>;
+    /**
+     * Disable a sub-account by index
+     * @param index Account index to disable
+     * @returns Updated wallet info
+     */
+    disableSubAccount(index: number): Promise<WalletInfo>;
+    /**
+     * This method is used to sign a solana transaction with v3 sign api,
+     * which is enabled in default.
+     * @param transaction Solana transaction to sign
+     * @returns signed transaction
+     */
     signSolanaTransaction(transaction: Transaction | VersionedTransaction): Promise<Transaction | VersionedTransaction>;
+    /**
+     * This method is used to sign a ethereum eip712 transaction with v2 sign api,
+     * which is disabled in default.
+     * @param params Ethereum eip712 transaction parameters
+     * @returns signature
+     */
     signEthereumEip712(params: {
         domain: {
             name: string;
@@ -530,6 +469,11 @@ declare class WalletClient {
     getSolanaBalance(): Promise<string>;
     getEthereumBalance(): Promise<string>;
     fetchCoinbaseToken(address: string, blockchain?: "solana" | "ethereum"): Promise<string>;
+    /**
+     * This method is used to sign a ethereum eip712 transaction with v2 sign api,
+     * which is disabled in default.
+     * @returns viem signer adapter
+     */
     viemSignerAdapter(): {
         signTypedData: (params: {
             domain: {
@@ -583,15 +527,7 @@ declare class WalletClient {
      * @param request Build transaction request
      * @returns Build transaction response with raw transaction
      */
-    buildTransaction(request: BuildTransactionRequest): Promise<BuildTransactionResponse>;
-    getCrossMarginGeneralInfo(): Promise<CrossMarginGeneralInfoResponse>;
-    getCrossMarginBorrowQuote(payload: CrossMarginBorrowQuoteRequest): Promise<CrossMarginBorrowQuoteResponse>;
-    borrowCrossMargin(payload: CrossMarginBorrowRequest): Promise<CrossMarginBorrowResponse>;
-    getCrossMarginRepayQuote(payload: CrossMarginRepayQuoteRequest): Promise<CrossMarginRepayQuoteResponse>;
-    repayCrossMargin(payload: CrossMarginRepayRequest): Promise<CrossMarginRepayResponse>;
-    adjustCrossMarginMargin(payload: CrossMarginAdjustMarginRequest): Promise<CrossMarginAdjustMarginResponse>;
-    getCrossMarginOpenPositions(): Promise<UserOpenPositionsResponse>;
-    getCrossMarginHistory(): Promise<UserHistoryResponse>;
+    buildTransaction(request: BuildTransactionRequest, walletAddress?: string): Promise<BuildTransactionResponse>;
 }
 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>>;
 
@@ -848,5 +784,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, BorrowedAsset, CollateralAsset, CrossMarginOperationType, CrossMarginPositionStatus, 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, BigDecimalString, BorrowedAssetGeneralInfo, BuildTransactionRequest, BuildTransactionResponse, CoinbaseOnrampRequest, CollateralAssetGeneralInfo, CollateralAssetInfo, CrossMarginAdjustMarginRequest, CrossMarginAdjustMarginResponse, CrossMarginBorrowQuoteRequest, CrossMarginBorrowQuoteResponse, CrossMarginBorrowRequest, CrossMarginBorrowResponse, CrossMarginGeneralInfoResponse, CrossMarginRepayQuoteRequest, CrossMarginRepayQuoteResponse, CrossMarginRepayRequest, CrossMarginRepayResponse, DeBridgeDlnCreateTxRequest, IModalManager, LoginModalProps, LoginType, MiddleAccount, MiddleAccountRequest, OrderState, SignMessageResponse, SignRequestV1, SignRequestV2, SignTransactionResponse, SignTransactionReturnType, Social, SocialInfo, SupportedTransactionVersions, TransactionOrVersionedTransaction, TransferRequest, UnsignedTx, UserClosedPositionInfo, UserHistoryResponse, UserOpenPositionInfo, UserOpenPositionsResponse, UserOperationInfo, UserSession, Wallet, WalletInfo, WalletProviderConfig };
+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 };

package/package.json

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