superstack-wallet-sdk 0.5.7 → 0.5.9

package/dist/esm/types/types.d.ts

@@ -3,7 +3,7 @@ import { WalletClient } from "./client";
 export type SupportedTransactionVersions = ReadonlySet<TransactionVersion> | null | undefined;
 export type TransactionOrVersionedTransaction<S extends SupportedTransactionVersions> = S extends null | undefined ? Transaction : Transaction | VersionedTransaction;
 export declare function isVersionedTransaction(transaction: Transaction | VersionedTransaction): transaction is VersionedTransaction;
-export type LoginType = "TwitterOAuth" | "GoogleOAuth" | "Phantom" | "Okx" | "Email" | "Phone" | "Telegram" | "TelegramOAuth" | "MetaMask" | "Rabby" | "Coinbase" | "WalletConnect";
+export type LoginType = "Email" | "Phone" | "TwitterOAuth" | "GoogleOAuth" | "Telegram" | "TelegramOAuth" | "Apple" | "Phantom" | "Okx" | "MetaMask" | "Rabby" | "Coinbase" | "WalletConnect";
 export declare enum Network {
     Solana = "Solana",
     Ethereum = "Ethereum"
@@ -13,12 +13,10 @@ export declare enum WalletType {
     Embedded = "Embedded"
 }
 export declare enum SocialType {
-    Email = "Email",
     Google = "Google",
     Twitter = "Twitter",
-    Phantom = "Phantom",
-    Phone = "Phone",
-    Okx = "Okx"
+    Telegram = "Telegram",
+    Apple = "Apple"
 }
 export type Social = {
     [key in SocialType]: string;
@@ -39,36 +37,72 @@ export 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;
 }
 export 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;
 }
+export interface SubAccountInfo {
+    account_index: number;
+    secondary_index: number;
+    name?: string;
+    created_at: number;
+    is_exported: boolean;
+    is_enabled: boolean;
+}
 export interface AccountInfo {
     name: string | null;
+    sub_accounts: SubAccountInfo[];
 }
+export type MultiAccountRequest = {
+    type: "Create";
+    data: {
+        name?: string | null;
+    };
+} | {
+    type: "Enable";
+    data: {
+        index: number;
+    };
+} | {
+    type: "Disable";
+    data: {
+        index: number;
+    };
+};
 export interface SignRequestV1 {
+    user_id: string;
+    network: string;
     address: string;
-    userId: string;
     message: string;
-    network: string;
-    requestId: string;
 }
-export interface UnsignedTx {
+export interface UnsignedTxV2 {
     Solana?: string;
     EthereumEip712?: Record<string, unknown>;
 }
 export interface SignRequestV2 {
+    user_id: string;
+    network: string;
     address: string;
+    tx: UnsignedTxV2;
+}
+export interface UnsignedTxV3 {
+    Solana?: string;
+}
+export interface SignRequestV3 {
     user_id: string;
     network: string;
-    tx: UnsignedTx;
+    address: string;
+    tx: UnsignedTxV3;
 }
 export interface UserSession {
     id: string;
@@ -134,13 +168,13 @@ export interface OrderState {
 }
 export 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;
 }
 export declare enum VaultId {
     HyperbeatUltraHype = "HyperbeatUltraHype",
@@ -185,6 +219,8 @@ export interface DeBridgeDlnCreateTxRequest {
     srcChainPriorityLevel?: string | null;
 }
 export type BuildTransactionRequest = {
+    wallet_address?: string | null;
+} & ({
     type: "HyperbeatVaultApprove";
     data: {
         vault_id: VaultId;
@@ -229,140 +265,245 @@ export type BuildTransactionRequest = {
     data: {
         request: DeBridgeDlnCreateTxRequest;
     };
-};
+});
 export interface BuildTransactionResponse {
     raw_transaction: string;
     metadata?: any;
 }
-export type BigDecimalString = string;
-export declare enum BorrowedAsset {
-    HypercorePerpsUSDC = "HypercorePerpsUSDC"
-}
-export declare enum CollateralAsset {
-    HypercoreSpotBTC = "HypercoreSpotBTC"
-}
-export declare enum CrossMarginPositionStatus {
-    Open = "Open",
-    Closed = "Closed",
-    PartiallyLiquidated = "PartiallyLiquidated",
-    AllLiquidated = "AllLiquidated"
-}
-export declare enum CrossMarginOperationType {
-    Borrow = "Borrow",
-    Repay = "Repay",
-    AddMargin = "AddMargin",
-    RemoveMargin = "RemoveMargin",
-    Liquidation = "Liquidation"
-}
-export interface CollateralAssetInfo {
-    amount: BigDecimalString;
-    contribution?: number;
-    liquidation_price?: number;
-}
-export interface CrossMarginBorrowQuoteRequest {
-    collateral_assets: Partial<Record<CollateralAsset, BigDecimalString>>;
-}
-export 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;
+export declare enum LighterOrderSide {
+    Buy = "buy",
+    Sell = "sell"
+}
+export 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"
+}
+export declare enum LighterTimeInForce {
+    ImmediateOrCancel = "immediate_or_cancel",
+    GoodTillTime = "good_till_time",
+    PostOnly = "post_only"
+}
+export declare enum LighterMarginMode {
+    Cross = "cross",
+    Isolated = "isolated"
+}
+export declare enum LighterGroupingType {
+    Default = "default",
+    OneTriggersTheOther = "one_triggers_the_other",
+    OneCancelsTheOther = "one_cancels_the_other",
+    OneTriggersAOneCancelsTheOther = "one_triggers_a_one_cancels_the_other"
+}
+export interface LighterTxContext {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+}
+export 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;
+}
+export 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;
+}
+export interface LighterWithdrawParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    usdc_amount: number;
+}
+export interface LighterCreateSubAccountParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+}
+export 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;
+}
+export interface LighterGroupedOrdersParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    grouping_type: LighterGroupingType;
+    orders: LighterGroupedOrderEntry[];
+}
+export 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;
+}
+export interface LighterCancelOrderParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    market_index: number;
+    index: number;
+}
+export interface LighterCancelAllOrdersParams {
+    account_index: number;
+    from_account_index: number;
+    api_key_index: number;
+    expired_at: number;
+    nonce: number;
+    time_in_force: LighterTimeInForce;
+    time: number;
+}
+export 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;
+});
+export interface LighterBuildTransactionResponse {
+    tx_type: number;
+    tx_info: string;
+    tx_hash?: string | null;
+    hash: string;
+}
+export interface LighterAuthRequest {
+    wallet_address?: string | null;
+    expires_in_ms?: number | null;
+    account_index: number;
+}
+export interface LighterAuthResponse {
+    auth: string;
     expires_at: number;
 }
