@lifi/sdk 4.0.0-alpha.1 → 4.0.0-alpha.2

package/package.json.tmp

@@ -1,103 +0,0 @@
-{
-  "name": "@lifi/sdk",
-  "version": "4.0.0-alpha.1",
-  "description": "LI.FI SDK for Any-to-Any Cross-Chain-Swap",
-  "homepage": "https://github.com/lifinance/sdk",
-  "bugs": {
-    "url": "https://github.com/lifinance/sdk/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/lifinance/sdk.git",
-    "directory": "packages/sdk"
-  },
-  "license": "Apache-2.0",
-  "author": "Eugene Chybisov <eugene@li.finance>",
-  "type": "module",
-  "sideEffects": false,
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
-  "typings": "./dist/types/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/cjs/index.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "scripts": {
-    "build": "pnpm clean && pnpm build:version && pnpm build:cjs && pnpm build:esm && pnpm build:types && pnpm build:clean",
-    "build:cjs": "tsc --project ./tsconfig.json --module commonjs --outDir ./dist/cjs --removeComments --verbatimModuleSyntax false && mkdir -p ./dist/cjs && printf '{\"type\":\"commonjs\"}' > ./dist/cjs/package.json",
-    "build:esm": "tsc --project ./tsconfig.json --module es2015 --outDir ./dist/esm && mkdir -p ./dist/esm && printf '{\"type\": \"module\",\"sideEffects\":false}' > ./dist/esm/package.json",
-    "build:types": "tsc --project ./tsconfig.json --module esnext --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap",
-    "build:prerelease": "node ../../scripts/prerelease.js && cpy '../../*.md' .",
-    "build:postrelease": "node ../../scripts/postrelease.js && rm -rf *.md",
-    "build:clean": "rm -rf tsconfig.tsbuildinfo ./dist/tsconfig.tsbuildinfo",
-    "build:version": "node ../../scripts/version.js",
-    "clean": "pnpm build:clean && rm -rf dist",
-    "coverage": "vitest run --coverage",
-    "test": "vitest --run --dangerouslyIgnoreUnhandledErrors",
-    "test:cov": "pnpm test --coverage",
-    "test:unit": "pnpm test .unit.spec.ts --passWithNoTests",
-    "check:types": "tsc --noEmit",
-    "check:circular-deps": "madge --circular $(find ./src -name '*.ts')",
-    "check:circular-deps-graph": "madge --circular $(find ./src -name '*.ts') --image graph.svg",
-    "watch": "tsc -w -p ./tsconfig.json"
-  },
-  "dependencies": {
-    "@lifi/types": "^17.46.0",
-    "viem": "^2.39.0"
-  },
-  "devDependencies": {
-    "@lifi/data-types": "^6.40.0",
-    "@vitest/coverage-v8": "^4.0.10",
-    "cpy-cli": "^6.0.0",
-    "madge": "^8.0.0",
-    "msw": "^2.11.3",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.10"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "files": [
-    "dist/**",
-    "!dist/**/*.tsbuildinfo",
-    "src/**/*.ts",
-    "!src/**/*.spec.ts",
-    "!src/**/*.test.ts",
-    "!src/**/*.mock.ts",
-    "!src/**/*.spec.ts",
-    "!src/**/*.handlers.ts",
-    "!src/**/*.tsbuildinfo",
-    "!**/__mocks__/**",
-    "!*.tmp",
-    "!*.env",
-    "!tsconfig.json"
-  ],
-  "keywords": [
-    "swap",
-    "bridge",
-    "bridge-aggregation",
-    "cross-chain",
-    "cross-chain-applications",
-    "cross-chain-bridge",
-    "dapp",
-    "defi",
-    "ethereum",
-    "bitcoin",
-    "solana",
-    "sui",
-    "tron",
-    "lifi",
-    "multi-chain",
-    "sdk",
-    "ethers",
-    "viem",
-    "wagmi",
-    "web3",
-    "web3-react"
-  ]
-}

package/src/actions/actions.unit.handlers.ts

