(mirror) feat: add deferred payment scheme sdk implementation

.gitignore

@@ -7,3 +7,7 @@ proxy
 .env
 __pycache__/
 **/.DS_Store
+cache/
+out/
+lcov.info
+broadcast/

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "solidity/deferred-escrow/lib/openzeppelin-contracts"]
+	path = solidity/deferred-escrow/lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+[submodule "solidity/deferred-escrow/lib/forge-std"]
+	path = solidity/deferred-escrow/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "solidity/deferred-escrow/lib/safe-singleton-deployer-sol"]
+	path = solidity/deferred-escrow/lib/safe-singleton-deployer-sol
+	url = https://github.com/wilsoncusack/safe-singleton-deployer-sol

examples/typescript/clients/axios/deferred.ts

@@ -0,0 +1,67 @@
+import axios from "axios";
+import { config } from "dotenv";
+import {
+  withDeferredPaymentInterceptor,
+  decodeXPaymentResponse,
+  createSigner,
+  type Hex,
+} from "x402-axios";
+
+config();
+
+const privateKey = process.env.PRIVATE_KEY as Hex | string;
+const baseURL = process.env.RESOURCE_SERVER_URL as string; // e.g. https://example.com
+const endpointPath = process.env.ENDPOINT_PATH as string; // e.g. /weather
+
+if (!baseURL || !privateKey || !endpointPath) {
+  console.error("Missing required environment variables");
+  process.exit(1);
+}
+
+/**
+ * This example shows how to use the x402-axios package to make a request to a resource server that requires a payment
+ * using deferred scheme.
+ *
+ * To run this example, you need to set the following environment variables:
+ * - PRIVATE_KEY: The private key of the signer (buyer)
+ * - RESOURCE_SERVER_URL: The URL of the resource server
+ * - ENDPOINT_PATH: The path of the endpoint to call on the resource server
+ *
+ */
+async function main(): Promise<void> {
+  const signer = await createSigner("base-sepolia", privateKey);
+  const api = withDeferredPaymentInterceptor(
+    axios.create({
+      baseURL,
+    }),
+    signer,
+    // [
+    //   {
+    //     asset: "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
+    //     assetDomain: {
+    //       name: "USDC",
+    //       version: "2",
+    //     },
+    //     threshold: "996000",
+    //     amount: "100",
+    //   },
+    // ],
+  );
+
+  try {
+    const response = await api.get(endpointPath);
+    console.log(response.data);
+
+    const xPaymentHeader = response.config.headers["X-PAYMENT"];
+    const paymentPayload = JSON.parse(Buffer.from(xPaymentHeader, "base64").toString("utf-8"));
+    console.log("Deferred voucher details:");
+    console.log(paymentPayload.payload.voucher);
+
+    const paymentResponse = decodeXPaymentResponse(response.headers["x-payment-response"]);
+    console.log(paymentResponse);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+main();

examples/typescript/clients/axios/package.json

@@ -4,6 +4,7 @@
   "type": "module",
   "scripts": {
     "dev": "tsx index.ts",
+    "dev:deferred": "tsx deferred.ts",
     "dev:multi-network-signer": "tsx multi-network-signer.ts",
     "format": "prettier -c .prettierrc --write \"**/*.{ts,js,cjs,json,md}\"",
     "format:check": "prettier -c .prettierrc --check \"**/*.{ts,js,cjs,json,md}\"",
@@ -27,4 +28,4 @@
     "tsx": "^4.7.0",
     "typescript": "^5.3.0"
   }
-}
+}

examples/typescript/clients/axios/tsconfig.json

@@ -9,7 +9,12 @@
     "strict": true,
     "resolveJsonModule": true,
     "baseUrl": ".",
-    "types": ["node"]
+    "types": [
+      "node"
+    ]
   },
-  "include": ["index.ts"]
-}
+  "include": [
+    "index.ts",
+    "deferred.ts"
+  ]
+}

examples/typescript/facilitator/.env-local

@@ -1,3 +1,3 @@
 EVM_PRIVATE_KEY=0xYourPrivateKey
 SVM_PRIVATE_KEY=base58EncodedSolanaPrivateKey
-PORT=3002
+PORT=3002