@payai/x402-axios-starter 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,2 @@
1
+ This package includes portions derived from coinbase/x402 (examples/typescript/clients/axios), Apache-2.0,
2
+ commit 0dfd3e683f1563543bd62a3ad84cbc6851d4054b. See LICENSE and upstream LICENSE notices.
package/README.md ADDED
@@ -0,0 +1,96 @@
1
+ # x402 Axios Starter
2
+
3
+ Starter for running an x402 axios client.
4
+
5
+ You can find the upstream example at [coinbase/x402 → examples/typescript/clients/axios](https://github.com/coinbase/x402/tree/main/examples/typescript/clients/axios).
6
+
7
+ ## Getting Started
8
+
9
+ ### Requirements
10
+
11
+ - **Node.js**: 18 or newer
12
+
13
+ ### Create a new app using the template
14
+
15
+ Use your preferred package manager to scaffold:
16
+
17
+ #### npm (npx)
18
+ ```bash
19
+ npm exec @payai/x402-axios-starter -- my-x402-app
20
+ ```
21
+
22
+ #### pnpm
23
+ ```bash
24
+ pnpm dlx @payai/x402-axios-starter my-x402-app
25
+ ```
26
+
27
+ #### bun
28
+ ```bash
29
+ bunx @payai/x402-axios-starter my-x402-app
30
+ ```
31
+
32
+ Then inside your new app:
33
+
34
+ ```bash
35
+ npm run dev
36
+ ```
37
+
38
+ ### How the created client example works
39
+
40
+ When you run the generated app, `index.ts` will:
41
+
42
+ - Load environment variables from `.env` (for example: `RESOURCE_SERVER_URL`, `ENDPOINT_PATH`, `PRIVATE_KEY`).
43
+ - Create an Axios instance and attach x402 payment interceptor using `withPaymentInterceptor`.
44
+ - Call your configured endpoint at `${RESOURCE_SERVER_URL}${ENDPOINT_PATH}`.
45
+ - Log two things to the console:
46
+ - The parsed JSON response body
47
+ - The decoded `x-payment-response` headers (useful for inspecting payment receipts/metadata)
48
+
49
+
50
+ ## The Starter Itself
51
+
52
+ Below are notes on the starter itself, which creates the example that devs use to get started.
53
+
54
+ ### How sync works
55
+
56
+ - Workflow: `.github/workflows/sync.yml`
57
+ - Triggered hourly (cron) and on manual dispatch.
58
+ - Steps (high level):
59
+ - Sparse clone upstream `coinbase/x402` and restrict to `examples/typescript/clients/axios`.
60
+ - Resolve latest `x402-axios` version from npm (best-effort).
61
+ - Mirror files into `vendor/upstream/` (transient; ignored in git and cleaned up).
62
+ - Run `scripts/sanitize.sh` to:
63
+ - Copy all files from `vendor/upstream/` into `template/` (root of the template), preserving structure.
64
+ - Remove any legacy `template/src/` directory.
65
+ - Refresh `NOTICE` with the upstream commit and clean up `vendor/` and `upstream/` directories.
66
+ - Inject the resolved `x402-axios` version into `template/package.json` (replacing any workspace reference).
67
+ - Open a PR with the changes using `peter-evans/create-pull-request`.
68
+
69
+ Notes:
70
+
71
+ - If `npm view x402-axios version` fails, the workflow falls back to `0.0.0` and will skip injecting the dependency until it is available.
72
+ - The template mirrors the upstream example at the template root (no `src/` in the template). Your generated app runs from its root.
73
+
74
+ ### Local development of this starter
75
+
76
+ ```bash
77
+ # run the sanitize/mapping script locally (after an upstream sync or manual vendor update)
78
+ scripts/sanitize.sh examples/typescript/clients/axios <commit-sha>
79
+ ```
80
+
81
+ Key files:
82
+
83
+ - `template/` – shipped starter template; mirrors upstream example at root
84
+ - `vendor/upstream/` – transient mirror used during sync (gitignored and cleaned)
85
+ - `.github/workflows/sync.yml` – sync/PR workflow
86
+ - `scripts/sanitize.sh` – maps upstream example into `template/` (root)
87
+ - `bin/create.js` – CLI that scaffolds a new project from `template/`
88
+
89
+ ### Releasing this starter to npm (optional)
90
+
91
+ - The `Release` workflow publishes on pushes to `main`.
92
+ - Requires `NPM_TOKEN` secret configured in the repo.
93
+
94
+ ### License and attribution
95
+
96
+ Apache-2.0. Portions are derived from `coinbase/x402` (see `NOTICE`, `LICENSE`, and upstream notices).
package/bin/create.js ADDED
@@ -0,0 +1,83 @@
1
+ #!/usr/bin/env node
2
+ /* eslint-disable no-console */
3
+ import fs from "fs";
4
+ import path from "path";
5
+ import url from "url";
6
+ import { execSync } from "child_process";
7
+
8
+ const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
9
+ const repoRoot = path.join(__dirname, "..");
10
+ const templateDir = path.join(repoRoot, "template");
11
+
12
+ const nameArg = process.argv[2];
13
+ const projectName = nameArg && !nameArg.startsWith("-") ? nameArg : "x402-axios-app";
14
+ const targetDir = path.resolve(process.cwd(), projectName);
15
+
16
+ if (fs.existsSync(targetDir) && fs.readdirSync(targetDir).length) {
17
+ console.error(`\nTarget directory '${projectName}' is not empty. Choose another name or empty it.\n`);
18
+ process.exit(1);
19
+ }
20
+
21
+ // copy template
22
+ fs.cpSync(templateDir, targetDir, { recursive: true });
23
+
24
+ // ensure the root package.json name matches the project
25
+ const rootPkgPath = path.join(targetDir, "package.json");
26
+ if (fs.existsSync(rootPkgPath)) {
27
+ const rootPkg = JSON.parse(fs.readFileSync(rootPkgPath, "utf8"));
28
+ rootPkg.name = projectName.replace(/[^a-zA-Z0-9-_./@]/g, "-");
29
+ fs.writeFileSync(rootPkgPath, JSON.stringify(rootPkg, null, 2));
30
+ }
31
+
32
+ // perform post-scaffold steps for convenience
33
+ console.log(`\nSetting up your project in: ${targetDir}`);
34
+
35
+ // 1) Copy environment template
36
+ try {
37
+ const envLocal = path.join(targetDir, ".env-local");
38
+ const envExample = path.join(targetDir, ".env.example");
39
+ const envTarget = path.join(targetDir, ".env");
40
+ if (fs.existsSync(envLocal)) {
41
+ console.log("- Creating .env from .env-local");
42
+ fs.copyFileSync(envLocal, envTarget);
43
+ } else if (fs.existsSync(envExample)) {
44
+ console.log("- Creating .env from .env.example");
45
+ fs.copyFileSync(envExample, envTarget);
46
+ } else {
47
+ console.log("- No .env-local or .env.example found; please create .env manually");
48
+ }
49
+ } catch (err) {
50
+ console.warn("- Skipped env setup:", err instanceof Error ? err.message : String(err));
51
+ }
52
+
53
+ // 2) Install dependencies
54
+ try {
55
+ console.log("- Installing dependencies (npm install)...");
56
+ execSync("npm install", { stdio: "inherit", cwd: targetDir });
57
+ } catch (err) {
58
+ console.warn("- npm install failed, you may run it manually:", err instanceof Error ? err.message : String(err));
59
+ }
60
+
61
+ // init git
62
+ try {
63
+ execSync("git init", { stdio: "ignore", cwd: targetDir });
64
+ } catch {}
65
+
66
+ // print next steps
67
+ console.log(`
68
+ Successfully created ${projectName}!
69
+
70
+ You now have a starter example for Axios wrapped with x402 payment handling.
71
+
72
+ Next steps:
73
+ cd ${projectName}
74
+ # edit values inside .env
75
+ npm run dev
76
+
77
+ After install, open the main file (e.g., index.ts) to see how the example works.
78
+ Docs: https://docs.payai.network
79
+
80
+ Happy building 🏗️
81
+ `);
82
+
83
+
package/package.json ADDED
@@ -0,0 +1,39 @@
1
+ {
2
+ "name": "@payai/x402-axios-starter",
3
+ "version": "0.1.0",
4
+ "private": false,
5
+ "description": "Create an x402 Axios client in less than 2 minutes!",
6
+ "type": "module",
7
+ "bin": {
8
+ "create-x402-axios": "bin/create.js"
9
+ },
10
+ "files": [
11
+ "template/**",
12
+ "bin/**",
13
+ "LICENSE",
14
+ "NOTICE",
15
+ "README.md"
16
+ ],
17
+ "license": "Apache-2.0",
18
+ "engines": {
19
+ "node": ">=18"
20
+ },
21
+ "keywords": [
22
+ "x402",
23
+ "axios",
24
+ "typescript",
25
+ "coinbase",
26
+ "starter",
27
+ "template",
28
+ "example"
29
+ ],
30
+ "author": "PayAI",
31
+ "repository": {
32
+ "type": "git",
33
+ "url": "https://github.com/PayAINetwork/x402-axios-starter"
34
+ },
35
+ "config": {
36
+ "x402AxiosVersion": "0.5.1"
37
+ }
38
+ }
39
+
@@ -0,0 +1,3 @@
1
+ RESOURCE_SERVER_URL=http://localhost:4021
2
+ ENDPOINT_PATH=/weather
3
+ PRIVATE_KEY=
@@ -0,0 +1,8 @@
1
+ docs/
2
+ dist/
3
+ node_modules/
4
+ coverage/
5
+ .github/
6
+ src/client
7
+ **/**/*.json
8
+ *.md
@@ -0,0 +1,11 @@
1
+ {
2
+ "tabWidth": 2,
3
+ "useTabs": false,
4
+ "semi": true,
5
+ "singleQuote": false,
6
+ "trailingComma": "all",
7
+ "bracketSpacing": true,
8
+ "arrowParens": "avoid",
9
+ "printWidth": 100,
10
+ "proseWrap": "never"
11
+ }
@@ -0,0 +1,80 @@
1
+ # x402-axios Example Client
2
+
3
+ This is an example client that demonstrates how to use the `x402-axios` package to make HTTP requests to endpoints protected by the x402 payment protocol.
4
+
5
+ ## Prerequisites
6
+
7
+ - Node.js v20+ (install via [nvm](https://github.com/nvm-sh/nvm))
8
+ - pnpm v10 (install via [pnpm.io/installation](https://pnpm.io/installation))
9
+ - A running x402 server (you can use the example express server at `examples/typescript/servers/express`)
10
+ - A valid Ethereum private key for making payments
11
+
12
+ ## Setup
13
+
14
+ 1. Install and build all packages from the typescript examples root:
15
+ ```bash
16
+ cd ../../
17
+ pnpm install
18
+ pnpm build
19
+ cd clients/axios
20
+ ```
21
+
22
+ 2. Copy `.env-local` to `.env` and add your Ethereum private key (remember it should have USDC on Base Sepolia, which you can provision using the [CDP Faucet](https://portal.cdp.coinbase.com/products/faucet)):
23
+ ```bash
24
+ cp .env-local .env
25
+ ```
26
+
27
+ 3. Start the example client (remember you need to be running a server locally or point at an endpoint):
28
+ ```bash
29
+ pnpm dev
30
+ ```
31
+
32
+ ## How It Works
33
+
34
+ The example demonstrates how to:
35
+ 1. Create a wallet client using viem
36
+ 2. Create an Axios instance with x402 payment handling
37
+ 3. Make a request to a paid endpoint
38
+ 4. Handle the response or any errors
39
+
40
+ ## Example Code
41
+
42
+ ```typescript
43
+ import { config } from "dotenv";
44
+ import { createWalletClient, http, publicActions } from "viem";
45
+ import { privateKeyToAccount } from "viem/accounts";
46
+ import { withPaymentInterceptor } from "x402-axios";
47
+ import axios from "axios";
48
+ import { baseSepolia } from "viem/chains";
49
+
50
+ config();
51
+
52
+ const { RESOURCE_SERVER_URL, PRIVATE_KEY, ENDPOINT_PATH } = process.env;
53
+
54
+ // Create wallet client
55
+ const account = privateKeyToAccount(PRIVATE_KEY as "0x${string}");
56
+ const client = createWalletClient({
57
+ account,
58
+ transport: http(),
59
+ chain: baseSepolia,
60
+ }).extend(publicActions);
61
+
62
+ // Create Axios instance with payment handling
63
+ const api = withPaymentInterceptor(
64
+ axios.create({
65
+ baseURL: RESOURCE_SERVER_URL,
66
+ }),
67
+ client
68
+ );
69
+
70
+ // Make request to paid endpoint
71
+ api
72
+ .get(ENDPOINT_PATH)
73
+ .then(response => {
74
+ console.log(response.headers);
75
+ console.log(response.data);
76
+ })
77
+ .catch(error => {
78
+ console.error(error.response?.data?.error);
79
+ });
80
+ ```
@@ -0,0 +1,72 @@
1
+ import js from "@eslint/js";
2
+ import ts from "@typescript-eslint/eslint-plugin";
3
+ import tsParser from "@typescript-eslint/parser";
4
+ import prettier from "eslint-plugin-prettier";
5
+ import jsdoc from "eslint-plugin-jsdoc";
6
+ import importPlugin from "eslint-plugin-import";
7
+
8
+ export default [
9
+ {
10
+ ignores: ["dist/**", "node_modules/**"],
11
+ },
12
+ {
13
+ files: ["**/*.ts"],
14
+ languageOptions: {
15
+ parser: tsParser,
16
+ sourceType: "module",
17
+ ecmaVersion: 2020,
18
+ globals: {
19
+ process: "readonly",
20
+ __dirname: "readonly",
21
+ module: "readonly",
22
+ require: "readonly",
23
+ Buffer: "readonly",
24
+ exports: "readonly",
25
+ setTimeout: "readonly",
26
+ clearTimeout: "readonly",
27
+ setInterval: "readonly",
28
+ clearInterval: "readonly",
29
+ },
30
+ },
31
+ plugins: {
32
+ "@typescript-eslint": ts,
33
+ prettier: prettier,
34
+ jsdoc: jsdoc,
35
+ import: importPlugin,
36
+ },
37
+ rules: {
38
+ ...ts.configs.recommended.rules,
39
+ "import/first": "error",
40
+ "prettier/prettier": "error",
41
+ "@typescript-eslint/member-ordering": "error",
42
+ "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_$" }],
43
+ "jsdoc/tag-lines": ["error", "any", { startLines: 1 }],
44
+ "jsdoc/check-alignment": "error",
45
+ "jsdoc/no-undefined-types": "off",
46
+ "jsdoc/check-param-names": "error",
47
+ "jsdoc/check-tag-names": "error",
48
+ "jsdoc/check-types": "error",
49
+ "jsdoc/implements-on-classes": "error",
50
+ "jsdoc/require-description": "error",
51
+ "jsdoc/require-jsdoc": [
52
+ "error",
53
+ {
54
+ require: {
55
+ FunctionDeclaration: true,
56
+ MethodDefinition: true,
57
+ ClassDeclaration: true,
58
+ ArrowFunctionExpression: false,
59
+ FunctionExpression: false,
60
+ },
61
+ },
62
+ ],
63
+ "jsdoc/require-param": "error",
64
+ "jsdoc/require-param-description": "error",
65
+ "jsdoc/require-param-type": "off",
66
+ "jsdoc/require-returns": "error",
67
+ "jsdoc/require-returns-description": "error",
68
+ "jsdoc/require-returns-type": "off",
69
+ "jsdoc/require-hyphen-before-param-description": ["error", "always"],
70
+ },
71
+ },
72
+ ];
@@ -0,0 +1,37 @@
1
+ import axios from "axios";
2
+ import { config } from "dotenv";
3
+ import { Hex } from "viem";
4
+ import { privateKeyToAccount } from "viem/accounts";
5
+ import { withPaymentInterceptor, decodeXPaymentResponse } from "x402-axios";
6
+
7
+ config();
8
+
9
+ const privateKey = process.env.PRIVATE_KEY as Hex;
10
+ const baseURL = process.env.RESOURCE_SERVER_URL as string; // e.g. https://example.com
11
+ const endpointPath = process.env.ENDPOINT_PATH as string; // e.g. /weather
12
+
13
+ if (!baseURL || !privateKey || !endpointPath) {
14
+ console.error("Missing required environment variables");
15
+ process.exit(1);
16
+ }
17
+
18
+ const account = privateKeyToAccount(privateKey);
19
+
20
+ const api = withPaymentInterceptor(
21
+ axios.create({
22
+ baseURL,
23
+ }),
24
+ account,
25
+ );
26
+
27
+ api
28
+ .get(endpointPath)
29
+ .then(response => {
30
+ console.log(response.data);
31
+
32
+ const paymentResponse = decodeXPaymentResponse(response.headers["x-payment-response"]);
33
+ console.log(paymentResponse);
34
+ })
35
+ .catch(error => {
36
+ console.error(error);
37
+ });
@@ -0,0 +1,30 @@
1
+ {
2
+ "name": "axios-client-example",
3
+ "private": true,
4
+ "type": "module",
5
+ "scripts": {
6
+ "dev": "tsx index.ts",
7
+ "format": "prettier -c .prettierrc --write \"**/*.{ts,js,cjs,json,md}\"",
8
+ "format:check": "prettier -c .prettierrc --check \"**/*.{ts,js,cjs,json,md}\"",
9
+ "lint": "eslint . --ext .ts --fix",
10
+ "lint:check": "eslint . --ext .ts"
11
+ },
12
+ "dependencies": {
13
+ "axios": "^1.7.9",
14
+ "dotenv": "^16.5.0",
15
+ "viem": "^2.21.26",
16
+ "x402-axios": "^undefined"
17
+ },
18
+ "devDependencies": {
19
+ "@eslint/js": "^9.24.0",
20
+ "@typescript-eslint/eslint-plugin": "^8.29.1",
21
+ "@typescript-eslint/parser": "^8.29.1",
22
+ "eslint": "^9.24.0",
23
+ "eslint-plugin-import": "^2.31.0",
24
+ "eslint-plugin-jsdoc": "^50.6.9",
25
+ "eslint-plugin-prettier": "^5.2.6",
26
+ "prettier": "3.5.2",
27
+ "tsx": "^4.7.0",
28
+ "typescript": "^5.3.0"
29
+ }
30
+ }
@@ -0,0 +1,15 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2020",
4
+ "module": "ES2020",
5
+ "moduleResolution": "bundler",
6
+ "esModuleInterop": true,
7
+ "forceConsistentCasingInFileNames": true,
8
+ "skipLibCheck": true,
9
+ "strict": true,
10
+ "resolveJsonModule": true,
11
+ "baseUrl": ".",
12
+ "types": ["node"]
13
+ },
14
+ "include": ["index.ts"]
15
+ }