@@ -1,78 +0,0 @@
-import { findDefaultToken } from '@lifi/data-types'
-import { ChainId, CoinKey } from '@lifi/types'
-import { HttpResponse, http } from 'msw'
-import { setupServer } from 'msw/node'
-import { afterAll, afterEach, beforeAll, beforeEach, vi } from 'vitest'
-import { createClient } from '../client/createClient.js'
-import { requestSettings } from '../utils/request.js'
-
-const client = createClient({
-  integrator: 'lifi-sdk',
-})
-
-export const handlers = [
-  http.post(`${client.config.apiUrl}/advanced/routes`, async () => {
-    return HttpResponse.json({})
-  }),
-  http.post(`${client.config.apiUrl}/advanced/possibilities`, async () =>
-    HttpResponse.json({})
-  ),
-  http.get(`${client.config.apiUrl}/token`, async () => HttpResponse.json({})),
-  http.get(`${client.config.apiUrl}/quote`, async () => HttpResponse.json({})),
-  http.get(`${client.config.apiUrl}/status`, async () => HttpResponse.json({})),
-  http.get(`${client.config.apiUrl}/chains`, async () =>
-    HttpResponse.json({ chains: [{ id: 1 }] })
-  ),
-  http.get(`${client.config.apiUrl}/tools`, async () =>
-    HttpResponse.json({ bridges: [], exchanges: [] })
-  ),
-  http.get(`${client.config.apiUrl}/tokens`, async () =>
-    HttpResponse.json({
-      tokens: {
-        [ChainId.ETH]: [findDefaultToken(CoinKey.ETH, ChainId.ETH)],
-      },
-    })
-  ),
-  http.post(`${client.config.apiUrl}/advanced/stepTransaction`, async () =>
-    HttpResponse.json({})
-  ),
-  http.get(`${client.config.apiUrl}/gas/suggestion/${ChainId.OPT}`, async () =>
-    HttpResponse.json({})
-  ),
-  http.get(`${client.config.apiUrl}/connections`, async () =>
-    HttpResponse.json({ connections: [] })
-  ),
-  http.get(`${client.config.apiUrl}/analytics/transfers`, async () =>
-    HttpResponse.json({})
-  ),
-]
-
-/**
- * Sets up MSW server with common handlers for HTTP-based tests
- * Call this function at the top level of your test file
- */
-export const setupTestServer = () => {
-  const server = setupServer(...handlers)
-
-  beforeAll(() => {
-    server.listen({
-      onUnhandledRequest: 'warn',
-    })
-    requestSettings.retries = 0
-  })
-
-  beforeEach(() => {
-    vi.clearAllMocks()
-  })
-
-  afterEach(() => server.resetHandlers())
-
-  afterAll(() => {
-    requestSettings.retries = 1
-    server.close()
-  })
-
-  return server
-}
-
-export { client }

package/src/actions/getChains.unit.spec.ts

@@ -1,19 +0,0 @@
-import { describe, expect, it, vi } from 'vitest'
-import * as request from '../utils/request.js'
-import { client, setupTestServer } from './actions.unit.handlers.js'
-import { getChains } from './getChains.js'
-
-const mockedFetch = vi.spyOn(request, 'request')
-
-describe('getChains', () => {
-  setupTestServer()
-
-  describe('and the backend call is successful', () => {
-    it('call the server once', async () => {
-      const chains = await getChains(client)
-
-      expect(chains[0]?.id).toEqual(1)
-      expect(mockedFetch).toHaveBeenCalledTimes(1)
-    })
-  })
-})

package/src/actions/getConnections.unit.spec.ts

@@ -1,45 +0,0 @@
-import { findDefaultToken } from '@lifi/data-types'
-import type { ConnectionsRequest } from '@lifi/types'
-import { ChainId, CoinKey } from '@lifi/types'
-import { HttpResponse, http } from 'msw'
-import { describe, expect, it, vi } from 'vitest'
-import * as request from '../utils/request.js'
-import { client, setupTestServer } from './actions.unit.handlers.js'
-import { getConnections } from './getConnections.js'
-
-const mockedFetch = vi.spyOn(request, 'request')
-
-describe('getConnections', () => {
-  const server = setupTestServer()
-
-  it('returns empty array in response', async () => {
-    server.use(
-      http.get(`${client.config.apiUrl}/connections`, async () =>
-        HttpResponse.json({ connections: [] })
-      )
-    )
-
-    const connectionRequest: ConnectionsRequest = {
-      fromChain: ChainId.BSC,
-      toChain: ChainId.OPT,
-      fromToken: findDefaultToken(CoinKey.USDC, ChainId.BSC).address,
-      toToken: findDefaultToken(CoinKey.USDC, ChainId.OPT).address,
-      allowBridges: ['connext', 'uniswap', 'polygon'],
-      allowExchanges: ['1inch', 'ParaSwap', 'SushiSwap'],
-      denyBridges: ['Hop', 'Multichain'],
-      preferBridges: ['Hyphen', 'Across'],
-      denyExchanges: ['UbeSwap', 'BeamSwap'],
-      preferExchanges: ['Evmoswap', 'Diffusion'],
-    }
-
-    const generatedURL =
-      'https://li.quest/v1/connections?fromChain=56&fromToken=0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d&toChain=10&toToken=0x0b2c639c533813f4aa9d7837caf62653d097ff85&allowBridges=connext&allowBridges=uniswap&allowBridges=polygon&denyBridges=Hop&denyBridges=Multichain&preferBridges=Hyphen&preferBridges=Across&allowExchanges=1inch&allowExchanges=ParaSwap&allowExchanges=SushiSwap&denyExchanges=UbeSwap&denyExchanges=BeamSwap&preferExchanges=Evmoswap&preferExchanges=Diffusion'
-
-    await expect(getConnections(client, connectionRequest)).resolves.toEqual({
-      connections: [],
-    })
-
-    expect((mockedFetch.mock.calls[0][1] as URL).href).toEqual(generatedURL)
-    expect(mockedFetch).toHaveBeenCalledOnce()
-  })
-})

