tapimo 0.13.0 → 0.15.0

package/src/internal/{funding → routes}/providers/across.ts

@@ -1,11 +1,11 @@
 import { Address } from 'ox'
 import * as z from 'zod/mini'
 
-import * as FundingChain from '../Chain.js'
-import * as FundingProvider from '../Provider.js'
+import * as RoutesChain from '../Chain.js'
+import * as RoutesProvider from '../Provider.js'
 
 const defaultBaseUrl = 'https://app.across.to/api'
-const defaultFetch: FundingProvider.Fetch = (input, init) => globalThis.fetch(input, init)
+const defaultFetch: RoutesProvider.Fetch = (input, init) => globalThis.fetch(input, init)
 
 namespace schema {
   const IntegerString = z.string().check(z.regex(/^\d+$/))
@@ -28,24 +28,24 @@ namespace schema {
   })
 }
 
-/** Creates an Across funding provider backed by `/swap/approval`. */
+/** Creates an Across route provider backed by `/swap/approval`. */
 export function across(options: across.Options) {
   if (options.apiKey.length === 0 || !/^0x[\da-fA-F]{4}$/.test(options.integratorId))
-    throw new FundingProvider.ProviderConfigurationError()
+    throw new RoutesProvider.ProviderConfigurationError()
   if (!Address.validate(options.userAddress, { strict: false }))
-    throw new FundingProvider.ProviderConfigurationError()
+    throw new RoutesProvider.ProviderConfigurationError()
 
   const endpoint = new URL(options.baseUrl ?? defaultBaseUrl)
   endpoint.pathname = `${endpoint.pathname.replace(/\/+$/, '')}/swap/approval`
   const fetch = options.fetch ?? defaultFetch
   const now = options.now ?? (() => new Date())
 
-  return FundingProvider.from({
+  return RoutesProvider.from({
     id: 'across',
     name: 'Across',
     async getQuote({ candidate, route }, signal) {
-      const destinationChainId = FundingChain.eip155Id(route.destination.chain)
-      const sourceChainId = FundingChain.eip155Id(route.source.chain)
+      const destinationChainId = RoutesChain.eip155Id(route.destination.chain)
+      const sourceChainId = RoutesChain.eip155Id(route.source.chain)
       const url = new URL(endpoint)
       url.search = new URLSearchParams({
         amount: candidate.sourceAmount.amount,
@@ -62,13 +62,13 @@ export function across(options: across.Options) {
       }).toString()
 
       try {
-        const quote = await FundingProvider.requestJson(url, {
+        const quote = await RoutesProvider.requestJson(url, {
           fetch,
           headers: { Authorization: `Bearer ${options.apiKey}` },
           signal,
         })
         const parsed = schema.Quote.safeParse(quote)
-        if (!parsed.success) throw new FundingProvider.ProviderPayloadError()
+        if (!parsed.success) throw new RoutesProvider.ProviderPayloadError()
         const response = parsed.data
         const expiresAt = new Date(response.quoteExpiryTimestamp * 1_000)
         const sampledAt = now()
@@ -82,7 +82,7 @@ export function across(options: across.Options) {
           Number.isNaN(expiresAt.getTime()) ||
           response.quoteExpiryTimestamp * 1_000 <= sampledAt.getTime()
         )
-          throw new FundingProvider.ProviderPayloadError()
+          throw new RoutesProvider.ProviderPayloadError()
 
         return {
           expiresAt: expiresAt.toISOString(),
@@ -98,7 +98,7 @@ export function across(options: across.Options) {
           status: 'available',
         }
       } catch (cause) {
-        const unavailable = FundingProvider.unavailable(cause, [
+        const unavailable = RoutesProvider.unavailable(cause, [
           'AMOUNT_TOO_HIGH',
           'AMOUNT_TOO_LOW',
           'INSUFFICIENT_LIQUIDITY',
@@ -107,7 +107,7 @@ export function across(options: across.Options) {
           'UNSUPPORTED_ROUTE',
         ])
         if (!unavailable) throw cause
-        return FundingProvider.unavailableResult({
+        return RoutesProvider.unavailableResult({
           detail: 'across:swap-approval',
           message: unavailable,
           now: now(),
@@ -126,7 +126,7 @@ export declare namespace across {
     /** Override for tests or Across test environments. */
     baseUrl?: string | undefined
     /** Fetch implementation override for tests. */
-    fetch?: FundingProvider.Fetch | undefined
+    fetch?: RoutesProvider.Fetch | undefined
     /** Across integrator id sent as the required query parameter. */
     integratorId: string
     /** Clock override for deterministic tests. */
@@ -139,7 +139,7 @@ export declare namespace across {
 function matchesToken(
   token: z.output<typeof schema.Quote>['inputToken'],
   chainId: string,
-  expected: FundingProvider.TokenRef,
+  expected: RoutesProvider.TokenRef,
 ) {
   return (
     token.address.toLowerCase() === expected.address.toLowerCase() &&

package/src/internal/{funding → routes}/providers/index.test.ts

@@ -1,5 +1,8 @@
-import * as TestFunding from '../../../../test/Funding.js'
-import * as FundingProvider from '../Provider.js'
+import { RpcRequestError } from 'viem'
+
+import * as TestRoutes from '../../../../test/Routes.js'
+import * as Store from '../../Store.js'
+import * as RoutesProvider from '../Provider.js'
 import * as Across from './across.js'
 import * as Relay from './relay.js'
 import * as Rhino from './rhino.js'
@@ -8,7 +11,7 @@ import * as Stargate from './stargate.js'
 import * as Symbiosis from './symbiosis.js'
 
 const now = () => new Date('2026-01-01T00:00:00.000Z')
-const evmUserAddress = TestFunding.relayQuoteUsers['eip155:4217']
+const evmUserAddress = TestRoutes.relayQuoteUsers['eip155:4217']
 const solanaUserAddress = '7ZwiMrYFNCzZ4TcPkeMx7BTZSZ9jDgGR8H8Nkazhr6L1'
 const providers = [
   Across.across({
@@ -16,7 +19,7 @@ const providers = [
     integratorId: '0xdead',
     userAddress: '0x1111111111111111111111111111111111111111',
   }),
-  Relay.relay({ userAddresses: TestFunding.relayQuoteUsers }),
+  Relay.relay({ userAddresses: TestRoutes.relayQuoteUsers }),
   Rhino.rhino(),
   Squid.squid({
     integratorId: 'squid-integrator-id',
@@ -26,7 +29,7 @@ const providers = [
   Symbiosis.symbiosis({ userAddress: '0x1111111111111111111111111111111111111111' }),
 ] as const
 
-describe('funding providers', () => {
+describe('route providers', () => {
   test('maps successful Across quotes to available quote results', async () => {
     const requests: RecordedRequest[] = []
     const candidate = quoteCandidate('across')
@@ -113,7 +116,7 @@ describe('funding providers', () => {
 
     await expect(
       provider.getQuote(getQuoteInput(candidate), new AbortController().signal),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderPayloadError]`)
+    ).rejects.toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderPayloadError]`)
   })
 
   test('rejects invalid Across configuration', () => {
@@ -123,7 +126,7 @@ describe('funding providers', () => {
         integratorId: 'tempo',
         userAddress: '0x1111111111111111111111111111111111111111',
       }),
-    ).toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderConfigurationError]`)
+    ).toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderConfigurationError]`)
   })
 
   test('maps successful Relay quotes to available quote results', async () => {
@@ -145,7 +148,7 @@ describe('funding providers', () => {
       apiKey: 'relay-api-key',
       fetch,
       now,
-      userAddresses: TestFunding.relayQuoteUsers,
+      userAddresses: TestRoutes.relayQuoteUsers,
     })
 
     const result = await provider.getQuote(getQuoteInput(candidate), new AbortController().signal)
@@ -182,7 +185,7 @@ describe('funding providers', () => {
       new AbortController().signal,
     )
 
-    expect(FundingProvider.canPrepareTransfer(provider)).toBe(true)
+    expect(RoutesProvider.canPrepareTransfer(provider)).toBe(true)
     expect(result).toMatchInlineSnapshot(`
       {
         "quality": {
@@ -261,7 +264,7 @@ describe('funding providers', () => {
           'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp': '0x1111111111111111111111111111111111111111',
         },
       }),
-    ).toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderConfigurationError]`)
+    ).toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderConfigurationError]`)
   })
 
   test('maps successful Squid quotes to available quote results', async () => {
@@ -337,10 +340,21 @@ describe('funding providers', () => {
     })
   })
 
-  test('exposes Base and Ethereum Stargate quote candidates', () => {
+  test('exposes inbound and outbound Stargate quote candidates', () => {
     expect(
       ['base', 'ethereum'].map((sourceChain) => quoteCandidate('stargate', { sourceChain }).id),
     ).toEqual(['base-usdc-tempo-usdce-stargate', 'ethereum-usdc-tempo-usdce-stargate'])
+    expect(
+      ['base', 'ethereum'].map(
+        (destinationChain) =>
+          quoteCandidate('stargate', {
+            destinationChain,
+            destinationToken: 'USDC',
+            sourceChain: 'tempo',
+            sourceToken: 'USDC.e',
+          }).id,
+      ),
+    ).toEqual(['tempo-usdce-base-usdc-stargate', 'tempo-usdce-ethereum-usdc-stargate'])
   })
 
   test('maps successful Symbiosis quotes to available quote results', async () => {
@@ -438,7 +452,7 @@ describe('funding providers', () => {
 
     await expect(
       provider.getQuote(getQuoteInput(candidate), new AbortController().signal),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderPayloadError]`)
+    ).rejects.toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderPayloadError]`)
   })
 
   test('enforces the Symbiosis provider quota before fetching', async () => {
@@ -451,20 +465,26 @@ describe('funding providers', () => {
     })
 
     await Promise.all(
-      Array.from({ length: 4 }, () =>
-        provider.getQuote(getQuoteInput(candidate), new AbortController().signal),
+      Array.from({ length: 4 }, (_, index) =>
+        provider.getQuote(
+          getQuoteInput(candidate, { quotaKey: `organization:production:org_${index}` }),
+          new AbortController().signal,
+        ),
       ),
     )
     const cause = await provider
-      .getQuote(getQuoteInput(candidate), new AbortController().signal)
+      .getQuote(
+        getQuoteInput(candidate, { quotaKey: 'organization:production:org_overflow' }),
+        new AbortController().signal,
+      )
       .catch((error: unknown) => error)
 
     expect(requests).toHaveLength(4)
     expect(cause).toMatchObject({
-      name: 'FundingProvider.ProviderRateLimitError',
+      name: 'RoutesProvider.ProviderRateLimitError',
     })
     expect(
-      FundingProvider.failure({
+      RoutesProvider.failure({
         cause,
         operation: 'getQuote',
         provider: getProvider('symbiosis'),
@@ -476,6 +496,79 @@ describe('funding providers', () => {
     })
   })
 
+  test('reserves Symbiosis capacity for another tenant', async () => {
+    const requests: RecordedRequest[] = []
+    const candidate = quoteCandidate('symbiosis')
+    const provider = Symbiosis.symbiosis({
+      fetch: recordingFetch(requests, async () => jsonResponse(symbiosisQuote(candidate))),
+      now,
+      userAddress: '0x1111111111111111111111111111111111111111',
+    })
+    const first = getQuoteInput(candidate, { quotaKey: 'organization:production:org_a' })
+    const second = getQuoteInput(candidate, { quotaKey: 'organization:production:org_b' })
+
+    for (let count = 0; count < 3; count++)
+      await expect(provider.getQuote(first, new AbortController().signal)).resolves.toMatchObject({
+        status: 'available',
+      })
+    await expect(provider.getQuote(first, new AbortController().signal)).rejects.toBeInstanceOf(
+      RoutesProvider.ProviderRateLimitError,
+    )
+    await expect(provider.getQuote(second, new AbortController().signal)).resolves.toMatchObject({
+      status: 'available',
+    })
+    expect(requests).toHaveLength(4)
+  })
+
+  test('reuses one durable quota record across windows', async () => {
+    const requests: RecordedRequest[] = []
+    const candidate = quoteCandidate('symbiosis')
+    const rateLimitStore = Store.memory()
+    let time = now()
+    const provider = Symbiosis.symbiosis({
+      fetch: recordingFetch(requests, async () => jsonResponse(symbiosisQuote(candidate))),
+      now: () => time,
+      rateLimitStore,
+      userAddress: '0x1111111111111111111111111111111111111111',
+    })
+
+    for (let window = 0; window < 3; window++) {
+      await provider.getQuote(
+        getQuoteInput(candidate, { quotaKey: `organization:production:org_${window}` }),
+        new AbortController().signal,
+      )
+      time = new Date(time.getTime() + 1_000)
+    }
+
+    expect((await rateLimitStore.list()).keys).toEqual([{ name: 'routes:symbiosis:quote' }])
+    expect(requests).toHaveLength(3)
+  })
+
+  test('does not reset a newer Symbiosis quota window for a stale request', async () => {
+    const requests: RecordedRequest[] = []
+    const candidate = quoteCandidate('symbiosis')
+    const rateLimitStore = Store.memory()
+    const quotaKey = 'organization:production:org_a'
+    const quota = JSON.stringify({
+      bucket: Math.floor(now().getTime() / 1_000) + 1,
+      count: 3,
+      tenants: [{ count: 3, key: quotaKey }],
+    })
+    await rateLimitStore.put('routes:symbiosis:quote', quota)
+    const provider = Symbiosis.symbiosis({
+      fetch: recordingFetch(requests, async () => jsonResponse(symbiosisQuote(candidate))),
+      now,
+      rateLimitStore,
+      userAddress: '0x1111111111111111111111111111111111111111',
+    })
+
+    await expect(
+      provider.getQuote(getQuoteInput(candidate, { quotaKey }), new AbortController().signal),
+    ).rejects.toBeInstanceOf(RoutesProvider.ProviderRateLimitError)
+    expect(await rateLimitStore.get('routes:symbiosis:quote')).toBe(quota)
+    expect(requests).toHaveLength(0)
+  })
+
   test('maps unavailable Symbiosis routes to unavailable quote results', async () => {
     const candidate = quoteCandidate('symbiosis')
     const provider = Symbiosis.symbiosis({
@@ -519,7 +612,7 @@ describe('funding providers', () => {
   test('rejects invalid Symbiosis configuration', () => {
     expect(() =>
       Symbiosis.symbiosis({ userAddress: 'invalid' }),
-    ).toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderConfigurationError]`)
+    ).toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderConfigurationError]`)
   })
 
   test('maps successful Rhino quotes to available quote results', async () => {
@@ -638,7 +731,7 @@ describe('funding providers', () => {
     await expect(
       provider.getQuote(getQuoteInput(candidate), new AbortController().signal),
     ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `[FundingProvider.ProviderResponseError: Provider request failed with status 400]`,
+      `[RoutesProvider.ProviderResponseError: Provider request failed with status 400]`,
     )
   })
 
@@ -658,7 +751,7 @@ describe('funding providers', () => {
         .getQuote(getQuoteInput(candidate), new AbortController().signal)
         .catch((error: unknown) => error)
       expect(cause).toMatchObject({
-        name: 'FundingProvider.ProviderResponseError',
+        name: 'RoutesProvider.ProviderResponseError',
         status: failure.status,
       })
     }
@@ -682,7 +775,7 @@ describe('funding providers', () => {
 
     await expect(
       provider.getQuote(getQuoteInput(candidate), new AbortController().signal),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderPayloadError]`)
+    ).rejects.toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderPayloadError]`)
   })
 
   test('rejects non-representable Rhino output precision', async () => {
@@ -703,7 +796,7 @@ describe('funding providers', () => {
 
     await expect(
       provider.getQuote(getQuoteInput(candidate), new AbortController().signal),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderPayloadError]`)
+    ).rejects.toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderPayloadError]`)
   })
 
   test('calls the runtime fetch method with its global receiver', async () => {
@@ -724,7 +817,7 @@ describe('funding providers', () => {
     try {
       const provider = Relay.relay({
         now,
-        userAddresses: TestFunding.relayQuoteUsers,
+        userAddresses: TestRoutes.relayQuoteUsers,
       })
       const result = await provider.getQuote(getQuoteInput(candidate), new AbortController().signal)
 
@@ -783,7 +876,7 @@ describe('funding providers', () => {
 
       await expect(
         provider.getQuote(getQuoteInput(candidate), new AbortController().signal),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderPayloadError]`)
+      ).rejects.toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderPayloadError]`)
     })
 
   const invalidSquidQuotes = [
@@ -841,7 +934,7 @@ describe('funding providers', () => {
 
       await expect(
         provider.getQuote(getQuoteInput(candidate), new AbortController().signal),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderPayloadError]`)
+      ).rejects.toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderPayloadError]`)
     })
 
   const invalidSymbiosisQuotes = [
@@ -908,7 +1001,7 @@ describe('funding providers', () => {
 
       await expect(
         provider.getQuote(getQuoteInput(candidate), new AbortController().signal),
-      ).rejects.toThrowErrorMatchingInlineSnapshot(`[FundingProvider.ProviderPayloadError]`)
+      ).rejects.toThrowErrorMatchingInlineSnapshot(`[RoutesProvider.ProviderPayloadError]`)
     })
 
   test('returns bounded Across failure diagnostics', async () => {
@@ -927,7 +1020,7 @@ describe('funding providers', () => {
       .catch((error: unknown) => error)
 
     expect(
-      FundingProvider.failure({
+      RoutesProvider.failure({
         cause,
         operation: 'getQuote',
         provider: getProvider('across'),
@@ -943,8 +1036,8 @@ describe('funding providers', () => {
 
   test('returns explicit timeout failure diagnostics', () => {
     expect(
-      FundingProvider.failure({
-        cause: new FundingProvider.ProviderTimeoutError(),
+      RoutesProvider.failure({
+        cause: new RoutesProvider.ProviderTimeoutError(),
         operation: 'getQuote',
         provider: getProvider('across'),
       }),
@@ -957,7 +1050,7 @@ describe('funding providers', () => {
 
   test('returns bounded Squid failure diagnostics', () => {
     expect(
-      FundingProvider.failure({
+      RoutesProvider.failure({
         cause: new TypeError('network failure'),
         operation: 'getQuote',
         provider: getProvider('squid'),
@@ -970,22 +1063,30 @@ describe('funding providers', () => {
   })
 
   test('returns bounded Stargate failure diagnostics', () => {
+    const cause = new RpcRequestError({
+      body: { method: 'eth_call' },
+      error: { code: -32_000, message: 'upstream failure' },
+      url: 'https://credential.example.com',
+    })
+
     expect(
-      FundingProvider.failure({
-        cause: new TypeError('network failure'),
+      RoutesProvider.failure({
+        cause,
         operation: 'getQuote',
         provider: getProvider('stargate'),
       }),
     ).toEqual({
-      failure: 'network',
+      code: 'RpcRequestError:-32000',
+      failure: 'query',
       id: 'stargate',
+      message: 'upstream failure',
       operation: 'getQuote',
     })
   })
 
   test('returns bounded Symbiosis failure diagnostics', () => {
     expect(
-      FundingProvider.failure({
+      RoutesProvider.failure({
         cause: new TypeError('network failure'),
         operation: 'getQuote',
         provider: getProvider('symbiosis'),
@@ -1004,11 +1105,12 @@ type RecordedRequest = {
 }
 
 function quoteCandidate(
-  provider: FundingProvider.ProviderId = 'relay',
+  provider: RoutesProvider.ProviderId = 'relay',
   options: quoteCandidate.Options = {},
-): FundingProvider.getQuote.Parameters['candidate'] {
-  const [candidate] = FundingProvider.getQuoteCandidates({
-    catalog: TestFunding.snapshot,
+): RoutesProvider.getQuote.Parameters['candidate'] {
+  const [candidate] = RoutesProvider.getQuoteCandidates({
+    catalog: TestRoutes.snapshot,
+    destinationChain: options.destinationChain,
     destinationToken: options.destinationToken,
     provider,
     providers,
@@ -1021,7 +1123,7 @@ function quoteCandidate(
   return candidate
 }
 
-function getProvider(id: FundingProvider.ProviderId) {
+function getProvider(id: RoutesProvider.ProviderId) {
   const provider = providers.find((entry) => entry.id === id)
   if (!provider) throw new Error(`Missing ${id} provider`)
   return provider
@@ -1029,13 +1131,14 @@ function getProvider(id: FundingProvider.ProviderId) {
 
 declare namespace quoteCandidate {
   type Options = {
+    destinationChain?: string | undefined
     destinationToken?: string | undefined
     sourceChain?: string | undefined
     sourceToken?: string | undefined
   }
 }
 
-function acrossQuote(candidate: FundingProvider.getQuote.Parameters['candidate']) {
+function acrossQuote(candidate: RoutesProvider.getQuote.Parameters['candidate']) {
   return {
     amountType: 'exactInput',
     expectedFillTime: 2,
@@ -1058,7 +1161,7 @@ function acrossQuote(candidate: FundingProvider.getQuote.Parameters['candidate']
   }
 }
 
-function squidQuote(candidate: FundingProvider.getQuote.Parameters['candidate']) {
+function squidQuote(candidate: RoutesProvider.getQuote.Parameters['candidate']) {
   return {
     route: {
       estimate: {
@@ -1081,7 +1184,7 @@ function squidQuote(candidate: FundingProvider.getQuote.Parameters['candidate'])
   }
 }
 
-function symbiosisQuote(candidate: FundingProvider.getQuote.Parameters['candidate']) {
+function symbiosisQuote(candidate: RoutesProvider.getQuote.Parameters['candidate']) {
   const source =
     candidate.sourceChain.kind === 'tron'
       ? {
@@ -1117,13 +1220,15 @@ function symbiosisQuote(candidate: FundingProvider.getQuote.Parameters['candidat
 }
 
 function getQuoteInput(
-  candidate: FundingProvider.getQuote.Parameters['candidate'],
-): FundingProvider.getQuote.Parameters {
+  candidate: RoutesProvider.getQuote.Parameters['candidate'],
+  options: getQuoteInput.Options = {},
+): RoutesProvider.getQuote.Parameters {
   return {
     candidate,
     cache: { bypass: false },
     destinationChain: candidate.destinationChain,
     destinationToken: candidate.destinationToken,
+    quotaKey: options.quotaKey ?? 'organization:production:org_test',
     request: {
       provider: candidate.provider.id,
       sourceAmount: candidate.sourceAmount.amount,
@@ -1138,6 +1243,14 @@ function getQuoteInput(
   }
 }
 
+declare namespace getQuoteInput {
+  /** Optional quote input overrides. */
+  type Options = {
+    /** Stable non-secret tenant identity. */
+    quotaKey?: string | undefined
+  }
+}
+
 function recordingFetch(
   requests: RecordedRequest[],
   respond: (request: RecordedRequest) => Response | Promise<Response>,