trailsapi

type AbortIntentRequest struct {
	// intentId is the ID of the intent which has been aborted
	IntentID prototyp.Hash `json:"intentId"`
	// chainId is required to specify which chain the transaction was aborted
	ChainID uint64 `json:"chainId"`
	// abortTransactionHash is the transaction hash of the abort transaction
	// submitted by the user which we validate before updating status
	AbortTransactionHash prototyp.Hash `json:"abortTransactionHash"`
}

type AbortIntentResponse struct {
	IntentID prototyp.Hash `json:"intentId"`
	Status   IntentStatus  `json:"status"`
}

type BigInt big.Int

type CCTPTransfer struct {
	ID                 uint64             `json:"id" db:"id,omitempty"`
	IntentID           prototyp.Hash      `json:"intentId" db:"intent_id"`
	OriginChainID      uint64             `json:"originChainId" db:"orig_chain_id"`
	DestinationChainID uint64             `json:"destinationChainId" db:"dest_chain_id"`
	OriginTxnID        uint64             `json:"originTxnId" db:"orig_txn_id"`
	OriginTxnHash      prototyp.Hash      `json:"originTxnHash" db:"orig_txn_hash"`
	DestinationTxnID   uint64             `json:"destinationTxnId" db:"dest_txn_id"`
	Message            prototyp.Hash      `json:"message" db:"message,omitempty"`
	Attestation        prototyp.Hash      `json:"attestation" db:"attestation,omitempty"`
	Status             CCTPTransferStatus `json:"status" db:"status"`
	StatusReason       *string            `json:"statusReason" db:"status_reason,omitempty"`
	CreatedAt          time.Time          `json:"createdAt" db:"created_at,omitempty"`
	UpdatedAt          time.Time          `json:"updatedAt" db:"updated_at,omitempty"`
}

type CCTPTransferStatus uint8

type ChainGasUsageStatus string

type ChainInfo struct {
	// id is the chain id
	ID uint64 `json:"id"`
	// id is the chain full name
	Name string `json:"name"`
	// tokenName/Symbol/Decimals are the native currency details
	TokenName     string `json:"tokenName"`
	TokenSymbol   string `json:"tokenSymbol"`
	TokenDecimals uint8  `json:"tokenDecimals"`
	// is testnet flag informs whether the chain is a testnet
	IsTestnet bool `json:"isTestnet"`
	// supportsBridging indicates whether the chain supports bridging operations
	SupportsBridging bool `json:"supportsBridging"`
	// additional metadata
	LogoURI          string `json:"logoUri"`
	BlockExplorerURL string `json:"blockExplorerUrl"`
}

type ChainMetadata struct {
	ChainID uint64 `json:"chainId"`
	Name    string `json:"name"`
	LogoURI string `json:"logoUri,omitempty"`
	Testnet *bool  `json:"testnet,omitempty"`
}

type CommitIntentRequest struct {
	Intent *Intent `json:"intent"`
}

type CommitIntentResponse struct {
	IntentID prototyp.Hash `json:"intentId"`
}

type DepositIntentEntry struct {
	// EIP-712 TrailsIntent signature (hex)
	IntentSignature prototyp.Hash `json:"intentSignature"`
	// EIP-2612 permit signature (hex, if approval needed)
	PermitSignature *prototyp.Hash `json:"permitSignature"`
	// Permit expiration timestamp
	PermitDeadline *uint64 `json:"permitDeadline"`
	// Permit amount (usually max uint256)
	PermitAmount prototyp.BigInt `json:"permitAmount"`
	// Fee amount in deposit token
	FeeAmount prototyp.BigInt `json:"feeAmount"`
	// Fee token address (same as deposit token)
	FeeToken prototyp.Hash `json:"feeToken"`
	// Address that receives the fee
	FeeCollector prototyp.Hash `json:"feeCollector"`
	// User nonce from Intent Entrypoint contract (provided by client)
	UserNonce uint64 `json:"userNonce"`
	// Intent deadline timestamp
	Deadline uint64 `json:"deadline"`
}

type DepositSignature struct {
	// Required: EIP-712 TrailsIntent signature (hex)
	IntentSignature prototyp.Hash `json:"intentSignature"`
	// Optional: EIP-2612 permit signature (hex, if token approval needed)
	PermitSignature *prototyp.Hash `json:"permitSignature"`
	// Optional: Permit expiration timestamp
	PermitDeadline *uint64 `json:"permitDeadline"`
	// Optional: Permit amount (usually max uint256)
	PermitAmount prototyp.BigInt `json:"permitAmount"`
	// Required: Selected fee option from gasFeeOptions
	SelectedGasFeeOption *FeeOption `json:"selectedGasFeeOption"`
	// Required: User nonce from Intent Entrypoint contract (fetched fresh at execute time)
	UserNonce uint64 `json:"userNonce"`
	// Required: Intent deadline timestamp
	Deadline uint64 `json:"deadline"`
}

type DepositTransaction struct {
	// toAddress is the origin intent address where the deposit is sent to.
	ToAddress prototyp.Hash `json:"toAddress"`
	// tokenAddress is the token being deposited.
	TokenAddress prototyp.Hash `json:"tokenAddress"`
	// decimals is the number of decimals for the token. If the value is null, it
	// means we were unable to retrieve the decimals for the token.
	Decimals *uint8 `json:"decimals"`
	// amount is the token amount being deposited.
	Amount prototyp.BigInt `json:"amount"`
}

