@atumlabs/mppx-atum-escrow 0.3.0 → 0.4.1

package/dist/server.d.ts

@@ -1,10 +1,10 @@
-import * as zod_v4_core from 'zod/v4/core';
-import * as z from 'zod/mini';
-import { j as ChainDefaults, c as ChargeRequest } from './internal-9tB7y-A7.js';
-export { A as AtumEscrowChallenge, a as AtumEscrowCredential, C as ChargeCredentialPayload, d as ChargeRequestSchema, e as CredentialPayloadSchema, I as INTENT, f as INTENT_ID_META_KEY, M as METHOD_NAME, h as atumEscrowChargeMethod } from './internal-9tB7y-A7.js';
+import { i as atumEscrowChargeMethod, j as ChainDefaults, d as ChargeRequest } from './internal-BZBJJfaL.js';
+export { A as AtumEscrowChallenge, a as AtumEscrowCredential, C as ChargeCredentialPayload, e as ChargeRequestSchema, f as CredentialPayloadSchema, I as INTENT, g as INTENT_ID_META_KEY, M as METHOD_NAME } from './internal-BZBJJfaL.js';
 import { Errors, Receipt, Method } from 'mppx';
 import { PaymentRequest } from './generated/index.js';
 export { PaymentRequest } from './generated/index.js';
