@metaflux-dex/client 0.0.3 → 0.0.5

package/src/types/info/index.ts

@@ -0,0 +1,78 @@
+// Re-export barrel for the `/info` response type modules, split by domain:
+//   core.ts      — node / account / market / vault / staking / fee shapes
+//   reads.ts     — book / trade / account-history reads
+//   hl-parity.ts — the HL-node parity query shapes
+
+export type {
+  NodeInfo,
+  AccountState,
+  AccountPosition,
+  Balances,
+  Tier,
+  MarginMode,
+  MarketInfo,
+  Funding,
+  VaultState,
+  StakingState,
+  Delegation,
+  PendingUnstake,
+  FeeSchedule,
+  FeeTier,
+} from './core.js';
+export type {
+  OpenOrders,
+  OpenOrder,
+  L2Book,
+  L2Level,
+  RecentTrades,
+  UserFills,
+  FundingHistory,
+  FundingSample,
+  BlockInfo,
+  Agents,
+  AgentEntry,
+  SubAccounts,
+  SubAccountEntry,
+  Mip3ActiveBids,
+  Mip3Bid,
+} from './reads.js';
+export type {
+  SpotMeta,
+  SpotPair,
+  SpotToken,
+  SpotClearinghouseState,
+  SpotBalance,
+  ExchangeStatus,
+  FrontendOpenOrders,
+  FrontendOpenOrder,
+  OrderTrigger,
+  Liquidatable,
+  LiquidatableAccount,
+  ActiveAssetData,
+  MaxMarketOrderNtls,
+  MaxMarketOrderNtl,
+  VaultSummaries,
+  VaultSummary,
+  UserVaultEquities,
+  VaultEquity,
+  LeadingVaults,
+  UserRateLimit,
+  SpotDeployState,
+  DelegatorSummary,
+  MaxBuilderFee,
+  UserToMultiSigSigners,
+  UserRole,
+  PerpsAtOpenInterestCap,
+  ValidatorL1Votes,
+  ValidatorL1Vote,
+  MarginTable,
+  MarginTier,
+  PerpDexs,
+  PerpDex,
+  ValidatorSummaries,
+  ValidatorSummary,
+  GossipRootIps,
+  WebData2,
+  WebData2Clearinghouse,
+  WebData2Position,
+} from './hl-parity.js';

package/src/types/info/reads.ts

