tapimo 0.11.0 → 0.12.0

package/src/internal/funding/DepositAddress.ts

@@ -3,6 +3,7 @@ import * as z from 'zod/mini'
 import type * as Db from '../../db/Db.js'
 import * as FundingDepositAddresses from '../../db/tables/fundingDepositAddresses.js'
 import * as Id from '../Id.js'
+import * as OpenApi from '../OpenApi.js'
 import * as Provider from './Provider.js'
 import * as Transfer from './Transfer.js'
 
@@ -83,51 +84,57 @@ export namespace schema {
     .check(z.describe('Public route and ownership-independent fields of a deposit address.'))
 
   /** One reusable funding deposit address. */
-  export const FundingDepositAddress = z
-    .object({
-      address: Snapshot.shape.address,
-      createdAt: z
-        .string()
-        .check(
-          z.describe('When the deposit address was created (ISO 8601).'),
-          z.meta({ examples: ['2026-08-04T00:00:00.000Z'] }),
-        ),
-      destinationChain: Snapshot.shape.destinationChain,
-      destinationToken: Snapshot.shape.destinationToken,
-      id: z
-        .string()
-        .check(
-          z.regex(/^fda_[A-Za-z0-9_-]+$/),
-          z.describe('Funding deposit address id (`fda_…`).'),
-          z.meta({ examples: ['fda_001785792000000_2ZPE2gvateYEQ0dQslgvkhjx'] }),
-        ),
-      provider: Snapshot.shape.provider,
-      recipient: Snapshot.shape.recipient,
-      refundAddress: Snapshot.shape.refundAddress,
-      sourceChain: Snapshot.shape.sourceChain,
-      sourceToken: Snapshot.shape.sourceToken,
-      status: Status,
-      subsidize: Snapshot.shape.subsidize,
-      updatedAt: z
-        .string()
-        .check(
-          z.describe('When the deposit address last materially changed (ISO 8601).'),
-          z.meta({ examples: ['2026-08-04T00:00:00.000Z'] }),
-        ),
-    })
-    .check(z.describe('One reusable address for funding a Tempo account.'))
+  export const FundingDepositAddress = OpenApi.component(
+    z
+      .object({
+        address: Snapshot.shape.address,
+        createdAt: z.iso
+          .datetime()
+          .check(
+            z.describe('When the deposit address was created (ISO 8601).'),
+            z.meta({ examples: ['2026-08-04T00:00:00.000Z'] }),
+          ),
+        destinationChain: Snapshot.shape.destinationChain,
+        destinationToken: Snapshot.shape.destinationToken,
+        id: z
+          .string()
+          .check(
+            z.regex(/^fda_[A-Za-z0-9_-]+$/),
+            z.describe('Funding deposit address id (`fda_…`).'),
+            z.meta({ examples: ['fda_001785792000000_2ZPE2gvateYEQ0dQslgvkhjx'] }),
+          ),
+        provider: Snapshot.shape.provider,
+        recipient: Snapshot.shape.recipient,
+        refundAddress: Snapshot.shape.refundAddress,
+        sourceChain: Snapshot.shape.sourceChain,
+        sourceToken: Snapshot.shape.sourceToken,
+        status: Status,
+        subsidize: Snapshot.shape.subsidize,
+        updatedAt: z.iso
+          .datetime()
+          .check(
+            z.describe('When the deposit address last materially changed (ISO 8601).'),
+            z.meta({ examples: ['2026-08-04T00:00:00.000Z'] }),
+          ),
+      })
+      .check(z.describe('One reusable address for funding a Tempo account.')),
+    'FundingDepositAddress',
+  )
 
   /** A reusable funding deposit address with terms sampled during creation. */
-  export const CreatedFundingDepositAddress = z
-    .object({
-      ...FundingDepositAddress.shape,
-      destinationAmount: Provider.schema.FundingQuote.shape.destinationAmount,
-      destinationAmountMin: Provider.schema.FundingQuote.shape.destinationAmountMin,
-      fees: z.array(Transfer.schema.Fee).check(z.describe('Fees applied to the quoted deposit.')),
-      quote: Provider.schema.QuoteDetails,
-      sourceAmount: Provider.schema.FundingQuote.shape.sourceAmount,
-    })
-    .check(z.describe('A reusable funding deposit address with current quoted delivery terms.'))
+  export const CreatedFundingDepositAddress = OpenApi.component(
+    z
+      .object({
+        ...FundingDepositAddress.shape,
+        destinationAmount: Provider.schema.FundingQuote.shape.destinationAmount,
+        destinationAmountMin: Provider.schema.FundingQuote.shape.destinationAmountMin,
+        fees: z.array(Transfer.schema.Fee).check(z.describe('Fees applied to the quoted deposit.')),
+        quote: Provider.schema.QuoteDetails,
+        sourceAmount: Provider.schema.FundingQuote.shape.sourceAmount,
+      })
+      .check(z.describe('A reusable funding deposit address with current quoted delivery terms.')),
+    'CreatedFundingDepositAddress',
+  )
 }
 
 /** Stored public snapshot of a funding deposit address. */

