mppx 0.6.30 → 0.7.0

package/dist/tempo/session/client/Session.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../../../src/tempo/session/client/Session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAc,MAAM,MAAM,CAAA;AAI/C,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AACnD,OAAO,KAAK,MAAM,MAAM,yBAAyB,CAAA;AAGjD,OAAO,EAAuB,KAAK,YAAY,EAAE,MAAM,iBAAiB,CAAA;AASxE,OAAO,EAAE,oBAAoB,EAAE,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAEhF;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,UAAU,GAAE,OAAO,CAAC,UAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAoD1D;AAED,qEAAqE;AACrE,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,KAAK,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,UAAU,GAC9C,MAAM,CAAC,WAAW,CAAC,UAAU,GAAG;QAC9B,4JAA4J;QAC5J,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACtC,sEAAsE;QACtE,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC7B,2CAA2C;QAC3C,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC5B,0GAA0G;QAC1G,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC/B,6CAA6C;QAC7C,eAAe,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC,GAAG,SAAS,CAAA;KAC9D,CAAA;CACJ"}

package/dist/tempo/session/client/Session.js

@@ -0,0 +1,55 @@
+import { 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 * as defaults from '../../internal/defaults.js';
+import * as Methods from '../../Methods.js';
+import { serializeCredential } from './ChannelOps.js';
+import { sessionContextSchema } from './CredentialState.js';
+import { createChannelCache, executeCredentialPlan, planCredential, resolveChallengeContext, } from './CredentialState.js';
+export { sessionContextSchema } 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 = {}) {
+    const { account, authorizedSigner, decimals = defaults.decimals, escrow: escrowOverride, getClient: getClientParameter, maxDeposit: maxDepositParameter, onChannelUpdate, } = 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 cache = createChannelCache(onChannelUpdate);
+    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 account = getAccount(resolved.client, context);
+            const payload = await executeCredentialPlan(planCredential({
+                account,
+                authorizedSigner,
+                cache,
+                context,
+                decimals,
+                maxDeposit,
+                resolved,
+            }), cache);
+            return serializeCredential(challenge, payload, resolved.chainId, account);
+        },
+    });
+}
+//# sourceMappingURL=Session.js.map

package/dist/tempo/session/client/Session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Session.js","sourceRoot":"","sources":["../../../../src/tempo/session/client/Session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,UAAU,EAAE,MAAM,MAAM,CAAA;AAC/C,OAAO,EAAE,KAAK,IAAI,WAAW,EAAE,MAAM,aAAa,CAAA;AAElD,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAA;AAClD,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AACnD,OAAO,KAAK,MAAM,MAAM,yBAAyB,CAAA;AACjD,OAAO,KAAK,QAAQ,MAAM,4BAA4B,CAAA;AACtD,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,mBAAmB,EAAqB,MAAM,iBAAiB,CAAA;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,cAAc,EACd,uBAAuB,GACxB,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,oBAAoB,EAAuB,MAAM,sBAAsB,CAAA;AAEhF;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,aAAiC,EAAE;IACzD,MAAM,EACJ,OAAO,EACP,gBAAgB,EAChB,QAAQ,GAAG,QAAQ,CAAC,QAAQ,EAC5B,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,kBAAkB,EAC7B,UAAU,EAAE,mBAAmB,EAC/B,eAAe,GAChB,GAAG,UAAU,CAAA;IACd,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC;QACnC,KAAK,EAAE,WAAW;QAClB,SAAS,EAAE,kBAAkB;QAC7B,MAAM,EAAE,QAAQ,CAAC,MAAM;KACxB,CAAC,CAAA;IACF,MAAM,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;IACnD,MAAM,UAAU,GACd,mBAAmB,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC3F,MAAM,KAAK,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAA;IAEjD,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE;QACtC,kBAAkB,CAAC,EAAE,SAAS,EAAE;YAC9B,OAAO,CACL,SAAS,CAAC,eAAe,CACvB,SAAS,CAAC,OAAO,CAAC,aAAa,EAC/B,SAAS,CAAC,gBAAgB,CAAC,eAAe,CAC3C,KAAK,SAAS,CAAC,gBAAgB,CAAC,EAAE,CACpC,CAAA;QACH,CAAC;QACD,OAAO,EAAE,oBAAoB;QAC7B,KAAK,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE;YAC3C,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAAC;gBAC7C,SAAS;gBACT,cAAc;gBACd,SAAS;aACV,CAAC,CAAA;YACF,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;YACpD,MAAM,OAAO,GAAG,MAAM,qBAAqB,CACzC,cAAc,CAAC;gBACb,OAAO;gBACP,gBAAgB;gBAChB,KAAK;gBACL,OAAO;gBACP,QAAQ;gBACR,UAAU;gBACV,QAAQ;aACT,CAAC,EACF,KAAK,CACN,CAAA;YACD,OAAO,mBAAmB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC3E,CAAC;KACF,CAAC,CAAA;AACJ,CAAC"}