package/src/actions/getContractCallsQuote.unit.spec.ts

@@ -1,323 +0,0 @@
-import type {
-  ContractCallsQuoteRequest,
-  LiFiStep,
-  RequestOptions,
-} from '@lifi/types'
-import { ChainId } from '@lifi/types'
-import { HttpResponse, http } from 'msw'
-import { describe, expect, it } from 'vitest'
-import { ValidationError } from '../errors/errors.js'
-import { SDKError } from '../errors/SDKError.js'
-import { client, setupTestServer } from './actions.unit.handlers.js'
-import { getContractCallsQuote } from './getContractCallsQuote.js'
-
-describe('getContractCallsQuote', () => {
-  const server = setupTestServer()
-
-  const createMockContractCallsRequest = (
-    overrides: Partial<ContractCallsQuoteRequest> = {}
-  ): ContractCallsQuoteRequest => ({
-    fromChain: ChainId.ETH,
-    fromToken: '0xA0b86a33E6441c8C06DDD4f36e4C4C5B4c3B4c3B',
-    fromAddress: '0x1234567890123456789012345678901234567890',
-    toChain: ChainId.POL,
-    toToken: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
-    contractCalls: [
-      {
-        fromAmount: '1000000',
-        fromTokenAddress: '0xA0b86a33E6441c8C06DDD4f36e4C4C5B4c3B4c3B',
-        toContractAddress: '0x1234567890123456789012345678901234567890',
-        toContractCallData: '0x1234567890abcdef',
-        toContractGasLimit: '100000',
-      },
-    ],
-    fromAmount: '1000000',
-    ...overrides,
-  })
-
-  const mockLiFiStep: LiFiStep = {
-    id: 'test-step-id',
-    type: 'lifi',
-    includedSteps: [],
-    tool: 'test-tool',
-    toolDetails: {
-      key: 'test-tool',
-      name: 'Test Tool',
-      logoURI: 'https://example.com/logo.png',
-    },
-    action: {
-      fromChainId: ChainId.ETH,
-      toChainId: ChainId.POL,
-      fromToken: {
-        address: '0xA0b86a33E6441c8C06DDD4f36e4C4C5B4c3B4c3B',
-        symbol: 'USDC',
-        decimals: 6,
-        chainId: ChainId.ETH,
-        name: 'USD Coin',
-        priceUSD: '1.00',
-      },
-      toToken: {
-        address: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174',
-        symbol: 'USDC',
-        decimals: 6,
-        chainId: ChainId.POL,
-        name: 'USD Coin',
-        priceUSD: '1.00',
-      },
-      fromAmount: '1000000',
-      fromAddress: '0x1234567890123456789012345678901234567890',
-      toAddress: '0x1234567890123456789012345678901234567890',
-    },
-    estimate: {
-      fromAmount: '1000000',
-      toAmount: '1000000',
-      toAmountMin: '970000',
-      approvalAddress: '0x1234567890123456789012345678901234567890',
-      tool: 'test-tool',
-      executionDuration: 30000,
-    },
-    transactionRequest: {
-      to: '0x1234567890123456789012345678901234567890',
-      data: '0x',
-      value: '0',
-      gasLimit: '100000',
-    },
-  }
-
-  describe('success scenarios', () => {
-    it('should get contract calls quote successfully with fromAmount', async () => {
-      server.use(
-        http.post(`${client.config.apiUrl}/quote/contractCalls`, async () => {
-          return HttpResponse.json(mockLiFiStep)
-        })
-      )
-
-      const request = createMockContractCallsRequest({
-        fromAmount: '1000000',
-      })
-
-      const result = await getContractCallsQuote(client, request)
-
-      expect(result).toEqual(mockLiFiStep)
-    })
-
-    it('should get contract calls quote successfully with toAmount', async () => {
-      server.use(
-        http.post(`${client.config.apiUrl}/quote/contractCalls`, async () => {
-          return HttpResponse.json(mockLiFiStep)
-        })
-      )
-
-      const request = createMockContractCallsRequest({
-        toAmount: '1000000',
-        fromAmount: undefined,
-      })
-
-      const result = await getContractCallsQuote(client, request)
-
-      expect(result).toEqual(mockLiFiStep)
-    })
-
-    it('should pass request options correctly', async () => {
-      const mockAbortController = new AbortController()
-      const options: RequestOptions = {
-        signal: mockAbortController.signal,
-      }
-
-      let capturedOptions: any
-      server.use(
-        http.post(
-          `${client.config.apiUrl}/quote/contractCalls`,
-          async ({ request }) => {
-            capturedOptions = request
-            return HttpResponse.json(mockLiFiStep)
-          }
-        )
-      )
-
-      const request = createMockContractCallsRequest()
-
-      await getContractCallsQuote(client, request, options)
-
-      expect(capturedOptions.signal).toBeDefined()
-      expect(capturedOptions.signal).toBeInstanceOf(AbortSignal)
-    })
-  })
-
-  describe('validation scenarios', () => {
-    it('should throw SDKError when fromChain is missing', async () => {
-      const invalidRequest = createMockContractCallsRequest({
-        fromChain: undefined as any,
-      })
-
-      await expect(
-        getContractCallsQuote(client, invalidRequest)
-      ).rejects.toThrow(SDKError)
-
-      try {
-        await getContractCallsQuote(client, invalidRequest)
-      } catch (error) {
-        expect(error).toBeInstanceOf(SDKError)
-        expect((error as SDKError).cause).toBeInstanceOf(ValidationError)
-        expect((error as SDKError).cause.message).toBe(
-          'Required parameter "fromChain" is missing.'
-        )
-      }
-    })
-
-    it('should throw SDKError when fromToken is missing', async () => {
-      const invalidRequest = createMockContractCallsRequest({
-        fromToken: undefined as any,
-      })
-
-      await expect(
-        getContractCallsQuote(client, invalidRequest)
-      ).rejects.toThrow(SDKError)
-
-      try {
-        await getContractCallsQuote(client, invalidRequest)
-      } catch (error) {
-        expect(error).toBeInstanceOf(SDKError)
-        expect((error as SDKError).cause).toBeInstanceOf(ValidationError)
-        expect((error as SDKError).cause.message).toBe(
-          'Required parameter "fromToken" is missing.'
-        )
-      }
-    })
-
-    it('should throw SDKError when fromAddress is missing', async () => {
-      const invalidRequest = createMockContractCallsRequest({
-        fromAddress: undefined as any,
-      })
-
-      await expect(
-        getContractCallsQuote(client, invalidRequest)
-      ).rejects.toThrow(SDKError)
-
-      try {
-        await getContractCallsQuote(client, invalidRequest)
-      } catch (error) {
-        expect(error).toBeInstanceOf(SDKError)
-        expect((error as SDKError).cause).toBeInstanceOf(ValidationError)
-        expect((error as SDKError).cause.message).toBe(
-          'Required parameter "fromAddress" is missing.'
-        )
-      }
-    })
-
-    it('should throw SDKError when toChain is missing', async () => {
-      const invalidRequest = createMockContractCallsRequest({
-        toChain: undefined as any,
-      })
-
-      await expect(
-        getContractCallsQuote(client, invalidRequest)
-      ).rejects.toThrow(SDKError)
-
-      try {
-        await getContractCallsQuote(client, invalidRequest)
-      } catch (error) {
-        expect(error).toBeInstanceOf(SDKError)
-        expect((error as SDKError).cause).toBeInstanceOf(ValidationError)
-        expect((error as SDKError).cause.message).toBe(
-          'Required parameter "toChain" is missing.'
-        )
-      }
-    })
-
-    it('should throw SDKError when toToken is missing', async () => {
-      const invalidRequest = createMockContractCallsRequest({
-        toToken: undefined as any,
-      })
-
-      await expect(
-        getContractCallsQuote(client, invalidRequest)
-      ).rejects.toThrow(SDKError)
-
-      try {
-        await getContractCallsQuote(client, invalidRequest)
-      } catch (error) {
-        expect(error).toBeInstanceOf(SDKError)
-        expect((error as SDKError).cause).toBeInstanceOf(ValidationError)
-        expect((error as SDKError).cause.message).toBe(
-          'Required parameter "toToken" is missing.'
-        )
-      }
-    })
-
-    it('should throw SDKError when contractCalls is missing', async () => {
-      const invalidRequest = createMockContractCallsRequest({
-        contractCalls: undefined as any,
-      })
-
-      await expect(
-        getContractCallsQuote(client, invalidRequest)
-      ).rejects.toThrow(SDKError)
-
-      try {
-        await getContractCallsQuote(client, invalidRequest)
-      } catch (error) {
-        expect(error).toBeInstanceOf(SDKError)
-        expect((error as SDKError).cause).toBeInstanceOf(ValidationError)
-        expect((error as SDKError).cause.message).toBe(
-          'Required parameter "contractCalls" is missing.'
-        )
-      }
-    })
-
-    it('should throw SDKError when both fromAmount and toAmount are missing', async () => {
-      const invalidRequest = createMockContractCallsRequest()
-      // Remove both fromAmount and toAmount to test validation
-      delete (invalidRequest as any).fromAmount
-      delete (invalidRequest as any).toAmount
-
-      await expect(
-        getContractCallsQuote(client, invalidRequest)
-      ).rejects.toThrow(SDKError)
-
-      try {
-        await getContractCallsQuote(client, invalidRequest)
-      } catch (error) {
-        expect(error).toBeInstanceOf(SDKError)
-        expect((error as SDKError).cause).toBeInstanceOf(ValidationError)
-        expect((error as SDKError).cause.message).toBe(
-          'Required parameter "fromAmount" or "toAmount" is missing.'
-        )
-      }
-    })
-  })
-
-  describe('error scenarios', () => {
-    it('should throw SDKError when network request fails', async () => {
-      server.use(
-        http.post(`${client.config.apiUrl}/quote/contractCalls`, async () => {
-          return HttpResponse.error()
-        })
-      )
-
-      const request = createMockContractCallsRequest()
-
-      await expect(getContractCallsQuote(client, request)).rejects.toThrow(
-        SDKError
-      )
-    })
-
-    it('should throw SDKError when request times out', async () => {
-      server.use(
-        http.post(`${client.config.apiUrl}/quote/contractCalls`, async () => {
-          // Simulate timeout by not responding
-          await new Promise(() => {}) // Never resolves
-        })
-      )
-
-      const request = createMockContractCallsRequest()
-      const timeoutOptions: RequestOptions = {
-        signal: AbortSignal.timeout(100), // 100ms timeout
-      }
-
-      await expect(
-        getContractCallsQuote(client, request, timeoutOptions)
-      ).rejects.toThrow()
-    })
-  })
-})

