@lifi/sdk 4.0.1 → 4.2.0

package/dist/esm/version.js

@@ -1,6 +1,6 @@
 //#region src/version.ts
 const name = "@lifi/sdk";
-const version = "4.0.1";
+const version = "4.2.0";
 //#endregion
 export { name, version };
 

package/dist/esm/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","names":[],"sources":["../../src/version.ts"],"sourcesContent":["export const name = '@lifi/sdk'\nexport const version = '4.0.1'\n"],"mappings":";AAAA,MAAa,OAAO;AACpB,MAAa,UAAU"}
+{"version":3,"file":"version.js","names":[],"sources":["../../src/version.ts"],"sourcesContent":["export const name = '@lifi/sdk'\nexport const version = '4.2.0'\n"],"mappings":";AAAA,MAAa,OAAO;AACpB,MAAa,UAAU"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/sdk",
-  "version": "4.0.1",
+  "version": "4.2.0",
   "description": "LI.FI SDK for Any-to-Any Cross-Chain-Swap",
   "homepage": "https://github.com/lifinance/sdk",
   "bugs": {

package/src/actions/getQuote.ts

@@ -8,6 +8,7 @@ import type {
 } from '../types/actions.js'
 import type { SDKClient } from '../types/core.js'
 import { request } from '../utils/request.js'
+import { toQueryString } from '../utils/toQueryString.js'
 
 /**
  * Get a quote for a token transfer
@@ -95,8 +96,8 @@ export async function getQuote(
 
   return await request<LiFiStep>(
     client.config,
-    `${client.config.apiUrl}/${isFromAmountRequest ? 'quote' : 'quote/toAmount'}?${new URLSearchParams(
-      params as unknown as Record<string, string>
+    `${client.config.apiUrl}/${isFromAmountRequest ? 'quote' : 'quote/toAmount'}?${toQueryString(
+      params as Record<string, unknown>
     )}`,
     {
       signal: options?.signal,

package/src/actions/getRoutes.ts

@@ -1,6 +1,7 @@
-import type { RequestOptions, RoutesRequest, RoutesResponse } from '@lifi/types'
+import type { RequestOptions, RoutesResponse } from '@lifi/types'
 import { ValidationError } from '../errors/errors.js'
 import { SDKError } from '../errors/SDKError.js'
+import type { RoutesRequest } from '../types/actions.js'
 import type { SDKClient } from '../types/core.js'
 import { isRoutesRequest } from '../utils/isRoutesRequest.js'
 import { request } from '../utils/request.js'

package/src/actions/getStepTransaction.ts

@@ -1,5 +1,6 @@
-import type { LiFiStep, RequestOptions, SignedLiFiStep } from '@lifi/types'
+import type { LiFiStep, RequestOptions } from '@lifi/types'
 import { ChainId } from '@lifi/types'
+import type { LiFiStepRequest } from '../types/actions.js'
 import type { SDKClient } from '../types/core.js'
 import { isStep } from '../utils/isStep.js'
 import { request } from '../utils/request.js'
@@ -14,7 +15,7 @@ import { request } from '../utils/request.js'
  */
 export const getStepTransaction = async (
   client: SDKClient,
-  step: LiFiStep | SignedLiFiStep,
+  step: LiFiStepRequest,
   options?: RequestOptions
 ): Promise<LiFiStep> => {
   if (!isStep(step)) {
@@ -27,6 +28,7 @@ export const getStepTransaction = async (
   let requestUrl = `${config.apiUrl}/advanced/stepTransaction`
   const jitoBundle = config.routeOptions?.jitoBundle
   const svmSponsor = config.routeOptions?.svmSponsor
+  const svmPriorityFeeLevel = config.routeOptions?.svmPriorityFeeLevel
 
   if (step.action.fromChainId === ChainId.SOL) {
     const queryParams = new URLSearchParams()
@@ -36,6 +38,9 @@ export const getStepTransaction = async (
     if (svmSponsor) {
       queryParams.set('svmSponsor', svmSponsor)
     }
+    if (svmPriorityFeeLevel) {
+      queryParams.set('svmPriorityFeeLevel', svmPriorityFeeLevel)
+    }
     if (queryParams.size > 0) {
       requestUrl = `${requestUrl}?${queryParams}`
     }

package/src/actions/index.ts

@@ -16,9 +16,7 @@ import type {
   RelayStatusRequest,
   RelayStatusResponseData,
   RequestOptions,
-  RoutesRequest,
   RoutesResponse,
-  SignedLiFiStep,
   StatusResponse,
   Token,
   TokenAmount,
@@ -34,7 +32,9 @@ import type {
 } from '@lifi/types'
 import type {
   GetStatusRequestExtended,
+  LiFiStepRequest,
   QuoteRequestFromAmount,
+  RoutesRequest,
 } from '../types/actions.js'
 import type { SDKClient } from '../types/core.js'
 import { getChains } from './getChains.js'
@@ -152,7 +152,9 @@ export type Actions = {
   ) => Promise<LiFiStep>
 
   /**
-   * Get a set of routes for a request that describes a transfer of tokens
+   * Get a set of routes for a request that describes a transfer of tokens.
+   * Optional limit-order fields (`toAmount`, `validUntil`, `partiallyFillable`)
+   * may be supplied and are resolved on the backend.
    * @param params - A description of the transfer
    * @param options - Request options
    * @returns The resulting routes that can be used to realize the described transfer
@@ -174,13 +176,14 @@ export type Actions = {
   ) => Promise<StatusResponse>
 
   /**
-   * Get a step transaction
+   * Get a step transaction. The step's `action` may carry the optional
+   * limit-order fields, which are resolved on the backend.
    * @param params - The configuration of the requested step transaction
    * @param options - Request options
    * @returns Step transaction
    */
   getStepTransaction: (
-    params: LiFiStep | SignedLiFiStep,
+    params: LiFiStepRequest,
     options?: RequestOptions
   ) => Promise<LiFiStep>
 

package/src/index.ts

@@ -67,6 +67,13 @@ export {
 } from './errors/errors.js'
 export { HTTPError } from './errors/httpError.js'
 export { SDKError } from './errors/SDKError.js'
+export type {
+  GetStatusRequestExtended,
+  LiFiStepRequest,
+  QuoteRequest,
+  QuoteRequestFromAmount,
+  QuoteRequestToAmount,
+} from './types/actions.js'
 export type {
   AcceptExchangeRateUpdateHook,
   AcceptSlippageUpdateHook,

package/src/types/actions.ts

@@ -1,12 +1,41 @@
 import type {
+  Action,
   GetStatusRequest,
+  LiFiStep,
   QuoteRequest as QuoteRequestBase,
+  RoutesRequest as RoutesRequestBase,
+  SignedLiFiStep,
 } from '@lifi/types'
 
 export type GetStatusRequestExtended = GetStatusRequest & {
   fromAddress?: string
 }
 
+/**
+ * Optional limit-order fields. Supplying them opts a request into limit-order
+ * handling; resolution happens on the backend.
+ */
+type OrderFields = {
+  toAmount?: string
+  validUntil?: number
+  partiallyFillable?: boolean
+}
+
+export type RoutesRequest = Omit<RoutesRequestBase, 'options'> &
+  OrderFields & {
+    options?: RoutesRequestBase['options'] & {
+      /** (default: false) Whether to request private routes */
+      private?: boolean
+    }
+  }
+
+/**
+ * A step request that may carry the optional limit-order `action` fields.
+ */
+export type LiFiStepRequest = (LiFiStep | SignedLiFiStep) & {
+  action: Action & OrderFields
+}
+
 export type QuoteRequestFromAmount = QuoteRequestBase
 
 export type QuoteRequestToAmount = Omit<QuoteRequestBase, 'fromAmount'> & {

package/src/utils/isStep.ts

@@ -15,6 +15,9 @@ const isAction = (action: Action): action is Action => {
 }
 
 const isEstimate = (estimate: Estimate): estimate is Estimate => {
+  if (!estimate) {
+    return false
+  }
   const { fromAmount, toAmount, toAmountMin, approvalAddress } = estimate
 
   return (
@@ -36,6 +39,6 @@ export const isStep = (step: LiFiStep): step is LiFiStep => {
     ['swap', 'cross', 'lifi'].includes(type) &&
     typeof tool === 'string' &&
     isAction(action) &&
-    isEstimate(estimate)
+    (!estimate || isEstimate(estimate))
   )
 }

package/src/utils/toQueryString.ts

@@ -0,0 +1,35 @@
+type QueryPrimitive = string | number | boolean | bigint
+
+const isPrimitive = (value: unknown): value is QueryPrimitive =>
+  typeof value === 'string' ||
+  typeof value === 'number' ||
+  typeof value === 'boolean' ||
+  typeof value === 'bigint'
+
+// Arrays of objects use qs indices notation (`key[0][subKey]=value`) to match
+// the backend's `qs.parse(str, { comma: true })`; only values are encoded.
+const serialize = (key: string, value: unknown): string[] => {
+  if (value === undefined || value === null) {
+    return []
+  }
+  if (isPrimitive(value)) {
+    return [`${key}=${encodeURIComponent(String(value))}`]
+  }
+  if (Array.isArray(value)) {
+    // Scalar arrays stay comma-joined (backend splits on `comma: true`).
+    if (value.every(isPrimitive)) {
+      return [`${key}=${encodeURIComponent(value.join(','))}`]
+    }
+    return value.flatMap((item, index) => serialize(`${key}[${index}]`, item))
+  }
+  return Object.entries(value as Record<string, unknown>).flatMap(
+    ([subKey, subValue]) => serialize(`${key}[${subKey}]`, subValue)
+  )
+}
+
+// Encode params into a query string (no leading `?`). Drop-in for
+// `URLSearchParams` that handles nested array/object params; skips null/undefined.
+export const toQueryString = (params: Record<string, unknown>): string =>
+  Object.entries(params)
+    .flatMap(([key, value]) => serialize(key, value))
+    .join('&')

package/src/version.ts

@@ -1,2 +1,2 @@
 export const name = '@lifi/sdk'
-export const version = '4.0.1'
+export const version = '4.2.0'