package/dist/tempo/session/client/SessionManager.d.ts

@@ -0,0 +1,120 @@
+import type { Hex } from 'ox';
+import { type Address } from 'viem';
+import type * as Account from '../../../viem/Account.js';
+import type * as Client from '../../../viem/Client.js';
+import type { ChannelDescriptor } from '../precompile/Protocol.js';
+import { type SessionReceipt } from '../precompile/Protocol.js';
+import { deserializeSnapshot as deserializeSessionSnapshot, serializeSnapshot as serializeSessionSnapshot } from '../Snapshot.js';
+import type { SessionState } from './Runtime.js';
+import { type TempoSessionChallenge } from './Transports.js';
+import { type SessionManagedWebSocket, type WebSocketConstructor } from './Transports.js';
+import { type SseDriverOptions } from './Transports.js';
+import { type WebSocketDriverOptions } from './Transports.js';
+export { computeFallbackCloseAmount, type FallbackCloseAmountParameters } from './Runtime.js';
+/** Auto-driving client manager for HTTP, SSE, and WebSocket TIP-1034 sessions. */
+export type SessionManager = {
+    /** Active channel ID, when a channel has been opened or recovered. */
+    readonly channelId: Hex.Hex | undefined;
+    /** Local cumulative voucher authorization in raw token units. */
+    readonly cumulative: bigint;
+    /** Whether the manager currently has an open local channel. */
+    readonly opened: boolean;
+    /** Current pure session state-machine state. */
+    readonly state: SessionState;
+    /** Runs the HTTP 402 probe, signs/open/top-ups as needed, retries, and returns receipt metadata. */
+    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<PaymentResponse>;
+    /** Opens a paid SSE stream and auto-posts vouchers/top-ups when the server requests more headroom. */
+    sse(input: RequestInfo | URL, init?: SessionManagerSseOptions): Promise<AsyncIterable<string>>;
+    /** Opens a paid WebSocket session after an HTTP challenge probe and manages in-band voucher frames. */
+    ws(input: string | URL, init?: SessionManagerWebSocketOptions): Promise<SessionManagedWebSocket>;
+    /** Tops up the active channel deposit. String amounts are parsed with the manager decimals; bigint amounts are raw units. */
+    topUp(amount: string | bigint): Promise<SessionReceipt | undefined>;
+    /** Cooperatively closes the active channel using the latest locally authorized spend boundary. */
+    close(): Promise<SessionReceipt | undefined>;
+};
+/** Options for `SessionManager.sse()`. */
+export type SessionManagerSseOptions = SseDriverOptions;
+/** Options for `SessionManager.ws()`. */
+export type SessionManagerWebSocketOptions = WebSocketDriverOptions;
+/** HTTP response enriched with the latest session payment metadata. */
+export type PaymentResponse = Response & {
+    /** Parsed payment receipt, when the response included one. */
+    receipt: SessionReceipt | null;
+    /** Last session challenge observed by the manager. */
+    challenge: TempoSessionChallenge | null;
+    /** Active channel ID, when available. */
+    channelId: Hex.Hex | null;
+    /** Local cumulative voucher authorization in raw token units. */
+    cumulative: bigint;
+};
+/** Serializable client-side channel snapshot stored between manager instances. */
+export type StoredSessionChannel = {
+    /** Latest known channel ID. Used as the next request's channel hint. */
+    channelId: Hex.Hex;
+    /** Latest local cumulative voucher authorization in raw token units. */
+    cumulativeAmount: string;
+    /** Latest known deposit in raw token units. */
+    deposit: string;
+    /** TIP-1034 channel descriptor, used as a fallback when the server cannot snapshot. */
+    descriptor: ChannelDescriptor;
+    /** Escrow address used to derive the channel ID. */
+    escrow: Address;
+    /** Chain ID used to derive the channel ID. */
+    chainId: number;
+    /** Whether the channel was open when stored. Closed channels are not used as hints. */
+    opened: boolean;
+    /** Client timestamp for debugging or app-level eviction. */
+    updatedAt: number;
+};
+/** Optional per-manager store for channel hints and restart recovery. */
+export type SessionStore = {
+    /** Reads the latest stored channel snapshot for this manager scope. */
+    get(): Promise<StoredSessionChannel | null | undefined> | StoredSessionChannel | null | undefined;
+    /** Persists the latest channel snapshot. */
+    set(channel: StoredSessionChannel): Promise<void> | void;
+    /** Deletes the stored snapshot when a channel is closed, when supported. */
+    delete?(): Promise<void> | void;
+};
+/**
+ * Creates a session manager that handles the full client payment lifecycle:
+ * channel open, incremental vouchers, SSE streaming, and channel close.
+ *
+ * Internally delegates to the `session()` method for all
+ * channel state management and credential creation, and to `Fetch.from`
+ * for the 402 challenge/retry flow.
+ *
+ * ## Session resumption
+ *
+ * The manager only keeps active client transport state in memory. Channel
+ * descriptors and cumulative voucher state are hydrated from server snapshots
+ * when challenges include them; otherwise the next request opens a fresh
+ * TIP-1034 channel. `maxDeposit` remains the local cap for all automatic
+ * voucher and top-up decisions.
+ */
+export declare function sessionManager(parameters: sessionManager.Parameters): SessionManager;
+/** Type helpers for `sessionManager()`. */
+export declare namespace sessionManager {
+    const serializeSnapshot: typeof serializeSessionSnapshot;
+    const deserializeSnapshot: typeof deserializeSessionSnapshot;
+    type Parameters = Account.getResolver.Parameters & Client.getResolver.Parameters & {
+        /** Address authorized to sign vouchers. Defaults to the account access key address when available, otherwise the account address. */
+        authorizedSigner?: Address | undefined;
+        /** Enables same-route HEAD bootstrap from a server session snapshot before opening a new channel. */
+        bootstrap?: boolean | undefined;
+        /** Viem client instance. Shorthand for `getClient: () => client`. */
+        client?: import('viem').Client | undefined;
+        /** Token decimals used to convert `maxDeposit` to raw units. Defaults to `6`. */
+        decimals?: number | undefined;
+        /** TIP20EscrowChannel precompile address override. */
+        escrow?: Address | undefined;
+        /** Fetch implementation used for HTTP probes, management posts, and paid retries. */
+        fetch?: typeof globalThis.fetch | undefined;
+        /** Maximum deposit in human-readable units (e.g. `'10'` for 10 tokens). Converted to raw units via `decimals`. */
+        maxDeposit?: string | undefined;
+        /** Optional per-manager store for persisted channel hints and restart recovery. */
+        sessionStore?: SessionStore | undefined;
+        /** Optional websocket constructor for runtimes without a global WebSocket. */
+        webSocket?: WebSocketConstructor | undefined;
+    };
+}
+//# sourceMappingURL=SessionManager.d.ts.map

