rename session -> channel

Author: phdargen

examples/typescript/clients/batch-settlement-streaming/index.ts

@@ -1,11 +1,11 @@
 import { isBatchSettlementDepositPayload, toClientEvmSigner } from "@x402/evm";
 import {
   BatchSettlementEvmScheme,
-  FileClientSessionStorage,
-  InMemoryClientSessionStorage,
+  FileClientChannelStorage,
+  InMemoryClientChannelStorage,
   computeChannelId,
 } from "@x402/evm/batch-settlement/client";
-import type { ClientSessionStorage } from "@x402/evm/batch-settlement/client";
+import type { ClientChannelStorage } from "@x402/evm/batch-settlement/client";
 import { x402Client, x402HTTPClient } from "@x402/fetch";
 import {
   decodePaymentRequiredHeader,
@@ -68,14 +68,14 @@ const voucherSigner = evmVoucherSignerPrivateKey
 
 const effectiveVoucherSigner = voucherSigner ?? signer;
 
-const sessionStorage: ClientSessionStorage = storageDir
-  ? new FileClientSessionStorage({ directory: storageDir })
-  : new InMemoryClientSessionStorage();
+const channelStorage: ClientChannelStorage = storageDir
+  ? new FileClientChannelStorage({ directory: storageDir })
+  : new InMemoryClientChannelStorage();
 
 const batchedScheme = new BatchSettlementEvmScheme(signer, {
   depositPolicy,
   salt: channelSalt,
-  storage: sessionStorage,
+  storage: channelStorage,
   ...(voucherSigner ? { voucherSigner } : {}),
 });
 

examples/typescript/clients/batch-settlement/concurrent.ts

@@ -1,7 +1,7 @@
 import { toClientEvmSigner } from "@x402/evm";
 import {
   BatchSettlementEvmScheme,
-  FileClientSessionStorage,
+  FileClientChannelStorage,
 } from "@x402/evm/batch-settlement/client";
 import { x402Client, wrapFetchWithPayment, x402HTTPClient } from "@x402/fetch";
 import { config } from "dotenv";
@@ -77,7 +77,7 @@ async function main(): Promise<void> {
       depositPolicy: { maxDeposit: "1000000", depositMultiplier: 5 },
       salt,
       ...(voucherSigner ? { voucherSigner } : {}),
-      ...(storageDir ? { storage: new FileClientSessionStorage({ directory: storageDir }) } : {}),
+      ...(storageDir ? { storage: new FileClientChannelStorage({ directory: storageDir }) } : {}),
     });
 
     const client = new x402Client();

examples/typescript/clients/batch-settlement/index.ts

@@ -1,7 +1,7 @@
 import { toClientEvmSigner } from "@x402/evm";
 import {
   BatchSettlementEvmScheme,
-  FileClientSessionStorage,
+  FileClientChannelStorage,
 } from "@x402/evm/batch-settlement/client";
 import { x402Client, wrapFetchWithPayment, x402HTTPClient } from "@x402/fetch";
 import { config } from "dotenv";
@@ -60,7 +60,7 @@ async function main(): Promise<void> {
     },
     salt: channelSalt,
     ...(voucherSigner ? { voucherSigner } : {}),
-    ...(storageDir ? { storage: new FileClientSessionStorage({ directory: storageDir }) } : {}),
+    ...(storageDir ? { storage: new FileClientChannelStorage({ directory: storageDir }) } : {}),
   });
 
   const client = new x402Client();

examples/typescript/servers/batch-settlement-streaming/index.ts

@@ -5,7 +5,7 @@ import {
   encodePaymentResponseHeader,
 } from "@x402/core/http";
 import type { PaymentPayload, SettleResponse } from "@x402/core/types";
