SimulateSwapType

Result of a token contract swap. Reference for the SimulateSwapType type in the Codex API: every field, its type, and the operations that return it.

buySuccess · Boolean

Buy outcome inferred from recorded errors. Do not use this flag alone: pending or incomplete records may have no errors. Inspect verdict and status.

buyTax · String

Current analyzer: tax on the simulated buy alone, excluding pool fees, as a decimal fraction encoded as a string (0.05 means 5%). Legacy simulation rows used percentage values and a different sign convention; values are returned without normalization. Null when the buy could not be measured on its own.

buyGasUsed · String

Gas units consumed by the simulated buy, encoded as an integer string. Null when not recorded.

maxBuyAmount · String

Legacy detected buy limit in decimal-adjusted token units. Null when a limit was not recorded; this does not prove unrestricted buying.

sellSuccess · Boolean

Sell outcome inferred from recorded errors. Do not use this flag alone: pending or incomplete records may have no errors. Inspect verdict and status.

sellTax · String

Current analyzer: tax on the simulated sell alone, excluding pool fees, as a decimal fraction encoded as a string (0.05 means 5%). Null when the sell could not be measured on its own, or when the sale failed by reverting or returning almost nothing; a sell cap stores the tax measured on the smaller sale that went through. Older records can instead hold an estimate from the whole buy-and-sell round trip, or 1 for a failed sell; TokenRisk.sellTax returns measured values only. Legacy simulation rows used percentage values and a different sign convention; values are returned without normalization.

sellGasUsed · String

Gas units consumed by the simulated sell, encoded as an integer string. Null when not recorded.

maxSellAmount · String

Current analyzer: detected sell limit in raw token units. Legacy simulations used decimal-adjusted token units. Null when a limit was not recorded; this does not prove unrestricted selling.

​

Used By

Returned by

• getSimulateTokenContractResults: Returns recorded token analyses, including pending and failed requests. Results are ordered by block number descending, then request timestamp descending. Use simulationId to retrieve a specific request.
• onSimulateTokenContract: Live-streamed published analysis results for a token, across all simulation IDs. This is not a complete request-status stream: use getSimulateTokenContractResults to check pending, failed or indeterminate outcomes.