mppx 0.0.1 → 0.1.0

package/dist/tempo/stream/Types.d.ts

@@ -0,0 +1,78 @@
+import type { Address, Hex } from 'viem';
+/**
+ * Voucher for cumulative payment.
+ * Cumulative monotonicity prevents replay attacks.
+ */
+export interface Voucher {
+    channelId: Hex;
+    cumulativeAmount: bigint;
+}
+/**
+ * Signed voucher with EIP-712 signature.
+ */
+export interface SignedVoucher extends Voucher {
+    signature: Hex;
+}
+/**
+ * Stream credential payload (discriminated union).
+ */
+export type StreamCredentialPayload = {
+    action: 'open';
+    type: 'transaction';
+    channelId: Hex;
+    transaction: Hex;
+    signature: Hex;
+    authorizedSigner?: Address | undefined;
+    cumulativeAmount: string;
+} | {
+    action: 'topUp';
+    type: 'transaction';
+    channelId: Hex;
+    transaction: Hex;
+    additionalDeposit: string;
+} | {
+    action: 'voucher';
+    channelId: Hex;
+    cumulativeAmount: string;
+    signature: Hex;
+} | {
+    action: 'close';
+    channelId: Hex;
+    cumulativeAmount: string;
+    signature: Hex;
+};
+/**
+ * SSE event emitted when session balance is exhausted mid-stream.
+ * The client responds by sending a new voucher credential.
+ *
+ * Per spec §11.6, the event data contains:
+ * - `channelId` — channel identifier
+ * - `requiredCumulative` — minimum cumulative amount the next voucher must authorize
+ * - `acceptedCumulative` — current highest accepted voucher amount
+ * - `deposit` — current on-chain deposit ceiling; when `requiredCumulative > deposit`
+ *   the client must top up the channel before sending a new voucher
+ */
+export interface NeedVoucherEvent {
+    channelId: Hex;
+    requiredCumulative: string;
+    acceptedCumulative: string;
+    deposit: string;
+}
+/**
+ * Stream receipt returned in Payment-Receipt header.
+ */
+export interface StreamReceipt {
+    method: 'tempo';
+    intent: 'session';
+    status: 'success';
+    timestamp: string;
+    /** Payment reference (channelId). Satisfies Receipt.Receipt contract. */
+    reference: string;
+    challengeId: string;
+    channelId: Hex;
+    acceptedCumulative: string;
+    spent: string;
+    units?: number | undefined;
+    txHash?: Hex | undefined;
+}
+//# sourceMappingURL=Types.d.ts.map

package/dist/tempo/stream/Types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Types.d.ts","sourceRoot":"","sources":["../../../src/tempo/stream/Types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAExC;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,GAAG,CAAA;IACd,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO;IAC5C,SAAS,EAAE,GAAG,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IACE,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,aAAa,CAAA;IACnB,SAAS,EAAE,GAAG,CAAA;IACd,WAAW,EAAE,GAAG,CAAA;IAChB,SAAS,EAAE,GAAG,CAAA;IACd,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,gBAAgB,EAAE,MAAM,CAAA;CACzB,GACD;IACE,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,EAAE,aAAa,CAAA;IACnB,SAAS,EAAE,GAAG,CAAA;IACd,WAAW,EAAE,GAAG,CAAA;IAChB,iBAAiB,EAAE,MAAM,CAAA;CAC1B,GACD;IACE,MAAM,EAAE,SAAS,CAAA;IACjB,SAAS,EAAE,GAAG,CAAA;IACd,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,GAAG,CAAA;CACf,GACD;IACE,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,GAAG,CAAA;IACd,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,GAAG,CAAA;CACf,CAAA;AAEL;;;;;;;;;;GAUG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,GAAG,CAAA;IACd,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,SAAS,CAAA;IACjB,MAAM,EAAE,SAAS,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,GAAG,CAAA;IACd,kBAAkB,EAAE,MAAM,CAAA;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,GAAG,GAAG,SAAS,CAAA;CACzB"}

package/dist/tempo/stream/Types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Types.js.map

