Module models

Module models 

Source

Macrosยง

hex_id ๐Ÿ”’
Like newtype_id! but adds IntoValidId with hex validation for &str/String, and a passthrough for the type itself. Keeps infallible From for internal/serde use.
newtype_id ๐Ÿ”’

Structsยง

AccountResponse
Account response from GET /v1/accounts.
AggregatedAssetInfo
Asset metadata from GET /v1/aggregated/assets.
AggregatedOrderbook
Aggregated orderbook from GET /v1/aggregated/orderbook.
AggregatedTickerData
Aggregated ticker value from GET /v1/aggregated/ticker.
AggregatedTrade
Trade from GET /v1/aggregated/trades.
AssetId
A hex asset ID.
BalanceEntry
WebSocket balance entry.
BalanceResponse
Balance response from GET /v1/balance.
BalanceUpdate
WebSocket balance update.
Bar
OHLCV bar/candle data.
CancelOrderAction
A CancelOrder action payload.
CoingeckoAggregatedOrderbook
CoinGecko aggregated orderbook from GET /v1/aggregated/coingecko/orderbook.
ContractId
A hex contract ID.
CreateAccountResponse
Response from POST /v1/accounts (create account).
CreateOrderAction
A CreateOrder action payload.
DepthLevel
A single depth level (price + quantity).
DepthSnapshot
Depth snapshot from GET /v1/depth or WebSocket subscribe_depth.
DepthUpdate
Depth update from WebSocket subscribe_depth_update.
FaucetResponse
Response from faucet mint.
Market
A trading market.
MarketActions ๐Ÿ”’
A market-grouped set of actions.
MarketAsset
Asset info within a market.
MarketId
A hex market ID.
MarketSummary
Market summary from GET /v1/markets/summary.
MarketSymbol
A market symbol pair like โ€œFUEL/USDCโ€.
MarketTicker
Market ticker from GET /v1/markets/ticker.
MarketsResponse
Top-level response from GET /v1/markets.
NonceUpdate
WebSocket nonce update.
Order
An order from the API.
OrderBookBalance
Order book balance entry.
OrderId
A hex order ID.
OrderUpdate
WebSocket order update.
OrdersResponse
Response from GET /v1/orders.
PairSummary
Pair summary from GET /v1/aggregated/summary.
PairTicker
Pair ticker from GET /v1/aggregated/coingecko/tickers.
Price
A market-bound human-readable order price.
Quantity
A market-bound human-readable order quantity.
ReferralInfo
Response from GET /analytics/v1/referral/code-info.
Session
Local session state tracked by the client.
SessionActionsRequest ๐Ÿ”’
Request body for POST /v1/session/actions.
SessionActionsResponse
Response from POST /v1/session/actions.
SessionInfo
Session info within an account response.
SessionRequest
Request body for PUT /v1/session.
SessionResponse
Response from PUT /v1/session.
SettleBalanceAction
A SettleBalance action payload.
Trade
A trade from the API.
TradeAccount
Trading account info from GET /v1/accounts.
TradeAccountId
A hex trade account ID.
TradeId
A trade identifier.
TradeUpdate
WebSocket trade update.
TradesResponse
Response from GET /v1/trades.
TxId
A hex transaction ID.
TxResult
Transaction result for simple operations (cancel, settle).
WhitelistRequest
Request body for POST /analytics/v1/whitelist.
WhitelistResponse
Response from POST /analytics/v1/whitelist.
WithdrawRequest
Request body for POST /v1/accounts/withdraw.
WithdrawResponse
Response from POST /v1/accounts/withdraw.
WsMessage
Generic WebSocket message for initial parsing.

Enumsยง

Action
High-level action for use with batch_actions.
ActionItem
A single action in the actions request.
Identity
A Fuel Identity โ€” either an Address or a ContractId.
OrderPriceInput
Flexible input accepted by O2Client::create_order for price values.
OrderQuantityInput
Flexible input accepted by O2Client::create_order for quantity values.
OrderType
High-level order type with associated data.
Side
Order side: Buy or Sell.
Signature
A signature wrapper.
TraderSide
The querying accountโ€™s role in a trade.

Traitsยง

IntoMarketSymbol
Converts input into a validated, normalized MarketSymbol.
IntoValidId
Trait for types that can be validated and converted into a hex ID newtype. Implemented by &str, String (with hex validation) and the ID type itself (passthrough).

Functionsยง

deserialize_optional_f64 ๐Ÿ”’
Deserialize an optional value that may be a JSON number or a string, storing as f64.
deserialize_optional_u64 ๐Ÿ”’
Deserialize an optional value that may be a JSON number or a string, storing as u64.
deserialize_string_or_f64 ๐Ÿ”’
Deserialize a value that may be a JSON number or a string containing an f64.
deserialize_string_or_u64 ๐Ÿ”’
Deserialize a value that may be a JSON number or a string containing a number.
deserialize_string_or_u128 ๐Ÿ”’
Deserialize a value that may be a JSON number or a string containing a u128.
normalize_hex_prefixed ๐Ÿ”’
validate_hex ๐Ÿ”’

Type Aliasesยง

AggregatedAssets
Symbol-keyed assets map from GET /v1/aggregated/assets.
AggregatedTicker
Pair-keyed map from GET /v1/aggregated/ticker.