mppx 0.8.17 → 0.8.18

package/src/tempo/subscription/Store.ts

@@ -1,449 +0,0 @@
-import { Secp256k1 } from 'ox'
-import { Account as TempoAccount } from 'viem/tempo'
-
-import * as Store from '../../Store.js'
-import type { SubscriptionAccessKeyRecord, SubscriptionRecord } from './Types.js'
-
-const defaultRecordPrefix = 'tempo:subscription:record:'
-const defaultKeyPrefix = 'tempo:subscription:key:'
-const defaultActivationPrefix = 'tempo:subscription:activation:'
-const defaultAccessKeyPrefix = 'tempo:subscription:access-key:'
-const defaultCredentialPrefix = 'tempo:subscription:credential:'
-const defaultActivationTimeoutMs = 15 * 60 * 1_000
-const defaultRenewalTimeoutMs = 15 * 60 * 1_000
-
-/** Subscription-aware wrapper around a generic key-value store. */
-export type SubscriptionStore = {
-  /** Runs activation once for a challenge and resolved lookup key. */
-  activate<result extends { subscription: SubscriptionRecord }>(
-    parameters: ActivateParameters<result>,
-  ): Promise<ActivateResult<result>>
-  /** Looks up a subscription by subscription ID. */
-  get(subscriptionId: string): Promise<SubscriptionRecord | null>
-  /** Looks up a generated access key for a resolved request key. */
-  getAccessKey(key: string): Promise<SubscriptionAccessKeyRecord | null>
-  /** Looks up a generated access key by its public access key address. */
-  getAccessKeyByAddress(address: string): Promise<SubscriptionAccessKeyRecord | null>
-  /** Looks up the active subscription for a resolved request key. */
-  getByKey(key: string): Promise<SubscriptionRecord | null>
-  /** Gets or creates the server-owned access key for a resolved request key. */
-  getOrCreateAccessKey(key: string): Promise<SubscriptionAccessKeyRecord>
-  /** Upserts a subscription record and marks it as active for its lookup key. */
-  put(record: SubscriptionRecord): Promise<void>
-  /** Runs renewal once for a subscription period. */
-  renew<result extends { subscription: SubscriptionRecord }>(
-    parameters: RenewParameters<result>,
-  ): Promise<RenewResult<result>>
-}
-
-type ActivateParameters<result extends { subscription: SubscriptionRecord }> = {
-  challengeId: string
-  create: () => Promise<result>
-  isReusable?: ((subscription: SubscriptionRecord) => boolean) | undefined
-  lookupKey: string
-}
-
-export type ActivateResult<result extends { subscription: SubscriptionRecord }> =
-  | { status: 'activated'; result: result }
-  | { status: 'claimMismatch' }
-  | { status: 'existing'; subscription: SubscriptionRecord }
-  | { status: 'inFlight' }
-  | { status: 'replayed' }
-
-type RenewParameters<result extends { subscription: SubscriptionRecord }> = {
-  inFlightReference: string
-  periodIndex: number
-  renew: (parameters: {
-    inFlightReference: string
-    periodIndex: number
-    subscription: SubscriptionRecord
-  }) => Promise<result>
-  subscriptionId: string
-}
-
-export type RenewResult<result extends { subscription: SubscriptionRecord }> =
-  | { status: 'charged'; subscription: SubscriptionRecord }
-  | { status: 'inFlight'; subscription: SubscriptionRecord }
-  | { status: 'missing' }
-  | { status: 'renewed'; result: result }
-  | { status: 'superseded'; subscription: SubscriptionRecord }
-  | { status: 'claimMismatch' }
-
-type ActivationMarker = {
-  challengeId?: string
-  committingAt?: string
-  startedAt?: string
-}
-
-/** Wraps a generic key-value {@link Store.Store} with subscription-specific accessors. */
-export function fromStore(
-  store: Store.AtomicStore<Record<string, unknown>>,
-  options?: fromStore.Options,
-): SubscriptionStore {
-  const {
-    accessKeyPrefix = defaultAccessKeyPrefix,
-    activationPrefix = defaultActivationPrefix,
-    activationTimeoutMs = defaultActivationTimeoutMs,
-    credentialPrefix = defaultCredentialPrefix,
-    keyPrefix = defaultKeyPrefix,
-    recordPrefix = defaultRecordPrefix,
-    renewalTimeoutMs = defaultRenewalTimeoutMs,
-  } = options ?? {}
-
-  function recordKey(subscriptionId: string): string {
-    return `${recordPrefix}${subscriptionId}`
-  }
-
-  function activationKey(key: string): string {
-    return `${activationPrefix}${key}`
-  }
-
-  function credentialKey(challengeId: string): string {
-    return `${credentialPrefix}${challengeId}`
-  }
-
-  function accessKeyKey(key: string): string {
-    return `${accessKeyPrefix}${key}`
-  }
-
-  function accessKeyAddressKey(address: string): string {
-    return `${accessKeyPrefix}address:${address.toLowerCase()}`
-  }
-
-  function lookupRecordKey(key: string): string {
-    return `${keyPrefix}${key}`
-  }
-
-  async function getByLookupKey(key: string): Promise<SubscriptionRecord | null> {
-    const subscriptionId = (await store.get(lookupRecordKey(key))) as string | null
-    if (!subscriptionId) return null
-    return (await store.get(recordKey(subscriptionId))) as SubscriptionRecord | null
-  }
-
-  async function clearRenewalState(subscriptionId: string, periodIndex: number, attempt: string) {
-    await store.update(recordKey(subscriptionId), (current) => {
-      const subscription = current as SubscriptionRecord | null
-      if (
-        !subscription ||
-        subscription.inFlightPeriod !== periodIndex ||
-        subscription.inFlightAttempt !== attempt
-      ) {
-        return { op: 'noop', result: undefined }
-      }
-      return {
-        op: 'set',
-        value: clearRenewal(subscription),
-        result: undefined,
-      }
-    })
-  }
-
-  async function clearActivationState(lookupKey: string, challengeId: string) {
-    await store.update(activationKey(lookupKey), (current) => {
-      const marker = current as ActivationMarker | null
-      if (marker?.challengeId !== challengeId) return { op: 'noop', result: undefined }
-      return { op: 'delete', result: undefined }
-    })
-  }
-
-  async function ownsActivation(lookupKey: string, challengeId: string): Promise<boolean> {
-    const marker = (await store.get(activationKey(lookupKey))) as ActivationMarker | null
-    return marker?.challengeId === challengeId
-  }
-
-  return {
-    async activate({ challengeId, create, isReusable, lookupKey }) {
-      const claimed = await store.update(credentialKey(challengeId), (current) => {
-        if (current) return { op: 'noop', result: false }
-        return {
-          op: 'set',
-          value: { claimedAt: timestamp() },
-          result: true,
-        }
-      })
-      if (!claimed) return { status: 'replayed' }
-
-      const existing = await getByLookupKey(lookupKey)
-      if (existing && isReusable?.(existing)) {
-        return { status: 'existing', subscription: existing }
-      }
-
-      const started = await store.update(
-        activationKey(lookupKey),
-        (current): Store.Change<unknown, { status: 'started' } | { status: 'inFlight' }> => {
-          const marker = current as ActivationMarker | null
-          if (marker && !isStaleActivation(marker, activationTimeoutMs)) {
-            return { op: 'noop', result: { status: 'inFlight' as const } }
-          }
-          return {
-            op: 'set',
-            value: {
-              challengeId,
-              startedAt: timestamp(),
-            },
-            result: { status: 'started' as const },
-          }
-        },
-      )
-      if (started.status !== 'started') return { status: 'inFlight' }
-
-      const claimedExisting = await getByLookupKey(lookupKey)
-      if (claimedExisting && isReusable?.(claimedExisting)) {
-        await clearActivationState(lookupKey, challengeId)
-        return { status: 'existing', subscription: claimedExisting }
-      }
-
-      const result = await create().catch(async (error) => {
-        await clearActivationState(lookupKey, challengeId)
-        throw error
-      })
-      const { subscription } = result
-      const committed = await store.update(activationKey(subscription.lookupKey), (current) => {
-        const marker = current as ActivationMarker | null
-        if (marker?.challengeId !== challengeId) return { op: 'noop', result: false }
-        return {
-          op: 'set',
-          value: {
-            ...marker,
-            committingAt: timestamp(),
-            startedAt: timestamp(),
-          },
-          result: true,
-        }
-      })
-      if (!committed) {
-        await store.put(recordKey(subscription.subscriptionId), {
-          ...subscription,
-          canceledAt: subscription.canceledAt ?? timestamp(),
-        })
-        return { status: 'claimMismatch' }
-      }
-
-      const previous = await getByLookupKey(subscription.lookupKey)
-      if (previous && previous.subscriptionId !== subscription.subscriptionId) {
-        if (!(await ownsActivation(subscription.lookupKey, challengeId))) {
-          return { status: 'claimMismatch' }
-        }
-        await store.put(recordKey(previous.subscriptionId), {
-          ...previous,
-          canceledAt: previous.canceledAt ?? timestamp(),
-        })
-      }
-      if (!(await ownsActivation(subscription.lookupKey, challengeId))) {
-        return { status: 'claimMismatch' }
-      }
-      await store.put(recordKey(subscription.subscriptionId), subscription)
-      if (!(await ownsActivation(subscription.lookupKey, challengeId))) {
-        return { status: 'claimMismatch' }
-      }
-      await store.put(lookupRecordKey(subscription.lookupKey), subscription.subscriptionId)
-      await clearActivationState(subscription.lookupKey, challengeId)
-      return { status: 'activated', result }
-    },
-
-    async get(subscriptionId) {
-      return (await store.get(recordKey(subscriptionId))) as SubscriptionRecord | null
-    },
-
-    async getAccessKey(key) {
-      return (await store.get(accessKeyKey(key))) as SubscriptionAccessKeyRecord | null
-    },
-
-    async getAccessKeyByAddress(address) {
-      return (await store.get(accessKeyAddressKey(address))) as SubscriptionAccessKeyRecord | null
-    },
-
-    async getByKey(key) {
-      return getByLookupKey(key)
-    },
-
-    async getOrCreateAccessKey(key) {
-      const existing = (await store.get(accessKeyKey(key))) as SubscriptionAccessKeyRecord | null
-      if (existing) return existing
-
-      const privateKey = Secp256k1.randomPrivateKey()
-      const account = TempoAccount.fromSecp256k1(privateKey)
-      const candidate = {
-        accessKeyAddress: account.address.toLowerCase() as `0x${string}`,
-        keyType: account.keyType,
-        privateKey,
-      } satisfies SubscriptionAccessKeyRecord
-      return store
-        .update(
-          accessKeyKey(key),
-          (current): Store.Change<unknown, SubscriptionAccessKeyRecord> => {
-            if (current) {
-              return { op: 'noop', result: current as SubscriptionAccessKeyRecord }
-            }
-            return { op: 'set', value: candidate, result: candidate }
-          },
-        )
-        .then(async (record) => {
-          await store.update(accessKeyAddressKey(record.accessKeyAddress), (current) => {
-            if (current) return { op: 'noop', result: undefined }
-            return { op: 'set', value: record, result: undefined }
-          })
-          return record
-        })
-    },
-
-    async put(record) {
-      await store.put(recordKey(record.subscriptionId), record)
-      await store.put(lookupRecordKey(record.lookupKey), record.subscriptionId)
-    },
-
-    async renew({ inFlightReference, periodIndex, renew, subscriptionId }) {
-      const attempt = createAttemptToken()
-      const started = await store.update(
-        recordKey(subscriptionId),
-        (
-          current,
-        ): Store.Change<
-          unknown,
-          | { status: 'started'; subscription: SubscriptionRecord }
-          | { status: 'charged'; subscription: SubscriptionRecord }
-          | { status: 'inFlight'; subscription: SubscriptionRecord }
-          | { status: 'missing' }
-        > => {
-          const subscription = current as SubscriptionRecord | null
-          if (!subscription) return { op: 'noop', result: { status: 'missing' as const } }
-          if (subscription.lastChargedPeriod >= periodIndex) {
-            return {
-              op: 'noop',
-              result: { status: 'charged' as const, subscription },
-            }
-          }
-          if (
-            subscription.inFlightPeriod !== undefined &&
-            !isStaleRenewal(subscription, renewalTimeoutMs)
-          ) {
-            return {
-              op: 'noop',
-              result: { status: 'inFlight' as const, subscription },
-            }
-          }
-
-          const next = {
-            ...subscription,
-            inFlightAttempt: attempt,
-            inFlightPeriod: periodIndex,
-            inFlightReference,
-            inFlightStartedAt: timestamp(),
-          }
-          return {
-            op: 'set',
-            value: next,
-            result: { status: 'started' as const, subscription: next },
-          }
-        },
-      )
-      if (started.status !== 'started') return started
-      const active = await getByLookupKey(started.subscription.lookupKey)
-      if (active?.subscriptionId !== subscriptionId) {
-        await clearRenewalState(subscriptionId, periodIndex, attempt)
-        return { status: 'superseded', subscription: started.subscription }
-      }
-
-      const result = await renew({
-        inFlightReference,
-        periodIndex,
-        subscription: started.subscription,
-      }).catch(async (error) => {
-        await clearRenewalState(subscriptionId, periodIndex, attempt)
-        throw error
-      })
-
-      const activeAfterRenew = await getByLookupKey(result.subscription.lookupKey)
-      if (activeAfterRenew?.subscriptionId !== subscriptionId) {
-        await clearRenewalState(subscriptionId, periodIndex, attempt)
-        return { status: 'superseded', subscription: started.subscription }
-      }
-
-      const committed = await store.update(recordKey(subscriptionId), (current) => {
-        const existing = current as SubscriptionRecord | null
-        if (
-          !existing ||
-          existing.inFlightPeriod !== periodIndex ||
-          existing.inFlightAttempt !== attempt
-        ) {
-          return { op: 'noop', result: false }
-        }
-
-        const terminal = {
-          ...(existing.canceledAt ? { canceledAt: existing.canceledAt } : {}),
-          ...(existing.revokedAt ? { revokedAt: existing.revokedAt } : {}),
-        }
-        return {
-          op: 'set',
-          value: clearRenewal({
-            ...result.subscription,
-            ...terminal,
-            lastChargedPeriod: periodIndex,
-            subscriptionId,
-          }),
-          result: true,
-        }
-      })
-      if (!committed) return { status: 'claimMismatch' }
-
-      const ownsLookup = await store.update(
-        lookupRecordKey(result.subscription.lookupKey),
-        (current) => {
-          if (current !== subscriptionId) return { op: 'noop', result: false }
-          return { op: 'set', value: subscriptionId, result: true }
-        },
-      )
-      if (!ownsLookup) return { status: 'superseded', subscription: started.subscription }
-      return { status: 'renewed', result }
-    },
-  }
-}
-
-export declare namespace fromStore {
-  type Options = {
-    /** Key prefix for server-owned subscription access keys. @default `'tempo:subscription:access-key:'` */
-    accessKeyPrefix?: string | undefined
-    /** Key prefix for resolved subscription activation locks. @default `'tempo:subscription:activation:'` */
-    activationPrefix?: string | undefined
-    /** Milliseconds before a stuck activation lock can be replaced. @default `900000` */
-    activationTimeoutMs?: number | undefined
-    /** Key prefix for single-use activation credential markers. @default `'tempo:subscription:credential:'` */
-    credentialPrefix?: string | undefined
-    /** Key prefix for subscription records. @default `'tempo:subscription:record:'` */
-    recordPrefix?: string | undefined
-    /** Milliseconds before a stuck renewal lock can be replaced. @default `900000` */
-    renewalTimeoutMs?: number | undefined
-    /** Key prefix for resolved request keys. @default `'tempo:subscription:key:'` */
-    keyPrefix?: string | undefined
-  }
-}
-
-function isStaleActivation(marker: { startedAt?: string | undefined }, timeoutMs: number) {
-  if (!Number.isFinite(timeoutMs) || timeoutMs < 0) return false
-  if ('committingAt' in marker && marker.committingAt) return false
-  const startedAt = new Date(marker.startedAt ?? '').getTime()
-  if (!Number.isFinite(startedAt)) return true
-  return Date.now() - startedAt >= timeoutMs
-}
-
-function isStaleRenewal(subscription: SubscriptionRecord, timeoutMs: number) {
-  return isStaleActivation({ startedAt: subscription.inFlightStartedAt }, timeoutMs)
-}
-
-function clearRenewal(subscription: SubscriptionRecord): SubscriptionRecord {
-  return {
-    ...subscription,
-    inFlightAttempt: undefined,
-    inFlightPeriod: undefined,
-    inFlightReference: undefined,
-    inFlightStartedAt: undefined,
-  }
-}
-
-function timestamp() {
-  return new Date().toISOString()
-}
-
-function createAttemptToken() {
-  return globalThis.crypto.randomUUID()
-}