package/dist/tempo/stream/Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Types.js","sourceRoot":"","sources":["../../../src/tempo/stream/Types.ts"],"names":[],"mappings":""}

package/dist/tempo/stream/Voucher.d.ts

@@ -0,0 +1,20 @@
+import { type Address } from 'ox';
+import type { Account, Client, Hex } from 'viem';
+import type { SignedVoucher, Voucher } from './Types.js';
+/**
+ * Sign a voucher with an account.
+ */
+export declare function signVoucher(client: Client, account: Account, message: Voucher, escrowContract: Address.Address, chainId: number, authorizedSigner?: Address.Address | undefined): Promise<Hex>;
+/**
+ * Verify a voucher signature matches the expected signer.
+ *
+ * Supports both direct signatures (secp256k1/p256/webAuthn) and
+ * Tempo access key (keychain) signatures. For keychain signatures,
+ * the envelope's `userAddress` is compared to `expectedSigner`.
+ */
+export declare function verifyVoucher(escrowContract: Address.Address, chainId: number, voucher: SignedVoucher, expectedSigner: Address.Address): Promise<boolean>;
+/**
+ * Parse a voucher from credential payload.
+ */
+export declare function parseVoucherFromPayload(channelId: Hex, cumulativeAmount: string, signature: Hex): SignedVoucher;
+//# sourceMappingURL=Voucher.d.ts.map

package/dist/tempo/stream/Voucher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Voucher.d.ts","sourceRoot":"","sources":["../../../src/tempo/stream/Voucher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAa,MAAM,IAAI,CAAA;AAE5C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAGhD,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AA8BxD;;GAEG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,OAAO,CAAC,OAAO,EAC/B,OAAO,EAAE,MAAM,EACf,gBAAgB,CAAC,EAAE,OAAO,CAAC,OAAO,GAAG,SAAS,GAC7C,OAAO,CAAC,GAAG,CAAC,CAyBd;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,cAAc,EAAE,OAAO,CAAC,OAAO,EAC/B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,aAAa,EACtB,cAAc,EAAE,OAAO,CAAC,OAAO,GAC9B,OAAO,CAAC,OAAO,CAAC,CAuBlB;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,GAAG,EACd,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,GAAG,GACb,aAAa,CAMf"}

package/dist/tempo/stream/Voucher.js

