mppx 0.6.31 → 0.8.0

package/src/tempo/session/client/Session.ts

@@ -0,0 +1,123 @@
+import { type Address, parseUnits } from 'viem'
+import { tempo as tempo_chain } from 'viem/chains'
+
+import * as Constants from '../../../Constants.js'
+import * as Method from '../../../Method.js'
+import * as Account from '../../../viem/Account.js'
+import * as Client from '../../../viem/Client.js'
+import type {
+  ResolveAccount as ResolveAccount_,
+  ResolveAccountInfo as ResolveAccountInfo_,
+} from '../../client/ResolveAccount.js'
+import * as defaults from '../../internal/defaults.js'
+import * as Methods from '../../Methods.js'
+import { serializeCredential, type ChannelEntry } from './ChannelOps.js'
+import { createChannelStore, type ChannelStore } from './ChannelStore.js'
+import {
+  executeCredentialPlan,
+  planCredential,
+  resolveChallengeContext,
+  resolveRecoverContext,
+  sessionContextSchema,
+} from './CredentialState.js'
+
+export { sessionContextSchema, type SessionContext } from './CredentialState.js'
+
+/**
+ * Creates the low-level TIP-1034 session payment method for use with `Mppx.create()`.
+ *
+ * Supports auto mode (server hints drive open/top-up sizing, with optional
+ * `maxDeposit` as a local cap) and manual mode (`context.action` with a
+ * channel descriptor).
+ */
+export function session(parameters: session.Parameters = {}) {
+  const {
+    account,
+    channelStore,
+    decimals = defaults.decimals,
+    escrow: escrowOverride,
+    getClient: getClientParameter,
+    maxDeposit: maxDepositParameter,
+    onChannelUpdate,
+    resolveAccount,
+  } = parameters
+  const getClient = Client.getResolver({
+    chain: tempo_chain,
+    getClient: getClientParameter,
+    rpcUrl: defaults.rpcUrl,
+  })
+  const getAccount = Account.getResolver({ account })
+  const maxDeposit =
+    maxDepositParameter !== undefined ? parseUnits(maxDepositParameter, decimals) : undefined
+  const store = channelStore ?? createChannelStore()
+  const sink = { store, notifyUpdate: (entry: ChannelEntry) => onChannelUpdate?.(entry) }
+
+  return Method.toClient(Methods.session, {
+    canHandleChallenge({ challenge }) {
+      return (
+        Constants.getMethodDetail(
+          challenge.request.methodDetails,
+          Constants.MethodDetailKeys.sessionProtocol,
+        ) === Constants.SessionProtocols.v2
+      )
+    },
+    context: sessionContextSchema,
+    async createCredential({ challenge, context }) {
+      const resolved = await resolveChallengeContext({
+        challenge,
+        escrowOverride,
+        getClient,
+      })
+      const defaultAccount = getAccount(resolved.client, context)
+      const entry = await store.get(resolved.key)
+      // Resolve recovery hints early so account selection can satisfy an existing channel authority.
+      const recoverContext = resolveRecoverContext({ context, snapshot: resolved.snapshot })
+      const descriptor = context?.action
+        ? context.descriptor
+        : (entry?.descriptor ?? recoverContext?.descriptor)
+      const account =
+        (await resolveAccount?.({
+          account: defaultAccount,
+          chainId: resolved.chainId,
+          operation: {
+            kind: 'authorizePaymentChannel',
+            ...(descriptor ? { authority: descriptor.authorizedSigner } : {}),
+          },
+        })) ?? defaultAccount
+      const payload = await executeCredentialPlan(
+        planCredential({
+          account,
+          entry,
+          context,
+          decimals,
+          maxDeposit,
+          resolved,
+        }),
+        sink,
+      )
+      return serializeCredential(challenge, payload, resolved.chainId, account)
+    },
+  })
+}
+
+/** Type helpers for the low-level TIP-1034 session client method. */
+export declare namespace session {
+  type ResolveAccount = ResolveAccount_
+  type ResolveAccountInfo = ResolveAccountInfo_
+
+  type Parameters = Account.getResolver.Parameters &
+    Client.getResolver.Parameters & {
+      /** Pluggable persistence for reusable channels. Defaults to an in-memory store. */
+      channelStore?: ChannelStore | undefined
+      /** Token decimals for parsing human-readable amounts (default: 6). */
+      decimals?: number | undefined
+      /** TIP20EscrowChannel address override. */
+      escrow?: Address | undefined
+      /** Maximum channel deposit in human-readable units. Caps server-suggested opens and automatic top-ups. */
+      maxDeposit?: string | undefined
+      /** Called whenever channel state changes. */
+      onChannelUpdate?: ((entry: ChannelEntry) => void) | undefined
+      /** Selects the account that signs this session credential after the challenge is known. */
+      resolveAccount?: ResolveAccount | undefined
+    }
+}