-import { BatchSettlementEvmScheme, FileSessionStorage } from "@x402/evm/batch-settlement/server";
+import { BatchSettlementEvmScheme, FileChannelStorage } from "@x402/evm/batch-settlement/server";
 import {
   isBatchSettlementDepositPayload,
   isBatchSettlementVoucherPayload,
@@ -85,7 +85,7 @@ const facilitatorClient = new HTTPFacilitatorClient({ url: facilitatorUrl });
 const batchedScheme = new BatchSettlementEvmScheme(evmAddress, {
   ...(receiverAuthorizerSigner ? { receiverAuthorizerSigner } : {}),
   withdrawDelay,
-  ...(storageDir ? { storage: new FileSessionStorage({ directory: storageDir }) } : {}),
+  ...(storageDir ? { storage: new FileChannelStorage({ directory: storageDir }) } : {}),
 });
 
 const resourceServer = new x402ResourceServer(facilitatorClient).register(NETWORK, batchedScheme);

examples/typescript/servers/batch-settlement/index.ts

@@ -1,5 +1,5 @@
 import { HTTPFacilitatorClient } from "@x402/core/server";
-import { BatchSettlementEvmScheme, FileSessionStorage } from "@x402/evm/batch-settlement/server";
+import { BatchSettlementEvmScheme, FileChannelStorage } from "@x402/evm/batch-settlement/server";
 import { paymentMiddleware, setSettlementOverrides, x402ResourceServer } from "@x402/express";
 import { config } from "dotenv";
 import express from "express";
@@ -36,7 +36,7 @@ const facilitatorClient = new HTTPFacilitatorClient({ url: facilitatorUrl });
 const batchedScheme = new BatchSettlementEvmScheme(evmAddress, {
   ...(receiverAuthorizerSigner ? { receiverAuthorizerSigner } : {}),
   withdrawDelay,
-  ...(storageDir ? { storage: new FileSessionStorage({ directory: storageDir }) } : {}),
+  ...(storageDir ? { storage: new FileChannelStorage({ directory: storageDir }) } : {}),
 });
 
 const resourceServer = new x402ResourceServer(facilitatorClient).register(NETWORK, batchedScheme);

typescript/packages/mechanisms/evm/src/batch-settlement/README.md

@@ -73,13 +73,13 @@ The server claims any outstanding vouchers and then executes `refundWithSignatur
 
 ### Persistence
 
-By default, channel state is stored in memory. For long-lived clients, use `FileClientSessionStorage`:
+By default, channel state is stored in memory. For long-lived clients, use `FileClientChannelStorage`:
 
 ```typescript
-import { FileClientSessionStorage } from "@x402/evm/batch-settlement/client";
+import { FileClientChannelStorage } from "@x402/evm/batch-settlement/client";
 
 const scheme = new BatchSettlementEvmScheme(signer, {
-  storage: new FileClientSessionStorage({ directory: "./channels" }),
+  storage: new FileClientChannelStorage({ directory: "./channels" }),
 });
 ```
 
@@ -93,13 +93,13 @@ Register the scheme with an `x402ResourceServer` and pair it with a `ChannelMana
 import { x402ResourceServer } from "@x402/core/server";
 import {
   BatchSettlementEvmScheme,
-  FileSessionStorage,
+  FileChannelStorage,
 } from "@x402/evm/batch-settlement/server";
 
 const scheme = new BatchSettlementEvmScheme(receiverAddress, {
   receiverAuthorizerSigner,        // optional: self-managed authorizer (recommended)
   withdrawDelay: 900,              // 15 min – 30 days
-  storage: new FileSessionStorage({ directory: "./sessions" }),
+  storage: new FileChannelStorage({ directory: "./channels" }),
 });
 
 const server = new x402ResourceServer(facilitatorClient).register("eip155:84532", scheme);

…m/src/batch-settlement/client/session.ts …m/src/batch-settlement/client/channel.tstypescript/packages/mechanisms/evm/src/batch-settlement/client/session.ts renamed to typescript/packages/mechanisms/evm/src/batch-settlement/client/channel.ts typescript/packages/mechanisms/evm/src/batch-settlement/client/session.ts renamed to typescript/packages/mechanisms/evm/src/batch-settlement/client/channel.ts

@@ -6,17 +6,15 @@ import { batchSettlementABI } from "../abi";
 import { BATCH_SETTLEMENT_ADDRESS, MIN_WITHDRAW_DELAY } from "../constants";
 import type { BatchSettlementPaymentRequirementsExtra, ChannelConfig } from "../types";
 import { computeChannelId } from "../utils";
-import type { BatchSettlementClientContext, ClientSessionStorage } from "./storage";
+import type { BatchSettlementClientContext, ClientChannelStorage } from "./storage";
 
 /**
- * Runtime dependency bag shared by every storage-bound client helper (session,
- * recovery, refund) and the {@link BatchSettlementEvmScheme} class. Carries the
- * live signer + storage plus the channel-id inputs (`salt`, `payerAuthorizer`,
- * optional separate `voucherSigner`).
+ * Runtime dependency bag shared by every storage-bound client helper (channel,
+ * recovery, refund) and the {@link BatchSettlementEvmScheme} class.
  */
 export interface BatchSettlementClientDeps {
   signer: ClientEvmSigner;
-  storage: ClientSessionStorage;
+  storage: ClientChannelStorage;
   salt: `0x${string}`;
   payerAuthorizer?: `0x${string}`;
   voucherSigner?: ClientEvmSigner;
@@ -53,13 +51,13 @@ export function buildChannelConfig(
 }
 
 /**
- * Updates local session state from a parsed `SettleResponse`.
+ * Updates local channel state from a parsed `SettleResponse`.
  *
- * @param storage - Client session storage.
+ * @param storage - Client channel storage.
  * @param settle - The parsed settle response.
  */
 export async function processSettleResponse(
-  storage: ClientSessionStorage,
+  storage: ClientChannelStorage,
   settle: SettleResponse,
 ): Promise<void> {
   const extra = settle.extra ?? {};
@@ -70,7 +68,7 @@ export async function processSettleResponse(
   const key = channelId.toLowerCase();
 
   if (extra.refund === true) {
-    await updateSessionAfterRefund(storage, key, extra);
+    await updateChannelAfterRefund(storage, key, extra);
     return;
   }
 
@@ -91,18 +89,18 @@ export async function processSettleResponse(
 }
 
 /**
- * Reconciles local session state with the outcome of a cooperative refund.
+ * Reconciles local channel state with the outcome of a cooperative refund.
  *
- * Deletes the session when the post-refund balance is zero (full refund),
+ * Deletes the channel record when the post-refund balance is zero (full refund),
  * otherwise updates `balance`, `chargedCumulativeAmount`, and `totalClaimed`
  * from the server snapshot (partial refund — channel stays open).
  *
- * @param storage - Client session storage.
+ * @param storage - Client channel storage.
  * @param channelKey - Lowercased channel id used as the storage key.
  * @param settleExtra - The `extra` block from the refund settle response.
  */
-export async function updateSessionAfterRefund(
-  storage: ClientSessionStorage,
+export async function updateChannelAfterRefund(
+  storage: ClientChannelStorage,
   channelKey: string,
   settleExtra: Record<string, unknown>,
 ): Promise<void> {
@@ -132,11 +130,11 @@ export async function updateSessionAfterRefund(
  * Decodes the header into a `SettleResponse` and delegates to
  * {@link processSettleResponse}.
  *
- * @param storage - Client session storage.
+ * @param storage - Client channel storage.
  * @param getHeader - Function to retrieve a response header by name.
  */
 export async function processPaymentResponse(
-  storage: ClientSessionStorage,
+  storage: ClientChannelStorage,
   getHeader: (name: string) => string | null | undefined,
 ): Promise<void> {
   const raw = getHeader("PAYMENT-RESPONSE");
@@ -147,19 +145,19 @@ export async function processPaymentResponse(
 }
 
 /**
- * Recovers a channel session from on-chain state (useful after a cold start or
- * session loss).
+ * Recovers a channel record from on-chain state (useful after a cold start or
+ * channel record loss).
  *
  * @param deps - Signer + storage + identity inputs.
  * @param paymentRequirements - Server payment requirements used to derive the ChannelConfig.
  * @returns The recovered client context.
  */
-export async function recoverSession(
+export async function recoverChannel(
   deps: BatchSettlementClientDeps,
   paymentRequirements: PaymentRequirements,
 ): Promise<BatchSettlementClientContext> {
   if (!deps.signer.readContract) {
-    throw new Error("recoverSession requires ClientEvmSigner.readContract");
+    throw new Error("recoverChannel requires ClientEvmSigner.readContract");
   }
 
   const config = buildChannelConfig(deps, paymentRequirements);
@@ -203,29 +201,29 @@ export async function readChannelBalanceAndTotalClaimed(
 }
 
 /**
- * Returns whether a local session exists for the given channel.
+ * Returns whether a local channel record exists for the given channel.
  *
- * @param storage - Client session storage.
+ * @param storage - Client channel storage.
  * @param channelId - The channel identifier to check.
- * @returns `true` when a session is stored for the channel.
+ * @returns `true` when a channel record is stored.
  */
-export async function hasSession(
-  storage: ClientSessionStorage,
+export async function hasChannel(
+  storage: ClientChannelStorage,
   channelId: string,
 ): Promise<boolean> {
-  const session = await storage.get(channelId.toLowerCase());
-  return session !== undefined;
+  const channel = await storage.get(channelId.toLowerCase());
+  return channel !== undefined;
 }
 
 /**
- * Returns the local session context for a channel, if present.
+ * Returns the local channel context for a channel, if present.
  *
- * @param storage - Client session storage.
+ * @param storage - Client channel storage.
  * @param channelId - The channel identifier.
  * @returns Stored context or `undefined`.
  */
-export async function getSession(
-  storage: ClientSessionStorage,
+export async function getChannel(
+  storage: ClientChannelStorage,
   channelId: string,
 ): Promise<BatchSettlementClientContext | undefined> {
   return storage.get(channelId.toLowerCase());

typescript/packages/mechanisms/evm/src/batch-settlement/client/config.ts

@@ -1,5 +1,5 @@
 import type { ClientEvmSigner } from "../../signer";
-import { type ClientSessionStorage, InMemoryClientSessionStorage } from "./storage";
+import { type ClientChannelStorage, InMemoryClientChannelStorage } from "./storage";
 
 const DEFAULT_SALT =
   "0x0000000000000000000000000000000000000000000000000000000000000000" as `0x${string}`;
@@ -21,7 +21,7 @@ export interface BatchSettlementDepositPolicy {
  */
 export interface BatchSettlementEvmSchemeOptions {
   depositPolicy?: BatchSettlementDepositPolicy;
-  storage?: ClientSessionStorage;
+  storage?: ClientChannelStorage;
   salt?: `0x${string}`;
   payerAuthorizer?: `0x${string}`;
   /** When set, EIP-712 vouchers are signed with this key; deposits still use the main `signer`. */
@@ -34,7 +34,7 @@ export interface BatchSettlementEvmSchemeOptions {
  */
 export interface ResolvedClientOptions {
   depositPolicy?: BatchSettlementDepositPolicy;
-  storage: ClientSessionStorage;
+  storage: ClientChannelStorage;
   salt: `0x${string}`;
   payerAuthorizer?: `0x${string}`;
   voucherSigner?: ClientEvmSigner;
@@ -70,19 +70,19 @@ export function resolveClientOptions(
   second?: BatchSettlementEvmSchemeOptions | BatchSettlementDepositPolicy,
 ): ResolvedClientOptions {
   if (second === undefined) {
-    return { storage: new InMemoryClientSessionStorage(), salt: DEFAULT_SALT };
+    return { storage: new InMemoryClientChannelStorage(), salt: DEFAULT_SALT };
   }
   if (isBatchSettlementEvmSchemeOptions(second)) {
     return {
-      storage: second.storage ?? new InMemoryClientSessionStorage(),
+      storage: second.storage ?? new InMemoryClientChannelStorage(),
       depositPolicy: second.depositPolicy,
       salt: second.salt ?? DEFAULT_SALT,
       payerAuthorizer: second.payerAuthorizer,
       voucherSigner: second.voucherSigner,
     };
   }
   return {
-    storage: new InMemoryClientSessionStorage(),
+    storage: new InMemoryClientChannelStorage(),
     depositPolicy: second,
     salt: DEFAULT_SALT,
   };

typescript/packages/mechanisms/evm/src/batch-settlement/client/fileStorage.ts

@@ -2,23 +2,23 @@ import { unlink } from "node:fs/promises";
 import { join } from "node:path";
 
 import { isNodeEnoent, readJsonFile, writeJsonAtomic } from "../storage-utils";
-import type { FileSessionStorageOptions } from "../types";
-import type { ClientSessionStorage, BatchSettlementClientContext } from "./storage";
+import type { FileChannelStorageOptions } from "../types";
+import type { ClientChannelStorage, BatchSettlementClientContext } from "./storage";
 
 /**
- * Node.js file-backed {@link ClientSessionStorage} for the batched client scheme.
- * Each channel's context is persisted as `{root}/client/{channelId}.json` so that sessions
- * survive process restarts.
+ * Node.js file-backed {@link ClientChannelStorage} for the batched client scheme.
+ * Each channel's context is persisted as `{root}/client/{channelId}.json` so that channel
+ * records survive process restarts.
  */
-export class FileClientSessionStorage implements ClientSessionStorage {
+export class FileClientChannelStorage implements ClientChannelStorage {
   private readonly root: string;
 
   /**
-   * Creates file-backed client session storage under the given root directory.
+   * Creates file-backed client channel storage under the given root directory.
    *
    * @param options - Configuration including the storage root directory.
    */
-  constructor(options: FileSessionStorageOptions) {
+  constructor(options: FileChannelStorageOptions) {
     this.root = options.directory;
   }