model

Documentation

Index

• type GetContractsResponse
• type GetQuoteResponse
  • func QuoteResponseFromDbQuote(dbQuote *db.Quote) *GetQuoteResponse
• type GetQuoteSpecificRequest
• type PutAckRequest
• type PutBulkQuotesRequest
• type PutQuoteRequest
• type PutRelayAckResponse

Types

type GetContractsResponse

type GetContractsResponse struct {
	// Contracts is a map of chain id to contract address
	Contracts map[uint32]string `json:"contracts"`
}

GetContractsResponse contains the schema for a GET /contract response.

type GetQuoteResponse

type GetQuoteResponse struct {
	// OriginChainID is the chain which the relayer is willing to relay from
	OriginChainID int `json:"origin_chain_id"`
	// OriginTokenAddr is the token address for which the relayer willing to relay from
	OriginTokenAddr string `json:"origin_token_addr"`
	// DestChainID is the chain which the relayer is willing to relay to
	DestChainID int `json:"dest_chain_id"`
	// DestToken is the token address for which the relayer willing to relay to
	DestTokenAddr string `json:"dest_token_addr"`
	// DestAmount is the max amount of liquidity which exists for a given destination token, provided in the destination token decimals
	DestAmount string `json:"dest_amount"`
	// MaxOriginAmount is the maximum amount of origin tokens bridgeable
	MaxOriginAmount string `json:"max_origin_amount"`
	// FixedFee is the fixed fee for the quote, provided in the destination token terms
	FixedFee string `json:"fixed_fee"`
	// Address of the relayer providing the quote
	RelayerAddr string `json:"relayer_addr"`
	// OriginFastBridgeAddress is the address of the fast bridge contract on the origin chain
	OriginFastBridgeAddress string `json:"origin_fast_bridge_address"`
	// DestFastBridgeAddress is the address of the fast bridge contract on the destination chain
	DestFastBridgeAddress string `json:"dest_fast_bridge_address"`
	// UpdatedAt is the time that the quote was last upserted
	UpdatedAt string `json:"updated_at"`
}

GetQuoteResponse contains the schema for a GET /quote response.

func QuoteResponseFromDbQuote

func QuoteResponseFromDbQuote(dbQuote *db.Quote) *GetQuoteResponse

QuoteResponseFromDbQuote converts a db.Quote to a GetQuoteResponse.

type GetQuoteSpecificRequest

type GetQuoteSpecificRequest struct {
	OriginChainID   int    `json:"originChainId"`
	OriginTokenAddr string `json:"originTokenAddr"`
	DestChainID     int    `json:"destChainId"`
	DestTokenAddr   string `json:"destTokenAddr"`
}

GetQuoteSpecificRequest contains the schema for a GET /quote request with specific params.

type PutAckRequest

type PutAckRequest struct {
	TxID        string `json:"tx_id"`
	DestChainID int    `json:"dest_chain_id"`
}

PutAckRequest contains the schema for a PUT /ack request.

type PutBulkQuotesRequest

type PutBulkQuotesRequest struct {
	Quotes []PutQuoteRequest `json:"quotes"`
}

PutBulkQuotesRequest contains the schema for a PUT /quote request.

type PutQuoteRequest

type PutQuoteRequest struct {
	OriginChainID           int    `json:"origin_chain_id"`
	OriginTokenAddr         string `json:"origin_token_addr"`
	DestChainID             int    `json:"dest_chain_id"`
	DestTokenAddr           string `json:"dest_token_addr"`
	DestAmount              string `json:"dest_amount"`
	MaxOriginAmount         string `json:"max_origin_amount"`
	FixedFee                string `json:"fixed_fee"`
	OriginFastBridgeAddress string `json:"origin_fast_bridge_address"`
	DestFastBridgeAddress   string `json:"dest_fast_bridge_address"`
}

PutQuoteRequest contains the schema for a PUT /quote request.

type PutRelayAckResponse

type PutRelayAckResponse struct {
	// TxID is the transaction ID
	TransactionID string `json:"tx_id"`
	// ShouldRelay is a boolean indicating whether the transaction should be relayed
	ShouldRelay bool `json:"should_relay"`
	// RelayerAddress is the address of the relayer that is currently acked
	RelayerAddress string `json:"relayer_address"`
}

PutRelayAckResponse contains the schema for a PUT /relay/ack response.