tapimo 0.7.0 → 0.7.2

package/src/apps/data/routes/valuation.test.ts

@@ -1,3 +1,5 @@
+/** @module-tag localnet */
+
 import * as fs from 'node:fs'
 import { Value as core_Value } from 'ox'
 import { Schema } from 'tapimo'
@@ -11,6 +13,18 @@ import * as TestViem from '../../../../test/Viem.js'
 import * as Tokens from './tokens.js'
 import * as Valuation from './valuation.js'
 
+type OpenApiDocument = {
+  paths: Record<string, Record<string, OpenApiOperation>>
+}
+
+type OpenApiOperation = {
+  parameters?: readonly OpenApiParameter[] | undefined
+}
+
+type OpenApiParameter = {
+  name: string
+}
+
 const runtime = Runtime.get()
 const db = TestApp.database()
 await TestApp.verifiedSeed(db, runtime.chainId)
@@ -108,12 +122,22 @@ describe('GET /addresses/:address/valuation', () => {
     ).toBe(true)
   })
 
-  test('normalizes the denomination', () => {
+  test('normalizes the valuation currency', () => {
     expect(
-      Valuation.schema.getAddressValuation.Query.parse({ denomination: 'aud' }).denomination,
+      Valuation.schema.getAddressValuation.Query.parse({ currency: 'aud' }).currency,
     ).toMatchInlineSnapshot(`"AUD"`)
     expect(
-      Valuation.schema.getAddressValuation.Query.safeParse({ denomination: 'DOLLARS' }).success,
+      Valuation.schema.getAddressValuation.Query.safeParse({
+        currency: 'DOLLARS',
+      }).success,
+    ).toBe(false)
+    expect(
+      Valuation.schema.getAddressValuation.Query.safeParse({ denomination: 'AUD' }).success,
+    ).toBe(false)
+    expect(
+      Valuation.schema.getAddressValuation.Query.safeParse({
+        'valuation.currency': 'AUD',
+      }).success,
     ).toBe(false)
   })
 
@@ -174,7 +198,7 @@ describe('GET /addresses/:address/valuation', () => {
       const usd = await TestApp.json(usdResponse, Valuation.schema.getAddressValuation.Response)
       // Denominations are case-insensitive.
       const audResponse = await client.v1.addresses[':address'].valuation.$get(
-        { param: { address: holder }, query: { denomination: 'aud' } },
+        { param: { address: holder }, query: { currency: 'aud' } },
         TestApp.auth,
       )
       const aud = await TestApp.json(audResponse, Valuation.schema.getAddressValuation.Response)
@@ -205,7 +229,7 @@ describe('GET /addresses/:address/valuation', () => {
     const holder = await holderWithBalance(client)
 
     const response = await client.v1.addresses[':address'].valuation.$get(
-      { param: { address: holder }, query: { denomination: 'EUR' } },
+      { param: { address: holder }, query: { currency: 'EUR' } },
       TestApp.auth,
     )
     const body = await TestApp.json(response, Valuation.schema.getAddressValuation.Response)
@@ -308,7 +332,7 @@ describe('GET /addresses/:address/valuation', () => {
       const holder = await holderWithBalance(client)
 
       const response = await client.v1.addresses[':address'].valuation.$get(
-        { param: { address: holder }, query: { denomination: 'AUD' } },
+        { param: { address: holder }, query: { currency: 'AUD' } },
         TestApp.auth,
       )
       const body = await TestApp.json(response, Schema.ErrorResponse)
@@ -334,7 +358,7 @@ describe('GET /addresses/:address/valuation', () => {
       const holder = await holderWithBalance(client)
 
       const response = await client.v1.addresses[':address'].valuation.$get(
-        { param: { address: holder }, query: { denomination: 'JPY' } },
+        { param: { address: holder }, query: { currency: 'JPY' } },
         TestApp.auth,
       )
       const body = await TestApp.json(response, Schema.ErrorResponse)
@@ -355,7 +379,7 @@ describe('GET /addresses/:address/valuation', () => {
 
   test('rejects unsupported denominations for an address with no holdings', async () => {
     const response = await app({ fx: { oracle: fixed } }).v1.addresses[':address'].valuation.$get(
-      { param: { address: emptyAccount() }, query: { denomination: 'JPY' } },
+      { param: { address: emptyAccount() }, query: { currency: 'JPY' } },
       TestApp.auth,
     )
     const body = await TestApp.json(response, Schema.ErrorResponse)
@@ -424,7 +448,7 @@ describe('GET /addresses/:address/valuation', () => {
 
   test('rejects malformed denominations', async () => {
     const response = await app().v1.addresses[':address'].valuation.$get(
-      { param: { address: emptyAccount() }, query: { denomination: 'DOLLARS' } },
+      { param: { address: emptyAccount() }, query: { currency: 'DOLLARS' } },
       TestApp.auth,
     )
     const body = await TestApp.json(response, Schema.ErrorResponse)
@@ -435,3 +459,32 @@ describe('GET /addresses/:address/valuation', () => {
     expect(stable.error.code).toMatchInlineSnapshot(`"query_invalid"`)
   })
 })
+
+describe('OpenAPI', () => {
+  test('publishes scoped valuation currency parameters', async () => {
+    const application = TestApp.create({ auth: false })
+    const spec = (await (await application.request('/openapi.json')).json()) as OpenApiDocument
+    const operations = [
+      spec.paths['/v1/addresses/{address}/activities']?.['get'],
+      spec.paths['/v1/addresses/{address}/balances']?.['get'],
+      spec.paths['/v1/exchange/quotes']?.['post'],
+      spec.paths['/v1/exchange/swaps']?.['get'],
+      spec.paths['/v1/transactions/receipts']?.['get'],
+      spec.paths['/v1/transactions/{transactionHash}/activities']?.['get'],
+      spec.paths['/v1/transactions/{transactionHash}/receipt']?.['get'],
+      spec.paths['/v1/transfers']?.['get'],
+    ]
+
+    for (const operation of operations) {
+      const names = operation?.parameters?.map((parameter) => parameter.name)
+      expect(names).toContain('valuation.currency')
+      expect(names).not.toContain('denomination')
+    }
+
+    const valuation = spec.paths['/v1/addresses/{address}/valuation']?.['get']
+    const names = valuation?.parameters?.map((parameter) => parameter.name)
+    expect(names).toContain('currency')
+    expect(names).not.toContain('valuation.currency')
+    expect(names).not.toContain('denomination')
+  })
+})

package/src/apps/data/routes/valuation.ts

@@ -80,7 +80,7 @@ export namespace schema {
     export const Query = z
       .strictObject({
         chainId: Schema.ChainIdQuery,
-        denomination: Schema.Denomination,
+        currency: Schema.Denomination,
       })
       .check(z.describe('Query parameters for valuing an account’s verified holdings.'))
 
@@ -185,7 +185,7 @@ export function addresses(options: addresses.Options = {}) {
         const valuation = await getAddressValuation(c, {
           address,
           chainId: query.chainId ?? c.get('chainId'),
-          denomination: query.denomination ?? 'USD',
+          denomination: query.currency ?? 'USD',
           oracle,
         })
         return c.json(Response.validated(schema.getAddressValuation.Response, valuation), 200)

package/src/apps/data/routes/verified-tokens.test.ts

@@ -87,6 +87,21 @@ describe('GET /verified-tokens', () => {
     )
     expect(second.status).toBe(304)
   })
+
+  test('refreshes cached reads after a snapshot publish', async () => {
+    const db = TestApp.database()
+    await VerifiedTokens.replace(db, chainId, seedList)
+    const client = TestApp.client({ auth: { keys: [reader] }, db })
+
+    await client.v1['verified-tokens'].$get({ query: {} }, as(reader))
+    await VerifiedTokens.replace(db, chainId, seedList.slice(1))
+
+    const response = await client.v1['verified-tokens'].$get({ query: {} }, as(reader))
+    const body = await TestApp.json(response, Verified.schema.listVerifiedTokens.Response)
+    expect(body.data.map((token) => token.address)).toEqual(
+      seedList.slice(1).map((token) => token.address),
+    )
+  })
 })
 
 describe('GET /verified-tokens/currencies', () => {
@@ -97,6 +112,23 @@ describe('GET /verified-tokens/currencies', () => {
     const body = await TestApp.json(response, Verified.schema.getVerifiedTokenCurrencies.Response)
     expect([...body.data]).toEqual(['EUR', 'USD'])
   })
+
+  test('refreshes cached reads after a snapshot publish', async () => {
+    const db = TestApp.database()
+    await VerifiedTokens.replace(db, chainId, seedList)
+    const client = TestApp.client({ auth: { keys: [reader] }, db })
+
+    await client.v1['verified-tokens'].currencies.$get({ query: {} }, as(reader))
+    await VerifiedTokens.replace(
+      db,
+      chainId,
+      seedList.filter((token) => token.currency === 'USD'),
+    )
+
+    const response = await client.v1['verified-tokens'].currencies.$get({ query: {} }, as(reader))
+    const body = await TestApp.json(response, Verified.schema.getVerifiedTokenCurrencies.Response)
+    expect([...body.data]).toEqual(['USD'])
+  })
 })
 
 describe('GET /verified-tokens/:address', () => {
@@ -123,4 +155,23 @@ describe('GET /verified-tokens/:address', () => {
     const body = (await response.json()) as { error?: { code?: string } }
     expect(body.error?.code).toBe('verified_token_not_found')
   })
+
+  test('refreshes cached reads after a snapshot publish', async () => {
+    const db = TestApp.database()
+    await VerifiedTokens.replace(db, chainId, seedList)
+    const client = TestApp.client({ auth: { keys: [reader] }, db })
+    const address = seedList[0].address
+
+    await client.v1['verified-tokens'][':address'].$get(
+      { param: { address }, query: {} },
+      as(reader),
+    )
+    await VerifiedTokens.replace(db, chainId, seedList.slice(1))
+
+    const response = await client.v1['verified-tokens'][':address'].$get(
+      { param: { address }, query: {} },
+      as(reader),
+    )
+    expect(response.status).toBe(404)
+  })
 })

package/src/apps/data/routes/verified-tokens.ts

@@ -4,6 +4,7 @@ import * as z from 'zod/mini'
 import type * as App from '../../../App.js'
 import * as Auth from '../../../internal/Auth.js'
 import * as Cache from '../../../internal/Cache.js'
+import * as EdgeCache from '../../../internal/EdgeCache.js'
 import * as OpenApi from '../../../internal/OpenApi.js'
 import * as Response from '../../../internal/Response.js'
 import * as Schema from '../../../internal/Schema.js'
@@ -168,11 +169,23 @@ export function verifiedTokens() {
         summary: 'List verified tokens',
         tags: ['Verified Tokens'],
       }),
-      Cache.response<App.Environment>({
-        cacheControl: Cache.policies.stable,
-        name: 'tempo-api:verified-tokens:v1',
-        key: (c) => Cache.urlKey(c, schema.listVerifiedTokens.Query),
-      }),
+      // The shared edge cache is URL-keyed and cannot include the snapshot version.
+      EdgeCache.setEligibility(
+        Cache.response<App.Environment>({
+          cacheControl: Cache.policies.stable,
+          name: 'tempo-api:verified-tokens:v1',
+          key: async (c) => {
+            const base = Cache.urlKey(c, schema.listVerifiedTokens.Query)
+            const query = schema.listVerifiedTokens.Query.parse(
+              Object.fromEntries(new URL(c.req.url).searchParams),
+            )
+            const chainId = query.chainId ?? c.get('chainId')
+            const { version } = await VerifiedTokens.snapshot(c, chainId)
+            return `${base}:v:${version}`
+          },
+        }),
+        () => false,
+      ),
       async (c) => {
         if (Auth.narrowAccess) return Auth.paidAccessError(c)
         if (OpenApi.narrowValidation)
@@ -213,11 +226,23 @@ export function verifiedTokens() {
         summary: 'List verified currencies',
         tags: ['Verified Tokens'],
       }),
-      Cache.response<App.Environment>({
-        cacheControl: Cache.policies.stable,
-        name: 'tempo-api:verified-tokens:v1',
-        key: (c) => Cache.urlKey(c, schema.getVerifiedTokenCurrencies.Query),
-      }),
+      // The shared edge cache is URL-keyed and cannot include the snapshot version.
+      EdgeCache.setEligibility(
+        Cache.response<App.Environment>({
+          cacheControl: Cache.policies.stable,
+          name: 'tempo-api:verified-tokens:v1',
+          key: async (c) => {
+            const base = Cache.urlKey(c, schema.getVerifiedTokenCurrencies.Query)
+            const query = schema.getVerifiedTokenCurrencies.Query.parse(
+              Object.fromEntries(new URL(c.req.url).searchParams),
+            )
+            const chainId = query.chainId ?? c.get('chainId')
+            const { version } = await VerifiedTokens.snapshot(c, chainId)
+            return `${base}:v:${version}`
+          },
+        }),
+        () => false,
+      ),
       async (c) => {
         if (Auth.narrowAccess) return Auth.paidAccessError(c)
         if (OpenApi.narrowValidation)
@@ -265,11 +290,23 @@ export function verifiedTokens() {
         summary: 'Get verified token',
         tags: ['Verified Tokens'],
       }),
-      Cache.response<App.Environment>({
-        cacheControl: Cache.policies.stable,
-        name: 'tempo-api:verified-tokens:v1',
-        key: (c) => Cache.urlKey(c, schema.getVerifiedToken.Query),
-      }),
+      // The shared edge cache is URL-keyed and cannot include the snapshot version.
+      EdgeCache.setEligibility(
+        Cache.response<App.Environment>({
+          cacheControl: Cache.policies.stable,
+          name: 'tempo-api:verified-tokens:v1',
+          key: async (c) => {
+            const base = Cache.urlKey(c, schema.getVerifiedToken.Query)
+            const query = schema.getVerifiedToken.Query.parse(
+              Object.fromEntries(new URL(c.req.url).searchParams),
+            )
+            const chainId = query.chainId ?? c.get('chainId')
+            const { version } = await VerifiedTokens.snapshot(c, chainId)
+            return `${base}:v:${version}`
+          },
+        }),
+        () => false,
+      ),
       async (c) => {
         if (Auth.narrowAccess) return Auth.paidAccessError(c)
         if (OpenApi.narrowValidation)