@0xtrails/api 0.9.4 → 0.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xtrails/api",
-  "version": "0.9.4",
+  "version": "0.10.0",
   "type": "module",
   "description": "Trails API Client SDK",
   "repository": "https://github.com/0xsequence/trails/tree/master/packages/trails-api",

package/src/trails-api.gen.ts

@@ -1,7 +1,7 @@
 /* eslint-disable */
-// trails-api v1-25.12.24-aa15bcd 894b96262ee91cc331115b7f7aaeb656c8d7b55d
+// trails-api v1 9923827ab0683bd37e4aa9e713fa728b4c930297
 // --
-// Code generated by Webrpc-gen@v0.31.3 with typescript generator. DO NOT EDIT.
+// Code generated by Webrpc-gen@v0.32.2 with typescript generator. DO NOT EDIT.
 //
 // webrpc-gen -schema=trails-api.ridl -target=typescript -client -service=Trails -methodTreeShake -ignore=@onramp -out=./clients/trails-api.gen.ts
 
@@ -9,10 +9,10 @@
 export const WebrpcVersion = 'v1'
 
 // Schema version of your RIDL schema
-export const WebrpcSchemaVersion = 'v1-25.12.24-aa15bcd'
+export const WebrpcSchemaVersion = 'v1'
 
 // Schema hash generated from your RIDL schema
-export const WebrpcSchemaHash = '894b96262ee91cc331115b7f7aaeb656c8d7b55d'
+export const WebrpcSchemaHash = '9923827ab0683bd37e4aa9e713fa728b4c930297'
 
 //
 // Client interface