@@ -0,0 +1,165 @@
+// Book / trade / account-history response interfaces for `POST /info`.
+//
+// Source of truth: the KB spec metaflux-knowledges/api/rest/info.md. Field
+// names are the exact snake_case keys the node emits inside `{type, data}.data`.
+// Money magnitudes that can exceed 2^53 are typed `string`.
+
+/// One resting order inside an `OpenOrders` response.
+export interface OpenOrder {
+  /// Server order id.
+  oid: number;
+  /// Asset / market id the order rests on.
+  market_id: number;
+  /// Order side.
+  side: 'bid' | 'ask';
+  /// Resting price, fixed-point decimal string.
+  px: string;
+  /// Remaining size, fixed-point decimal string.
+  size: string;
+  /// Insertion timestamp (consensus ms).
+  inserted_at_ms: number;
+}
+
+/// `open_orders` — account-scoped resting orders across every perp book.
+export interface OpenOrders {
+  /// Resolved account address (0x).
+  address: string;
+  /// Echoed only when the request used `account_id`.
+  account_id?: number;
+  /// Resting orders.
+  orders: OpenOrder[];
+}
+
+/// One aggregated L2 book level.
+export interface L2Level {
+  /// Level price, fixed-point decimal string.
+  px: string;
+  /// Summed size at the level, fixed-point decimal string.
+  size: string;
+  /// Resting orders at the level.
+  n_orders: number;
+}
+
+/// `l2_book` — market-scoped aggregated bid/ask levels.
+export interface L2Book {
+  /// Echoed market id.
+  market_id: number;
+  /// Bid side (best-first, descending price).
+  bids: L2Level[];
+  /// Ask side (ascending price).
+  asks: L2Level[];
+}
+
+/// `recent_trades` — market-scoped trade tape (honest-empty today).
+export interface RecentTrades {
+  /// Echoed market id.
+  market_id: number;
+  /// Timestamp of the last trade (`0` if none).
+  last_trade_ms: number;
+  /// Empty until the trade indexer lands.
+  trades: unknown[];
+}
+
+/// `user_fills` — account-scoped fill history (honest-empty today).
+export interface UserFills {
+  /// Resolved account address (0x).
+  address: string;
+  /// Echoed only when the request used `account_id`.
+  account_id?: number;
+  /// Empty until the fill indexer lands.
+  fills: unknown[];
+}
+
+/// One funding premium sample.
+export interface FundingSample {
+  /// Sample timestamp (consensus ms).
+  ts_ms: number;
+  /// Funding premium sample (signed), decimal string.
+  premium: string;
+}
+
+/// `funding_history` — market-scoped funding premium samples.
+export interface FundingHistory {
+  /// Echoed market id.
+  market_id: number;
+  /// Ordered ring of `(ts_ms, premium)` samples.
+  samples: FundingSample[];
+}
+
+/// `block_info` — committed block metadata.
+export interface BlockInfo {
+  /// Latest committed block height.
+  height: number;
+  /// Consensus round of that block.
+  round: number;
+  /// Current epoch.
+  epoch: number;
+  /// Block timestamp (consensus ms).
+  timestamp_ms: number;
+  /// Block hash (0x + 32 bytes); all-zero until plumbed into read state.
+  block_hash: string;
+}
+
+/// One approved agent inside an `Agents` response.
+export interface AgentEntry {
+  /// Approved agent wallet address (0x).
+  agent: string;
+  /// Agent approval expiry (consensus ms).
+  expires_at_ms: number;
+}
+
+/// `agents` — approved agent / API wallets for an account.
+export interface Agents {
+  /// Resolved master address (0x).
+  address: string;
+  /// Echoed only when the request used `account_id`.
+  account_id?: number;
+  /// Approved agents.
+  agents: AgentEntry[];
+}
+
+/// One sub-account inside a `SubAccounts` response.
+export interface SubAccountEntry {
+  /// Sub-account index under the parent.
+  index: number;
+  /// Sub-account address (0x).
+  address: string;
+}
+
+/// `sub_accounts` — sub-accounts of an account.
+export interface SubAccounts {
+  /// Resolved parent address (0x).
+  address: string;
+  /// Echoed only when the request used `account_id`.
+  account_id?: number;
+  /// Sub-accounts.
+  sub_accounts: SubAccountEntry[];
+}
+
+/// One MIP-3 auction bid.
+export interface Mip3Bid {
+  /// Bidder address (0x).
+  bidder: string;
+  /// Bid amount, decimal string.
+  amount: string;
+  /// Bid submission timestamp (consensus ms).
+  submitted_at_ms: number;
+  /// Bid tag (e.g. the proposed market name).
+  tag: string;
+}
+
+/// `mip3_active_bids` — MIP-3 permissionless perp-deploy auction snapshot.
+export interface Mip3ActiveBids {
+  /// Current auction round.
+  auction_round: number;
+  /// Leading bid amount, decimal string.
+  current_bid: string;
+  /// Current winning bidder (0x), or `null` if none.
+  current_winner: string | null;
+  /// Auction close timestamp (consensus ms).
+  auction_end_ms: number;
+  /// Auction start timestamp (consensus ms).
+  started_at_ms: number;
+  /// Bids.
+  bids: Mip3Bid[];
+}

package/src/types/meta-bridge.ts

@@ -0,0 +1,22 @@
+// MTF-native MetaBridge withdrawal action payload types.
+//
+// Sender-authorized: the signer is the account whose cross-collateral is
+// debited. The withdrawal queues an outbound message for validator co-signing,
+// which releases funds on the destination chain.
+
+/// Destination chain for a MetaBridge withdrawal. PascalCase to match the
+/// node's chain enum.
+export type MbChain = 'Base' | 'Arbitrum' | 'Solana';
+
+/// `mb_withdraw` — withdraw cross-collateral to a destination chain.
+export interface MbWithdraw {
+  /// Destination chain.
+  chain: MbChain;
+  /// MetaFlux asset id (`u32`; currently only `0` = USDC cross-collateral).
+  asset: number;
+  /// Amount in base units (`u64`).
+  amount: number;
+  /// Destination address as `0x`-hex: a 20-byte EVM address (Base / Arbitrum)
+  /// or a 32-byte recipient (Solana).
+  dst_addr: string;
+}

package/src/types/spot.ts