type ExecuteIntentRequest struct {
	IntentID prototyp.Hash `json:"intentId"`
	// Traditional deposit: provide transaction hash
	DepositTransactionHash prototyp.Hash `json:"depositTransactionHash"`
	// Gasless deposit: provide signatures (mutually exclusive with depositTransactionHash)
	DepositSignature *DepositSignature `json:"depositSignature"`
}

type ExecuteIntentResponse struct {
	IntentID     prototyp.Hash `json:"intentId"`
	IntentStatus IntentStatus  `json:"intentStatus"`
}

type FeeOption struct {
	// if value is 0x000...000 or 0xeee...eeee, it is native token
	TokenAddress        prototyp.Hash   `json:"tokenAddress"`
	TokenSymbol         string          `json:"tokenSymbol"`
	TokenDecimals       uint8           `json:"tokenDecimals"`
	Amount              prototyp.BigInt `json:"amount"`
	AmountUSD           float64         `json:"amountUsd"`
	FeeCollectorAddress prototyp.Hash   `json:"feeCollectorAddress"`
	// - isNative: bool
	// - supportsPermit: bool
	Is2612 bool `json:"is2612"`
}

type GasEstimate struct {
	TotalGas      uint64  `json:"totalGas"`
	GasPrice      string  `json:"gasPrice"`
	NativeCost    string  `json:"nativeCost"`
	NativeCostUSD float64 `json:"nativeCostUsd"`
}

type GasFeeOptions struct {
	GasEstimate         *GasEstimate  `json:"gasEstimate"`
	FeeOptions          []*FeeOption  `json:"feeOptions"`
	ExpiresAt           time.Time     `json:"expiresAt"`
	FeeCollectorAddress prototyp.Hash `json:"feeCollectorAddress"`
}

type GetChainsRequest struct {
	// TODO: use enum eventually..
	RouteProvider *string `json:"routeProvider"`
}

type GetChainsResponse struct {
	Chains []*ChainInfo `json:"chains"`
}

type GetExactInputRoutesRequest struct {
	OriginChainID      uint64        `json:"originChainId"`
	OriginTokenAddress prototyp.Hash `json:"originTokenAddress"`
	// optionally passed to filter results
	DestinationChainID      *uint64       `json:"destinationChainId"`
	DestinationTokenAddress prototyp.Hash `json:"destinationTokenAddress"`
}

type GetExactInputRoutesResponse struct {
	Tokens []*TokenInfo `json:"tokens"`
}

type GetExactOutputRoutesRequest struct {
	DestinationChainID      uint64        `json:"destinationChainId"`
	DestinationTokenAddress prototyp.Hash `json:"destinationTokenAddress"`
	// optionally passed to filter results to only tokens from this origin chain
	OriginChainID *uint64 `json:"originChainId"`
	// optionally passed to filter results to only this specific origin token
	OriginTokenAddress prototyp.Hash `json:"originTokenAddress"`
	// owner address is used to filter tokens the owner has a balance on.
	//
	// if unspecified, then we filter origin tokens based on popular options
	// as is useful for a qr code deposit flow.
	OwnerAddress prototyp.Hash `json:"ownerAddress"`
}

type GetExactOutputRoutesResponse struct {
	Tokens []*TokenInfo `json:"tokens"`
}

type GetIntentHistoryRequest struct {
	// cursor paging parameters
	Page *Page `json:"page"`
	// optional project id scope filter
	ByProjectID    uint64        `json:"byProjectId"`
	ByOwnerAddress prototyp.Hash `json:"byOwnerAddress"`
}

type GetIntentHistoryResponse struct {
	Intents  []*IntentHistory `json:"intents"`
	NextPage *Page            `json:"nextPage"`
}

type GetIntentReceiptRequest struct {
	IntentID prototyp.Hash `json:"intentId"`
}

type GetIntentReceiptResponse struct {
	IntentReceipt *IntentReceipt `json:"intentReceipt"`
}

type GetIntentRequest struct {
	IntentID prototyp.Hash `json:"intentId"`
}

type GetIntentResponse struct {
	Intent *Intent `json:"intent"`
}

type GetIntentTransactionHistoryRequest struct {
	// cursor paging parameters
	Page *Page `json:"page"`
	// optional project id scope filter
	ByProjectID    uint64        `json:"byProjectId"`
	ByOwnerAddress prototyp.Hash `json:"byOwnerAddress"`
}

type GetIntentTransactionHistoryResponse struct {
	Intents  []*IntentSummary `json:"intents"`
	NextPage *Page            `json:"nextPage"`
}

type GetTokenListRequest struct {
	// chainIds is required to specify which chains to get featured tokens for
	ChainIDs []uint64 `json:"chainIds"`
	// optional search query string to search token name/symbol/address.
	// when searching lists, all of the lists will be used in the search automatically.
	SearchQuery string `json:"searchQuery"`
	// optional limit to return per chain, ie. like the top N number of tokens
	// sorted by featured then alphabetically by name.
	Limit int32 `json:"limit"`
	// optional token address to filter results to a specific token, useful for checking
	// if tokenAddress filter is used, the entire token list is searched for the token
	TokenAddress prototyp.Hash `json:"tokenAddress"`
	// optional filter to include all tokens in response, not just featured
	// by default, only featured tokens are returned.
	IncludeAllListed bool `json:"includeAllListed"`
	// optional filter to include external tokens in response, in addition to listed/featured
	// by default, external tokens are not returned.
	IncludeExternal bool `json:"includeExternal"`
	// optional filter to exlude specific token addresses from the response
	ExcludeTokens []prototyp.Hash `json:"excludeTokens"`
}

