@payai/x402-hono-starter 1.0.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/servers/hono), Apache-2.0,
2
+ commit f74bda39cc692f97e55fdb0bbfdff4a0f5e7f758. See LICENSE and upstream LICENSE notices.
package/README.md ADDED
@@ -0,0 +1,163 @@
1
+ # x402 Hono Starter
2
+
3
+ A Hono application with x402 payment protocol integration, providing a modern web framework alternative to Next.js with the same payment functionality.
4
+
5
+ ## Features
6
+
7
+ - **Hono Framework**: Fast, lightweight web framework for Bun/Node.js
8
+ - **x402 Payment Integration**: Built-in payment middleware for micro-payments
9
+ - **TypeScript Support**: Full TypeScript support with proper type definitions
10
+ - **Tailwind CSS**: Utility-first CSS framework for styling
11
+ - **API Routes**: RESTful API endpoints with payment protection
12
+ - **Static File Serving**: Built-in static file serving for assets
13
+
14
+ ## Getting Started
15
+
16
+ ### Requirements
17
+
18
+ - **Node.js**: 18 or newer
19
+
20
+ ### Create a new app using the template
21
+
22
+ #### npm (npx)
23
+
24
+ ```bash
25
+ npm exec @payai/x402-hono-starter -- my-x402-app
26
+ ```
27
+
28
+ #### pnpm
29
+
30
+ ```bash
31
+ pnpm dlx @payai/x402-hono-starter my-x402-app
32
+ ```
33
+
34
+ #### bun
35
+
36
+ ```bash
37
+ bunx @payai/x402-hono-starter my-x402-app
38
+ ```
39
+
40
+ Then inside your new app:
41
+
42
+ ```bash
43
+ npm run dev
44
+ ```
45
+
46
+ ### Manual Installation
47
+
48
+ 1. Clone or download this starter template
49
+ 2. Install dependencies:
50
+
51
+ ```bash
52
+ bun install
53
+ ```
54
+
55
+ 3. Copy the environment file:
56
+
57
+ ```bash
58
+ cp env.local .env.local
59
+ ```
60
+
61
+ 4. Update your environment variables in `.env.local`:
62
+
63
+ ```env
64
+ # Replace with your actual wallet address
65
+ RESOURCE_WALLET_ADDRESS=YourAddress
66
+
67
+ # Facilitator URL
68
+ FACILITATOR_URL=https://facilitator.payai.network
69
+ ```
70
+
71
+ 5. Start the development server:
72
+
73
+ ```bash
74
+ bun run dev
75
+ ```
76
+
77
+ 6. Open [http://localhost:3000](http://localhost:3000) in your browser
78
+
79
+ ## Project Structure
80
+
81
+ ```
82
+ src/
83
+ ├── index.ts # Main application entry point
84
+ ├── routes/
85
+ │ ├── home.tsx # Home page route
86
+ │ ├── premium.tsx # Premium content page
87
+ │ └── api/
88
+ │ ├── weather/ # Weather API endpoint
89
+ │ └── premium/
90
+ │ └── content/ # Premium content API
91
+ ├── styles/
92
+ │ └── globals.css # Global styles with Tailwind
93
+ └── ...
94
+ ```
95
+
96
+ ## API Endpoints
97
+
98
+ ### Free Endpoints
99
+
100
+ - `GET /` - Home page
101
+ - `GET /premium` - Premium content page
102
+
103
+ ### Protected Endpoints (Require Payment)
104
+
105
+ - `GET /api/weather` - Weather data (requires $0.001 USDC)
106
+ - `GET /api/premium/content` - Premium content (requires custom token payment)
107
+
108
+ ## Payment Configuration
109
+
110
+ The payment middleware is configured in `src/index.ts`:
111
+
112
+ ```typescript
113
+ const paymentConfig = {
114
+ '/api/weather': {
115
+ price: '$0.001',
116
+ network: 'base-sepolia',
117
+ },
118
+ '/api/premium/*': {
119
+ price: {
120
+ amount: '100000',
121
+ asset: {
122
+ address: '0xabc',
123
+ decimals: 18,
124
+ eip712: {
125
+ name: 'WETH',
126
+ version: '1',
127
+ },
128
+ },
129
+ },
130
+ network: 'base-sepolia',
131
+ },
132
+ };
133
+ ```
134
+
135
+ ## Available Scripts
136
+
137
+ - `bun run dev` - Start development server with hot reload
138
+ - `bun run build` - Build the application for production
139
+ - `bun run start` - Start the production server
140
+ - `bun run lint` - Run ESLint
141
+ - `bun run format` - Format code with Prettier
142
+ - `bun run format:check` - Check code formatting
143
+
144
+ ## Development
145
+
146
+ The application uses:
147
+
148
+ - **Hono** for the web framework
149
+ - **x402-hono** for payment middleware
150
+ - **TypeScript** for type safety
151
+ - **Tailwind CSS** for styling
152
+ - **ESLint** and **Prettier** for code quality
153
+
154
+ ## Deployment
155
+
156
+ The application can be deployed to any platform that supports Bun or Node.js:
157
+
158
+ 1. Build the application: `bun run build`
159
+ 2. Start the production server: `bun run start`
160
+
161
+ ## License
162
+
163
+ Apache-2.0
package/bin/create.js ADDED
@@ -0,0 +1,81 @@
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 : "my-x402-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 a Hono server 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
+ `);
package/package.json ADDED
@@ -0,0 +1,42 @@
1
+ {
2
+ "name": "@payai/x402-hono-starter",
3
+ "version": "1.0.0",
4
+ "private": false,
5
+ "publishConfig": {
6
+ "access": "public",
7
+ "registry": "https://registry.npmjs.org"
8
+ },
9
+ "description": "Create an x402 Hono server in less than 2 minutes!",
10
+ "type": "module",
11
+ "bin": {
12
+ "create-x402-hono": "bin/create.js"
13
+ },
14
+ "files": [
15
+ "template/**",
16
+ "bin/**",
17
+ "LICENSE",
18
+ "NOTICE",
19
+ "README.md"
20
+ ],
21
+ "license": "Apache-2.0",
22
+ "engines": {
23
+ "node": ">=18"
24
+ },
25
+ "keywords": [
26
+ "x402",
27
+ "hono",
28
+ "typescript",
29
+ "coinbase",
30
+ "starter",
31
+ "template",
32
+ "example"
33
+ ],
34
+ "author": "PayAI",
35
+ "repository": {
36
+ "type": "git",
37
+ "url": "git+https://github.com/PayAINetwork/x402-hono-starter.git"
38
+ },
39
+ "config": {
40
+ "x402HonoVersion": "2.2.0"
41
+ }
42
+ }
@@ -0,0 +1,7 @@
1
+ FACILITATOR_URL=https://facilitator.payai.network
2
+ NETWORK=solana-devnet
3
+ ADDRESS=
4
+
5
+ # required if using the Base mainnet facilitator
6
+ CDP_API_KEY_ID="Coinbase Developer Platform Key"
7
+ CDP_API_KEY_SECRET="Coinbase Developer Platform Key Secret"
@@ -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,150 @@
1
+ # x402-hono Example Server
2
+
3
+ This is an example Hono server that demonstrates how to use the `x402-hono` middleware to implement paywall functionality in your API endpoints.
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 valid Ethereum address for receiving payments
10
+ - Coinbase Developer Platform API Key & Secret (if accepting payments on Base mainnet)
11
+ -- get them here [https://portal.cdp.coinbase.com/projects](https://portal.cdp.coinbase.com/projects)
12
+
13
+ ## Setup
14
+
15
+ 1. Copy `.env-local` to `.env` and add your Ethereum address to receive payments:
16
+
17
+ ```bash
18
+ cp .env-local .env
19
+ ```
20
+
21
+ 2. Install and build all packages from the typescript examples root:
22
+
23
+ ```bash
24
+ cd ../../
25
+ pnpm install
26
+ pnpm build
27
+ cd servers/hono
28
+ ```
29
+
30
+ 3. Run the server
31
+
32
+ ```bash
33
+ pnpm install
34
+ pnpm dev
35
+ ```
36
+
37
+ ## Testing the Server
38
+
39
+ You can test the server using one of the example clients:
40
+
41
+ ### Using the Fetch Client
42
+
43
+ ```bash
44
+ cd ../clients/fetch
45
+ # Ensure .env is setup
46
+ pnpm install
47
+ pnpm dev
48
+ ```
49
+
50
+ ### Using the Axios Client
51
+
52
+ ```bash
53
+ cd ../clients/axios
54
+ # Ensure .env is setup
55
+ pnpm install
56
+ pnpm dev
57
+ ```
58
+
59
+ These clients will demonstrate how to:
60
+
61
+ 1. Make an initial request to get payment requirements
62
+ 2. Process the payment requirements
63
+ 3. Make a second request with the payment token
64
+
65
+ ## Example Endpoint
66
+
67
+ The server includes a single example endpoint at `/weather` that requires a payment of $0.001 to access. The endpoint returns a simple weather report.
68
+
69
+ ## Response Format
70
+
71
+ ### Payment Required (402)
72
+
73
+ ```json
74
+ {
75
+ "error": "X-PAYMENT header is required",
76
+ "paymentRequirements": {
77
+ "scheme": "exact",
78
+ "network": "base",
79
+ "maxAmountRequired": "1000",
80
+ "resource": "http://localhost:4021/weather",
81
+ "description": "",
82
+ "mimeType": "",
83
+ "payTo": "0xYourAddress",
84
+ "maxTimeoutSeconds": 60,
85
+ "asset": "0x...",
86
+ "outputSchema": null,
87
+ "extra": null
88
+ }
89
+ }
90
+ ```
91
+
92
+ ### Successful Response
93
+
94
+ ```ts
95
+ // Body
96
+ {
97
+ "report": {
98
+ "weather": "sunny",
99
+ "temperature": 70
100
+ }
101
+ }
102
+ // Headers
103
+ {
104
+ "X-PAYMENT-RESPONSE": "..." // Encoded response object
105
+ }
106
+ ```
107
+
108
+ ## Extending the Example
109
+
110
+ To add more paid endpoints, follow this pattern:
111
+
112
+ ```typescript
113
+ // First, configure the payment middleware with your routes
114
+ app.use(
115
+ paymentMiddleware(payTo, {
116
+ // Define your routes and their payment requirements
117
+ "/your-endpoint": {
118
+ price: "$0.10",
119
+ network,
120
+ },
121
+ "/premium/*": {
122
+ price: {
123
+ amount: "100000",
124
+ asset: {
125
+ address: "0xabc",
126
+ decimals: 18,
127
+ eip712: {
128
+ name: "WETH",
129
+ version: "1",
130
+ },
131
+ },
132
+ },
133
+ network,
134
+ },
135
+ }),
136
+ );
137
+
138
+ // Then define your routes as normal
139
+ app.get("/your-endpoint", c => {
140
+ return c.json({
141
+ // Your response data
142
+ });
143
+ });
144
+
145
+ app.get("/premium/content", c => {
146
+ return c.json({
147
+ content: "This is premium content",
148
+ });
149
+ });
150
+ ```
@@ -0,0 +1,4 @@
1
+
2
+ FACILITATOR_URL=https://facilitator.payai.network
3
+
4
+ NETWORK=solana-devnet
@@ -0,0 +1,73 @@
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
+ console: "readonly",
25
+ exports: "readonly",
26
+ setTimeout: "readonly",
27
+ clearTimeout: "readonly",
28
+ setInterval: "readonly",
29
+ clearInterval: "readonly",
30
+ },
31
+ },
32
+ plugins: {
33
+ "@typescript-eslint": ts,
34
+ prettier: prettier,
35
+ jsdoc: jsdoc,
36
+ import: importPlugin,
37
+ },
38
+ rules: {
39
+ ...ts.configs.recommended.rules,
40
+ "import/first": "error",
41
+ "prettier/prettier": "error",
42
+ "@typescript-eslint/member-ordering": "error",
43
+ "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_$" }],
44
+ "jsdoc/tag-lines": ["error", "any", { startLines: 1 }],
45
+ "jsdoc/check-alignment": "error",
46
+ "jsdoc/no-undefined-types": "off",
47
+ "jsdoc/check-param-names": "error",
48
+ "jsdoc/check-tag-names": "error",
49
+ "jsdoc/check-types": "error",
50
+ "jsdoc/implements-on-classes": "error",
51
+ "jsdoc/require-description": "error",
52
+ "jsdoc/require-jsdoc": [
53
+ "error",
54
+ {
55
+ require: {
56
+ FunctionDeclaration: true,
57
+ MethodDefinition: true,
58
+ ClassDeclaration: true,
59
+ ArrowFunctionExpression: false,
60
+ FunctionExpression: false,
61
+ },
62
+ },
63
+ ],
64
+ "jsdoc/require-param": "error",
65
+ "jsdoc/require-param-description": "error",
66
+ "jsdoc/require-param-type": "off",
67
+ "jsdoc/require-returns": "error",
68
+ "jsdoc/require-returns-description": "error",
69
+ "jsdoc/require-returns-type": "off",
70
+ "jsdoc/require-hyphen-before-param-description": ["error", "always"],
71
+ },
72
+ },
73
+ ];
@@ -0,0 +1,48 @@
1
+ import { config } from "dotenv";
2
+ import { Hono } from "hono";
3
+ import { serve } from "@hono/node-server";
4
+ import { paymentMiddleware, Network, Resource, SolanaAddress } from "x402-hono";
5
+
6
+ config();
7
+
8
+ const facilitatorUrl = process.env.FACILITATOR_URL as Resource;
9
+ const payTo = process.env.ADDRESS as `0x${string}` | SolanaAddress;
10
+ const network = process.env.NETWORK as Network;
11
+
12
+ if (!facilitatorUrl || !payTo || !network) {
13
+ console.error("Missing required environment variables");
14
+ process.exit(1);
15
+ }
16
+
17
+ const app = new Hono();
18
+
19
+ console.log("Server is running");
20
+
21
+ app.use(
22
+ paymentMiddleware(
23
+ payTo,
24
+ {
25
+ "/weather": {
26
+ price: "$0.001",
27
+ network,
28
+ },
29
+ },
30
+ {
31
+ url: facilitatorUrl,
32
+ },
33
+ ),
34
+ );
35
+
36
+ app.get("/weather", c => {
37
+ return c.json({
38
+ report: {
39
+ weather: "sunny",
40
+ temperature: 70,
41
+ },
42
+ });
43
+ });
44
+
45
+ serve({
46
+ fetch: app.fetch,
47
+ port: 4021,
48
+ });
@@ -0,0 +1,31 @@
1
+ {
2
+ "name": "hono-server-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
+ "@hono/node-server": "^1.13.8",
14
+ "@x402/hono": "^2.2.0",
15
+ "dotenv": "^16.4.7",
16
+ "hono": "^4.7.1"
17
+ },
18
+ "devDependencies": {
19
+ "tsup": "^7.2.0",
20
+ "tsx": "^4.7.0",
21
+ "typescript": "^5.3.0",
22
+ "@eslint/js": "^9.24.0",
23
+ "eslint": "^9.24.0",
24
+ "eslint-plugin-jsdoc": "^50.6.9",
25
+ "eslint-plugin-prettier": "^5.2.6",
26
+ "@typescript-eslint/eslint-plugin": "^8.29.1",
27
+ "@typescript-eslint/parser": "^8.29.1",
28
+ "eslint-plugin-import": "^2.31.0",
29
+ "prettier": "3.5.2"
30
+ }
31
+ }
@@ -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
+ }