Valantis Documentation
Valantis Website
  • Welcome to Valantis
  • Sovereign Pool
    • The Modules
      • Pool Manager
      • Liquidity Module
      • Swap Fee Module
      • Verifier Module
      • Oracle Module
      • Sovereign Vault
        • Rebase token support
      • Gauge
    • Interacting with Pools
      • Swap Parameters
      • Swap Steps
      • Multi Token Support
      • Deposit Liquidity
      • Withdraw Liquidity
      • Flash Loans
  • Hybrid Order Type (HOT)
    • Understanding HOT: A Graphical Overview
    • HOT API
      • HTTP request parameters
      • HTTP request response
      • Reasoning for Request structure
      • Solver Integration
      • Market Maker integration
    • HOT Smart Contracts
      • Interfaces
      • State variables and roles
      • AMM
      • HOT Swap
      • AMM Swap
      • Hybrid Order Type (HOT) struct parameters
      • Alternating Nonce Bitmap
      • Deposits
      • Withdrawals
      • Deployment Assumptions
    • Liquidity Manager Docs
      • Reference Oracle
      • Deposit
      • Withdraw
      • Signature
    • Swap
      • Swap Context
      • AMM Swap
      • HOT Swap
      • HOT Quote Parameters
        • Bitmap Nonce Instructions
    • Solver Docs
      • Solver Request
      • Simple HOT Swap Example
      • Partial Fill HOT Swap Example
    • Risks and Trust Assumptions
      • Roles
        • Sovereign Pool Manager
        • HOT Manager
        • HOT Signer
        • Liquidity Provider
      • Threats
        • Deposit Sandwich
        • Malicious Price Bound
        • Malicious Signer
        • Mispriced HOT Quote
  • Validly
    • Understanding Validly
    • Swap
    • Deposits and Withdrawals
    • Deployments
  • Stake Exchange (stHYPE AMM)
    • Swap
      • Instant Withdrawals (LST -> Native Token)
      • New Stake (Native Token -> LST)
    • LP Positions
      • LP Withdrawals Instant
      • LP Withdrawal Queued
    • Ratio Fee
    • Lending of Reserves
    • Smart contracts
      • STEXAMM.sol
      • StHYPEWithdrawalModule.sol
      • StexRatioSwapFeeModule.sol
      • DepositWrapper.sol
      • AaveLendingModule.sol
    • Risks and Trust Assumptions
    • Integration examples
  • Deploy and Build
  • Resources
    • Audits
    • Links
    • Get HYPE on HyperEVM
Powered by GitBook
On this page

Was this helpful?

  1. Hybrid Order Type (HOT)
  2. HOT API

HTTP request parameters

Solvers send requests for HOT Quotes to the Valantis HOT API. A Solver’s request includes information about the current price they are getting at alternate venues, along with volume, and estimates about gas costs (optional).

The request parameters are described as follows:

{
  "authorized_recipient": "string",
  "authorized_sender": "string",
  "chain_id": 0,
  "token_in": "string",
  "token_out": "string",
  "expected_gas_price": "30",
  "expected_gas_units": "200000",
  "amount_in": "string",
  "amount_out_requested": "string",
  "request_expiry": 0,
  "quote_expiry": 0
}

authorized_recipient - the address to send tokenOut to.

authorized_sender - the authorized executor of the Signed Quote to be returned

chain_id - network chain ID

token_in - address of the input token

token_out - address of the output token

expected_gas_price - (Optional) the solver's gas price estimate in gwei. Note that it can also be in decimals, for example, "0.01" gwei.

expected_gas_units - (Optional) the solver's estimate of the amount of gas consumed by the venue they are replacing HOT swap with.

amount_in - input token amount being requested

amount_out_requested - minimum output token expected to receive. Note that the price that the solver is requesting for, is calculated as amount_in/amount_out_requested or amount_out_requested/amount_in depending upon the direction of the swap. Exception: If 0 is passed, the HTTP request will still work and the response will return the default price that the Liquidity Manager can offer (similar to RFQ APIs).

request_expiry - Unix timestamp in seconds after which the HTTPS request times out and the request is considered expired.

quote_expiry - Unix timestamp in seconds after which the signed HOT quote expires and is rejected by the pool. Note: quote_expiry gets capped at a maximum value, in order to ensure that excessively delayed HOT AMM price updates are not applied.

Liquidity Managers analyze incoming requests and construct Signed Quotes which match or beat the price a Solver currently has. The Liquidity Manager attaches an AMM state update to the requests they choose to fulfil.

PreviousHOT APINextHTTP request response

Last updated 9 months ago

Was this helpful?