@@ -0,0 +1,98 @@
+import { Signature } from 'ox';
+import { SignatureEnvelope } from 'ox/tempo';
+import { isAddressEqual, recoverTypedDataAddress } from 'viem';
+import { signTypedData } from 'viem/actions';
+/** Must match the on-chain TempoStreamChannel DOMAIN_SEPARATOR name. */
+const DOMAIN_NAME = 'Tempo Stream Channel';
+/** Must match the on-chain TempoStreamChannel DOMAIN_SEPARATOR version. */
+const DOMAIN_VERSION = '1';
+/**
+ * EIP-712 domain for voucher signing.
+ */
+function getVoucherDomain(escrowContract, chainId) {
+    return {
+        name: DOMAIN_NAME,
+        version: DOMAIN_VERSION,
+        chainId,
+        verifyingContract: escrowContract,
+    };
+}
+/**
+ * EIP-712 types for voucher signing.
+ * Matches @tempo/stream-channels/voucher and on-chain VOUCHER_TYPEHASH.
+ */
+const voucherTypes = {
+    Voucher: [
+        { name: 'channelId', type: 'bytes32' },
+        { name: 'cumulativeAmount', type: 'uint128' },
+    ],
+};
+/**
+ * Sign a voucher with an account.
+ */
+export async function signVoucher(client, account, message, escrowContract, chainId, authorizedSigner) {
+    const signature = await signTypedData(client, {
+        account,
+        domain: getVoucherDomain(escrowContract, chainId),
+        types: voucherTypes,
+        primaryType: 'Voucher',
+        message: {
+            channelId: message.channelId,
+            cumulativeAmount: message.cumulativeAmount,
+        },
+    });
+    // When a separate authorizedSigner is used (e.g. access key), unwrap the
+    // keychain envelope — the escrow contract verifies raw ECDSA signatures
+    // against authorizedSigner, not keychain-wrapped ones.
+    // TODO: when TIP-1020 is implemented, we can remove this.
+    if (authorizedSigner) {
+        try {
+            const envelope = SignatureEnvelope.from(signature);
+            if (envelope.type === 'keychain' && envelope.inner.type === 'secp256k1')
+                return Signature.toHex(envelope.inner.signature);
+        }
+        catch { }
+    }
+    return signature;
+}
+/**
+ * Verify a voucher signature matches the expected signer.
+ *
+ * Supports both direct signatures (secp256k1/p256/webAuthn) and
+ * Tempo access key (keychain) signatures. For keychain signatures,
+ * the envelope's `userAddress` is compared to `expectedSigner`.
+ */
+export async function verifyVoucher(escrowContract, chainId, voucher, expectedSigner) {
+    try {
+        const domain = getVoucherDomain(escrowContract, chainId);
+        const message = {
+            channelId: voucher.channelId,
+            cumulativeAmount: voucher.cumulativeAmount,
+        };
+        const envelope = SignatureEnvelope.from(voucher.signature);
+        if (envelope.type === 'keychain')
+            return isAddressEqual(envelope.userAddress, expectedSigner);
+        const signer = await recoverTypedDataAddress({
+            domain,
+            types: voucherTypes,
+            primaryType: 'Voucher',
+            message,
+            signature: voucher.signature,
+        });
+        return isAddressEqual(signer, expectedSigner);
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Parse a voucher from credential payload.
+ */
+export function parseVoucherFromPayload(channelId, cumulativeAmount, signature) {
+    return {
+        channelId,
+        cumulativeAmount: BigInt(cumulativeAmount),
+        signature,
+    };
+}
+//# sourceMappingURL=Voucher.js.map

package/dist/tempo/stream/Voucher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Voucher.js","sourceRoot":"","sources":["../../../src/tempo/stream/Voucher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,SAAS,EAAE,MAAM,IAAI,CAAA;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,MAAM,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAG5C,wEAAwE;AACxE,MAAM,WAAW,GAAG,sBAAsB,CAAA;AAC1C,2EAA2E;AAC3E,MAAM,cAAc,GAAG,GAAG,CAAA;AAE1B;;GAEG;AACH,SAAS,gBAAgB,CAAC,cAA+B,EAAE,OAAe;IACxE,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,cAAc;QACvB,OAAO;QACP,iBAAiB,EAAE,cAAc;KACzB,CAAA;AACZ,CAAC;AAED;;;GAGG;AACH,MAAM,YAAY,GAAG;IACnB,OAAO,EAAE;QACP,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,SAAS,EAAE;KAC9C;CACO,CAAA;AAEV;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAc,EACd,OAAgB,EAChB,OAAgB,EAChB,cAA+B,EAC/B,OAAe,EACf,gBAA8C;IAE9C,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE;QAC5C,OAAO;QACP,MAAM,EAAE,gBAAgB,CAAC,cAAc,EAAE,OAAO,CAAC;QACjD,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,SAAS;QACtB,OAAO,EAAE;YACP,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;SAC3C;KACF,CAAC,CAAA;IAEF,yEAAyE;IACzE,wEAAwE;IACxE,uDAAuD;IACvD,0DAA0D;IAC1D,IAAI,gBAAgB,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,SAAyC,CAAC,CAAA;YAClF,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW;gBACrE,OAAO,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACpD,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,cAA+B,EAC/B,OAAe,EACf,OAAsB,EACtB,cAA+B;IAE/B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,gBAAgB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;QACxD,MAAM,OAAO,GAAG;YACd,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;SAC3C,CAAA;QAED,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAyC,CAAC,CAAA;QAE1F,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU;YAAE,OAAO,cAAc,CAAC,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC,CAAA;QAE7F,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC;YAC3C,MAAM;YACN,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,SAAS;YACtB,OAAO;YACP,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC,CAAA;QACF,OAAO,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,SAAc,EACd,gBAAwB,EACxB,SAAc;IAEd,OAAO;QACL,SAAS;QACT,gBAAgB,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAC1C,SAAS;KACV,CAAA;AACH,CAAC"}