tapimo 0.12.0 → 0.13.0

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

@@ -171,13 +171,13 @@ export namespace schema {
     .strictObject({
       chainId: Schema.ChainId.check(
         z.describe('Private Zone chain id.'),
-        z.meta({ examples: [1424310001] }),
+        z.meta({ examples: [1424310003] }),
       ),
       inputTokens: z
         .array(Schema.Address)
         .check(
           z.describe('Tokens accepted by private deposits.'),
-          z.meta({ examples: [['0x20c000000000000000000000ff04042ee92fd449']] }),
+          z.meta({ examples: [['0x20c0000000000000000000002139993d5f625d59']] }),
         ),
       name: z
         .string()
@@ -186,7 +186,7 @@ export namespace schema {
         .array(Schema.Address)
         .check(
           z.describe('Tokens supported by private redemptions.'),
-          z.meta({ examples: [['0x20c000000000000000000000ff04042ee92fd449']] }),
+          z.meta({ examples: [['0x20c0000000000000000000002139993d5f625d59']] }),
         ),
     })
     .check(z.describe('Private Zone route configured for a verified vault.'))
@@ -195,7 +195,7 @@ export namespace schema {
     .strictObject({
       chainId: Schema.ChainId.check(
         z.describe('Private Zone chain id.'),
-        z.meta({ examples: [1424310001] }),
+        z.meta({ examples: [1424310003] }),
       ),
       deploymentBlock: z
         .number()
@@ -203,17 +203,17 @@ export namespace schema {
           z.int(),
           z.nonnegative(),
           z.describe('Parent-chain block that deployed the Earn router.'),
-          z.meta({ examples: [31039238] }),
+          z.meta({ examples: [31730087] }),
         ),
       earnRouter: Schema.Address.check(
         z.describe('Parent-chain router for this Zone and Earn vault.'),
-        z.meta({ examples: ['0x9144086a79dea966d8bf1b52125ebed8919fc45c'] }),
+        z.meta({ examples: ['0xebedc74ffeead186acc6cac05eb82fb9e093a7c7'] }),
       ),
       inputTokens: z
         .array(Schema.Address)
         .check(
           z.describe('Tokens accepted by private deposits.'),
-          z.meta({ examples: [['0x20c000000000000000000000ff04042ee92fd449']] }),
+          z.meta({ examples: [['0x20c0000000000000000000002139993d5f625d59']] }),
         ),
       name: z
         .string()
@@ -222,7 +222,7 @@ export namespace schema {
         .array(Schema.Address)
         .check(
           z.describe('Tokens returned by private redemptions.'),
-          z.meta({ examples: [['0x20c000000000000000000000ff04042ee92fd449']] }),
+          z.meta({ examples: [['0x20c0000000000000000000002139993d5f625d59']] }),
         ),
     })
     .check(z.describe('Verified Earn route through one private Zone.'))
@@ -327,12 +327,12 @@ export namespace schema {
         examples: [
           [
             {
-              chainId: 1424310001,
-              deploymentBlock: 31039238,
-              earnRouter: '0x9144086a79dea966d8bf1b52125ebed8919fc45c',
-              inputTokens: ['0x20c000000000000000000000ff04042ee92fd449'],
+              chainId: 1424310003,
+              deploymentBlock: 31730087,
+              earnRouter: '0xebedc74ffeead186acc6cac05eb82fb9e093a7c7',
+              inputTokens: ['0x20c0000000000000000000002139993d5f625d59'],
               name: 'zone-moderato-internal',
-              outputTokens: ['0x20c000000000000000000000ff04042ee92fd449'],
+              outputTokens: ['0x20c0000000000000000000002139993d5f625d59'],
             },
           ],
         ],

package/src/apps/data/routes/earn.zone-access.test.ts

@@ -4,15 +4,15 @@ import * as Earn from './earn.js'
 
 describe('hasZoneAccess', () => {
   test('matches every Zone granted by read or wildcard scopes', () => {
-    const scopes = ['data:read', 'zone:1424310001:read', 'zone:1424310003:write']
-    const visible = [1424310001, 1424310002, 1424310003].filter((chainId) =>
+    const scopes = ['data:read', 'zone:1424310003:read', 'zone:1424310005:write']
+    const visible = [1424310003, 1424310004, 1424310005].filter((chainId) =>
       Earn.hasZoneAccess({ chainId, scopes }),
     )
 
-    expect(visible).toStrictEqual([1424310001])
-    expect(Earn.hasZoneAccess({ chainId: 1424310002, scopes: ['*'] })).toBe(true)
-    expect(Earn.hasZoneAccess({ chainId: 1424310003, scopes })).toBe(false)
-    expect(Earn.hasZoneAccess({ chainId: 1424310001 })).toBe(false)
+    expect(visible).toStrictEqual([1424310003])
+    expect(Earn.hasZoneAccess({ chainId: 1424310004, scopes: ['*'] })).toBe(true)
+    expect(Earn.hasZoneAccess({ chainId: 1424310005, scopes })).toBe(false)
+    expect(Earn.hasZoneAccess({ chainId: 1424310003 })).toBe(false)
   })
 })
 

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

@@ -85,6 +85,8 @@ export namespace schema {
     })
     .check(z.describe('One event log emitted by a contract during transaction execution.'))
 
+  const rpcLog = OpenApi.component(Log, 'RpcTransactionLog')
+
   /** The verbatim JSON-RPC payloads, surfaced under each resource's `rpc` field. */
   export namespace Rpc {
     // TODO(ox/zod): replace with the zod schema for `ox/tempo`'s
@@ -145,7 +147,7 @@ export namespace schema {
         ),
         gasUsed: Schema.Quantity.check(z.describe('Gas actually used to execute the transaction.')),
         logs: z
-          .array(Log)
+          .array(rpcLog)
           .check(z.describe('Event logs emitted by contracts while this transaction executed.')),
         logsBloom: z
           .optional(Schema.Hex)
@@ -186,6 +188,8 @@ export namespace schema {
       .check(z.describe('The transaction receipt exactly as returned by JSON-RPC.'))
   }
 
+  const rpcReceipt = OpenApi.component(Rpc.Receipt, 'RpcTransactionReceipt')
+
   /** Receipt metadata containing valuation provenance and the verbatim JSON-RPC receipt. */
   export const ReceiptMeta = z
     .object({
@@ -196,10 +200,12 @@ export namespace schema {
             'Rate provenance for the fee valuation. Present when conversion rates were consulted.',
           ),
         ),
-      rpc: Rpc.Receipt.check(z.describe('The original JSON-RPC receipt payload.')),
+      rpc: rpcReceipt.check(z.describe('The original JSON-RPC receipt payload.')),
     })
     .check(z.describe('Metadata for this receipt, including valuation and the JSON-RPC payload.'))
 
+  const receiptMeta = OpenApi.component(ReceiptMeta, 'TransactionReceiptMeta')
+
   /** The fee charged to the fee payer, carrying its value in the requested denomination. */
   export const FeeAmount = z
     .extend(Schema.TokenAmount, {
@@ -215,6 +221,8 @@ export namespace schema {
       z.describe('The fee charged to the fee payer, with its value in the requested denomination.'),
     )
 
+  const receiptFeeAmount = OpenApi.component(FeeAmount, 'TransactionReceiptFeeAmount')
+
   /**
    * A humanized transaction receipt: decoded `status`/`type`, plain-number gas
    * and block fields, a structured fee amount, and a decimal-string gas price.
@@ -255,7 +263,9 @@ export namespace schema {
       effectiveGasPrice: Schema.DecimalString.check(
         z.describe('Effective gas price paid for this transaction, in attodollars per gas.'),
       ),
-      feeAmount: FeeAmount.check(z.describe('Fee charged to the fee payer, denominated in USD.')),
+      feeAmount: receiptFeeAmount.check(
+        z.describe('Fee charged to the fee payer, denominated in USD.'),
+      ),
       feePayer: z
         .optional(Schema.Address)
         .check(z.describe('The address that paid the transaction fee.')),
@@ -278,11 +288,11 @@ export namespace schema {
         z.describe('Stable resource ID for this API response; it is the transaction hash.'),
       ),
       logs: z
-        .array(Log)
+        .array(rpcLog)
         .check(
           z.describe('Event logs emitted by this transaction, returned in JSON-RPC log format.'),
         ),
-      meta: ReceiptMeta.check(
+      meta: receiptMeta.check(
         z.describe(
           'Receipt metadata containing valuation rate provenance and the JSON-RPC payload.',
         ),
@@ -330,6 +340,9 @@ export namespace schema {
       ),
     )
 
+  /** Humanized transaction receipt shared by detail, list, and transaction includes. */
+  export const TransactionReceipt = OpenApi.component(Receipt, 'TransactionReceipt')
+
   /** Schemas for the getReceipt operation. */
   export namespace getReceipt {
     /** Path parameters for receipt requests. */
@@ -368,7 +381,7 @@ export namespace schema {
       .check(z.describe('Query parameters for looking up a receipt.'))
 
     /** A humanized receipt, with the verbatim JSON-RPC payload under `meta.rpc`. */
-    export const Response = Receipt
+    export const Response = TransactionReceipt
   }
 
   /** Schemas for the getReceipts (list) operation. */
@@ -453,15 +466,22 @@ export namespace schema {
       })
       .check(z.describe('Page-level resources attached to this response.'))
 
-    export const Response = z
-      .object({
-        data: z.array(getReceipt.Response).check(z.describe('Receipts on this page.')),
-        meta: z
-          .optional(Meta)
-          .check(z.describe('Page-level resources: opt-in counts and valuation rate provenance.')),
-        nextCursor: Schema.NextCursor,
-      })
-      .check(z.describe('A page of receipts ordered by block number and transaction position.'))
+    const meta = OpenApi.component(Meta, 'TransactionReceiptListMeta')
+
+    export const Response = OpenApi.component(
+      z
+        .object({
+          data: z.array(getReceipt.Response).check(z.describe('Receipts on this page.')),
+          meta: z
+            .optional(meta)
+            .check(
+              z.describe('Page-level resources: opt-in counts and valuation rate provenance.'),
+            ),
+          nextCursor: Schema.NextCursor,
+        })
+        .check(z.describe('A page of receipts ordered by block number and transaction position.')),
+      'TransactionReceiptList',
+    )
   }
 }
 
@@ -481,7 +501,10 @@ export function receipts(options: receipts.Options = {}) {
           'List transaction receipts across Tempo, with filters for addresses, blocks, timestamps, fees, and status.',
         operationId: 'getReceipts',
         responses: OpenApi.responses({
-          errors: { 502: 'Could not read receipt or token data from an upstream service.' },
+          errors: {
+            400: { codes: ['chain_id_invalid', 'chain_id_unsupported', 'query_invalid'] },
+            502: 'Could not read receipt or token data from an upstream service.',
+          },
           success: {
             description: 'A page of transaction receipts.',
             schema: schema.getReceipts.Response,
@@ -614,6 +637,14 @@ export function receipts(options: receipts.Options = {}) {
         operationId: 'getReceipt',
         responses: OpenApi.responses({
           errors: {
+            400: {
+              codes: [
+                'chain_id_invalid',
+                'chain_id_unsupported',
+                'query_invalid',
+                'transaction_invalid',
+              ],
+            },
             404: {
               description: 'No receipt was found for that transaction hash.',
               codes: ['receipt_not_found'],