@@ -0,0 +1,114 @@
+// MTF-native spot CLOB (SE-0) action types.
+//
+// Byte-for-byte mirrors of the server spot action structs. Field ORDER is
+// load-bearing for the signed bytes (see `buildNativeSpotOrderAction` /
+// `buildNativeSpotCancelAction`).
+
+import type { NativeSide, NativeStpMode, NativeTif } from './trading.js';
+
+/// MTF-native `spot_order` action shape (SE-0 spot CLOB) — byte-for-byte mirror
+/// of the server `NativeSpotOrder`. Sender-authorized (the signer is the trader,
+/// no `owner`); spot has no positions, so there is no `reduce_only` /
+/// `position_side`. v0 accepts ONLY `tif:"ioc"` with `limit_px > 0` — Gtc / Alo
+/// and a zero (market) price are rejected by the node.
+///
+/// Field ORDER is load-bearing for the signed bytes (see `buildNativeSpotOrderAction`).
+export interface NativeSpotOrder {
+  /// Spot pair id (`u32`); maps identity → asset id.
+  pair: number;
+  /// Side: `"bid"` (buy) or `"ask"` (sell).
+  side: NativeSide;
+  /// Base-asset size in raw lots (`u64` on the wire).
+  size: number;
+  /// Limit price in the 1e8 plane (`u64` on the wire); must be `> 0` in v0.
+  limit_px: number;
+  /// Time-in-force. v0 requires `"ioc"` (defaulted by the builder).
+  tif: NativeTif;
+  /// Self-trade-prevention mode.
+  stp_mode: NativeStpMode;
+  /// Optional `0x`-hex 32-char (16-byte) client order id. Omitted from the
+  /// signed bytes entirely when absent.
+  cloid?: string;
+}
+
+/// MTF-native `spot_cancel` action shape — byte-for-byte mirror of the server
+/// `NativeSpotCancel`. Cancels a resting spot order by `oid` (the node cancels
+/// by `oid`; there is no cancel-by-cloid on this path).
+export interface NativeSpotCancel {
+  /// Spot pair id (`u32`).
+  pair: number;
+  /// Server order id (`u64`) to cancel. REQUIRED.
+  oid: number;
+}
+
+// ---- Spot margin (leveraged spot) + Earn (lending pool) ----
+//
+// Available on devnet (preview). Leveraged spot is isolated per `(account,
+// pair)`: posted quote collateral is a loss buffer, the borrow funds the buy
+// 100%, and the bought base is held segregated on the margin account. Earn is
+// the supply side that funds the borrows. All six actions are sender-authorized
+// (the recovered signer is the actor — no `owner`). Decimal magnitudes
+// (`amount` / `borrow` / `shares`) ride the wire as JSON **strings** to preserve
+// fractional precision; `size` / `limit_px` are plain integers on the raw-lot /
+// 1e8 planes, like a `NativeSpotOrder`. Field ORDER is load-bearing for the
+// signed bytes (see the `buildNativeSpotMargin*` / `buildNativeEarn*` builders).
+
+/// MTF-native `spot_margin_deposit` action params — post quote collateral into
+/// the `(account, pair)` margin account. Margin must be enabled for the pair.
+export interface NativeSpotMarginDeposit {
+  /// Spot pair id (`u32`).
+  pair: number;
+  /// Quote collateral to post (whole units), as a decimal string (`> 0`).
+  amount: string;
+}
+
+/// MTF-native `spot_margin_withdraw` action params — withdraw free collateral
+/// back to the spendable quote balance (initial-margin-gated while open).
+export interface NativeSpotMarginWithdraw {
+  /// Spot pair id (`u32`).
+  pair: number;
+  /// Collateral to withdraw (whole quote units), as a decimal string (`> 0`).
+  amount: string;
+}
+
+/// MTF-native `spot_margin_open` action params — borrow quote from the pair's
+/// Earn pool and IOC-buy `size` base at up to `limit_px` on leverage. The
+/// borrow funds the buy 100%; unspent borrow is repaid instantly.
+export interface NativeSpotMarginOpen {
+  /// Spot pair id (`u32`).
+  pair: number;
+  /// Buy size in base raw lots (`u64`).
+  size: number;
+  /// Limit price in the 1e8 plane (`u64`, `> 0`).
+  limit_px: number;
+  /// Quote principal to draw from the Earn pool (whole units), as a decimal
+  /// string (`> 0`).
+  borrow: string;
+}
+
+/// MTF-native `spot_margin_close` action params — IOC-sell the held base at no
+/// less than `limit_px`, repay principal + interest, return the remainder.
+export interface NativeSpotMarginClose {
+  /// Spot pair id (`u32`).
+  pair: number;
+  /// Floor price for the close sell, in the 1e8 plane (`u64`, `> 0`).
+  limit_px: number;
+}
+
+/// MTF-native `earn_deposit` action params — supply quote into a lending pool
+/// for pool shares (1:1 on a fresh pool, else priced off NAV; auto-creates).
+export interface NativeEarnDeposit {
+  /// Lendable asset id (a spot pair's quote) — the pool key (`u32`).
+  asset: number;
+  /// Quote to supply (whole units), as a decimal string (`> 0`).
+  amount: string;
+}
+
+/// MTF-native `earn_withdraw` action params — redeem pool shares back to quote,
+/// clamped to the pool's idle liquidity (`supplied − borrowed`).
+export interface NativeEarnWithdraw {
+  /// Lendable asset id (the pool key) (`u32`).
+  asset: number;
+  /// Pool shares to redeem, as a decimal string (`> 0`, owned by the sender).
+  shares: string;
+}

