types

type AddrAmt ¶ added in v0.14.0

type AddrAmt struct {
	Token  common.Address
	Amount *big.Int
}

AddrAmt represents a token address and amount pair, with the amount being optional. If amount is nil or zero, quote response should inform the amount.

func (u AddrAmt) MarshalJSON() ([]byte, error)

func (u *AddrAmt) UnmarshalJSON(bz []byte) error

type Call ¶ added in v0.14.0

type Call solvernet.Call

Call wraps solvernet.Call to provide custom json marshaling.

func CallsFromBindings(calls []bindings.SolverNetCall) []Call

func (c Call) MarshalJSON() ([]byte, error)

func (c *Call) UnmarshalJSON(bz []byte) error

type CheckRequest ¶ added in v0.13.0

type CheckRequest struct {
	SourceChainID      uint64    `json:"sourceChainId"`
	DestinationChainID uint64    `json:"destChainId"`
	FillDeadline       uint32    `json:"fillDeadline"`
	Calls              []Call    `json:"calls"`
	Expenses           []Expense `json:"expenses"`
	Deposit            AddrAmt   `json:"deposit"`
}

CheckRequest is the expected request body for the /api/v1/check endpoint.

NOTE: Check request / response types mirror SolvertNet.OrderData, built specifically for EVM -> EVM orders via SolverNetInbox / Outbox contracts, with ERC7683 type hash matching SolverNetInbox.ORDERDATA_TYPEHASH.

To support multiple order types with this api (e.g. EVM -> Solana, Solana -> EVM) we'd need a more generic request / response format that discriminates on order type hash.

func CheckRequestFromOrderData(srcChainID uint64, data bindings.SolverNetOrderData) (CheckRequest, error)

type CheckResponse ¶ added in v0.13.0

type CheckResponse struct {
	Accepted          bool         `json:"accepted"`
	Rejected          bool         `json:"rejected"`
	RejectCode        RejectReason `json:"rejectCode"`
	RejectReason      string       `json:"rejectReason"`
	RejectDescription string       `json:"rejectDescription"`
}

CheckResponse is the response json for the /check endpoint.

type ContractsResponse ¶ added in v0.13.0

type ContractsResponse struct {
	Portal    common.Address `json:"portal"`
	Inbox     common.Address `json:"inbox"`
	Outbox    common.Address `json:"outbox"`
	Middleman common.Address `json:"middleman"`
	Executor  common.Address `json:"executor"`
}

ContractsResponse is the response json for the /api/vi/contracts endpoint.

type Expense ¶ added in v0.14.0

type Expense solvernet.Expense

Expense wraps solvernet.Expense to provide custom json marshaling.

func ExpensesFromBindings(expenses []solvernet.Expense) []Expense

func (e Expense) MarshalJSON() ([]byte, error)

func (e *Expense) UnmarshalJSON(bz []byte) error

type JSONError ¶ added in v0.14.0

type JSONError struct {
	Code    int    `json:"code"`
	Status  string `json:"status"`
	Message string `json:"message"`
}

type JSONErrorResponse ¶ added in v0.13.0

type JSONErrorResponse struct {
	Error JSONError `json:"error"`
}

JSONErrorResponse is a json response for http errors (e.g 4xx, 5xx), not used for rejections.

type Price ¶ added in v0.15.0

type Price struct {
	Price   *big.Rat
	Deposit tokens.Asset
	Expense tokens.Asset
}

Price represents the canonical solver price. It is 1 unit of deposit token denominated in expense tokens. A valid price is always > 0.

Given a price of 800 OMNI/ETH, when depositing 1 ETH the expense amount is 800 OMNI.

expense amount = deposit amount * price
deposit amount = expense amount / price

func (p Price) F64() float64

func (p Price) FormatF64() string

func (p Price) FormatPair() string

func (p Price) Inverse() Price

func (p Price) MarshalJSON() ([]byte, error)

func (p Price) String() string

func (p Price) ToDeposit(expenseAmount *big.Int) *big.Int

func (p Price) ToExpense(depositAmount *big.Int) *big.Int

func (p *Price) UnmarshalJSON(data []byte) error

func (p Price) WithFeeBips(fee int64) Price

type PriceRequest ¶ added in v0.15.0

type PriceRequest struct {
	SourceChainID      uint64         `json:"sourceChainId"`
	DestinationChainID uint64         `json:"destChainId"`
	DepositToken       common.Address `json:"depositToken"`
	ExpenseToken       common.Address `json:"expenseToken"`
}

type QuoteRequest ¶ added in v0.13.0

type QuoteRequest struct {
	SourceChainID      uint64  `json:"sourceChainId"`
	DestinationChainID uint64  `json:"destChainId"`
	Deposit            AddrAmt `json:"deposit"`
	Expense            AddrAmt `json:"expense"`
}

QuoteRequest is the expected request body for the /api/v1/quote endpoint. If deposit amount is omitted, the response will include the required deposit amount. If expense amount is omitted, the response will include the required expense amount.

type QuoteResponse ¶ added in v0.13.0

type QuoteResponse struct {
	Deposit           AddrAmt      `json:"deposit"`
	Expense           AddrAmt      `json:"expense"`
	Rejected          bool         `json:"rejected"`
	RejectCode        RejectReason `json:"rejectCode"`
	RejectReason      string       `json:"rejectReason"`
	RejectDescription string       `json:"rejectDescription"`
}

QuoteResponse is the response json for the /api/v1/quote endpoint.

type RejectReason ¶ added in v0.13.0

type RejectReason uint8

const (
	RejectNone                  RejectReason = 0
	RejectDestCallReverts       RejectReason = 1
	RejectInvalidDeposit        RejectReason = 2
	RejectInvalidExpense        RejectReason = 3
	RejectInsufficientDeposit   RejectReason = 4
	RejectInsufficientInventory RejectReason = 5
	RejectUnsupportedDeposit    RejectReason = 6
	RejectUnsupportedExpense    RejectReason = 7
	RejectUnsupportedDestChain  RejectReason = 8
	RejectUnsupportedSrcChain   RejectReason = 9
	RejectSameChain             RejectReason = 10
	RejectExpenseOverMax        RejectReason = 11
	RejectExpenseUnderMin       RejectReason = 12
	RejectCallNotAllowed        RejectReason = 13
)

func (i RejectReason) String() string

type TokenResponse ¶ added in v0.15.0

type TokenResponse struct {
	Enabled    bool           `json:"enabled"`
	Name       string         `json:"name"`
	Symbol     string         `json:"symbol"`
	ChainID    uint64         `json:"chainId"`
	Address    common.Address `json:"address"`
	Decimals   uint           `json:"decimals"`
	ExpenseMin *hexutil.Big   `json:"expenseMin"`
	ExpenseMax *hexutil.Big   `json:"expenseMax"`
}

type TokensResponse ¶ added in v0.15.0

type TokensResponse struct {
	Tokens []TokenResponse `json:"tokens"`
}