@nktkas/hyperliquid 0.24.2 → 0.25.0-beta.1

package/script/src/schemas/info/accounts.js

@@ -0,0 +1,658 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserNonFundingLedgerUpdate = exports.WithdrawUpdate = exports.VaultWithdrawUpdate = exports.VaultDistributionUpdate = exports.VaultDepositUpdate = exports.VaultCreateUpdate = exports.SubAccountTransferUpdate = exports.SpotTransferUpdate = exports.RewardsClaimUpdate = exports.LiquidationUpdate = exports.InternalTransferUpdate = exports.DepositUpdate = exports.AccountClassTransferUpdate = exports.UserRole = exports.UserRateLimit = exports.UserFundingUpdate = exports.FundingUpdate = exports.UserFees = exports.SubAccount = exports.SpotClearinghouseState = exports.SpotBalance = exports.Referral = exports.PreTransferCheck = exports.PortfolioPeriods = exports.Portfolio = exports.PerpsClearinghouseState = exports.MultiSigSigners = exports.LegalCheck = exports.ExtraAgent = exports.EvmEscrowsBalance = exports.AssetPosition = exports.ActiveAssetData = void 0;
+const v = __importStar(require("valibot"));
+const _base_js_1 = require("../_base.js");
+/** User active asset data. */
+exports.ActiveAssetData = v.pipe(v.strictObject({
+    /** User address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("User address.")),
+    /** Asset symbol (e.g., BTC). */
+    coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
+    /** Leverage configuration. */
+    leverage: v.pipe(v.union([
+        v.strictObject({
+            /** Leverage type. */
+            type: v.pipe(v.literal("isolated"), v.description("Leverage type.")),
+            /** Leverage value used. */
+            value: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.minValue(1), v.description("Leverage value used.")),
+            /** Amount of USD used (1 = 1$). */
+            rawUsd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount of USD used (1 = 1$).")),
+        }),
+        v.strictObject({
+            /** Leverage type. */
+            type: v.pipe(v.literal("cross"), v.description("Leverage type.")),
+            /** Leverage value used. */
+            value: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.minValue(1), v.description("Leverage value used.")),
+        }),
+    ]), v.description("Leverage configuration.")),
+    /** Maximum trade size range [min, max]. */
+    maxTradeSzs: v.pipe(v.strictTuple([_base_js_1.UnsignedDecimal, _base_js_1.UnsignedDecimal]), v.description("Maximum trade size range [min, max].")),
+    /** Available to trade range [min, max]. */
+    availableToTrade: v.pipe(v.strictTuple([_base_js_1.UnsignedDecimal, _base_js_1.UnsignedDecimal]), v.description("Available to trade range [min, max].")),
+    /** Mark price. */
+    markPx: v.pipe(_base_js_1.UnsignedDecimal, v.description("Mark price.")),
+}), v.description("User active asset data."));
+/** Position for a specific asset. */
+exports.AssetPosition = v.pipe(v.strictObject({
+    /** Position type. */
+    type: v.pipe(v.literal("oneWay"), v.description("Position type.")),
+    /** Position details. */
+    position: v.pipe(v.strictObject({
+        /** Asset symbol. */
+        coin: v.pipe(v.string(), v.description("Asset symbol.")),
+        /** Signed position size. */
+        szi: v.pipe(_base_js_1.SignedDecimal, v.description("Signed position size.")),
+        /** Leverage details. */
+        leverage: v.pipe(v.union([
+            v.strictObject({
+                /** Leverage type. */
+                type: v.pipe(v.literal("isolated"), v.description("Leverage type.")),
+                /** Leverage value used. */
+                value: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.minValue(1), v.description("Leverage value used.")),
+                /** Amount of USD used (1 = 1$). */
+                rawUsd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount of USD used (1 = 1$).")),
+            }),
+            v.strictObject({
+                /** Leverage type. */
+                type: v.pipe(v.literal("cross"), v.description("Leverage type.")),
+                /** Leverage value used. */
+                value: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.minValue(1), v.description("Leverage value used.")),
+            }),
+        ]), v.description("Leverage details.")),
+        /** Average entry price. */
+        entryPx: v.pipe(_base_js_1.UnsignedDecimal, v.description("Average entry price.")),
+        /** Position value. */
+        positionValue: v.pipe(_base_js_1.UnsignedDecimal, v.description("Position value.")),
+        /** Unrealized profit and loss. */
+        unrealizedPnl: v.pipe(_base_js_1.SignedDecimal, v.description("Unrealized profit and loss.")),
+        /** Return on equity. */
+        returnOnEquity: v.pipe(_base_js_1.SignedDecimal, v.description("Return on equity.")),
+        /** Liquidation price. */
+        liquidationPx: v.pipe(v.union([_base_js_1.UnsignedDecimal, v.null()]), v.description("Liquidation price.")),
+        /** Margin used. */
+        marginUsed: v.pipe(_base_js_1.UnsignedDecimal, v.description("Margin used.")),
+        /** Maximum allowed leverage. */
+        maxLeverage: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.minValue(1), v.description("Maximum allowed leverage.")),
+        /** Cumulative funding details. */
+        cumFunding: v.pipe(v.strictObject({
+            /** Total funding paid or received since account opening. */
+            allTime: v.pipe(_base_js_1.SignedDecimal, v.description("Total funding paid or received since account opening.")),
+            /** Funding accumulated since the position was opened. */
+            sinceOpen: v.pipe(_base_js_1.SignedDecimal, v.description("Funding accumulated since the position was opened.")),
+            /** Funding accumulated since the last change in position size. */
+            sinceChange: v.pipe(_base_js_1.SignedDecimal, v.description("Funding accumulated since the last change in position size.")),
+        }), v.description("Cumulative funding details.")),
+    }), v.description("Position details.")),
+}), v.description("Position for a specific asset."));
+/** Escrowed balance for a specific asset. */
+exports.EvmEscrowsBalance = v.pipe(v.strictObject({
+    /** Asset symbol. */
+    coin: v.pipe(v.string(), v.description("Asset symbol.")),
+    /** Unique identifier for the token. */
+    token: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Unique identifier for the token.")),
+    /** Total balance. */
+    total: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total balance.")),
+}), v.description("Escrowed balance for a specific asset."));
+/** Extra agent details for a user. */
+exports.ExtraAgent = v.pipe(v.strictObject({
+    /** Extra agent address. */
+    address: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Extra agent address.")),
+    /** Extra agent name. */
+    name: v.pipe(v.string(), v.minLength(1), v.description("Extra agent name.")),
+    /** Validity period as a timestamp (in ms since epoch). */
+    validUntil: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Validity period as a timestamp (in ms since epoch).")),
+}), v.description("Extra agent details for a user."));
+/** Legal verification status for a user. */
+exports.LegalCheck = v.pipe(v.strictObject({
+    /** Whether the user IP address is allowed. */
+    ipAllowed: v.pipe(v.boolean(), v.description("Whether the user IP address is allowed.")),
+    /** Whether the user has accepted the terms of service. */
+    acceptedTerms: v.pipe(v.boolean(), v.description("Whether the user has accepted the terms of service.")),
+    /** Whether the user is allowed to use the platform. */
+    userAllowed: v.pipe(v.boolean(), v.description("Whether the user is allowed to use the platform.")),
+}), v.description("Legal verification status for a user."));
+/** Multi-sig signers for a user. */
+exports.MultiSigSigners = v.pipe(v.strictObject({
+    /** Authorized users addresses. */
+    authorizedUsers: v.pipe(v.array(v.pipe(_base_js_1.Hex, v.length(42))), v.minLength(1), v.description("Authorized users addresses.")),
+    /** Threshold number of signatures required. */
+    threshold: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.minValue(1), v.description("Threshold number of signatures required.")),
+}), v.description("Multi-sig signers for a user."));
+/** Account summary for perpetual trading. */
+exports.PerpsClearinghouseState = v.pipe(v.strictObject({
+    /** Margin summary details. */
+    marginSummary: v.pipe(v.strictObject({
+        /** Total account value. */
+        accountValue: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total account value.")),
+        /** Total notional position value. */
+        totalNtlPos: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total notional position value.")),
+        /** Total raw USD value. */
+        totalRawUsd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total raw USD value.")),
+        /** Total margin used. */
+        totalMarginUsed: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total margin used.")),
+    }), v.description("Margin summary details.")),
+    /** Cross-margin summary details. */
+    crossMarginSummary: v.pipe(v.strictObject({
+        /** Total account value. */
+        accountValue: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total account value.")),
+        /** Total notional position value. */
+        totalNtlPos: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total notional position value.")),
+        /** Total raw USD value. */
+        totalRawUsd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total raw USD value.")),
+        /** Total margin used. */
+        totalMarginUsed: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total margin used.")),
+    }), v.description("Cross-margin summary details.")),
+    /** Maintenance margin used for cross-margin positions. */
+    crossMaintenanceMarginUsed: v.pipe(_base_js_1.UnsignedDecimal, v.description("Maintenance margin used for cross-margin positions.")),
+    /** Amount available for withdrawal. */
+    withdrawable: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount available for withdrawal.")),
+    /** List of asset positions. */
+    assetPositions: v.pipe(v.array(exports.AssetPosition), v.description("List of asset positions.")),
+    /** Timestamp when data was retrieved (in ms since epoch). */
+    time: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Timestamp when data was retrieved (in ms since epoch).")),
+}), v.description("Account summary for perpetual trading."));
+/** Portfolio metrics snapshot. */
+exports.Portfolio = v.pipe(v.strictObject({
+    /** History entries for account value as [timestamp, value]. */
+    accountValueHistory: v.pipe(v.array(v.strictTuple([v.pipe(v.number(), v.safeInteger(), v.minValue(0)), _base_js_1.UnsignedDecimal])), v.description("History entries for account value as [timestamp, value].")),
+    /** History entries for profit and loss as [timestamp, value]. */
+    pnlHistory: v.pipe(v.array(v.strictTuple([v.pipe(v.number(), v.safeInteger(), v.minValue(0)), _base_js_1.SignedDecimal])), v.description("History entries for profit and loss as [timestamp, value].")),
+    /** Volume metric for the portfolio. */
+    vlm: v.pipe(_base_js_1.UnsignedDecimal, v.description("Volume metric for the portfolio.")),
+}), v.description("Portfolio metrics snapshot."));
+/** Portfolio metrics grouped by time periods. */
+exports.PortfolioPeriods = v.pipe(v.strictTuple([
+    v.strictTuple([v.literal("day"), exports.Portfolio]),
+    v.strictTuple([v.literal("week"), exports.Portfolio]),
+    v.strictTuple([v.literal("month"), exports.Portfolio]),
+    v.strictTuple([v.literal("allTime"), exports.Portfolio]),
+    v.strictTuple([v.literal("perpDay"), exports.Portfolio]),
+    v.strictTuple([v.literal("perpWeek"), exports.Portfolio]),
+    v.strictTuple([v.literal("perpMonth"), exports.Portfolio]),
+    v.strictTuple([v.literal("perpAllTime"), exports.Portfolio]),
+]), v.description("Portfolio metrics grouped by time periods."));
+/** Pre-transfer user existence check result. */
+exports.PreTransferCheck = v.pipe(v.strictObject({
+    /** Activation fee. */
+    fee: v.pipe(_base_js_1.UnsignedDecimal, v.description("Activation fee.")),
+    /** Whether the user is sanctioned. */
+    isSanctioned: v.pipe(v.boolean(), v.description("Whether the user is sanctioned.")),
+    /** Whether the user exists. */
+    userExists: v.pipe(v.boolean(), v.description("Whether the user exists.")),
+    /** Whether the user has sent a transaction. */
+    userHasSentTx: v.pipe(v.boolean(), v.description("Whether the user has sent a transaction.")),
+}), v.description("Pre-transfer user existence check result."));
+/** Referral details for a user. */
+exports.Referral = v.pipe(v.strictObject({
+    /** Referrer details. */
+    referredBy: v.pipe(v.union([
+        v.strictObject({
+            /** Referrer address. */
+            referrer: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Referrer address.")),
+            /** Referral code used. */
+            code: v.pipe(v.string(), v.minLength(1), v.description("Referral code used.")),
+        }),
+        v.null(),
+    ]), v.description("Referrer details.")),
+    /** Cumulative traded volume. */
+    cumVlm: v.pipe(_base_js_1.UnsignedDecimal, v.description("Cumulative traded volume.")),
+    /** Rewards earned but not yet claimed. */
+    unclaimedRewards: v.pipe(_base_js_1.UnsignedDecimal, v.description("Rewards earned but not yet claimed.")),
+    /** Rewards that have been claimed. */
+    claimedRewards: v.pipe(_base_js_1.UnsignedDecimal, v.description("Rewards that have been claimed.")),
+    /** Builder reward amount. */
+    builderRewards: v.pipe(_base_js_1.UnsignedDecimal, v.description("Builder reward amount.")),
+    /** Current state of the referrer. */
+    referrerState: v.pipe(v.union([
+        v.strictObject({
+            /** Referrer is ready to receive rewards. */
+            stage: v.pipe(v.literal("ready"), v.description("Referrer is ready to receive rewards.")),
+            /** Referral program details. */
+            data: v.pipe(v.strictObject({
+                /** Assigned referral code. */
+                code: v.pipe(v.string(), v.minLength(1), v.description("Assigned referral code.")),
+                /** Total number of referrals. */
+                nReferrals: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Total number of referrals.")),
+                /** Summary of each referral state. */
+                referralStates: v.pipe(v.array(v.strictObject({
+                    /** Cumulative traded volume. */
+                    cumVlm: v.pipe(_base_js_1.UnsignedDecimal, v.description("Cumulative traded volume.")),
+                    /** Total fees rewarded to the referred user since referral. */
+                    cumRewardedFeesSinceReferred: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total fees rewarded to the referred user since referral.")),
+                    /** Total fees rewarded to the referrer from referred trades. */
+                    cumFeesRewardedToReferrer: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total fees rewarded to the referrer from referred trades.")),
+                    /** Timestamp when the referred user joined (in ms since epoch). */
+                    timeJoined: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Timestamp when the referred user joined (in ms since epoch).")),
+                    /** Address of the referred user. */
+                    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Address of the referred user.")),
+                    /** Mapping of token IDs to referral reward states. */
+                    tokenToState: v.pipe(v.array(v.strictTuple([
+                        v.pipe(v.number(), v.safeInteger(), v.minValue(0)),
+                        v.strictObject({
+                            /** Cumulative traded volume. */
+                            cumVlm: v.pipe(_base_js_1.UnsignedDecimal, v.description("Cumulative traded volume.")),
+                            /** Total fees rewarded to the referred user since referral. */
+                            cumRewardedFeesSinceReferred: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total fees rewarded to the referred user since referral.")),
+                            /** Total fees rewarded to the referrer from referred trades. */
+                            cumFeesRewardedToReferrer: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total fees rewarded to the referrer from referred trades.")),
+                        }),
+                    ])), v.description("Mapping of token IDs to referral reward states.")),
+                })), v.description("Summary of each referral state.")),
+            }), v.description("Referral program details.")),
+        }),
+        v.strictObject({
+            /** Referrer needs to create a referral code. */
+            stage: v.pipe(v.literal("needToCreateCode"), v.description("Referrer needs to create a referral code.")),
+        }),
+        v.strictObject({
+            /** Referrer must complete a trade before earning rewards. */
+            stage: v.pipe(v.literal("needToTrade"), v.description("Referrer must complete a trade before earning rewards.")),
+            /** Required trading volume details for activation. */
+            data: v.pipe(v.strictObject({
+                /** Required trading volume. */
+                required: v.pipe(_base_js_1.UnsignedDecimal, v.description("Required trading volume.")),
+            }), v.description("Required trading volume details for activation.")),
+        }),
+    ]), v.description("Current state of the referrer.")),
+    /** History of referral rewards. */
+    rewardHistory: v.pipe(v.array(v.strictObject({
+        /** Amount of earned rewards. */
+        earned: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount of earned rewards.")),
+        /** Traded volume at the time of reward. */
+        vlm: v.pipe(_base_js_1.UnsignedDecimal, v.description("Traded volume at the time of reward.")),
+        /** Traded volume via referrals. */
+        referralVlm: v.pipe(_base_js_1.UnsignedDecimal, v.description("Traded volume via referrals.")),
+        /** Timestamp when the reward was earned (in ms since epoch). */
+        time: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Timestamp when the reward was earned (in ms since epoch).")),
+    })), v.description("History of referral rewards.")),
+    /** Mapping of token IDs to referral reward states. */
+    tokenToState: v.pipe(v.array(v.strictTuple([
+        v.pipe(v.number(), v.safeInteger(), v.minValue(0)),
+        v.strictObject({
+            /** Cumulative traded volume. */
+            cumVlm: v.pipe(_base_js_1.UnsignedDecimal, v.description("Cumulative traded volume.")),
+            /** Rewards earned but not yet claimed. */
+            unclaimedRewards: v.pipe(_base_js_1.UnsignedDecimal, v.description("Rewards earned but not yet claimed.")),
+            /** Rewards that have been claimed. */
+            claimedRewards: v.pipe(_base_js_1.UnsignedDecimal, v.description("Rewards that have been claimed.")),
+            /** Builder reward amount. */
+            builderRewards: v.pipe(_base_js_1.UnsignedDecimal, v.description("Builder reward amount.")),
+        }),
+    ])), v.description("Mapping of token IDs to referral reward states.")),
+}), v.description("Referral details for a user."));
+/** Balance for a specific spot token. */
+exports.SpotBalance = v.pipe(v.strictObject({
+    /** Asset symbol. */
+    coin: v.pipe(v.string(), v.description("Asset symbol.")),
+    /** Unique identifier for the token. */
+    token: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Unique identifier for the token.")),
+    /** Total balance. */
+    total: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total balance.")),
+    /** Amount on hold. */
+    hold: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount on hold.")),
+    /** Entry notional value. */
+    entryNtl: v.pipe(_base_js_1.UnsignedDecimal, v.description("Entry notional value.")),
+}), v.description("Balance for a specific spot token."));
+/** Account summary for spot trading. */
+exports.SpotClearinghouseState = v.pipe(v.strictObject({
+    /** Balance for each token. */
+    balances: v.pipe(v.array(exports.SpotBalance), v.description("Balance for each token.")),
+    /** Escrowed balances. */
+    evmEscrows: v.pipe(v.optional(v.array(exports.EvmEscrowsBalance)), v.description("Escrowed balances.")),
+}), v.description("Account summary for spot trading."));
+/** Sub-account details for a user. */
+exports.SubAccount = v.pipe(v.strictObject({
+    /** Sub-account name. */
+    name: v.pipe(v.string(), v.minLength(1), v.description("Sub-account name.")),
+    /** Sub-account address. */
+    subAccountUser: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Sub-account address.")),
+    /** Master account address. */
+    master: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Master account address.")),
+    /** Perpetual trading clearinghouse state summary. */
+    clearinghouseState: v.pipe(exports.PerpsClearinghouseState, v.description("Perpetual trading clearinghouse state summary.")),
+    /** Spot tokens clearinghouse state. */
+    spotState: v.pipe(exports.SpotClearinghouseState, v.description("Spot tokens clearinghouse state.")),
+}), v.description("Sub-account details for a user."));
+/** User fees. */
+exports.UserFees = v.pipe(v.strictObject({
+    /** Daily user volume metrics. */
+    dailyUserVlm: v.pipe(v.array(v.strictObject({
+        /** Date in YYYY-M-D format. */
+        date: v.pipe(v.string(), v.isoDate(), v.description("Date in YYYY-M-D format.")),
+        /** User cross-trade volume. */
+        userCross: v.pipe(_base_js_1.UnsignedDecimal, v.description("User cross-trade volume.")),
+        /** User add-liquidity volume. */
+        userAdd: v.pipe(_base_js_1.UnsignedDecimal, v.description("User add-liquidity volume.")),
+        /** Exchange total volume. */
+        exchange: v.pipe(_base_js_1.UnsignedDecimal, v.description("Exchange total volume.")),
+    })), v.description("Daily user volume metrics.")),
+    /** Fee schedule information. */
+    feeSchedule: v.pipe(v.strictObject({
+        /** Cross-trade fee rate. */
+        cross: v.pipe(_base_js_1.UnsignedDecimal, v.description("Cross-trade fee rate.")),
+        /** Add-liquidity fee rate. */
+        add: v.pipe(_base_js_1.UnsignedDecimal, v.description("Add-liquidity fee rate.")),
+        /** Spot cross-trade fee rate. */
+        spotCross: v.pipe(_base_js_1.UnsignedDecimal, v.description("Spot cross-trade fee rate.")),
+        /** Spot add-liquidity fee rate. */
+        spotAdd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Spot add-liquidity fee rate.")),
+        /** Fee tiers details. */
+        tiers: v.pipe(v.strictObject({
+            /** VIP fee tier information. */
+            vip: v.pipe(v.array(v.strictObject({
+                /** Notional volume cutoff. */
+                ntlCutoff: v.pipe(_base_js_1.UnsignedDecimal, v.description("Notional volume cutoff.")),
+                /** Cross-trade fee rate. */
+                cross: v.pipe(_base_js_1.UnsignedDecimal, v.description("Cross-trade fee rate.")),
+                /** Add-liquidity fee rate. */
+                add: v.pipe(_base_js_1.UnsignedDecimal, v.description("Add-liquidity fee rate.")),
+                /** Spot cross-trade fee rate. */
+                spotCross: v.pipe(_base_js_1.UnsignedDecimal, v.description("Spot cross-trade fee rate.")),
+                /** Spot add-liquidity fee rate. */
+                spotAdd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Spot add-liquidity fee rate.")),
+            })), v.description("VIP fee tier information.")),
+            /** Market maker fee tier information. */
+            mm: v.pipe(v.array(v.strictObject({
+                /** Maker fraction cutoff. */
+                makerFractionCutoff: v.pipe(_base_js_1.UnsignedDecimal, v.description("Maker fraction cutoff.")),
+                /** Add-liquidity fee rate. */
+                add: v.pipe(_base_js_1.SignedDecimal, v.description("Add-liquidity fee rate.")),
+            })), v.description("Market maker fee tier information.")),
+        }), v.description("Fee tiers details.")),
+        /** Referral discount rate. */
+        referralDiscount: v.pipe(_base_js_1.UnsignedDecimal, v.description("Referral discount rate.")),
+        /** Staking discount tiers details. */
+        stakingDiscountTiers: v.pipe(v.array(v.strictObject({
+            /** Basis points of maximum supply. */
+            bpsOfMaxSupply: v.pipe(_base_js_1.UnsignedDecimal, v.description("Basis points of maximum supply.")),
+            /** Discount rate applied. */
+            discount: v.pipe(_base_js_1.UnsignedDecimal, v.description("Discount rate applied.")),
+        })), v.description("Staking discount tiers details.")),
+    }), v.description("Fee schedule information.")),
+    /** User cross-trade rate. */
+    userCrossRate: v.pipe(_base_js_1.UnsignedDecimal, v.description("User cross-trade rate.")),
+    /** User add-liquidity rate. */
+    userAddRate: v.pipe(_base_js_1.UnsignedDecimal, v.description("User add-liquidity rate.")),
+    /** User spot cross-trade rate. */
+    userSpotCrossRate: v.pipe(_base_js_1.UnsignedDecimal, v.description("User spot cross-trade rate.")),
+    /** User spot add-liquidity rate. */
+    userSpotAddRate: v.pipe(_base_js_1.UnsignedDecimal, v.description("User spot add-liquidity rate.")),
+    /** Active referral discount rate. */
+    activeReferralDiscount: v.pipe(_base_js_1.UnsignedDecimal, v.description("Active referral discount rate.")),
+    /** Trial details. */
+    trial: v.pipe(v.union([v.unknown(), v.null()]), v.description("Trial details.")),
+    /** Fee trial reward amount. */
+    feeTrialReward: v.pipe(_base_js_1.UnsignedDecimal, v.description("Fee trial reward amount.")),
+    /** Timestamp when next trial becomes available. */
+    nextTrialAvailableTimestamp: v.pipe(v.union([v.unknown(), v.null()]), v.description("Timestamp when next trial becomes available.")),
+    stakingLink: v.union([v.unknown(), v.null()]),
+    /** Active staking discount details. */
+    activeStakingDiscount: v.pipe(v.strictObject({
+        /** Basis points of maximum supply. */
+        bpsOfMaxSupply: v.pipe(_base_js_1.UnsignedDecimal, v.description("Basis points of maximum supply.")),
+        /** Discount rate applied. */
+        discount: v.pipe(_base_js_1.UnsignedDecimal, v.description("Discount rate applied.")),
+    }), v.description("Active staking discount details.")),
+}), v.description("User fees."));
+/** Funding update details. */
+exports.FundingUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("funding"), v.description("Update type.")),
+    /** Asset symbol. */
+    coin: v.pipe(v.string(), v.description("Asset symbol.")),
+    /** Amount transferred in USDC. */
+    usdc: v.pipe(_base_js_1.SignedDecimal, v.description("Amount transferred in USDC.")),
+    /** Signed position size. */
+    szi: v.pipe(_base_js_1.SignedDecimal, v.description("Signed position size.")),
+    /** Applied funding rate. */
+    fundingRate: v.pipe(_base_js_1.SignedDecimal, v.description("Applied funding rate.")),
+    /** Number of samples. */
+    nSamples: v.pipe(v.union([v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.null()]), v.description("Number of samples.")),
+}), v.description("Funding update details."));
+/** Funding ledger update for a user. */
+exports.UserFundingUpdate = v.pipe(v.strictObject({
+    /** Timestamp of the update (in ms since epoch). */
+    time: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Timestamp of the update (in ms since epoch).")),
+    /** L1 transaction hash. */
+    hash: v.pipe(v.pipe(_base_js_1.Hex, v.length(66)), v.description("L1 transaction hash.")),
+    /** Update details. */
+    delta: v.pipe(exports.FundingUpdate, v.description("Update details.")),
+}), v.description("Funding ledger update for a user."));
+/** User rate limits. */
+exports.UserRateLimit = v.pipe(v.strictObject({
+    /** Cumulative trading volume. */
+    cumVlm: v.pipe(_base_js_1.UnsignedDecimal, v.description("Cumulative trading volume.")),
+    /** Number of API requests used. */
+    nRequestsUsed: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Number of API requests used.")),
+    /** Maximum allowed API requests. */
+    nRequestsCap: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Maximum allowed API requests.")),
+}), v.description("User rate limits."));
+/** User role. */
+exports.UserRole = v.pipe(v.union([
+    v.strictObject({
+        /** Role identifier. */
+        role: v.pipe(v.union([v.literal("missing"), v.literal("user"), v.literal("vault")]), v.description("Role identifier.")),
+    }),
+    v.strictObject({
+        /** Role identifier. */
+        role: v.pipe(v.literal("agent"), v.description("Role identifier.")),
+        /** Details for agent role. */
+        data: v.pipe(v.strictObject({
+            /** Master account address associated with the agent. */
+            user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Master account address associated with the agent.")),
+        }), v.description("Details for agent role.")),
+    }),
+    v.strictObject({
+        /** Role identifier. */
+        role: v.pipe(v.literal("subAccount"), v.description("Role identifier.")),
+        /** Details for sub-account role. */
+        data: v.pipe(v.strictObject({
+            /** Master account address associated with the sub-account. */
+            master: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Master account address associated with the sub-account.")),
+        }), v.description("Details for sub-account role.")),
+    }),
+]), v.description("User role."));
+/** Transfer between spot and perpetual accounts. */
+exports.AccountClassTransferUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("accountClassTransfer"), v.description("Update type.")),
+    /** Amount transferred in USDC. */
+    usdc: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount transferred in USDC.")),
+    /** Indicates if the transfer is to the perpetual account. */
+    toPerp: v.pipe(v.boolean(), v.description("Indicates if the transfer is to the perpetual account.")),
+}), v.description("Transfer between spot and perpetual accounts."));
+/** Deposit update to an account. */
+exports.DepositUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("deposit"), v.description("Update type.")),
+    /** Amount deposited in USDC. */
+    usdc: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount deposited in USDC.")),
+}), v.description("Deposit update to an account."));
+/** Internal transfer between accounts. */
+exports.InternalTransferUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("internalTransfer"), v.description("Update type.")),
+    /** Amount transferred in USDC. */
+    usdc: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount transferred in USDC.")),
+    /** Initiator address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Initiator address.")),
+    /** Destination address. */
+    destination: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Destination address.")),
+    /** Transfer fee. */
+    fee: v.pipe(_base_js_1.UnsignedDecimal, v.description("Transfer fee.")),
+}), v.description("Internal transfer between accounts."));
+/** Liquidation event update. */
+exports.LiquidationUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("liquidation"), v.description("Update type.")),
+    /** Total notional value of liquidated positions. */
+    liquidatedNtlPos: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total notional value of liquidated positions.")),
+    /** Account value at liquidation time. */
+    accountValue: v.pipe(_base_js_1.UnsignedDecimal, v.description("Account value at liquidation time.")),
+    /** Leverage type for liquidated positions. */
+    leverageType: v.pipe(v.union([v.literal("Cross"), v.literal("Isolated")]), v.description("Leverage type for liquidated positions.")),
+    /** Details of each liquidated position. */
+    liquidatedPositions: v.pipe(v.array(v.strictObject({
+        /** Asset symbol of the liquidated position. */
+        coin: v.pipe(v.string(), v.description("Asset symbol of the liquidated position.")),
+        /** Signed position size liquidated. */
+        szi: v.pipe(_base_js_1.SignedDecimal, v.description("Signed position size liquidated.")),
+    })), v.description("Details of each liquidated position.")),
+}), v.description("Liquidation event update."));
+/** Rewards claim event update. */
+exports.RewardsClaimUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("rewardsClaim"), v.description("Update type.")),
+    /** Amount of rewards claimed. */
+    amount: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount of rewards claimed.")),
+    /** Token symbol. */
+    token: v.pipe(v.string(), v.description("Token symbol.")),
+}), v.description("Rewards claim event update."));
+/** Spot transfer update between accounts. */
+exports.SpotTransferUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("spotTransfer"), v.description("Update type.")),
+    /** Token symbol. */
+    token: v.pipe(v.string(), v.description("Token symbol.")),
+    /** Amount transferred. */
+    amount: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount transferred.")),
+    /** Equivalent USDC value. */
+    usdcValue: v.pipe(_base_js_1.UnsignedDecimal, v.description("Equivalent USDC value.")),
+    /** Initiator address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Initiator address.")),
+    /** Destination address. */
+    destination: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Destination address.")),
+    /** Transfer fee. */
+    fee: v.pipe(_base_js_1.UnsignedDecimal, v.description("Transfer fee.")),
+    /** Fee in native token. */
+    nativeTokenFee: v.pipe(_base_js_1.UnsignedDecimal, v.description("Fee in native token.")),
+    nonce: v.null(),
+    /** Token in which the fee is denominated (e.g., "USDC"). */
+    feeToken: v.pipe(v.string(), v.description('Token in which the fee is denominated (e.g., "USDC").')),
+}), v.description("Spot transfer update between accounts."));
+/** Transfer update between sub-accounts. */
+exports.SubAccountTransferUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("subAccountTransfer"), v.description("Update type.")),
+    /** Amount transferred in USDC. */
+    usdc: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount transferred in USDC.")),
+    /** Initiator address. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Initiator address.")),
+    /** Destination address. */
+    destination: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Destination address.")),
+}), v.description("Transfer update between sub-accounts."));
+/** Vault creation update. */
+exports.VaultCreateUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("vaultCreate"), v.description("Update type.")),
+    /** Address of the created vault. */
+    vault: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Address of the created vault.")),
+    /** Initial allocated amount in USDC. */
+    usdc: v.pipe(_base_js_1.UnsignedDecimal, v.description("Initial allocated amount in USDC.")),
+    /** Vault creation fee. */
+    fee: v.pipe(_base_js_1.UnsignedDecimal, v.description("Vault creation fee.")),
+}), v.description("Vault creation update."));
+/** Vault deposit update. */
+exports.VaultDepositUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("vaultDeposit"), v.description("Update type.")),
+    /** Address of the target vault. */
+    vault: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Address of the target vault.")),
+    /** Amount deposited in USDC. */
+    usdc: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount deposited in USDC.")),
+}), v.description("Vault deposit update."));
+/** Vault distribution update. */
+exports.VaultDistributionUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("vaultDistribution"), v.description("Update type.")),
+    /** Address of the vault distributing funds. */
+    vault: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Address of the vault distributing funds.")),
+    /** Amount distributed in USDC. */
+    usdc: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount distributed in USDC.")),
+}), v.description("Vault distribution update."));
+/** Vault withdrawal event update. */
+exports.VaultWithdrawUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("vaultWithdraw"), v.description("Update type.")),
+    /** Vault address. */
+    vault: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Vault address.")),
+    /** Address of the user withdrawing funds. */
+    user: v.pipe(v.pipe(_base_js_1.Hex, v.length(42)), v.description("Address of the user withdrawing funds.")),
+    /** Withdrawal request amount in USD. */
+    requestedUsd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Withdrawal request amount in USD.")),
+    /** Withdrawal commission fee. */
+    commission: v.pipe(_base_js_1.UnsignedDecimal, v.description("Withdrawal commission fee.")),
+    /** Closing cost associated with positions. */
+    closingCost: v.pipe(_base_js_1.UnsignedDecimal, v.description("Closing cost associated with positions.")),
+    /** Basis value for withdrawal calculation. */
+    basis: v.pipe(_base_js_1.UnsignedDecimal, v.description("Basis value for withdrawal calculation.")),
+    /** Net withdrawn amount in USD after fees and costs. */
+    netWithdrawnUsd: v.pipe(_base_js_1.UnsignedDecimal, v.description("Net withdrawn amount in USD after fees and costs.")),
+}), v.description("Vault withdrawal event update."));
+/** Withdrawal update from an account. */
+exports.WithdrawUpdate = v.pipe(v.strictObject({
+    /** Update type. */
+    type: v.pipe(v.literal("withdraw"), v.description("Update type.")),
+    /** Amount withdrawn in USDC. */
+    usdc: v.pipe(_base_js_1.UnsignedDecimal, v.description("Amount withdrawn in USDC.")),
+    /** Unique nonce for the withdrawal request. */
+    nonce: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Unique nonce for the withdrawal request.")),
+    /** Withdrawal fee. */
+    fee: v.pipe(_base_js_1.UnsignedDecimal, v.description("Withdrawal fee.")),
+}), v.description("Withdrawal update from an account."));
+/** Non-funding ledger update for a user. */
+exports.UserNonFundingLedgerUpdate = v.pipe(v.strictObject({
+    /** Timestamp of the update (in ms since epoch). */
+    time: v.pipe(v.pipe(v.number(), v.safeInteger(), v.minValue(0)), v.description("Timestamp of the update (in ms since epoch).")),
+    /** L1 transaction hash. */
+    hash: v.pipe(v.pipe(_base_js_1.Hex, v.length(66)), v.description("L1 transaction hash.")),
+    /** Update details. */
+    delta: v.pipe(v.union([
+        exports.AccountClassTransferUpdate,
+        exports.DepositUpdate,
+        exports.InternalTransferUpdate,
+        exports.LiquidationUpdate,
+        exports.RewardsClaimUpdate,
+        exports.SpotTransferUpdate,
+        exports.SubAccountTransferUpdate,
+        exports.VaultCreateUpdate,
+        exports.VaultDepositUpdate,
+        exports.VaultDistributionUpdate,
+        exports.VaultWithdrawUpdate,
+        exports.WithdrawUpdate,
+    ]), v.description("Update details.")),
+}), v.description("Non-funding ledger update for a user."));