@@ -100,11 +100,32 @@ export interface TrailsClient {
    */
   getTokenPrices(req: GetTokenPricesRequest, headers?: object, signal?: AbortSignal): Promise<GetTokenPricesResponse>
 
+  /**
+   * GetExchangeRate returns the exchange rate from USD to a specified currency.
+   */
+  getExchangeRate(req: GetExchangeRateRequest, headers?: object, signal?: AbortSignal): Promise<GetExchangeRateResponse>
+
+  /**
+   * GetCountryList returns the list of supported countries for onramp providers.
+   */
+  getCountryList(headers?: object, signal?: AbortSignal): Promise<GetCountryListResponse>
+
   /**
    * GetTrailsContracts returns Trails contract addresses used by the Trails Intents stack.
    */
   getTrailsContracts(headers?: object, signal?: AbortSignal): Promise<GetTrailsContractsResponse>
 
+  /**
+   * GetEarnPools returns aggregated pool information from DeFi protocols (Aave, Morpho).
+   * This endpoint provides yield-bearing opportunities across multiple chains.
+   */
+  getEarnPools(req: GetEarnPoolsRequest, headers?: object, signal?: AbortSignal): Promise<GetEarnPoolsResponse>
+
+  /**
+   * GetFiatCurrencyList returns the list of supported fiat currencies for display preferences.
+   */
+  getFiatCurrencyList(headers?: object, signal?: AbortSignal): Promise<GetFiatCurrencyListResponse>
+
   /**
    * @deprecated please use GetIntentHistory instead
    */
@@ -130,9 +151,17 @@ export enum RouteProvider {
   LIFI = 'LIFI',
   RELAY = 'RELAY',
   SUSHI = 'SUSHI',
+  WETH = 'WETH',
   ZEROX = 'ZEROX'
 }
 
+export enum FundMethod {
+  WALLET = 'WALLET',
+  DIRECT_TRANSFER = 'DIRECT_TRANSFER',
+  ONRAMP_MESH = 'ONRAMP_MESH',
+  ONRAMP_MELD = 'ONRAMP_MELD'
+}
+
 export enum IntentStatus {
   QUOTED = 'QUOTED',
   COMMITTED = 'COMMITTED',
@@ -148,7 +177,8 @@ export enum TransactionType {
   DEPOSIT = 'DEPOSIT',
   ORIGIN = 'ORIGIN',
   DESTINATION = 'DESTINATION',
-  ROUTE = 'ROUTE'
+  ROUTE = 'ROUTE',
+  REFUND = 'REFUND'
 }
 
 export enum TransactionContext {
@@ -185,6 +215,16 @@ export enum CCTPTransferStatus {
   FAILED = 'FAILED'
 }
 
+export enum RelayTransferStatus {
+  UNKNOWN = 'UNKNOWN',
+  ON_HOLD = 'ON_HOLD',
+  PENDING = 'PENDING',
+  FETCHING = 'FETCHING',
+  COMPLETE = 'COMPLETE',
+  REFUNDED = 'REFUNDED',
+  FAILED = 'FAILED'
+}
+
 export interface QuoteIntentRequest {
   ownerAddress: string
   originChainId: number
@@ -197,6 +237,7 @@ export interface QuoteIntentRequest {
   originTokenAmount?: bigint
   destinationTokenAmount?: bigint
   tradeType?: TradeType
+  fundMethod?: FundMethod
   onlyNativeGasFee?: boolean
   options?: QuoteIntentRequestOptions
 }
@@ -208,6 +249,12 @@ export interface QuoteIntentRequestOptions {
   trailsAddressOverrides?: TrailsAddressOverrides
 }
 
+export interface PassthroughInfo {
+  eligible: boolean
+  passthroughTransaction?: PassThroughTransaction
+  transactionStates?: Array<TransactionStateInfo>
+}
+
 export interface Intent {
   intentId: string
   status: IntentStatus
@@ -219,6 +266,7 @@ export interface Intent {
   destinationIntentAddress?: string
   salt: bigint
   depositTransaction: DepositTransaction
+  passthrough?: boolean
   originCalls: IntentCalls
   destinationCalls?: IntentCalls
   originPrecondition: TransactionPrecondition
@@ -239,6 +287,27 @@ export interface DepositTransaction {
   tokenAddress: string
   decimals?: number
   amount: bigint
+  chainId: number
+  to: string
+  data: string
+  value: bigint
+}
+
+export interface PassThroughTransaction {
+  toAddress: string
+  tokenAddress: string
+  decimals?: number
+  amount: bigint
+  chainId: number
+  to: string
+  data: string
+  value: bigint
+}
+
+export interface TransactionStateInfo {
+  id: string
+  label: string
+  chainId: number
 }
 
 export interface IntentCalls {
@@ -318,6 +387,7 @@ export interface IntentReceipt {
   depositTransaction: IntentTransaction
   originTransaction: IntentTransaction
   destinationTransaction?: IntentTransaction
+  refundTransaction?: IntentTransaction
   summary: IntentReceiptSummary
   updatedAt?: string
   createdAt?: string
@@ -480,6 +550,14 @@ export interface TokenPrice {
   updatedAt: string
 }
 
+export interface ExchangeRate {
+  name: string
+  symbol: string
+  value: number
+  vsCurrency: string
+  currencyType: string
+}
+
 export interface CCTPTransfer {
   id: number
   intentId: string
@@ -496,6 +574,21 @@ export interface CCTPTransfer {
   updatedAt: string
 }
 
+export interface RelayTransfer {
+  id: number
+  intentId: string
+  originChainId: number
+  destinationChainId: number
+  originTxnId: number
+  originTxnHash: string
+  destinationTxnId: number
+  destinationTxnHash: string
+  status: number
+  statusReason?: string
+  createdAt: string
+  updatedAt: string
+}
+
 export interface GasFeeOptions {
   gasEstimate: GasEstimate
   feeOptions: Array<FeeOption>
@@ -518,6 +611,7 @@ export interface FeeOption {
   amountUsd: number
   feeCollectorAddress: string
   is2612: boolean
+  isPassthroughEligible?: boolean
 }
 
 export interface DepositSignature {
@@ -579,6 +673,50 @@ export interface TokenInfo {
   featured: boolean
 }
 
+export interface EarnPool {
+  id: string
+  name: string
+  protocol: string
+  chainId: number
+  apy: number
+  tvl: number
+  token: PoolTokenInfo
+  depositAddress: string
+  isActive: boolean
+  poolUrl?: string
+  protocolUrl?: string
+  wrappedTokenGatewayAddress?: string
+}
+
+export interface PoolTokenInfo {
+  symbol: string
+  name: string
+  address: string
+  decimals: number
+  logoUrl?: string
+}
+
+export interface CountryRegion {
+  regionCode: string
+  name: string
+}
+
+export interface Country {
+  countryCode: string
+  name: string
+  flag: string
+  flagImageUrl: string
+  regions?: Array<CountryRegion>
+}
+
+export interface FiatCurrency {
+  code: string
+  symbol: string
+  name: string
+  flag: string
+  decimals: number
+}
+
 export interface MeldQuote {
   transactionType: string
   sourceAmount: number
@@ -628,6 +766,8 @@ export interface ServiceStatus {
 export interface QuoteIntentResponse {
   intent: Intent
   gasFeeOptions: GasFeeOptions
+  transactionStates?: Array<TransactionStateInfo>
+  passthrough?: PassthroughInfo
 }
 
 export interface CommitIntentRequest {
@@ -765,6 +905,19 @@ export interface GetTokenListResponse {
   tokens: Array<TokenInfo>
 }
 
+export interface GetEarnPoolsRequest {
+  chainIds?: Array<number>
+  protocols?: Array<string>
+  minTvl?: number
+  maxApy?: number
+}
+
+export interface GetEarnPoolsResponse {
+  pools: Array<EarnPool>
+  timestamp: string
+  cached: boolean
+}
+
 export interface Page {
   column?: string
   before?: number
@@ -808,12 +961,32 @@ export interface ClockResponse {
   serverTime: string
 }
 
+export interface GetExchangeRateRequest {
+  toCurrency: string
+}
+
+export interface GetExchangeRateResponse {
+  exchangeRate: ExchangeRate
+}
+
+export interface GetCountryListRequest {}
+
+export interface GetCountryListResponse {
+  countries: Array<Country>
+}
+
 export interface GetTrailsContractsRequest {}
 
 export interface GetTrailsContractsResponse {
   TrailsContracts: TrailsContracts
 }
 
+export interface GetFiatCurrencyListRequest {}
+
+export interface GetFiatCurrencyListResponse {
+  currencies: Array<FiatCurrency>
+}
+
 //
 // Client
 //
@@ -850,7 +1023,11 @@ export class Trails implements TrailsClient {
     getExactInputRoutes: (req: GetExactInputRoutesRequest) => ['Trails', 'getExactInputRoutes', req] as const,
     getTokenList: (req: GetTokenListRequest) => ['Trails', 'getTokenList', req] as const,
     getTokenPrices: (req: GetTokenPricesRequest) => ['Trails', 'getTokenPrices', req] as const,
+    getExchangeRate: (req: GetExchangeRateRequest) => ['Trails', 'getExchangeRate', req] as const,
+    getCountryList: () => ['Trails', 'getCountryList'] as const,
     getTrailsContracts: () => ['Trails', 'getTrailsContracts'] as const,
+    getEarnPools: (req: GetEarnPoolsRequest) => ['Trails', 'getEarnPools', req] as const,
+    getFiatCurrencyList: () => ['Trails', 'getFiatCurrencyList'] as const,
     getIntentTransactionHistory: (req: GetIntentTransactionHistoryRequest) =>
       ['Trails', 'getIntentTransactionHistory', req] as const
   }
@@ -1096,6 +1273,32 @@ export class Trails implements TrailsClient {
     )
   }
 
+  getExchangeRate = (req: GetExchangeRateRequest, headers?: object, signal?: AbortSignal): Promise<GetExchangeRateResponse> => {
+    return this.fetch(this.url('GetExchangeRate'), createHttpRequest(JsonEncode(req), headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return JsonDecode<GetExchangeRateResponse>(_data, 'GetExchangeRateResponse')
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error instanceof Error ? error.message : String(error)}` })
+      }
+    )
+  }
+
+  getCountryList = (headers?: object, signal?: AbortSignal): Promise<GetCountryListResponse> => {
+    return this.fetch(this.url('GetCountryList'), createHttpRequest('{}', headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return JsonDecode<GetCountryListResponse>(_data, 'GetCountryListResponse')
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error instanceof Error ? error.message : String(error)}` })
+      }
+    )
+  }
+
   getTrailsContracts = (headers?: object, signal?: AbortSignal): Promise<GetTrailsContractsResponse> => {
     return this.fetch(this.url('GetTrailsContracts'), createHttpRequest('{}', headers, signal)).then(
       res => {
@@ -1109,6 +1312,32 @@ export class Trails implements TrailsClient {
     )
   }
 
+  getEarnPools = (req: GetEarnPoolsRequest, headers?: object, signal?: AbortSignal): Promise<GetEarnPoolsResponse> => {
+    return this.fetch(this.url('GetEarnPools'), createHttpRequest(JsonEncode(req), headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return JsonDecode<GetEarnPoolsResponse>(_data, 'GetEarnPoolsResponse')
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error instanceof Error ? error.message : String(error)}` })
+      }
+    )
+  }
+
+  getFiatCurrencyList = (headers?: object, signal?: AbortSignal): Promise<GetFiatCurrencyListResponse> => {
+    return this.fetch(this.url('GetFiatCurrencyList'), createHttpRequest('{}', headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return JsonDecode<GetFiatCurrencyListResponse>(_data, 'GetFiatCurrencyListResponse')
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error instanceof Error ? error.message : String(error)}` })
+      }
+    )
+  }
+
   getIntentTransactionHistory = (
     req: GetIntentTransactionHistoryRequest,
     headers?: object,
@@ -1165,7 +1394,7 @@ const BIG_INT_FIELDS: { [typ: string]: (string | [string, string])[] } = {
   CommitIntentRequest: [['intent', 'Intent']],
   DepositIntentEntry: ['permitAmount'],
   DepositSignature: ['permitAmount', ['selectedGasFeeOption', 'FeeOption']],
-  DepositTransaction: ['amount'],
+  DepositTransaction: ['amount', 'value'],
   ExecuteIntentRequest: [['depositSignature', 'DepositSignature']],
   FeeOption: ['amount'],
   GasFeeOptions: [['feeOptions', 'FeeOption[]']],
@@ -1204,6 +1433,7 @@ const BIG_INT_FIELDS: { [typ: string]: (string | [string, string])[] } = {
     ['depositTransaction', 'IntentTransaction'],
     ['originTransaction', 'IntentTransaction'],
     ['destinationTransaction', 'IntentTransaction'],
+    ['refundTransaction', 'IntentTransaction'],
     ['summary', 'IntentReceiptSummary']
   ],
   IntentReceiptSummary: ['originTokenAmount', 'destinationTokenAmount'],
@@ -1211,10 +1441,13 @@ const BIG_INT_FIELDS: { [typ: string]: (string | [string, string])[] } = {
   IntentTransaction: ['tokenAmount', ['precondition', 'TransactionPrecondition'], ['depositIntentEntry', 'DepositIntentEntry']],
   IntentTransactionGasFee: ['totalGasLimit', 'gasPrice', 'totalFeeAmount', ['metaTxnFeeDetails', 'MetaTxnFeeDetails']],
   MetaTxnFeeDetails: ['estimatedGasLimit', 'feeNative'],
+  PassThroughTransaction: ['amount', 'value'],
+  PassthroughInfo: [['passthroughTransaction', 'PassThroughTransaction']],
   QuoteIntentRequest: ['destinationCallValue', 'originTokenAmount', 'destinationTokenAmount'],
   QuoteIntentResponse: [
     ['intent', 'Intent'],
-    ['gasFeeOptions', 'GasFeeOptions']
+    ['gasFeeOptions', 'GasFeeOptions'],
+    ['passthrough', 'PassthroughInfo']
   ],
   SearchIntentsResponse: [['intents', 'Intent[]']],
   TransactionCall: ['value', 'gasLimit'],
@@ -1971,7 +2204,7 @@ export const webrpcErrorByCode: { [code: number]: any } = {
 
 export const WebrpcHeader = 'Webrpc'
 
-export const WebrpcHeaderValue = 'webrpc@v0.31.3;gen-typescript@v0.23.1;trails-api@v1-25.12.24-aa15bcd'
+export const WebrpcHeaderValue = 'webrpc@v0.32.2;gen-typescript@v0.23.1;trails-api@v1'
 
 type WebrpcGenVersions = {
   WebrpcGenVersion: string