package/src/tempo/subscription/Types.ts

@@ -1,68 +0,0 @@
-import type { Address } from 'viem'
-
-/** Tempo-supported subscription period units. Use `day` or `week` in production; `dev_*` units are for development and tests. */
-export type SubscriptionPeriodUnit = 'dev_second' | 'day' | 'week'
-
-/** Access key information used to authorize recurring Tempo payments. */
-export type SubscriptionAccessKey = {
-  accessKeyAddress: Address
-  keyType: 'p256' | 'secp256k1' | 'webAuthn'
-}
-
-/** Server-owned subscription access key persisted for automatic billing. */
-export type SubscriptionAccessKeyRecord = SubscriptionAccessKey & {
-  privateKey: `0x${string}`
-}
-
-/** Request-scoped lookup key for the active subscription tied to a route. */
-export type SubscriptionLookup = {
-  accessKey?: SubscriptionAccessKey | undefined
-  key: string
-}
-
-/** Persisted recurring Tempo subscription state. */
-export type SubscriptionRecord = {
-  amount: string
-  billingAnchor: string
-  chainId?: number | undefined
-  currency: Address | string
-  externalId?: string | undefined
-  accessKey?: SubscriptionAccessKey | undefined
-  inFlightPeriod?: number | undefined
-  /** Per-attempt ownership token for the renewal currently in progress. */
-  inFlightAttempt?: string | undefined
-  /** Stable idempotency/reconciliation reference for a renewal currently in progress. */
-  inFlightReference?: string | undefined
-  inFlightStartedAt?: string | undefined
-  /** Signed key authorization used to activate the access key. */
-  keyAuthorization?: `0x${string}` | undefined
-  lastChargedPeriod: number
-  lookupKey: string
-  /** Root account that authorized the stored subscription access key. */
-  payer?: { address: Address; chainId: number } | undefined
-  periodCount: string
-  periodUnit: SubscriptionPeriodUnit
-  recipient: Address | string
-  reference: string
-  subscriptionExpires: string
-  subscriptionId: string
-  timestamp: string
-  canceledAt?: string | undefined
-  revokedAt?: string | undefined
-}
-
-/** Credential payload for a Tempo subscription activation. */
-export type SubscriptionCredentialPayload = {
-  signature: `0x${string}`
-  type: 'keyAuthorization'
-}
-
-/** Receipt returned for a Tempo subscription activation or renewal. */
-export type SubscriptionReceipt = {
-  method: 'tempo'
-  reference: string
-  status: 'success'
-  subscriptionId: string
-  timestamp: string
-  externalId?: string | undefined
-}

