@somnia-chain/markets-sdk / index / MarginAccount
Interface: MarginAccount
Defined in: packages/sdk/src/perp/margin.ts:39
An account's cross-margin state in the MarginBank (collateral is the bank's single collateral token, e.g. USDso — raw units).
Properties
unlockedCollateralBalance
unlockedCollateralBalance:
bigint
Defined in: packages/sdk/src/perp/margin.ts:41
Free collateral after locks (signed — settlement can drive it negative).
lockedCollateral
lockedCollateral:
bigint
Defined in: packages/sdk/src/perp/margin.ts:43
Collateral reserved for pending orders.
activePerpPools
activePerpPools:
`0x${string}`[]
Defined in: packages/sdk/src/perp/margin.ts:45
Perp pools where the account holds an open position.
equity
equity:
bigint
Defined in: packages/sdk/src/perp/margin.ts:47
Equity = collateral + unrealized PnL − pending funding (signed).
withdrawable
withdrawable:
bigint
Defined in: packages/sdk/src/perp/margin.ts:49
Collateral withdrawable right now (respects margin requirements).
imReq
imReq:
bigint
Defined in: packages/sdk/src/perp/margin.ts:51
Sum of notional × initialMarginBps / 10000 across all markets (raw).
mmReq
mmReq:
bigint
Defined in: packages/sdk/src/perp/margin.ts:53
Sum of notional × maintenanceMarginBps / 10000 across all markets (raw).
cmReq
cmReq:
bigint
Defined in: packages/sdk/src/perp/margin.ts:55
Sum of notional × closeOutMarginBps / 10000 across all markets (raw).
marginStatus
marginStatus:
MarginStatus
Defined in: packages/sdk/src/perp/margin.ts:57
Health bucket derived from equity vs the requirements.