type GetTokenListResponse struct {
	Tokens []*TokenInfo `json:"tokens"`
}

type GetTokenPricesRequest struct {
	Tokens []*Token `json:"tokens"`
}

type GetTokenPricesResponse struct {
	TokenPrices []*TokenPrice `json:"tokenPrices"`
}

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type Intent struct {
	// id is an internal-only sequential primary key.
	ID uint64 `json:"-" db:"id,omitempty"`
	// Trails/Sequence project id intent originated from
	ProjectID uint64 `json:"-" db:"project_id"`
	// intentId is a deterministic public intent identifier
	// based on the hash of the origin and destination intent addresses.
	IntentID prototyp.Hash `json:"intentId" db:"intent_id"`
	// intent status of different stages of the intent to keep track.
	// note: we also track status in IntentReceipt for execution status.
	Status       IntentStatus        `json:"status" db:"status,omitempty"`
	QuoteRequest *QuoteIntentRequest `json:"quoteRequest" db:"quote_request"`
	// intent owner / main signer
	OwnerAddress             prototyp.Hash            `json:"ownerAddress" db:"owner_address"`
	OriginChainID            uint64                   `json:"originChainId" db:"orig_chain_id"`
	DestinationChainID       uint64                   `json:"destinationChainId" db:"dest_chain_id"`
	OriginIntentAddress      prototyp.Hash            `json:"originIntentAddress" db:"orig_intent_address"`
	DestinationIntentAddress *prototyp.Hash           `json:"destinationIntentAddress,omitempty" db:"dest_intent_address,omitempty"`
	Salt                     prototyp.BigInt          `json:"salt" db:"salt"`
	DepositTransaction       *DepositTransaction      `json:"depositTransaction" db:"deposit_txn"`
	OriginCalls              *IntentCalls             `json:"originCalls" db:"orig_calls"`
	DestinationCalls         *IntentCalls             `json:"destinationCalls" db:"dest_calls,omitempty"`
	OriginPrecondition       *TransactionPrecondition `json:"originPrecondition" db:"orig_precondition"`
	DestinationPrecondition  *TransactionPrecondition `json:"destinationPrecondition" db:"dest_precondition,omitempty"`
	OriginMetaTxn            *MetaTxn                 `json:"originMetaTxn" db:"orig_meta_txn"`
	DestinationMetaTxn       *MetaTxn                 `json:"destinationMetaTxn" db:"dest_meta_txn,omitempty"`
	Quote                    *IntentProviderQuote     `json:"quote" db:"quote"`
	Fees                     *IntentFees              `json:"fees" db:"fees"`
	TrailsVersion            string                   `json:"trailsVersion" db:"trails_version"`
	TrailsContracts          *TrailsContracts         `json:"trailsContracts" db:"trails_contracts"`
	ExpiresAt                time.Time                `json:"expiresAt" db:"expires_at"`
	UpdatedAt                *time.Time               `json:"updatedAt,omitempty" db:"updated_at,omitempty"`
	CreatedAt                *time.Time               `json:"createdAt,omitempty" db:"created_at,omitempty"`
}

type IntentCalls struct {
	ChainID uint64             `json:"chainId"`
	Space   prototyp.BigInt    `json:"space"`
	Nonce   prototyp.BigInt    `json:"nonce"`
	Calls   []*TransactionCall `json:"calls"`
}

type IntentFees struct {
	// gas fees on origin and destination chains
	OriginGas      *IntentTransactionGasFee `json:"originGas"`
	DestinationGas *IntentTransactionGasFee `json:"destinationGas"`
	// provider fees (swap + bridge + trails)
	Provider *IntentProviderFees `json:"provider"`
	// total fees including provider fees + gas fees
	FeeTokenAddress prototyp.Hash   `json:"feeTokenAddress"`
	FeeTokenTotal   prototyp.BigInt `json:"feeTokenTotal"`
	TotalFeeAmount  prototyp.BigInt `json:"totalFeeAmount"`
	TotalFeeUSD     float64         `json:"totalFeeUsd"`
}