package/src/tempo/subscription/index.ts

@@ -1,23 +0,0 @@
-export { createSubscriptionReceipt, fromRecord } from './Receipt.js'
-export {
-  getSubscriptionRpcAllowedCalls,
-  getSubscriptionScopes,
-  signSubscriptionKeyAuthorization,
-  toSubscriptionExpiryDate,
-  toSubscriptionExpirySeconds,
-  toSubscriptionPeriodSeconds,
-  transferSelector,
-  transferWithMemoSelector,
-  verifySubscriptionKeyAuthorization,
-} from './KeyAuthorization.js'
-export { fromStore } from './Store.js'
-export type { ActivateResult, RenewResult, SubscriptionStore } from './Store.js'
-export type {
-  SubscriptionAccessKey,
-  SubscriptionAccessKeyRecord,
-  SubscriptionCredentialPayload,
-  SubscriptionLookup,
-  SubscriptionPeriodUnit,
-  SubscriptionRecord,
-  SubscriptionReceipt,
-} from './Types.js'

package/src/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../tsconfig.base.json",
-  "compilerOptions": {
-    "module": "nodenext",
-    "moduleResolution": "nodenext",
-    "types": ["node"]
-  },
-  "include": ["./**/*.ts"],
-  "exclude": ["./**/*.test.ts", "./**/*.test-d.ts", "./**/internal/html/**"]
-}