package/src/types/staking.ts

@@ -0,0 +1,27 @@
+// MTF-native staking action payload types.
+//
+// All sender-authorized (the recovered signer is the staking account). `amount`
+// rides the wire as a decimal string.
+
+/// `token_delegate` — delegate stake to a validator, or queue an undelegation.
+export interface TokenDelegate {
+  /// `0x`-hex 20-byte validator address.
+  validator: string;
+  /// Stake amount as a decimal string.
+  amount: string;
+  /// `true` = unstake / queue undelegation; `false` = delegate.
+  is_undelegate: boolean;
+}
+
+/// `claim_rewards` — claim accrued staking rewards.
+export interface ClaimRewards {
+  /// `0x`-hex 20-byte validator to claim from. Omit to claim across all
+  /// delegations.
+  validator?: string;
+}
+
+/// `link_staking_user` — alias another account as this account's staking target.
+export interface LinkStakingUser {
+  /// `0x`-hex 20-byte staking target address.
+  target: string;
+}

package/src/{types.ts → types/trading.ts}

@@ -1,7 +1,7 @@
-// Type definitions for the @metaflux-dex/client surface.
+// Trading type definitions for the @metaflux-dex/client surface.
 //
 // Shapes mirror the CCXT-compat REST responses emitted by the MetaFlux
-// api-gateway (`metaflux/crates/api-gateway/src/ccxt/types.rs`). The
+// api-gateway and the MTF-native signed-action wire. The
 // monetary-fields-as-decimal-strings convention is load-bearing — CCXT
 // clients pass these straight into `Decimal(value)` and any drift to
 // number-typed fields silently loses precision.
@@ -96,7 +96,7 @@ export interface SignedOrder {
 }
 
 /// MTF-native order action shape (snake_case), byte-for-byte mirror of the
-/// server `NativeOrder` (`metaflux/crates/api-node/src/rest/native_action.rs`).
+/// server `NativeOrder` (per the KB spec metaflux-knowledges/api/rest/exchange.md).
 /// These string/number forms are EXACTLY what rides inside the signed
 /// `action` JSON posted to `POST /exchange` — the digest covers the
 /// full object, so every field here is part of the signed bytes.
@@ -130,10 +130,26 @@ export interface NativeOrder {
   cloid?: string;
   /// Optional builder-code carve. Rides INSIDE the signed action object.
   builder?: NativeBuilder;
+  /// HEDGE MODE: target leg (`"long"` / `"short"`). OMITTED on a one-way
+  /// account (the default), REQUIRED on a hedge account — the node validates
+  /// the mode↔side pairing. Left off the signed bytes entirely when absent, so
+  /// a one-way payload stays byte-identical to a pre-hedge SDK.
+  position_side?: NativePositionSide;
+}
+
+/// MTF-native `set_position_mode` action payload — byte-for-byte mirror of the
+/// server `SetPositionModeParams`. Toggles the account between one-way (net,
+/// `hedge:false`) and hedge / two-way (`hedge:true`) position modes. Only legal
+/// while flat on every market (the node rejects a switch with open positions).
+/// Sender-authorized: the recovered signer IS the account, so there is no
+/// `owner` field.
+export interface NativeSetPositionMode {
+  /// `true` = hedge / two-way; `false` = one-way / net.
+  hedge: boolean;
 }
 
 /// MTF-native `cancel_order` action shape (snake_case), byte-for-byte mirror of