package/src/internal/funding/Provider.ts

@@ -2,6 +2,7 @@ import { Address, Base58, Bytes, Hash, Value as core_Value } from 'ox'
 import * as z from 'zod/mini'
 
 import * as core_Provider from '../Provider.js'
+import * as OpenApi from '../OpenApi.js'
 import * as Schema from '../Schema.js'
 import * as Value from '../Value.js'
 import * as Action from './Action.js'
@@ -42,85 +43,97 @@ export namespace schema {
   export const PositiveInteger = z.string().check(z.regex(/^(?=.*[1-9])\d+$/))
 
   /** Normalized chain reference passed to funding providers. */
-  export const ChainRef = Schema.describe(
-    z.object({
-      addressFormat: z
-        .enum(['base58', 'base58check', 'hex'])
-        .check(
-          z.describe('Address encoding used by accounts and token identifiers on this chain.'),
-          z.meta({ examples: ['hex'] }),
-        ),
-      id: z.string().check(z.describe('CAIP-2 chain id.'), z.meta({ examples: ['eip155:8453'] })),
-      kind: z
-        .enum(['evm', 'solana', 'tron'])
-        .check(
-          z.describe('Chain execution family used for provider routing.'),
-          z.meta({ examples: ['evm'] }),
-        ),
-      name: z
-        .string()
-        .check(z.describe('Human-readable chain name.'), z.meta({ examples: ['Base'] })),
-    }),
-    'A normalized chain reference for funding quotes.',
+  export const ChainRef = OpenApi.component(
+    Schema.describe(
+      z.object({
+        addressFormat: z
+          .enum(['base58', 'base58check', 'hex'])
+          .check(
+            z.describe('Address encoding used by accounts and token identifiers on this chain.'),
+            z.meta({ examples: ['hex'] }),
+          ),
+        id: z.string().check(z.describe('CAIP-2 chain id.'), z.meta({ examples: ['eip155:8453'] })),
+        kind: z
+          .enum(['evm', 'solana', 'tron'])
+          .check(
+            z.describe('Chain execution family used for provider routing.'),
+            z.meta({ examples: ['evm'] }),
+          ),
+        name: z
+          .string()
+          .check(z.describe('Human-readable chain name.'), z.meta({ examples: ['Base'] })),
+      }),
+      'A normalized chain reference for funding quotes.',
+    ),
+    'FundingChain',
   )
 
   /** Normalized token reference passed to funding providers. */
-  export const TokenRef = Schema.describe(
-    z.object({
-      address: z
-        .string()
-        .check(
-          z.describe('Contract address, mint, or issuer address on the token chain.'),
-          z.meta({ examples: ['0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'] }),
-        ),
-      currency: z
-        .string()
-        .check(
-          z.describe('Monetary denomination represented by this token.'),
-          z.meta({ examples: ['USD'] }),
-        ),
-      decimals: z
-        .number()
-        .check(
-          z.int(),
-          z.gte(0),
-          z.describe('Number of decimal places this token uses.'),
-          z.meta({ examples: [6] }),
-        ),
-      name: z
-        .string()
-        .check(z.describe('Human-readable token name.'), z.meta({ examples: ['USD Coin'] })),
-      standard: z
-        .string()
-        .check(z.describe('Token standard on the token chain.'), z.meta({ examples: ['ERC-20'] })),
-      symbol: z
-        .string()
-        .check(z.describe('Short token ticker symbol.'), z.meta({ examples: ['USDC'] })),
-      tokenKey: z.string().check(
-        z.describe('Stable Tempo token key scoped to the token chain.'),
-        z.meta({
-          examples: ['eip155:8453/erc20:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'],
-        }),
-      ),
-      verified: z
-        .boolean()
-        .check(
-          z.describe('Whether Tempo recognizes this token in its funding quote inventory.'),
-          z.meta({ examples: [true] }),
+  export const TokenRef = OpenApi.component(
+    Schema.describe(
+      z.object({
+        address: z
+          .string()
+          .check(
+            z.describe('Contract address, mint, or issuer address on the token chain.'),
+            z.meta({ examples: ['0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'] }),
+          ),
+        currency: z
+          .string()
+          .check(
+            z.describe('Monetary denomination represented by this token.'),
+            z.meta({ examples: ['USD'] }),
+          ),
+        decimals: z
+          .number()
+          .check(
+            z.int(),
+            z.gte(0),
+            z.describe('Number of decimal places this token uses.'),
+            z.meta({ examples: [6] }),
+          ),
+        name: z
+          .string()
+          .check(z.describe('Human-readable token name.'), z.meta({ examples: ['USD Coin'] })),
+        standard: z
+          .string()
+          .check(
+            z.describe('Token standard on the token chain.'),
+            z.meta({ examples: ['ERC-20'] }),
+          ),
+        symbol: z
+          .string()
+          .check(z.describe('Short token ticker symbol.'), z.meta({ examples: ['USDC'] })),
+        tokenKey: z.string().check(
+          z.describe('Stable Tempo token key scoped to the token chain.'),
+          z.meta({
+            examples: ['eip155:8453/erc20:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'],
+          }),
         ),
-    }),
-    'A normalized token reference for funding quotes.',
+        verified: z
+          .boolean()
+          .check(
+            z.describe('Whether Tempo recognizes this token in its funding quote inventory.'),
+            z.meta({ examples: [true] }),
+          ),
+      }),
+      'A normalized token reference for funding quotes.',
+    ),
+    'FundingToken',
   )
 
   /** Provider identity embedded in funding resources. */
-  export const ProviderRef = Schema.describe(
-    z.object({
-      id: z.string().check(z.describe('Stable provider id.'), z.meta({ examples: ['relay'] })),
-      name: z
-        .string()
-        .check(z.describe('Human-readable provider name.'), z.meta({ examples: ['Relay'] })),
-    }),
-    'Provider metadata embedded in a funding quote.',
+  export const ProviderRef = OpenApi.component(
+    Schema.describe(
+      z.object({
+        id: z.string().check(z.describe('Stable provider id.'), z.meta({ examples: ['relay'] })),
+        name: z
+          .string()
+          .check(z.describe('Human-readable provider name.'), z.meta({ examples: ['Relay'] })),
+      }),
+      'Provider metadata embedded in a funding quote.',
+    ),
+    'FundingProvider',
   )
 
   /** Source amount unit accepted by a funding quote request. */
@@ -264,84 +277,93 @@ export namespace schema {
   })
 
   /** Quote quality signals exposed to funding API callers. */
-  export const FundingQuoteQuality = Schema.describe(
-    z.object({
-      estimatedSeconds: z
-        .optional(z.number().check(z.int(), z.nonnegative()))
-        .check(
-          z.describe('Estimated settlement time in seconds, when known.'),
-          z.meta({ examples: [2] }),
-        ),
-      liquiditySource: z
-        .string()
-        .check(
-          z.describe('Provider source for the live quote quality signal.'),
-          z.meta({ examples: ['providerQuote'] }),
-        ),
-      sourceDetail: z
-        .optional(z.string())
-        .check(
-          z.describe('Provider-specific source or endpoint detail for the quality signal.'),
-          z.meta({ examples: ['providerEndpoint'] }),
-        ),
-      tier: z
-        .enum(['liquid', 'thin'])
-        .check(
-          z.describe('Machine-readable quote quality tier for a successful quote.'),
-          z.meta({ examples: ['liquid'] }),
-        ),
-    }),
-    'Machine-readable liquidity, fee, and source signals for a successful quote.',
+  export const FundingQuoteQuality = OpenApi.component(
+    Schema.describe(
+      z.object({
+        estimatedSeconds: z
+          .optional(z.number().check(z.int(), z.nonnegative()))
+          .check(
+            z.describe('Estimated settlement time in seconds, when known.'),
+            z.meta({ examples: [2] }),
+          ),
+        liquiditySource: z
+          .string()
+          .check(
+            z.describe('Provider source for the live quote quality signal.'),
+            z.meta({ examples: ['providerQuote'] }),
+          ),
+        sourceDetail: z
+          .optional(z.string())
+          .check(
+            z.describe('Provider-specific source or endpoint detail for the quality signal.'),
+            z.meta({ examples: ['providerEndpoint'] }),
+          ),
+        tier: z
+          .enum(['liquid', 'thin'])
+          .check(
+            z.describe('Machine-readable quote quality tier for a successful quote.'),
+            z.meta({ examples: ['liquid'] }),
+          ),
+      }),
+      'Machine-readable liquidity, fee, and source signals for a successful quote.',
+    ),
+    'FundingQuoteQuality',
   )
 
   /** Provider quote freshness data exposed to funding API callers. */
-  export const QuoteDetails = Schema.describe(
-    z.object({
-      expiresAt: z
-        .optional(z.iso.datetime())
-        .check(
-          z.describe('Timestamp after which the provider quote is no longer valid.'),
-          z.meta({ examples: ['2026-01-01T00:01:00Z'] }),
-        ),
-      sampledAt: z.iso
-        .datetime()
-        .check(
-          z.describe('Timestamp for the live quote request.'),
-          z.meta({ examples: ['2026-01-01T00:00:00Z'] }),
-        ),
-    }),
-    'Freshness data for a provider funding quote.',
+  export const QuoteDetails = OpenApi.component(
+    Schema.describe(
+      z.object({
+        expiresAt: z
+          .optional(z.iso.datetime())
+          .check(
+            z.describe('Timestamp after which the provider quote is no longer valid.'),
+            z.meta({ examples: ['2026-01-01T00:01:00Z'] }),
+          ),
+        sampledAt: z.iso
+          .datetime()
+          .check(
+            z.describe('Timestamp for the live quote request.'),
+            z.meta({ examples: ['2026-01-01T00:00:00Z'] }),
+          ),
+      }),
+      'Freshness data for a provider funding quote.',
+    ),
+    'FundingQuoteDetails',
   )
 
   /** Successful normalized funding quote returned to callers. */
-  export const FundingQuote = Schema.describe(
-    z.object({
-      destinationAmount: Schema.TokenAmount.check(z.describe('Expected destination amount.')),
-      destinationAmountMin: z
-        .optional(Schema.TokenAmount)
-        .check(
-          z.describe(
-            'Provider-derived minimum destination amount. Symbiosis and Squid quotes use a fixed 1% slippage tolerance.',
+  export const FundingQuote = OpenApi.component(
+    Schema.describe(
+      z.object({
+        destinationAmount: Schema.TokenAmount.check(z.describe('Expected destination amount.')),
+        destinationAmountMin: z
+          .optional(Schema.TokenAmount)
+          .check(
+            z.describe(
+              'Provider-derived minimum destination amount. Symbiosis and Squid quotes use a fixed 1% slippage tolerance.',
+            ),
           ),
+        destinationChain: ChainRef.check(
+          z.describe('Destination chain, always Tempo mainnet in V1.'),
         ),
-      destinationChain: ChainRef.check(
-        z.describe('Destination chain, always Tempo mainnet in V1.'),
-      ),
-      destinationToken: TokenRef.check(z.describe('Tempo token expected from this quote.')),
-      id: z
-        .string()
-        .check(
-          z.describe('Stable deterministic funding quote id.'),
-          z.meta({ examples: ['base-usdc-tempo-usdce-relay'] }),
-        ),
-      provider: ProviderRef,
-      quality: FundingQuoteQuality,
-      quote: QuoteDetails,
-      sourceAmount: Schema.TokenAmount,
-      sourceChain: ChainRef.check(z.describe('Chain where the caller currently holds funds.')),
-      sourceToken: TokenRef.check(z.describe('Token the caller currently holds.')),
-    }),
-    'One successful provider-specific funding quote.',
+        destinationToken: TokenRef.check(z.describe('Tempo token expected from this quote.')),
+        id: z
+          .string()
+          .check(
+            z.describe('Stable deterministic funding quote id.'),
+            z.meta({ examples: ['base-usdc-tempo-usdce-relay'] }),
+          ),
+        provider: ProviderRef,
+        quality: FundingQuoteQuality,
+        quote: QuoteDetails,
+        sourceAmount: Schema.TokenAmount,
+        sourceChain: ChainRef.check(z.describe('Chain where the caller currently holds funds.')),
+        sourceToken: TokenRef.check(z.describe('Token the caller currently holds.')),
+      }),
+      'One successful provider-specific funding quote.',
+    ),
+    'FundingQuote',
   )
 }