package/dist/tempo/session/client/SessionManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SessionManager.d.ts","sourceRoot":"","sources":["../../../../src/tempo/session/client/SessionManager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,IAAI,CAAA;AAC7B,OAAO,EAAc,KAAK,OAAO,EAAE,MAAM,MAAM,CAAA;AAK/C,OAAO,KAAK,KAAK,OAAO,MAAM,0BAA0B,CAAA;AACxD,OAAO,KAAK,KAAK,MAAM,MAAM,yBAAyB,CAAA;AAKtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAElE,OAAO,EAA8B,KAAK,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC3F,OAAO,EACL,mBAAmB,IAAI,0BAA0B,EACjD,iBAAiB,IAAI,wBAAwB,EAC9C,MAAM,gBAAgB,CAAA;AAIvB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAYhD,OAAO,EAOL,KAAK,qBAAqB,EAE3B,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EAE1B,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAkB,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAEvE,OAAO,EAGL,KAAK,sBAAsB,EAC5B,MAAM,iBAAiB,CAAA;AAExB,OAAO,EAAE,0BAA0B,EAAE,KAAK,6BAA6B,EAAE,MAAM,cAAc,CAAA;AAE7F,kFAAkF;AAClF,MAAM,MAAM,cAAc,GAAG;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,GAAG,SAAS,CAAA;IACvC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,+DAA+D;IAC/D,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IACxB,gDAAgD;IAChD,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAA;IAE5B,oGAAoG;IACpG,KAAK,CAAC,KAAK,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAC7E,sGAAsG;IACtG,GAAG,CAAC,KAAK,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;IAC9F,uGAAuG;IACvG,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAA;IAChG,6HAA6H;IAC7H,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAA;IACnE,kGAAkG;IAClG,KAAK,IAAI,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAA;CAC7C,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,CAAA;AAEvD,yCAAyC;AACzC,MAAM,MAAM,8BAA8B,GAAG,sBAAsB,CAAA;AAEnE,uEAAuE;AACvE,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG;IACvC,8DAA8D;IAC9D,OAAO,EAAE,cAAc,GAAG,IAAI,CAAA;IAC9B,sDAAsD;IACtD,SAAS,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACvC,yCAAyC;IACzC,SAAS,EAAE,GAAG,CAAC,GAAG,GAAG,IAAI,CAAA;IACzB,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,kFAAkF;AAClF,MAAM,MAAM,oBAAoB,GAAG;IACjC,wEAAwE;IACxE,SAAS,EAAE,GAAG,CAAC,GAAG,CAAA;IAClB,wEAAwE;IACxE,gBAAgB,EAAE,MAAM,CAAA;IACxB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,uFAAuF;IACvF,UAAU,EAAE,iBAAiB,CAAA;IAC7B,oDAAoD;IACpD,MAAM,EAAE,OAAO,CAAA;IACf,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAA;IACf,uFAAuF;IACvF,MAAM,EAAE,OAAO,CAAA;IACf,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,yEAAyE;AACzE,MAAM,MAAM,YAAY,GAAG;IACzB,uEAAuE;IACvE,GAAG,IAAI,OAAO,CAAC,oBAAoB,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,oBAAoB,GAAG,IAAI,GAAG,SAAS,CAAA;IACjG,4CAA4C;IAC5C,GAAG,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACxD,4EAA4E;IAC5E,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CAChC,CAAA;AAqID;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,cAAc,CAAC,UAAU,GAAG,cAAc,CA2hBpF;AAED,2CAA2C;AAC3C,yBAAiB,cAAc,CAAC;IACvB,MAAM,iBAAiB,iCAA2B,CAAA;IAClD,MAAM,mBAAmB,mCAA6B,CAAA;IAE7D,KAAY,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,UAAU,GACrD,MAAM,CAAC,WAAW,CAAC,UAAU,GAAG;QAC9B,qIAAqI;QACrI,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACtC,qGAAqG;QACrG,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC/B,qEAAqE;QACrE,MAAM,CAAC,EAAE,OAAO,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;QAC1C,iFAAiF;QACjF,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC7B,sDAAsD;QACtD,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC5B,qFAAqF;QACrF,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,GAAG,SAAS,CAAA;QAC3C,kHAAkH;QAClH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC/B,mFAAmF;QACnF,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;QACvC,8EAA8E;QAC9E,SAAS,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAA;KAC7C,CAAA;CACJ"}