-/// the server `NativeCancel` (`metaflux/crates/api-node/src/rest/native_action.rs`).
+/// the server `NativeCancel` (per the KB spec metaflux-knowledges/api/rest/exchange.md).
 /// Field ORDER is load-bearing for the same reason as `NativeOrder`: the server
 /// verifies the signature over the raw `action` bytes (see
 /// `buildNativeCancelAction`).
@@ -154,6 +170,10 @@ export interface NativeCancel {
 /// MTF-native side string — mirrors the server `NativeSide`.
 export type NativeSide = 'bid' | 'ask';
 
+/// MTF-native position-side string (HEDGE MODE) — mirrors the server
+/// `NativePositionSide`. Selects which leg a hedge-account order targets.
+export type NativePositionSide = 'long' | 'short';
+
 /// MTF-native order kind — mirrors the server `NativeOrderKind`. Only
 /// `limit` / `market` are mapped server-side; `stop_loss` / `take_profit`
 /// are rejected (triggers not wired).
@@ -180,6 +200,70 @@ export interface NativeBuilder {
   user: string;
 }
 
+// ---- order-management actions ----
+
+/// Order grouping for a [`BatchOrder`] — mirrors the server `OrderGrouping`.
+/// `"na"` = independent orders; the TP/SL variants attach children.
+export type OrderGrouping = 'na' | 'normalTpsl' | 'positionTpsl';
+
+/// `modify` action payload — amend a resting order's price and/or size in
+/// place. An omitted field is left unchanged.
+export interface Modify {
+  /// Target market id (`u32`).
+  market: number;
+  /// Order id to amend (`u64`).
+  oid: number;
+  /// New limit price in tick units (`u64`); omit to leave unchanged.
+  new_px?: number;
+  /// New size in tick units (`u64`); omit to leave unchanged.
+  new_size?: number;
+}
+
+/// `batch_modify` action payload — N [`Modify`]s under one signature.
+export interface BatchModify {
+  /// Modifications, applied in order.
+  modifications: Modify[];
+}
+
+/// `batch_order` action payload — N orders under one signature. Each order's
+/// `owner` must equal the signing wallet.
+export interface BatchOrder {
+  /// Orders to place, in priority order.
+  orders: NativeOrder[];
+  /// Grouping semantics. Defaults to `"na"` when omitted.
+  grouping?: OrderGrouping;
+}
+
+/// `batch_cancel` action payload — N cancels under one signature. Each cancel's
+/// `owner` must equal the signing wallet and must carry an `oid`.
+export interface BatchCancel {
+  /// Cancels to apply, in order.
+  cancels: NativeCancel[];
+}
+
+/// `cancel_by_cloid` action payload — cancel a resting order by client id.
+export interface CancelByCloid {
+  /// Target asset / market id (`u32`).
+  asset: number;
+  /// `0x`-hex 32-char (16-byte) client order id.
+  cloid: string;
+}
+
+/// `schedule_cancel` action payload — cancel-all of the sender's open orders at
+/// a future block.
+export interface ScheduleCancel {
+  /// Block height at which all of the sender's open orders are cancelled
+  /// (`u64`).
+  cancel_at_block: number;
+}
+
+/// `cancel_all_orders` action payload — cancel all of the sender's open orders,
+/// optionally filtered to one asset.
+export interface CancelAllOrders {
+  /// Asset filter (`u32`). Omit to cancel across all assets.
+  asset?: number;
+}
+
 /// Signed native action envelope posted to `POST /exchange`.
 ///
 /// `action` is the raw JSON STRING (not a parsed object) so the bytes sent
@@ -198,7 +282,7 @@ export interface NativeSignedAction {
 /// Per-order status entry returned by `/exchange` for an order-type action.
 ///
 /// Byte-for-byte the node `OrderStatusEntry`
-/// (`metaflux/crates/api-node/src/rest/exchange.rs`): a tagged union selected by
+/// (per the KB spec metaflux-knowledges/api/rest/exchange.md): a tagged union selected by
 /// the single present key, one entry per submitted order, in submission order.
 /// `total_sz` / `avg_px` are 8-decimal fixed-point u128 STRINGS (native JSON
 /// numbers lose precision past 2^53); `oid` / `nonce` are JSON numbers.
@@ -215,7 +299,7 @@ export type OrderStatus =
   | { pending: { action_hash: string; nonce: number } };
 
 /// Server response to `POST /exchange`. Mirrors the node `ExchangeResponse`
-/// (`metaflux/crates/api-node/src/rest/exchange.rs`).
+/// (per the KB spec metaflux-knowledges/api/rest/exchange.md).
 ///
 /// Two shapes share this struct (the node omits the absent keys):
 /// - **Order-type actions** (`submit_order` / `batch_order` / `cancel_order` /
@@ -241,8 +325,8 @@ export interface NativeExchangeAck {
   action_hash?: string;
 }
 
-/// Acknowledgement from `submitOrder`. Mirrors `Order` from the CCXT REST
-/// response shape (`api-gateway/src/ccxt/types.rs::Order`); monetary
+/// Acknowledgement from `submitOrder`. Mirrors `Order` from the gateway's
+/// CCXT-compat REST response shape; monetary
 /// fields are decimal strings to match what the gateway emits.
 export interface OrderAck {
   id: string;

package/src/types/twap.ts

@@ -0,0 +1,29 @@
+// MTF-native TWAP (time-weighted average price) action payload types.
+//
+// A TWAP parent slices `total_size` into `slice_count` child orders spaced
+// `delay_ms` apart. Sender-authorized (no `owner` field); `total_size` is in
+// fixed-point tick units like a perp order's `size`.
+
+import type { NativeSide } from './trading.js';
+
+/// `twap_order` — submit a sliced (TWAP) order.
+export interface TwapOrder {
+  /// Target market id (`u32`).
+  market: number;
+  /// Side: `"bid"` (buy) or `"ask"` (sell).
+  side: NativeSide;
+  /// Total size in fixed-point tick units (`u64`), split across all slices.
+  total_size: number;
+  /// Number of child slices (`u32`).
+  slice_count: number;
+  /// Inter-slice delay in milliseconds (`u64`).
+  delay_ms: number;
+  /// Reduce-only flag (each slice may only reduce an existing position).
+  reduce_only: boolean;
+}
+
+/// `twap_cancel` — cancel a running TWAP parent by id.
+export interface TwapCancel {
+  /// TWAP parent id (`u64`), assigned when the parent was submitted.
+  twap_id: number;
+}

package/src/types/vault.ts

@@ -0,0 +1,55 @@
+// MTF-native vault action payload types.
+//
+// Sender-authorized: the recovered signer is the leader / follower. Decimal
+// magnitudes (`amount` / `shares`) ride the wire as JSON strings.
+
+/// Kind of vault created by [`CreateVault`]. PascalCase to match the node's
+/// vault-kind enum.
+export type VaultKind = 'User' | 'Metaliquidity';
+
+/// `create_vault` — create a new vault. The signing wallet becomes the leader.
+export interface CreateVault {
+  /// Display name.
+  name: string;
+  /// Follower withdrawal lock period in seconds (`u64`).
+  lock_period_secs: number;
+  /// Optional parent vault id (`u64`).
+  parent?: number;
+  /// Vault kind. Defaults to `"User"` when omitted.
+  kind?: VaultKind;
+}
+
+/// `vault_transfer` — leader moves capital into (`deposit: true`) or out of
+/// (`deposit: false`) a vault.
+export interface VaultTransfer {
+  /// Target vault id (`u64`).
+  vault_id: number;
+  /// `true` = deposit (leader → vault), `false` = withdraw (vault → leader).
+  deposit: boolean;
+  /// Amount in USD as a decimal string.
+  amount: string;
+}
+
+/// `vault_modify` — leader updates vault configuration. An omitted field is
+/// left unchanged.
+export interface VaultModify {
+  /// Target vault id (`u64`).
+  vault_id: number;
+  /// New display name.
+  new_name?: string;
+  /// New lock period in seconds (`u64`).
+  new_lock_period_secs?: number;
+  /// New management fee in bps (`u16`).
+  new_management_fee_bps?: number;
+  /// New paused flag.
+  new_paused?: boolean;
+}
+
+/// `vault_withdraw` — follower redeems shares from a vault (subject to the
+/// per-vault lock).
+export interface VaultWithdraw {
+  /// Target vault id (`u64`).
+  vault_id: number;
+  /// Shares to redeem, as a decimal string.
+  shares: string;
+}