-export interface CrossMarginBorrowRequest {
+export interface LighterChangeKeyRequest {
+    wallet_address?: string | null;
+    account_index: number;
+}
+export interface LighterChangeKeyResponse {
+    account_index: number;
+    public_key: string;
+}
+export interface ExchangeSignature {
+    r: string;
+    s: string;
+    v: number;
+}
+export interface ExchangePayload {
+    action: any;
+    nonce: number;
+    signature: ExchangeSignature;
+    vaultAddress?: string | null;
+    expiresAfter?: number | null;
+}
+export interface ExchangeResponse {
+    payload: ExchangePayload;
+}
+export interface ExchangeRequest {
+    action: any;
+    vaultAddress?: string | null;
+    expiresAfter?: number | null;
+    isMainnet?: boolean | null;
+    walletAddress?: string | null;
+}
+export interface ExportInitRequest {
+    user_nonce: string;
+    account_index?: number;
+}
+export interface ExportInitResponse {
+    server_nonce: string;
+}
+export interface ExportFinishRequest {
+    user_nonce?: string;
+    server_nonce?: string;
+    account_index?: number;
+    is_export: boolean;
+}
+export interface ExportWallet {
     network: Network;
+    wallet_set: string;
     address: string;
-    quote_id: string;
-    collateral_assets: Partial<Record<CollateralAsset, BigDecimalString>>;
-    borrowed_asset: BorrowedAsset;
-    borrowed_amount: BigDecimalString;
-}
-export interface CrossMarginBorrowResponse {
-    position_id: string;
-}
-export interface CrossMarginRepayQuoteRequest {
-    position_id: string;
-}
-export interface CrossMarginRepayQuoteResponse {
-    quote_id: string;
-    repay_asset: BorrowedAsset;
-    borrowed_amount: BigDecimalString;
-    interest_cost: BigDecimalString;
-    repay_amount: BigDecimalString;
-    created_at: number;
-    expires_at: number;
+    private_key: string;
 }
-export interface CrossMarginRepayRequest {
-    position_id: string;
-    quote_id: string;
-    repay_asset: BorrowedAsset;
-    repay_amount: BigDecimalString;
-}
-export interface CrossMarginRepayResponse {
-    position_id: string;
-}
-export interface CrossMarginAdjustMarginRequest {
-    position_id: string;
-    is_add_margin: boolean;
-    collateral_assets: Partial<Record<CollateralAsset, BigDecimalString>>;
-}
-export interface CrossMarginAdjustMarginResponse {
-    position_id: string;
-}
-export interface BorrowedAssetGeneralInfo {
-    interest_rate_hourly: number;
-    interest_rate_annual: number;
-    available_amount: number;
-    max_borrowable_amount: number;
-}
-export interface CollateralAssetGeneralInfo {
-    liquidation_threshold: number;
-    h_vol: number;
-    price: number;
-}
-export interface CrossMarginGeneralInfoResponse {
-    collateral_info: Record<CollateralAsset, CollateralAssetGeneralInfo>;
-    borrowed_info: Record<BorrowedAsset, BorrowedAssetGeneralInfo>;
-}
-export 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;
-}
-export interface UserOpenPositionsResponse {
-    positions: UserOpenPositionInfo[];
-}
-export 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;
-}
-export interface UserOperationInfo {
-    position_id: string;
-    operation_id: string;
-    created_at: number;
-    finished_at: number;
-    operation_type: CrossMarginOperationType;
-    amount: BigDecimalString;
-    symbol: string;
-}
-export interface UserHistoryResponse {
-    positions: UserClosedPositionInfo[];
-    operations: UserOperationInfo[];
+export interface ExportWalletResponse {
+    user_id: string;
+    wallets: ExportWallet[];
+}
+export interface CloseInitRequest {
+    user_nonce: string;
+}
+export interface CloseInitResponse {
+    server_nonce: string;
+}
+export interface CloseFinishRequest {
+    user_nonce: string;
+    server_nonce: string;
+}
+export interface CloseFinishResponse {
+    user_id: string;
+    is_closed: boolean;
 }