type IntentHistory struct {
	// intent deterministic id
	IntentID prototyp.Hash `json:"intentId"`
	// intent status from the 'intents' table
	Status IntentStatus `json:"status"`
	// intent creation and expiration timestamps
	ExpiresAt time.Time  `json:"expiresAt" db:"expires_at"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// intent receipt from the 'intent_receipts' table
	//
	// NOTE: we will always include a receipt, even if we don't have one
	// in the db, so we can return the receipt.summary
	Receipt *IntentReceipt `json:"receipt"`
}

type IntentProviderFees struct {
	// quote provider fee component (swap and/or bridge)
	QuoteProvider       string          `json:"quoteProvider"`
	QuoteProviderFee    prototyp.BigInt `json:"quoteProviderFee"`
	QuoteProviderFeeUSD float64         `json:"quoteProviderFeeUsd"`
	// trails provider fee component, denominated in the origin token
	TrailsFee    prototyp.BigInt `json:"trailsFee"`
	TrailsFeeUSD float64         `json:"trailsFeeUsd"`
	// total provider fees, aka, swap + bridge + trails fees
	TotalFeeAmount prototyp.BigInt `json:"totalFeeAmount"`
	TotalFeeUSD    float64         `json:"totalFeeUsd"`
}

type IntentProviderQuote struct {
	RouteProviders           []RouteProvider `json:"routeProviders"`
	RouteProvidersRequestIDs []string        `json:"routeProvidersRequestIds"`
	RouteProvidersFeeUSD     []float64       `json:"routeProvidersFeeUsd"`
	FromAmount               prototyp.BigInt `json:"fromAmount"`
	FromAmountMin            prototyp.BigInt `json:"fromAmountMin"`
	FromAmountUSD            float64         `json:"fromAmountUsd"`
	FromAmountMinUSD         float64         `json:"fromAmountMinUsd"`
	ToAmount                 prototyp.BigInt `json:"toAmount"`
	ToAmountMin              prototyp.BigInt `json:"toAmountMin"`
	ToAmountUSD              float64         `json:"toAmountUsd"`
	ToAmountMinUSD           float64         `json:"toAmountMinUsd"`
	MaxSlippage              float64         `json:"maxSlippage"`
	PriceImpact              float64         `json:"priceImpact"`
	PriceImpactUSD           float64         `json:"priceImpactUsd"`
}

type IntentReceipt struct {
	// id is an internal-only sequential primary key.
	ID uint64 `json:"-" db:"id,omitempty"`
	// Trails/Sequence project id intent originated from
	ProjectID uint64 `json:"-" db:"project_id"`
	// intent deterministic id
	IntentID prototyp.Hash `json:"intentId" db:"intent_id"`
	// intent execution status
	Status IntentStatus `json:"status" db:"status,omitempty"`
	// intent owner / main signer
	OwnerAddress prototyp.Hash `json:"ownerAddress" db:"owner_address"`
	// origin chain id where the intent originated from
	OriginChainID uint64 `json:"originChainId" db:"orig_chain_id"`
	// destination chain id where the intent is targetting as final execution
	DestinationChainID uint64 `json:"destinationChainId" db:"dest_chain_id"`
	// deposit transaction transaction is the user-initiated transfer into
	// the origin intent address on the origin chain.
	//
	// also note, that if a user is using the 'gasless' deposit method,
	// then they supply us with an 'intentEntry' signature, and then
	// we relay the deposit as a meta-transaction on their behalf to
	// the intent entrypoint contract.
	//
	// there will also be a deposit transaction to the origin intent address.
	DepositTransactionID uint64             `json:"-" db:"deposit_txn_id"`
	DepositTransaction   *IntentTransaction `json:"depositTransaction" db:"-"`
	// origin intent transaction db reference and runtime type
	OriginTransactionID uint64             `json:"-" db:"orig_txn_id"`
	OriginTransaction   *IntentTransaction `json:"originTransaction" db:"-"`
	// destination intent transaction db reference and runtime type
	// note: this may be null if the intent did not require a destination txn,
	// ie. simple swap on origin chain only with no destination calldata.
	DestinationTransactionID *uint64               `json:"-" db:"dest_txn_id,omitempty"`
	DestinationTransaction   *IntentTransaction    `json:"destinationTransaction" db:"-"`
	Summary                  *IntentReceiptSummary `json:"summary" db:"summary"`
	// timestamp when the intent receipt was updated, usually from status change
	UpdatedAt *time.Time `json:"updatedAt,omitempty" db:"updated_at,omitempty"`
	// timestamp of when the intent receipt was created
	CreatedAt *time.Time `json:"createdAt,omitempty" db:"created_at,omitempty"`
}

type IntentReceiptSummary struct {
	IntentID            prototyp.Hash   `json:"intentId"`
	Status              IntentStatus    `json:"status"`
	OwnerAddress        prototyp.Hash   `json:"ownerAddress"`
	OriginChainID       uint64          `json:"originChainId"`
	DestinationChainID  uint64          `json:"destinationChainId"`
	TradeType           TradeType       `json:"tradeType"`
	RouteProviders      []RouteProvider `json:"routeProviders"`
	OriginIntentAddress prototyp.Hash   `json:"originIntentAddress"`
	OriginTokenAddress  prototyp.Hash   `json:"originTokenAddress"`
	OriginTokenAmount   prototyp.BigInt `json:"originTokenAmount"`
	OriginTokenMetadata *TokenMetadata  `json:"originTokenMetadata"`
	// NOTE: we will always set this value, even if its to the origin intent address as the same value.
	DestinationIntentAddress prototyp.Hash `json:"destinationIntentAddress"`
	// NOTE: for destinationTokenAddress, destinationTokenAmount, destinationToAddress, and destinationTokenMetadata
	// are assigned at execution time for EXACT_INPUT and also if destinationHasCallData is true, as we only
	// know the values once the destination txn has been executed.
	DestinationTokenAddress  *prototyp.Hash   `json:"destinationTokenAddress"`
	DestinationTokenAmount   *prototyp.BigInt `json:"destinationTokenAmount"`
	DestinationToAddress     *prototyp.Hash   `json:"destinationToAddress"`
	DestinationTokenMetadata *TokenMetadata   `json:"destinationTokenMetadata"`
	DestinationHasCallData   bool             `json:"destinationHasCallData"`
	DestinationHasCallValue  bool             `json:"destinationHasCallValue"`
	// memo is just any additional context / note we wanted to share
	// when computing the summary.
	Memo *string `json:"memo"`
	// createdAt is the time the intent quote was created
	CreatedAt time.Time `json:"createdAt"`
	// expiresAt is the time the intent quote expires
	ExpiresAt time.Time `json:"expiresAt"`
	// startedAt is the time the intent execution started
	StartedAt *time.Time `json:"startedAt"`
	// finishedAt is the time the intent execution finished
	FinishedAt *time.Time `json:"finishedAt"`
}

type IntentStatus uint8

type IntentSummary struct {
	ID uint64 `json:"-"`
	// intent deterministic id
	IntentID prototyp.Hash `json:"intentId"`
	// intent status
	Status IntentStatus `json:"status"`
	// intent owner / main signer
	OwnerAddress prototyp.Hash `json:"ownerAddress"`
	// origin and destination chain ids
	OriginChainID uint64 `json:"originChainId"`
	// - originChainMetadata: ChainMetadata
	DestinationChainID uint64 `json:"destinationChainId"`
	// origin and destination intent addresses
	OriginIntentAddress      prototyp.Hash `json:"originIntentAddress"`
	DestinationIntentAddress prototyp.Hash `json:"destinationIntentAddress"`
	// deposit transfer transaction hash and status, which is the init
	// transfer from the owner / main signer into the origin intent
	// address on the origin chain id
	DepositTransactionHash   *prototyp.Hash    `json:"depositTransactionHash"`
	DepositTransactionStatus TransactionStatus `json:"depositTransactionStatus"`
	// origin and destination execution transaction hashes and statuses
	OriginTransactionHash        *prototyp.Hash    `json:"originTransactionHash"`
	OriginTransactionStatus      TransactionStatus `json:"originTransactionStatus"`
	DestinationTransactionHash   *prototyp.Hash    `json:"destinationTransactionHash"`
	DestinationTransactionStatus TransactionStatus `json:"destinationTransactionStatus"`
	OriginTokenAddress           prototyp.Hash     `json:"originTokenAddress"`
	OriginTokenAmount            prototyp.BigInt   `json:"originTokenAmount"`
	OriginTokenMetadata          *TokenMetadata    `json:"originTokenMetadata"`
	DestinationTokenAddress      prototyp.Hash     `json:"destinationTokenAddress"`
	DestinationTokenAmount       prototyp.BigInt   `json:"destinationTokenAmount"`
	DestinationTokenMetadata     *TokenMetadata    `json:"destinationTokenMetadata"`
	DestinationToAddress         prototyp.Hash     `json:"destinationToAddress,omitempty"`
	ExpiresAt                    time.Time         `json:"expiresAt" db:"expires_at"`
	// timestamp when the intent receipt was updated, usually from status change
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	// timestamp of when the intent receipt was created
	CreatedAt time.Time `json:"createdAt"`
}

type IntentTransaction struct {
	// Auto-incrementing id used for table pk
	ID uint64 `json:"-" db:"id,omitempty"`
	// we don't return it in the json, no need. its internal.
	// Intent id this transaction is associated with
	IntentID prototyp.Hash `json:"intentId" db:"intent_id"`
	// Status of this specific transaction
	Status       TransactionStatus `json:"status" db:"status"`
	StatusReason *string           `json:"statusReason" db:"status_reason"`
	// Chain where this transaction executes
	ChainID     uint64             `json:"chainId" db:"chain_id"`
	Type        TransactionType    `json:"type" db:"type"`
	Context     TransactionContext `json:"context" db:"context"`
	FromAddress prototyp.Hash      `json:"fromAddress" db:"from_address"`
	// ie. originIntentAddress, TrailsRouter, or TrailsIntentEntrypoint
	ToAddress prototyp.Hash `json:"toAddress" db:"to_address"`
	// Token being transferred in this transaction
	TokenAddress prototyp.Hash `json:"tokenAddress" db:"token_address"`
	// Amount transferred in this transaction
	TokenAmount prototyp.BigInt `json:"tokenAmount" db:"token_amount"`
	Calldata    prototyp.Hash   `json:"-" db:"calldata,omitempty"`
	// for user-sent deposit txn, this will be null
	MetaTxnID       prototyp.Hash            `json:"metaTxnId,omitempty" db:"meta_txn_id,omitempty"`
	MetaTxnFeeQuote *string                  `json:"metaTxnFeeQuote" db:"fee_quote,omitempty"`
	Precondition    *TransactionPrecondition `json:"precondition" db:"precondition,omitempty"`
	// Gasless deposit metadata (nullable)
	DepositIntentEntry *DepositIntentEntry `json:"depositIntentEntry" db:"deposit_intent_entry,omitempty"`
	// Transaction hash received from the relayer after it's mined.
	TxnHash prototyp.Hash `json:"txnHash,omitempty" db:"txn_hash,omitempty"`
	// On-chain block timestamp when txn was mined
	TxnMinedAt *time.Time `json:"txnMinedAt" db:"txn_mined_at,omitempty"`
	UpdatedAt  *time.Time `json:"updatedAt,omitempty" db:"updated_at,omitempty"`
	CreatedAt  *time.Time `json:"createdAt,omitempty" db:"created_at,omitempty"`
}

type IntentTransactionGasFee struct {
	ChainID             uint64              `json:"chainId"`
	TotalGasLimit       prototyp.BigInt     `json:"totalGasLimit"`
	GasPrice            prototyp.BigInt     `json:"gasPrice"`
	NativeTokenSymbol   string              `json:"nativeTokenSymbol"`
	NativeTokenPriceUSD *float64            `json:"nativeTokenPriceUsd"`
	ChainGasUsageStatus ChainGasUsageStatus `json:"chainGasUsageStatus"`
	TotalFeeAmount      prototyp.BigInt     `json:"totalFeeAmount"`
	TotalFeeUSD         float64             `json:"totalFeeUsd"`
	// sequence relayer gas fee quotes
	// AKA, meta transaction gas fee quotes for pre-sponsored
	MetaTxnFeeDetails *MetaTxnFeeDetails `json:"metaTxnFeeDetails"`
	// metaTxnGasQuote is like a voucher for gas sponsorship from the relayer
	MetaTxnGasQuote string `json:"metaTxnGasQuote"`
}

type MeldQuote struct {
	TransactionType              string  `json:"transactionType"`
	SourceAmount                 float64 `json:"sourceAmount"`
	SourceAmountWithoutFees      float64 `json:"sourceAmountWithoutFees"`
	FiatAmountWithoutFees        float64 `json:"fiatAmountWithoutFees"`
	DestinationAmountWithoutFees float64 `json:"destinationAmountWithoutFees,omitempty"`
	SourceCurrencyCode           string  `json:"sourceCurrencyCode"`
	CountryCode                  string  `json:"countryCode"`
	TotalFee                     float64 `json:"totalFee"`
	NetworkFee                   float64 `json:"networkFee"`
	TransactionFee               float64 `json:"transactionFee"`
	DestinationAmount            float64 `json:"destinationAmount"`
	DestinationCurrencyCode      string  `json:"destinationCurrencyCode"`
	ExchangeRate                 float64 `json:"exchangeRate"`
	PaymentMethodType            string  `json:"paymentMethodType"`
	CustomerScore                float64 `json:"customerScore"`
	ServiceProvider              string  `json:"serviceProvider"`
	InstitutionName              string  `json:"institutionName,omitempty"`
	LowKyc                       bool    `json:"lowKyc,omitempty"`
	PartnerFee                   float64 `json:"partnerFee"`
}

type MetaTxn struct {
	ID      string `json:"id"`
	ChainID uint64 `json:"chainId"`
	// fromAddress ...?
	WalletAddress string `json:"walletAddress"`
	// TODO: name it.. toAddress ?
	Contract string `json:"contract"`
	Input    string `json:"input"`
}

type MetaTxnFeeDetails struct {
	MetaTxnID         string          `json:"metaTxnId"`
	EstimatedGasLimit prototyp.BigInt `json:"estimatedGasLimit"`
	FeeNative         prototyp.BigInt `json:"feeNative"`
}

type Options struct {
	// JWTAuthToken is an optional JWT token to authenticate with the api service.
	JWTAuthToken string

	// ProjectAccessKey is an optional project access key to authenticate with the api service.
	// This may be required if no `JWTAuthToken` is provided.
	ProjectAccessKey string

	// TrailsAPIServiceURL is an optional custom URL for the Trails API service.
	// If not provided, the default URL in `DefaultAPIServiceURL` will be used.
	TrailsAPIServiceURL string

	// HTTPClient is an optional custom HTTP client to use for communicating with the
	// api service.
	HTTPClient HTTPClient
}

type Page struct {
	// Cursor: column to compare before/after to
	Column *string `json:"column,omitempty"`
	// Cursor: return column < before - include to get previous page
	Before *uint64 `json:"before,omitempty"`
	// Cursor: return column > after - include to get next page
	After *uint64 `json:"after,omitempty"`
	// Sorting filter
	Sort []*SortBy `json:"sort,omitempty"`
	// Number of items per page
	PageSize *uint32 `json:"pageSize,omitempty"`
	// Indicates if there are more results available
	More *bool `json:"more,omitempty"`
}

type QuoteIntentRequest struct {
	// intent owner, aka the user address processing the quote
	OwnerAddress prototyp.Hash `json:"ownerAddress"`
	// origin chain and token details
	OriginChainID      uint64        `json:"originChainId"`
	OriginTokenAddress prototyp.Hash `json:"originTokenAddress"`
	// destination chain, token, and execution details
	DestinationChainID      uint64           `json:"destinationChainId"`
	DestinationTokenAddress prototyp.Hash    `json:"destinationTokenAddress"`
	DestinationToAddress    prototyp.Hash    `json:"destinationToAddress"`
	DestinationCallData     *string          `json:"destinationCallData"`
	DestinationCallValue    *prototyp.BigInt `json:"destinationCallValue"`
	// originTokenAmount is used with EXACT_INPUT txns
	OriginTokenAmount *prototyp.BigInt `json:"originTokenAmount"`
	// destinationTokenAmount is used with EXACT_OUTPUT txns
	DestinationTokenAmount *prototyp.BigInt `json:"destinationTokenAmount"`
	// tradeType indicates whether the trade is an exact input or exact output trade.
	// EXACT_OUTPUT is the default if unspecified.
	TradeType *TradeType `json:"tradeType,omitempty"`
	// onlyNativeGasFee indicates that only the native gas fee (ie. eth)
	// option will be returned, even if the user has no balance.
	// this option is useful for smart wallets which have their own gas abstraction.
	OnlyNativeGasFee bool `json:"onlyNativeGasFee,omitempty"`
	// options for additional auxiliary params
	Options *QuoteIntentRequestOptions `json:"options,omitempty"`
}

type QuoteIntentRequestOptions struct {
	SwapProvider   RouteProvider `json:"swapProvider,omitempty"`
	BridgeProvider RouteProvider `json:"bridgeProvider,omitempty"`
	// slippageTolerance is a decimal amount, for example
	// 0.001 is 0.1% slippage tolerance. If not specified (null),
	// AUTO mode is used where optimal slippage is calculated dynamically based on transaction USD value + routing provider.
	SlippageTolerance      *float64                `json:"slippageTolerance,omitempty"`
	TrailsAddressOverrides *TrailsAddressOverrides `json:"trailsAddressOverrides,omitempty"`
}

type QuoteIntentResponse struct {
	Intent        *Intent        `json:"intent"`
	GasFeeOptions *GasFeeOptions `json:"gasFeeOptions"`
}

type RouteProvider string

type RuntimeStatus struct {
	// overall status, true/false
	HealthOK   bool             `json:"healthOK"`
	Version    string           `json:"version"`
	Branch     string           `json:"branch"`
	CommitHash string           `json:"commitHash"`
	StartTime  time.Time        `json:"startTime"`
	Uptime     string           `json:"uptime"`
	Hostname   string           `json:"hostname"`
	Runnables  interface{}      `json:"runnables"`
	Services   []*ServiceStatus `json:"services"`
}

type SearchIntentsRequest struct {
	ByIntentID                 prototyp.Hash `json:"byIntentId"`
	ByProjectID                uint64        `json:"byProjectId"`
	ByTransactionHash          prototyp.Hash `json:"byTransactionHash"`
	ByOwnerAddress             prototyp.Hash `json:"byOwnerAddress"`
	ByOriginIntentAddress      prototyp.Hash `json:"byOriginIntentAddress"`
	ByDestinationIntentAddress prototyp.Hash `json:"byDestinationIntentAddress"`
	ByQueryString              string        `json:"byQueryString"`
}

type SearchIntentsResponse struct {
	// NOTE: we intentionally do not return a page here, and limit it to 10 latest results
	Intents []*Intent `json:"intents"`
}

type ServiceStatus struct {
	Name    string `json:"name"`
	Healthy bool   `json:"healthy"`
	Error   string `json:"error,omitempty"`
	Latency string `json:"latency"`
}

type SortBy struct {
	Column string    `json:"column"`
	Order  SortOrder `json:"order"`
}

type SortOrder uint32

type Token struct {
	ChainID      uint64        `json:"chainId"`
	TokenAddress prototyp.Hash `json:"tokenAddress"`
	TokenSymbol  *string       `json:"tokenSymbol,omitempty"`
}

type TokenInfo struct {
	ChainID  uint64        `json:"chainId"`
	Address  prototyp.Hash `json:"address"`
	Name     string        `json:"name"`
	Symbol   string        `json:"symbol"`
	Decimals uint8         `json:"decimals"`
	// supportsBridging indicates whether the chain supports bridging operations
	SupportsBridging bool `json:"supportsBridging,omitempty"`
	// additional metadata
	LogoURI      string `json:"logoUri"`
	Featured     bool   `json:"featured"`
	FeatureIndex int    `json:"-"`
}

type TokenMetadata struct {
	ChainID      uint64        `json:"chainId"`
	TokenAddress prototyp.Hash `json:"tokenAddress"`
	Name         string        `json:"name"`
	Symbol       string        `json:"symbol"`
	Decimals     *uint8        `json:"decimals,omitempty"`
	LogoURI      string        `json:"logoUri,omitempty"`
}

type TokenPrice struct {
	Token    *Token   `json:"token"`
	PriceUSD *float64 `json:"priceUsd"`
	// - price?: float64
	// - currency: string
	UpdatedAt time.Time `json:"updatedAt"`
}

type TradeType string

type TrailsAddressOverrides struct {
	SequenceWalletFactoryAddress              *string `json:"sequenceWalletFactoryAddress"`
	SequenceWalletMainModuleAddress           *string `json:"sequenceWalletMainModuleAddress"`
	SequenceWalletMainModuleUpgradableAddress *string `json:"sequenceWalletMainModuleUpgradableAddress"`
	SequenceWalletGuestModuleAddress          *string `json:"sequenceWalletGuestModuleAddress"`
	SequenceWalletUtilsAddress                *string `json:"sequenceWalletUtilsAddress"`
}

type TrailsClient interface {
	Ping(ctx context.Context) (string, error)
	RuntimeStatus(ctx context.Context) (*RuntimeStatus, error)
	Clock(ctx context.Context) (time.Time, error)
	QuoteIntent(ctx context.Context, quoteIntentRequest QuoteIntentRequest) (*QuoteIntentResponse, error)
	CommitIntent(ctx context.Context, commitIntentRequest CommitIntentRequest) (*CommitIntentResponse, error)
	ExecuteIntent(ctx context.Context, executeIntentRequest ExecuteIntentRequest) (*ExecuteIntentResponse, error)
	WaitIntentReceipt(ctx context.Context, waitIntentReceiptRequest WaitIntentReceiptRequest) (*WaitIntentReceiptResponse, error)
	GetIntentReceipt(ctx context.Context, getIntentReceiptRequest GetIntentReceiptRequest) (*GetIntentReceiptResponse, error)
	GetIntent(ctx context.Context, getIntentRequest GetIntentRequest) (*GetIntentResponse, error)
	SearchIntents(ctx context.Context, searchIntentsRequest SearchIntentsRequest) (*SearchIntentsResponse, error)
	GetIntentHistory(ctx context.Context, getIntentHistoryRequest GetIntentHistoryRequest) (*GetIntentHistoryResponse, error)
	AbortIntent(ctx context.Context, abortIntentRequest AbortIntentRequest) (*AbortIntentResponse, error)
	// GetChains will return the list of supported chains by Trails.
	GetChains(ctx context.Context, getChainsRequest GetChainsRequest) (*GetChainsResponse, error)
	// GetExactOutputRoutes will return a list of origin tokens, when given a destination chain and token,
	// that can be used to pay/send from an origin chain the exact output amount on the
	// destination chain.
	//
	// The request will include the destination chain and token desired. Optionally, the
	// user can specify an origin chain and token to filter results to only that specific
	// origin token. Additionally, an optional owner address can be provided to filter
	// results to only tokens the owner has a balance on (requires indexer gateway to be
	// configured).
	//
	// The response is a list of origin tokens and their chains which can be used to fulfill
	// the exact output request. These are tokens the user can send FROM to achieve the desired
	// destination token amount.
	//
	// aka, the 'pay' routes
	GetExactOutputRoutes(ctx context.Context, getExactOutputRoutesRequest GetExactOutputRoutesRequest) (*GetExactOutputRoutesResponse, error)
	// GetExactInputRoutes will return a list of destination tokens, when given an origin chain and token,
	// that can be used to send/swap to a destination chain and token.
	//
	// The request will include the origin chain and token used for input. Optionally, the
	// user can specify a destination chain and token to further filter the results.
	//
	// The response is a list of destination tokens and their chains which can be reached from
	// the origin token and chain. These are tokens the user can send TO from the given origin token.
	//
	// aka, the 'swap' routes
	GetExactInputRoutes(ctx context.Context, getExactInputRoutesRequest GetExactInputRoutesRequest) (*GetExactInputRoutesResponse, error)
	// GetTokenList will return a list of tokens based on the provided filters.
	// NOTE: there are many filters and options on GetTokenListRequest
	GetTokenList(ctx context.Context, getTokenListRequest GetTokenListRequest) (*GetTokenListResponse, error)
	// GetTokenPrices will return the live prices for a list of tokens.
	GetTokenPrices(ctx context.Context, getTokenPricesRequest GetTokenPricesRequest) (*GetTokenPricesResponse, error)
	// GetTrailsContracts returns Trails contract addresses used by the Trails Intents stack.
	GetTrailsContracts(ctx context.Context) (*TrailsContracts, error)
	// Deprecated: please use GetIntentHistory instead
	GetIntentTransactionHistory(ctx context.Context, getIntentTransactionHistoryRequest GetIntentTransactionHistoryRequest) (*GetIntentTransactionHistoryResponse, error)
}

type TrailsContracts struct {
	TrailsIntentEntrypointAddress prototyp.Hash `json:"trailsIntentEntrypointAddress"`
	TrailsRouterAddress           prototyp.Hash `json:"trailsRouterAddress"`
	TrailsRouterShimAddress       prototyp.Hash `json:"trailsRouterShimAddress"`
}

type TransactionCall struct {
	To              prototyp.Hash   `json:"to"`
	Value           prototyp.BigInt `json:"value"`
	Data            prototyp.Hash   `json:"data"`
	GasLimit        prototyp.BigInt `json:"gasLimit"`
	DelegateCall    *bool           `json:"delegateCall"`
	OnlyFallback    *bool           `json:"onlyFallback"`
	BehaviorOnError *uint8          `json:"behaviorOnError"`
}

type TransactionContext uint8

type TransactionPrecondition struct {
	// value must be 'tokenMinBalance' or ”
	Type         string          `json:"type"`
	ChainID      uint64          `json:"chainId"`
	OwnerAddress prototyp.Hash   `json:"ownerAddress"`
	TokenAddress prototyp.Hash   `json:"tokenAddress"`
	MinAmount    prototyp.BigInt `json:"minAmount"`
}

type TransactionStatus uint8

type TransactionType uint8

type WaitIntentReceiptRequest struct {
	IntentID prototyp.Hash `json:"intentId"`
	// lastReceiptStates is the previously returned status array from a prior
	// WaitIntentReceipt call. This allows the server to only return
	// updates since the last call, allowing for more efficient polling.
	LastReceiptStates []TransactionStatus `json:"lastReceiptStates"`
}

type WaitIntentReceiptResponse struct {
	IntentReceipt *IntentReceipt `json:"intentReceipt"`
	// receiptStates is an array of key statuses within the intentReceipt object
	// for all sub intent transactions.this can be passed back to subsequent
	// WaitIntentReceipt calls to as a form of a stateless cursor to only
	// get updates since last call.
	ReceiptStates []TransactionStatus `json:"receiptStates"`
	// done flag informs a client whether the wait completed successfully (true) or timed out (false).
	// as the clients will keep polling until done is true. NOTE: done does not indicate success,
	// it just indicates the execution is done, to check status see intentReceipt.status.
	Done bool `json:"done"`
}

type WebRPCError struct {
	Name       string `json:"error"`
	Code       int    `json:"code"`
	Message    string `json:"msg"`
	Cause      string `json:"cause,omitempty"`
	HTTPStatus int    `json:"status"`
	// contains filtered or unexported fields
}

type WebrpcGenVersions struct {
	WebrpcGenVersion string
	CodeGenName      string
	CodeGenVersion   string
	SchemaName       string
	SchemaVersion    string
}