+import './sender-auth-verify-C-Q-zvAO.js';
+import 'zod/mini';
 
 /**
  * This file was automatically generated by json-schema-to-typescript.
@@ -178,6 +178,26 @@ declare class PaymentRejectedError extends Errors.BadRequestError {
     });
 }
 
+/**
+ * Merchant-side entry point for the Atum escrow MPP payment method.
+ *
+ * Register the returned method into your `mppx` server to accept `atum-escrow`
+ * payments, and use {@link buildChargeRequest} / {@link corridorFromDefaults} to construct
+ * the `402` challenges. Verification recovers the source-chain deposit authorization per
+ * chain (EVM, Tron, Solana) and settles through the Atum Payment Gateway.
+ *
+ * @example
+ * ```ts
+ * import { Mppx } from 'mppx/server'
+ * import { registerServer } from '@atumlabs/mppx-atum-escrow/server'
+ *
+ * const method = registerServer({ submitter })
+ * const mppx = Mppx.create({ realm: 'api.example.com', secretKey, methods: [method] })
+ * ```
+ *
+ * @packageDocumentation
+ */
+
 /** One source chain/token the merchant accepts payment from. */
 interface AtumEscrowSource {
     /** CAIP-2 source chain id (e.g. `eip155:8453`, `tron:mainnet`, `solana:<genesis>`). */
@@ -220,8 +240,15 @@ interface AtumEscrowCorridor {
     /** Accepted source options; selected per charge by `(network, asset)`. */
     sources: AtumEscrowSource[];
 }
-/** Lifecycle state the gateway reports for a payment. */
-type PaymentSettlementStatus = "pending" | "completed" | "failed" | "cancelled";
+/**
+ * Lifecycle state the gateway reports for a payment.
+ *
+ * `finalizing` means the payment is on chain but has not yet reached the confirmation depth its
+ * chain requires. It is NOT terminal: a payer must keep waiting on the same idempotency key, never
+ * start a second payment for it.
+ *
+ */
+type PaymentSettlementStatus = 'pending' | 'finalizing' | 'completed' | 'failed';
 /** What a {@link PaymentSubmitter} resolves with. */
 interface PaymentSubmitResult {
     /** The gateway's payment id. Present whenever the payment was accepted. */
@@ -269,6 +296,18 @@ type AtumEscrowReceipt = Receipt.Receipt & {
     /** The full settlement confirmation. */
     fulfillmentConfirmation: FulfillmentConfirmation;
 };
+/**
+ * The merchant-side method {@link registerServer} returns, ready to register into an
+ * `mppx` server via `Mppx.create({ methods: [method] })`.
+ *
+ * Name this type when the method is built in one place and registered in another — for
+ * example a factory that assembles the corridor and submitter for your environment. Its
+ * `verify()` resolves with an {@link AtumEscrowReceipt}, so the settlement confirmation is
+ * available directly on the result.
+ */
+type AtumEscrowServer = Omit<Method.Server<typeof atumEscrowChargeMethod, {}, undefined, {}, undefined>, 'verify'> & {
+    verify: (parameters: Method.VerifyContext<typeof atumEscrowChargeMethod>) => Promise<AtumEscrowReceipt>;
+};
 /**
  * Configure the merchant side of the method.
  *
@@ -284,42 +323,7 @@ type AtumEscrowReceipt = Receipt.Receipt & {
  *
  * @param config - the gateway submitter and options.
  */
-declare function registerServer(config: AtumEscrowServerConfig): Method.Server<{
-    readonly name: "atum-escrow";
-    readonly intent: "charge";
-    readonly schema: {
-        readonly request: z.ZodMiniObject<{
-            source: z.ZodMiniObject<{
-                network: z.ZodMiniString<string>;
-                asset: z.ZodMiniString<string>;
-                amount: z.ZodMiniString<string>;
-            }, zod_v4_core.$strip>;
-            extra: z.ZodMiniObject<{
-                destination: z.ZodMiniObject<{
-                    network: z.ZodMiniString<string>;
-                    asset: z.ZodMiniString<string>;
-                    address: z.ZodMiniString<string>;
-                }, zod_v4_core.$strip>;
-                fulfillmentAmount: z.ZodMiniString<string>;
-                escrow: z.ZodMiniString<string>;
-                fulfillmentProxy: z.ZodMiniString<string>;
-                reserver: z.ZodMiniString<string>;
-                releaser: z.ZodMiniString<string>;
-                fulfillmentVerifierEndpoint: z.ZodMiniString<string>;
-                quoteDeadlineSeconds: z.ZodMiniNumber<number>;
-                fulfillmentDeadlineSeconds: z.ZodMiniNumber<number>;
-                svmSignatureClusterId: z.ZodMiniOptional<z.ZodMiniString<string>>;
-                svmSignatureDomainVersion: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
-                issuedAt: z.ZodMiniOptional<z.ZodMiniString<string>>;
-            }, zod_v4_core.$strip>;
-        }, zod_v4_core.$strip>;
-        readonly credential: {
-            readonly payload: z.ZodMiniObject<{
-                paymentRequest: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniUnknown>;
-            }, zod_v4_core.$strip>;
-        };
-    };
-}, {}, undefined, {}, undefined>;
+declare function registerServer(config: AtumEscrowServerConfig): AtumEscrowServer;
 /**
  * Validate a corridor's shape and per-source addresses. Run automatically by
  * {@link buildChargeRequest}; call it directly to fail fast at merchant startup.
@@ -444,4 +448,4 @@ declare function corridorFromDefaults(defaults: ChainDefaultsSource, params: {
     fulfillmentDeadlineSeconds: number;
 }): Promise<AtumEscrowCorridor>;
 
-export { type AtumEscrowCorridor, type AtumEscrowReceipt, type AtumEscrowServerConfig, type AtumEscrowSource, type ChainDefaultsSource, type ChargeChallenge, ChargeRequest, type FulfillmentConfirmation, PaymentRejectedError, type PaymentSettlementStatus, type PaymentSubmitResult, type PaymentSubmitter, type SettlementErrorDetails, SettlementFailedError, SettlementPendingError, buildChargeChallenge, buildChargeRequest, corridorFromDefaults, isPaymentRejected, isSettlementFailed, isSettlementPending, registerServer, validateCorridor };
+export { type AtumEscrowCorridor, type AtumEscrowReceipt, type AtumEscrowServer, type AtumEscrowServerConfig, type AtumEscrowSource, type ChainDefaultsSource, type ChargeChallenge, ChargeRequest, type FulfillmentConfirmation, PaymentRejectedError, type PaymentSettlementStatus, type PaymentSubmitResult, type PaymentSubmitter, type SettlementErrorDetails, SettlementFailedError, SettlementPendingError, atumEscrowChargeMethod, buildChargeChallenge, buildChargeRequest, corridorFromDefaults, isPaymentRejected, isSettlementFailed, isSettlementPending, registerServer, validateCorridor };

package/dist/server.js

@@ -1,8 +1,6 @@
 /*
- * Copyright (c) 2026 Atum Labs, Inc. All rights reserved.
- * Proprietary and confidential.
- * Access and use are governed by the LICENSE file distributed with this package.
- * Do not remove, alter, or obscure this notice.
+ * Copyright 2026 Atum Labs, Inc.
+ * SPDX-License-Identifier: Apache-2.0
  */
 import { createRequire as __atumCreateRequire } from 'module'; const require = __atumCreateRequire(import.meta.url);
 import {
@@ -17,7 +15,7 @@ import {
   isSettlementPending,
   registerServer,
   validateCorridor
-} from "./chunk-4YD6566T.js";
+} from "./chunk-EWIOTGMO.js";
 import {
   ChargeRequestSchema,
   CredentialPayloadSchema,
@@ -25,7 +23,7 @@ import {
   INTENT_ID_META_KEY,
   METHOD_NAME,
   atumEscrowChargeMethod
-} from "./chunk-Z3AUNEU5.js";
+} from "./chunk-LAWFMGYD.js";
 export {
   ChargeRequestSchema,
   CredentialPayloadSchema,

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@atumlabs/mppx-atum-escrow",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Atum cross-chain escrow payment method for the Machine Payments Protocol (MPP).",
   "author": "Atum Labs, Inc.",
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Apache-2.0",
   "publishConfig": {
-    "access": "restricted"
+    "access": "public"
   },
   "homepage": "https://github.com/Atum-Labs/protocol/tree/main/mppx-atum-escrow#readme",
   "repository": {
@@ -51,16 +51,18 @@
     "README.md",
     "CHANGELOG.md",
     "LICENSE",
+    "NOTICE",
     "THIRD-PARTY-NOTICES.txt"
   ],
   "scripts": {
-    "prebuild:deps": "node -e \"const {existsSync}=require('fs');for(const p of ['../contracts/evm/escrow-encoding/typescript/tsconfig.json','../contracts/tvm/escrow-encoding/typescript/tsconfig.json','../contracts/svm/escrow-encoding/typescript/tsconfig.json','../schemas/apis/x402/v1/bindings/typescript/tsconfig.json','../schemas/apis/fulfillment-confirmation/v1/bindings/typescript/tsconfig.json','../schemas/declarations/PaymentRequest/v1/bindings/typescript/sender-auth/tsconfig.json']){if(!existsSync(p)){console.error('bundled sibling not found at '+p+'. Is this checked out inside the protocol monorepo?');process.exit(1)}}if(!existsSync('../payment-gateway-client/dist/index.js')){console.error('@atum-labs/payment-gateway-client is not built. Run its build first (pnpm --filter @atum-labs/payment-gateway-client build).');process.exit(1)}\"",
-    "build:deps": "tsc -p ../contracts/evm/escrow-encoding/typescript/tsconfig.json && tsc -p ../contracts/tvm/escrow-encoding/typescript/tsconfig.json && tsc -p ../contracts/svm/escrow-encoding/typescript/tsconfig.json && tsc -p ../schemas/apis/x402/v1/bindings/typescript/tsconfig.json && tsc -p ../schemas/apis/fulfillment-confirmation/v1/bindings/typescript/tsconfig.json && tsc -p ../schemas/declarations/PaymentRequest/v1/bindings/typescript/sender-auth/tsconfig.json",
-    "build": "pnpm run build:deps && tsup && node scripts/stamp-entry-headers.mjs",
-    "typecheck": "pnpm run build:deps && tsc --noEmit",
-    "pretest": "pnpm run build:deps",
-    "test": "vitest run",
-    "clean": "rm -rf dist ../contracts/evm/escrow-encoding/typescript/dist ../contracts/tvm/escrow-encoding/typescript/dist ../contracts/svm/escrow-encoding/typescript/dist ../schemas/apis/x402/v1/bindings/typescript/dist ../schemas/apis/fulfillment-confirmation/v1/bindings/typescript/dist ../schemas/declarations/PaymentRequest/v1/bindings/typescript/sender-auth/dist",
+    "prebuild:deps": "node -e \"if(!require('fs').existsSync('../pnpm-workspace.yaml')){console.error('protocol workspace not found at ../pnpm-workspace.yaml. Is this checked out inside the protocol monorepo?');process.exit(1)}\"",
+    "build:deps": "pnpm --filter \"@atum-labs/mppx-atum-escrow^...\" run build",
+    "build": "tsup && node scripts/stamp-entry-headers.mjs",
+    "lint": "eslint . --max-warnings 0",
+    "typecheck": "tsc --noEmit",
+    "typecheck:tests": "tsc -p tsconfig.test.json",
+    "test": "pnpm run typecheck:tests && vitest run",
+    "clean": "rm -rf dist && pnpm --filter \"@atum-labs/mppx-atum-escrow^...\" run clean",
     "check:publishable": "node scripts/check-publishable.mjs",
     "gen:notices": "node scripts/gen-third-party-notices.mjs",
     "prepare": "pnpm run build",
@@ -82,6 +84,7 @@
     "@atum-labs/fulfillment-confirmation": "workspace:*",
     "@atum-labs/payment-gateway-client": "workspace:*",
     "@atum-labs/payment-request-sender-auth": "workspace:*",
+    "@atum-labs/payment-request-token-approval": "workspace:*",
     "@atum-labs/publish-guard": "workspace:*",
     "@atum-labs/schema-declarations": "workspace:*",
     "@atum-labs/solana-escrow-encoding": "workspace:*",
@@ -90,7 +93,7 @@
     "mppx": "^0.8.12",
     "tsup": "^8.5.1",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.9",
+    "vitest": "^4.1.11",
     "zod": "^4.4.3"
   }
 }