package/src/actions/getGasRecommendation.unit.spec.ts

@@ -1,40 +0,0 @@
-import { ChainId } from '@lifi/types'
-import { describe, expect, it, vi } from 'vitest'
-import { ValidationError } from '../errors/errors.js'
-import { SDKError } from '../errors/SDKError.js'
-import * as request from '../utils/request.js'
-import { client, setupTestServer } from './actions.unit.handlers.js'
-import { getGasRecommendation } from './getGasRecommendation.js'
-
-const mockedFetch = vi.spyOn(request, 'request')
-
-describe('getGasRecommendation', () => {
-  setupTestServer()
-
-  describe('user input is invalid', () => {
-    it('throw an error', async () => {
-      await expect(
-        getGasRecommendation(client, {
-          chainId: undefined as unknown as number,
-        })
-      ).rejects.toThrowError(
-        new SDKError(
-          new ValidationError('Required parameter "chainId" is missing.')
-        )
-      )
-      expect(mockedFetch).toHaveBeenCalledTimes(0)
-    })
-  })
-
-  describe('user input is valid', () => {
-    describe('and the backend call is successful', () => {
-      it('call the server once', async () => {
-        await getGasRecommendation(client, {
-          chainId: ChainId.OPT,
-        })
-
-        expect(mockedFetch).toHaveBeenCalledTimes(1)
-      })
-    })
-  })
-})