object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
schemaVersion |
Yes | Constant simulation-study-input-snapshot-v1 |
— |
engineVersion |
Yes | Constant digital-twin-pcg64-fixed-v2 |
— |
seed |
Yes | string |
— |
pathCount |
Yes | integer |
Allowed: 2000, 10000 |
stepCount |
Yes | integer |
Minimum: 1; Maximum: 365 |
targetTradeSizeQuote |
Yes | PositiveAtomicAmount | — |
startingPortfolioQuote |
Yes | PositiveAtomicAmount | — |
startingDepthQuote |
Yes | PositiveAtomicAmount | — |
startingInventoryPips |
Yes | Pips | — |
scenario |
Yes | object |
Additional properties rejected |
scenario.id |
Yes | string |
— |
scenario.name |
Yes | string |
— |
scenario.kind |
Yes | string |
Allowed: HISTORICAL_REPLAY, BULL, BEAR, SIDEWAYS, LIQUIDITY_CRISIS, TOKEN_UNLOCK, LARGE_BUYER, LARGE_SELLER, LIQUIDITY_WITHDRAWAL, GAS_SPIKE, ORACLE_OUTAGE, COMBINED |
scenario.driftPipsPerStep |
Yes | integer |
Minimum: -1000000; Maximum: 1000000 |
scenario.volatilityPipsPerStep |
Yes | Pips | — |
scenario.liquidityWithdrawalPips |
Yes | Pips | — |
scenario.oneSidedFlowPips |
Yes | Pips | — |
scenario.gasIncreasePips |
Yes | Pips | — |
scenario.oracleOutageStep |
No | integer |
Minimum: 0; Maximum: 364 |
scenario.historicalReturnPips |
No | Array of integer |
Min items: 1; Max items: 365 |
scenario.protocolFeePips |
No | Pips | — |
scenario.platformFeePips |
No | Pips | — |
scenario.unlocks |
No | Array of UnlockTranche | Max items: 256 |
variants |
Yes | Array of LiquidityPlanVariant | Min items: 5; Max items: 5 |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Exact definition: #/components/schemas/DisclosedSimulationStudyInputSnapshot in the OpenAPI contract.