minifetch-api 0.0.1

package/.env-local

@@ -0,0 +1,10 @@
+NETWORK=base-sepolia
+EXPLORER_BASE_URL=https://sepolia.basescan.org
+
+API_SERVER_URL=http://localhost:4021
+CHECK_ROBOTS_API_PATH=/api/v1/free/preflight/url-check
+METADATA_API_PATH=/api/v1/x402/extract/url-metadata
+
+METADATA_URL=
+METADATA_API_PARAM_INCLUDE_RESPONSE_BODY=
+PRIVATE_KEY=

package/.prettierignore

@@ -0,0 +1,8 @@
+docs/
+dist/
+node_modules/
+coverage/
+.github/
+src/client
+**/**/*.json
+*.md

package/.prettierrc

@@ -0,0 +1,11 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "printWidth": 100,
+  "proseWrap": "never"
+}

package/.tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ES2020",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "resolveJsonModule": true,
+    "baseUrl": ".",
+    "types": ["node"]
+  },
+  "include": ["index.ts"]
+}

package/README.md

@@ -0,0 +1,26 @@
+# Minifetch.com API
+
+Works with x402 payments on Base Sepolia Testnet (only) so far. Testnet API endpoints are not exposed. Check back again later!
+
+This client based on x402 payments [example client code](https://github.com/coinbase/x402/blob/main/examples/typescript/clients/fetch).
+
+## Prerequisites
+
+- Node.js v20+ (install via [nvm](https://github.com/nvm-sh/nvm))
+- pnpm v10 (install via [pnpm.io/installation](https://pnpm.io/installation))
+- A valid Ethereum private key for making USDC payments on Base Sepolia Testnet (only) -- live production client coming soon!
+
+## Setup
+
+1. Copy `.env-local` to `.env-base-testnet` and add your Ethereum private key:
+```bash
+cp .env-local .env-base-testnet
+```
+
+2. Start the example client:
+```bash
+pnpm install
+pnpm dev:testnet:check
+pnpm dev:testnet
+```
+

package/eslint.config.js

@@ -0,0 +1,72 @@
+import js from "@eslint/js";
+import ts from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import prettier from "eslint-plugin-prettier";
+import jsdoc from "eslint-plugin-jsdoc";
+import importPlugin from "eslint-plugin-import";
+
+export default [
+  {
+    ignores: ["dist/**", "node_modules/**"],
+  },
+  {
+    files: ["**/*.ts"],
+    languageOptions: {
+      parser: tsParser,
+      sourceType: "module",
+      ecmaVersion: 2020,
+      globals: {
+        process: "readonly",
+        __dirname: "readonly",
+        module: "readonly",
+        require: "readonly",
+        Buffer: "readonly",
+        exports: "readonly",
+        setTimeout: "readonly",
+        clearTimeout: "readonly",
+        setInterval: "readonly",
+        clearInterval: "readonly",
+      },
+    },
+    plugins: {
+      "@typescript-eslint": ts,
+      prettier: prettier,
+      jsdoc: jsdoc,
+      import: importPlugin,
+    },
+    rules: {
+      ...ts.configs.recommended.rules,
+      "import/first": "error",
+      "prettier/prettier": "error",
+      "@typescript-eslint/member-ordering": "error",
+      "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_$" }],
+      "jsdoc/tag-lines": ["error", "any", { startLines: 1 }],
+      "jsdoc/check-alignment": "error",
+      "jsdoc/no-undefined-types": "off",
+      "jsdoc/check-param-names": "error",
+      "jsdoc/check-tag-names": "error",
+      "jsdoc/check-types": "error",
+      "jsdoc/implements-on-classes": "error",
+      "jsdoc/require-description": "error",
+      "jsdoc/require-jsdoc": [
+        "error",
+        {
+          require: {
+            FunctionDeclaration: true,
+            MethodDefinition: true,
+            ClassDeclaration: true,
+            ArrowFunctionExpression: false,
+            FunctionExpression: false,
+          },
+        },
+      ],
+      "jsdoc/require-param": "error",
+      "jsdoc/require-param-description": "error",
+      "jsdoc/require-param-type": "off",
+      "jsdoc/require-returns": "error",
+      "jsdoc/require-returns-description": "error",
+      "jsdoc/require-returns-type": "off",
+      "jsdoc/require-hyphen-before-param-description": ["error", "always"],
+    },
+  },
+];

package/index.ts

@@ -0,0 +1,88 @@
+import { config } from "dotenv";
+import { Hex } from "viem";
+import { privateKeyToAccount } from "viem/accounts";
+import { decodeXPaymentResponse, wrapFetchWithPayment } from "x402-fetch";
+
+// Determine which env file to use
+const args = process.argv.slice(2);
+const envArg = args.find(arg => arg.startsWith("--env="));
+const env = envArg ? envArg.split("=")[1] : "default";
+console.log("env: " + env);
+
+let envPath = ".env";
+if (env !== "default") {
+  envPath = `.env-${env}`;
+}
+console.log("using env file: " + envPath);
+
+// Set dotenv config to use correct .env file
+config({ path: envPath });
+console.log("using network: " + process.env.NETWORK);
+
+// Set x402 constants from .env file
+const privateKey = `0x${process.env.PRIVATE_KEY}` as Hex;
+const explorerBaseUrl = process.env.EXPLORER_BASE_URL as string;
+const account = privateKeyToAccount(privateKey);
+
+// Set API url to query from .env file
+const baseURL = process.env.API_SERVER_URL as string;
+// Parse endpoint flag (if any)
+const endpointArg = args.find(arg => arg.startsWith("--endpoint="));
+const endpoint = endpointArg ? endpointArg.split("=")[1] : "metadata";
+// Pick the right endpoint path based on flag
+const endpointPath = endpoint === "check"
+  ? process.env.CHECK_ROBOTS_API_PATH as string
+  : process.env.METADATA_API_PATH as string;
+// Rest of the querystring params
+const metadataUrl = process.env.METADATA_URL as string; // url to fetch metadata from
+const boolInclRespBody = process.env.METADATA_API_PARAM_INCLUDE_RESPONSE_BODY as string;
+const paramInclRespBody = boolInclRespBody === 'true' ? `&includeResponseBody=true` : '';
+
+if (endpoint === "check") {
+  if (!baseURL || !endpointPath || !metadataUrl) {
+    console.error("Missing required environment variables");
+    process.exit(1);
+  }
+  const url = `${baseURL}${endpointPath}?url=${metadataUrl}`;
+  console.log("querying url via checkURL: " + url);
+  const checkURL = fetch(url, { method: "GET"})
+    .then(async response => {
+      const body = await response.json();
+      console.log("response body:");
+      console.log(body);
+    })
+    .catch(error => {
+      console.log("ERROR!");
+      console.dir(error);
+      console.error(error.response?.data?.error);
+    });
+
+} else {
+  if (!privateKey || !baseURL || !endpointPath || !metadataUrl) {
+    console.error("Missing required environment variables");
+    process.exit(1);
+  }
+  const url = `${baseURL}${endpointPath}?url=${metadataUrl}${paramInclRespBody}`;
+  console.log("querying url via fetchWithPayment: " + url);
+
+  // Fetch metadata url endpoint with payment
+  const fetchWithPayment = wrapFetchWithPayment(fetch, account);
+  fetchWithPayment(url, {
+    method: "GET",
+  })
+    .then(async response => {
+      const body = await response.json();
+      console.log("response body:");
+      console.log(body);
+
+      const paymentResponse = decodeXPaymentResponse(response.headers.get("x-payment-response")!);
+      console.log("payment response:");
+      console.log(paymentResponse);
+      console.log(`View transaction: ${explorerBaseUrl}/tx/${paymentResponse.transaction}`);
+    })
+    .catch(error => {
+      console.log("ERROR!");
+      console.dir(error);
+      console.error(error.response?.data?.error);
+    });
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "minifetch-api",
+  "version": "0.0.1",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/Niche-Networks/minifetch-api/issues"
+  },
+  "homepage": "https://minifetch.com/ ",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:Niche-Networks/minifetch-api.git"
+  },
+  "scripts": {
+    "dev:testnet": "tsx index.ts --env=base-testnet",
+    "dev:testnet:check": "tsx index.ts --env=base-testnet --endpoint=check",
+    "format": "prettier -c .prettierrc --write \"**/*.{ts,js,cjs,json,md}\"",
+    "format:check": "prettier -c .prettierrc --check \"**/*.{ts,js,cjs,json,md}\"",
+    "lint": "eslint . --ext .ts --fix",
+    "lint:check": "eslint . --ext .ts"
+  },
+  "dependencies": {
+    "dotenv": "^16.4.7",
+    "viem": "^2.23.1",
+    "x402-fetch": "0.6.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.24.0",
+    "eslint": "^9.24.0",
+    "eslint-plugin-jsdoc": "^50.6.9",
+    "eslint-plugin-prettier": "^5.2.6",
+    "@typescript-eslint/eslint-plugin": "^8.29.1",
+    "@typescript-eslint/parser": "^8.29.1",
+    "eslint-plugin-import": "^2.31.0",
+    "prettier": "3.5.2",
+    "tsx": "^4.7.0",
+    "typescript": "^5.3.0"
+  }
+}