@openreceive/node 0.4.14 → 0.4.16
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/README.md +11 -0
- package/dist/{chunk-GOWL2Y6H.js → chunk-LD7HMUY3.js} +3 -0
- package/dist/cli.js +33 -3
- package/dist/index.js +1 -1
- package/package.json +2 -2
- package/skills/debug-openreceive-payment/SKILL.md +20 -4
- package/skills/integrate-openreceive/SKILL.md +42 -21
- package/skills/integrate-openreceive/references/btcpay.md +5 -1
- package/skills/integrate-openreceive/references/django.md +20 -13
- package/skills/integrate-openreceive/references/fastapi.md +1 -1
- package/skills/integrate-openreceive/references/fastify.md +1 -1
- package/skills/integrate-openreceive/references/laravel.md +1 -1
- package/skills/integrate-openreceive/references/next.md +1 -1
- package/skills/integrate-openreceive/references/node.md +1 -1
- package/skills/integrate-openreceive/references/php.md +1 -1
- package/skills/integrate-openreceive/references/rails.md +1 -1
- package/skills/integrate-openreceive/references/woocommerce.md +107 -52
package/README.md
CHANGED
|
@@ -48,3 +48,14 @@ exposing payment instructions.
|
|
|
48
48
|
- [Optional swaps](https://github.com/openreceive/openreceive/blob/master/docs/guides/automated-swaps.md)
|
|
49
49
|
- [Test with a fake wallet](https://github.com/openreceive/openreceive/blob/master/docs/guides/host-testing.md)
|
|
50
50
|
- [Deploy and reconcile payments](https://github.com/openreceive/openreceive/blob/master/docs/guides/deploying.md)
|
|
51
|
+
|
|
52
|
+
## Agent skills
|
|
53
|
+
|
|
54
|
+
Run `npx openreceive skills install` from your application after installing an
|
|
55
|
+
OpenReceive server adapter. The offline copy ships in `@openreceive/node`, a
|
|
56
|
+
server-adapter dependency. For a frontend-only project, use
|
|
57
|
+
`npx skills add OpenReceive/openreceive`.
|
|
58
|
+
See [agent setup](https://openreceive.org/agents). The bundled installers write
|
|
59
|
+
to `.agents/skills/`; use `--dir .claude/skills` for Claude Code. They replace
|
|
60
|
+
only `integrate-openreceive` and `debug-openreceive-payment`, preserving
|
|
61
|
+
unrelated skills.
|
|
@@ -28,6 +28,7 @@ var NWC_ERROR_CODE_ALIASES = {
|
|
|
28
28
|
EXPIRED: "INVOICE_EXPIRED",
|
|
29
29
|
FETCH_ERROR: "WALLET_UNAVAILABLE",
|
|
30
30
|
FORBIDDEN: "RESTRICTED",
|
|
31
|
+
INFO_UNAVAILABLE_ERROR: "WALLET_UNAVAILABLE",
|
|
31
32
|
INVOICE_NOT_FOUND: "NOT_FOUND",
|
|
32
33
|
INVALID_PARAMETER: "INVALID_REQUEST",
|
|
33
34
|
INVALID_PARAMETERS: "INVALID_REQUEST",
|
|
@@ -37,6 +38,7 @@ var NWC_ERROR_CODE_ALIASES = {
|
|
|
37
38
|
NIP47_NETWORK_ERROR: "WALLET_UNAVAILABLE",
|
|
38
39
|
NOSTR_NETWORK_ERROR: "WALLET_UNAVAILABLE",
|
|
39
40
|
NOT_AUTHORIZED: "UNAUTHORIZED",
|
|
41
|
+
NOT_SENT_ERROR: "WALLET_UNAVAILABLE",
|
|
40
42
|
NOT_SUPPORTED: "UNSUPPORTED_METHOD",
|
|
41
43
|
NOTFOUND: "NOT_FOUND",
|
|
42
44
|
PERMISSION_DENIED: "RESTRICTED",
|
|
@@ -45,6 +47,7 @@ var NWC_ERROR_CODE_ALIASES = {
|
|
|
45
47
|
SERVICE_UNAVAILABLE: "WALLET_UNAVAILABLE",
|
|
46
48
|
TIMED_OUT: "TIMEOUT",
|
|
47
49
|
TIMEOUT_ERROR: "TIMEOUT",
|
|
50
|
+
TRANSPORT_ERROR: "WALLET_UNAVAILABLE",
|
|
48
51
|
UNKNOWN_METHOD: "UNSUPPORTED_METHOD",
|
|
49
52
|
UNSUPPORTED: "UNSUPPORTED_METHOD",
|
|
50
53
|
UNSUPPORTED_ENCRYPTION_MODE: "UNSUPPORTED_ENCRYPTION",
|
package/dist/cli.js
CHANGED
|
@@ -2,13 +2,13 @@ import {
|
|
|
2
2
|
createNwcReceiveClient,
|
|
3
3
|
readLscConnectionsFromEnvironment,
|
|
4
4
|
redactSecrets
|
|
5
|
-
} from "./chunk-
|
|
5
|
+
} from "./chunk-LD7HMUY3.js";
|
|
6
6
|
|
|
7
7
|
// src/cli.ts
|
|
8
|
-
import { existsSync } from "node:fs";
|
|
8
|
+
import { cpSync, existsSync, mkdirSync, realpathSync, rmSync } from "node:fs";
|
|
9
9
|
import { createRequire } from "node:module";
|
|
10
10
|
import path2 from "node:path";
|
|
11
|
-
import { pathToFileURL } from "node:url";
|
|
11
|
+
import { fileURLToPath, pathToFileURL } from "node:url";
|
|
12
12
|
import {
|
|
13
13
|
formatInvalidNwcMessage,
|
|
14
14
|
NwcUriParseError,
|
|
@@ -928,6 +928,8 @@ Commands:
|
|
|
928
928
|
debug-report Print the same diagnostics as a redacted support report
|
|
929
929
|
(alias of doctor; always exits 0).
|
|
930
930
|
scaffold payments Emit the openreceive_payments + openreceive_meta migration and wiring guide for your ORM.
|
|
931
|
+
skills install Copy bundled agent skills into .agents/skills.
|
|
932
|
+
--dir <path> selects another directory (e.g. .claude/skills).
|
|
931
933
|
|
|
932
934
|
Options:
|
|
933
935
|
-h, --help Show this help.
|
|
@@ -965,6 +967,33 @@ async function runCli(options) {
|
|
|
965
967
|
walletClientFactory: options.walletClientFactory
|
|
966
968
|
});
|
|
967
969
|
}
|
|
970
|
+
if (command === "skills") {
|
|
971
|
+
if (args[0] !== "install" || !(args.length === 1 || args.length === 3 && args[1] === "--dir" && args[2] && !args[2].startsWith("--"))) {
|
|
972
|
+
throw new Error("Usage: openreceive skills install [--dir <path>]");
|
|
973
|
+
}
|
|
974
|
+
const source = realpathSync(fileURLToPath(new URL("../skills/", import.meta.url)));
|
|
975
|
+
let target = path2.resolve(cwd, args[2] ?? ".agents/skills");
|
|
976
|
+
const names = ["integrate-openreceive", "debug-openreceive-payment"];
|
|
977
|
+
for (const name of names) {
|
|
978
|
+
if (!existsSync(path2.join(source, name, "SKILL.md"))) {
|
|
979
|
+
throw new Error(`Bundled skill missing: ${name}. Reinstall @openreceive/node.`);
|
|
980
|
+
}
|
|
981
|
+
}
|
|
982
|
+
mkdirSync(target, { recursive: true });
|
|
983
|
+
target = realpathSync(target);
|
|
984
|
+
if (target === source || target.startsWith(`${source}${path2.sep}`)) {
|
|
985
|
+
throw new Error("Choose a skills directory outside the installed package's bundle.");
|
|
986
|
+
}
|
|
987
|
+
for (const name of names) {
|
|
988
|
+
const destination = path2.join(target, name);
|
|
989
|
+
rmSync(destination, { recursive: true, force: true });
|
|
990
|
+
cpSync(path2.join(source, name), destination, { recursive: true });
|
|
991
|
+
stdout.write(`Wrote ${destination}
|
|
992
|
+
`);
|
|
993
|
+
}
|
|
994
|
+
stdout.write("For Claude Code: openreceive skills install --dir .claude/skills\n");
|
|
995
|
+
return 0;
|
|
996
|
+
}
|
|
968
997
|
if (command === "scaffold") {
|
|
969
998
|
const [target = "help", ...scaffoldArgs] = args;
|
|
970
999
|
if (target === "help" || target === "--help" || target === "-h") {
|
|
@@ -1047,6 +1076,7 @@ async function runDiagnostics(input) {
|
|
|
1047
1076
|
}
|
|
1048
1077
|
const lines = [
|
|
1049
1078
|
`OpenReceive ${input.command}`,
|
|
1079
|
+
"Agent skills: run `npx openreceive skills install`",
|
|
1050
1080
|
`node: ${process.version}`,
|
|
1051
1081
|
`cwd: ${input.cwd}`,
|
|
1052
1082
|
"storage: payment-attempt rows live in the host database (no separate store)",
|
package/dist/index.js
CHANGED
|
@@ -19,7 +19,7 @@ import {
|
|
|
19
19
|
summarizeReconcilePass,
|
|
20
20
|
summarizeSwapProviderApiRequest,
|
|
21
21
|
summarizeSwapProviderApiResponse
|
|
22
|
-
} from "./chunk-
|
|
22
|
+
} from "./chunk-LD7HMUY3.js";
|
|
23
23
|
|
|
24
24
|
// src/index.ts
|
|
25
25
|
import { OpenReceiveError as OpenReceiveError2 } from "@openreceive/core";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openreceive/node",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.16",
|
|
4
4
|
"description": "Accept Bitcoin Lightning payments in Node.js with your own wallet and optional USDT, USDC, SOL and ETH swaps.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"bitcoin",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"types": "./dist/index.d.ts",
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"@getalby/sdk": "^8.0.3",
|
|
20
|
-
"@openreceive/core": "0.4.
|
|
20
|
+
"@openreceive/core": "0.4.16"
|
|
21
21
|
},
|
|
22
22
|
"bin": {
|
|
23
23
|
"openreceive": "./bin/openreceive.mjs"
|
|
@@ -19,6 +19,12 @@ URL below is raw markdown — fetch it when the step needs it.
|
|
|
19
19
|
npx openreceive doctor # Node version, NWC_URI, swap config, wallet probe
|
|
20
20
|
npx openreceive doctor --db <db> # + are openreceive_payments/openreceive_meta migrated?
|
|
21
21
|
npx openreceive doctor --url http://localhost:3000 # + are the routes actually mounted?
|
|
22
|
+
bin/rails openreceive:doctor # Rails
|
|
23
|
+
manage.py openreceive_doctor # Django
|
|
24
|
+
openreceive doctor --app main:app # FastAPI
|
|
25
|
+
php artisan openreceive:doctor # Laravel
|
|
26
|
+
wp openreceive doctor # WordPress
|
|
27
|
+
php bin/doctor # plain PHP: host script calling $engine->doctor()
|
|
22
28
|
```
|
|
23
29
|
|
|
24
30
|
Each failing line states its own fix. `npx openreceive debug-report` prints the
|
|
@@ -32,7 +38,7 @@ same diagnostics redacted, always exit 0 — safe to share.
|
|
|
32
38
|
| `INVALID_NWC` / "not a valid NWC code" | The value is malformed (must be `nostr+walletconnect://` with 64-hex pubkey and secret, ≥1 `wss` relay). Re-copy it from the wallet. |
|
|
33
39
|
| "NOT receive-only" / spend methods advertised | The wallet minted a spend-capable code; OpenReceive fails closed because a leak would drain the wallet. Mint a receive-only code. Overriding (`allowSpendCapableWallet` / `OPENRECEIVE_ALLOW_SPEND_CAPABLE_NWC`) is a last resort. |
|
|
34
40
|
| Wallet preflight failed (methods/encryption) | The wallet must advertise `make_invoice` + `list_transactions` and NIP-04 or NIP-44 v2. Use a compatible wallet. |
|
|
35
|
-
| "The openreceive_meta table does not exist" / raw `no such table: openreceive_payments` | The migration was never applied. Node: `npx openreceive scaffold payments --orm <yours>`, then run the emitted migration through the app's normal workflow. Rails: `bin/rails generate openreceive:install`, then `bin/rails db:migrate`. https://openreceive.org/guides/storage.md |
|
|
41
|
+
| "The openreceive_meta table does not exist" / raw `no such table: openreceive_payments` | The migration was never applied. Node: `npx openreceive scaffold payments --orm <yours>`, then run the emitted migration through the app's normal workflow. Rails: `bin/rails generate openreceive:install`, then `bin/rails db:migrate`. Django: `manage.py openreceive_install <app> && manage.py migrate`. FastAPI: `openreceive scaffold payments --alembic --dialect <db>` (or `--sql`), then apply through the host workflow. Laravel: `php artisan openreceive:install && php artisan migrate`. Plain PHP: apply `OpenReceive\Storage\PaymentsSchema::statements($dialect)` through the host workflow. WordPress: check plugin activation/upgrades applied the tables. https://openreceive.org/guides/storage.md |
|
|
36
42
|
| "requires amountFor / onPaid / authorize / host" | The factory is missing a required hook — see the host contract in https://openreceive.org/guides/api-reference.md |
|
|
37
43
|
|
|
38
44
|
## 3. Request-time errors from the routes
|
|
@@ -51,7 +57,12 @@ same diagnostics redacted, always exit 0 — safe to share.
|
|
|
51
57
|
- Settlement is opportunistic: any OpenReceive request runs one reconcile pass
|
|
52
58
|
through a durable gate (min 3s between wallet scans, stretched by invoice
|
|
53
59
|
age). A quiet server settles on the next request — or run the optional
|
|
54
|
-
|
|
60
|
+
notifications worker: Rails `bin/rails openreceive:notifications`, Django
|
|
61
|
+
`manage.py openreceive_notifications`, FastAPI
|
|
62
|
+
`openreceive notifications --app main:app`, Laravel
|
|
63
|
+
`php artisan openreceive:notifications`, WordPress `wp openreceive notifications`,
|
|
64
|
+
or plain PHP's host script `php bin/notifications`. Node hosts run their
|
|
65
|
+
separate worker using the notifications API. No web-process timer is missing.
|
|
55
66
|
- An unpaid attempt closes only after a successful wallet scan at/after expiry
|
|
56
67
|
plus a 900s grace constant — a local clock alone never closes one. `expired`
|
|
57
68
|
arriving "late" is correct.
|
|
@@ -83,8 +94,13 @@ same diagnostics redacted, always exit 0 — safe to share.
|
|
|
83
94
|
|
|
84
95
|
- The components require `prefix` — the exact base path the routes are mounted
|
|
85
96
|
at (`"/openreceive"` unless you changed it).
|
|
86
|
-
- Import
|
|
87
|
-
|
|
97
|
+
- Import `@openreceive/react/styles.css` or `@openreceive/elements/styles.css`
|
|
98
|
+
alongside the component registration. For standalone Django/Laravel/PHP,
|
|
99
|
+
serve both `openreceive-checkout.js` (as a module) and
|
|
100
|
+
`openreceive-checkout.css`. Django serves them from `static/openreceive/`
|
|
101
|
+
via `collectstatic`; Laravel/PHP serve the unpacked standalone assets from
|
|
102
|
+
the public directory. Check that both requests succeed and the custom
|
|
103
|
+
element is registered. Do not process the compiled stylesheet with Tailwind.
|
|
88
104
|
- "invoice must not be an NWC connection string" means a server secret leaked
|
|
89
105
|
into a browser payload — stop and fix the server response; never render it.
|
|
90
106
|
https://openreceive.org/guides/frontend-checkout.md
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: integrate-openreceive
|
|
3
3
|
description: >
|
|
4
|
-
Integrate OpenReceive
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
4
|
+
Integrate OpenReceive Bitcoin Lightning checkout and optional USDT, USDC,
|
|
5
|
+
SOL, and ETH swaps. Use for Node.js, Express, Fastify, Next.js, Rails,
|
|
6
|
+
Python, Django, FastAPI, Laravel, plain PHP, WordPress/WooCommerce,
|
|
7
|
+
React, Vue, Svelte, Angular, or plain HTML applications, or connecting
|
|
8
|
+
BTCPay Server to a receive-only NWC wallet. A configured swap provider
|
|
9
|
+
converts these payments to BTC over Lightning in the merchant's connected
|
|
10
|
+
wallet; asset and network availability depends on the provider.
|
|
10
11
|
license: MIT
|
|
11
12
|
---
|
|
12
13
|
|
|
@@ -19,6 +20,10 @@ settles. There is no OpenReceive account and no API key; funds land directly in
|
|
|
19
20
|
the merchant's wallet. The one required credential is a **receive-only NWC
|
|
20
21
|
code** (`NWC_URI`).
|
|
21
22
|
|
|
23
|
+
Optional swaps let customers pay with USDT, USDC, SOL, and ETH. A configured
|
|
24
|
+
swap provider converts these payments to BTC over Lightning in the merchant's
|
|
25
|
+
connected wallet; asset and network availability depends on the provider.
|
|
26
|
+
|
|
22
27
|
## Pick the stack, then follow its directions
|
|
23
28
|
|
|
24
29
|
1. Identify the server stack of the application you are in.
|
|
@@ -28,6 +33,8 @@ code** (`NWC_URI`).
|
|
|
28
33
|
- Node, Fastify: [references/fastify.md](references/fastify.md)
|
|
29
34
|
- Node, Next.js App Router: [references/next.md](references/next.md)
|
|
30
35
|
- Rails: [references/rails.md](references/rails.md)
|
|
36
|
+
- Python, FastAPI: [references/fastapi.md](references/fastapi.md)
|
|
37
|
+
- Plain PHP: [references/php.md](references/php.md)
|
|
31
38
|
- Django: [references/django.md](references/django.md)
|
|
32
39
|
- Laravel: [references/laravel.md](references/laravel.md)
|
|
33
40
|
- WordPress + WooCommerce: [references/woocommerce.md](references/woocommerce.md) — the packaged gateway and merchant settings.
|
|
@@ -44,6 +51,9 @@ Fastify: `npm install @openreceive/fastify @openreceive/react`; Next.js:
|
|
|
44
51
|
`npm install @openreceive/next @openreceive/react`. Swap the UI package (`vue`,
|
|
45
52
|
`svelte`, `angular`, `elements`) for the frontend the app already has. Install
|
|
46
53
|
(Rails): `bundle add openreceive-rails`.
|
|
54
|
+
Django: `pip install "openreceive[django]"`; FastAPI:
|
|
55
|
+
`pip install "openreceive[fastapi]"`; Laravel: `composer require openreceive/laravel`;
|
|
56
|
+
plain PHP: `composer require openreceive/openreceive nyholm/psr7 nyholm/psr7-server`.
|
|
47
57
|
|
|
48
58
|
## The three server objects
|
|
49
59
|
|
|
@@ -108,25 +118,36 @@ overriding.
|
|
|
108
118
|
|
|
109
119
|
## Database tables
|
|
110
120
|
|
|
111
|
-
|
|
112
|
-
npx openreceive scaffold payments --orm prisma # or drizzle | typeorm | sequelize | knex
|
|
113
|
-
```
|
|
121
|
+
Generate the two tables in the host's existing database:
|
|
114
122
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
123
|
+
| Stack | Generate and apply |
|
|
124
|
+
| --- | --- |
|
|
125
|
+
| Node | `npx openreceive scaffold payments --orm <orm>`, then the app's normal migration command |
|
|
126
|
+
| Rails | `bin/rails generate openreceive:install && bin/rails db:migrate` |
|
|
127
|
+
| Django | `manage.py openreceive_install <app> && manage.py migrate` |
|
|
128
|
+
| FastAPI | `openreceive scaffold payments --alembic --dialect <db>` (or `--sql`), then apply through the app's migration workflow |
|
|
129
|
+
| Laravel | `php artisan openreceive:install && php artisan migrate` |
|
|
130
|
+
| Plain PHP | Use `OpenReceive\Storage\PaymentsSchema::statements($dialect)` in the host's migration workflow, as in the PHP reference |
|
|
119
131
|
|
|
120
|
-
|
|
132
|
+
These emit `openreceive_payments` + `openreceive_meta`. The tables sit beside
|
|
133
|
+
your models — no relations to them, no separate database, no Redis. WordPress
|
|
134
|
+
and BTCPay manage installation through their plugins; follow their references.
|
|
121
135
|
|
|
122
|
-
|
|
136
|
+
## Verify, and test without a real wallet
|
|
123
137
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
`
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
138
|
+
| Stack | Doctor | Test seam |
|
|
139
|
+
| --- | --- | --- |
|
|
140
|
+
| Node | `npx openreceive doctor` | `client` on `createOpenReceive` (`preflight`, `makeInvoice`, `listTransactions`), plus `StaticPriceProvider` |
|
|
141
|
+
| Rails | `bin/rails openreceive:doctor` | `config.nwc_client`, `config.swap_providers`, `config.price_provider` |
|
|
142
|
+
| Django | `manage.py openreceive_doctor` | `OPENRECEIVE["SERVICE"]`, a factory returning a `Service` built on `openreceive.testing` fakes |
|
|
143
|
+
| FastAPI | `openreceive doctor --app main:app` | `nwc_client`, `price_provider`, `swap_providers` on `openreceive_router`, using `openreceive.testing` fakes |
|
|
144
|
+
| Laravel | `php artisan openreceive:doctor` | Bind `ReceiveNwcClient`, `PriceProvider`, and `OpenReceiveServiceProvider::SWAP_PROVIDERS` in the container |
|
|
145
|
+
| Plain PHP | `php bin/doctor` (host script calling `$engine->doctor()`) | Build `Service` with `OpenReceive\Testing\FakeWallet`, `FakeSwapProvider`, and `OpenReceive\Rates\StaticPriceProvider` |
|
|
146
|
+
| WordPress | `wp openreceive doctor` | Repository development: the documented Docker `compose.testkit.yml` override |
|
|
147
|
+
| BTCPay | Follow the plugin reference's connection and checkout checks | Use the plugin's Docker test setup in its reference |
|
|
148
|
+
|
|
149
|
+
The routes, persistence, reconciliation, and fulfillment hooks then run the
|
|
150
|
+
production paths. Details: https://openreceive.org/guides/host-testing.md
|
|
130
151
|
|
|
131
152
|
## Deeper documentation
|
|
132
153
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (BTCPay Server)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Connect a BTCPay Server store to a receive-only NWC wallet with the OpenReceive
|
|
6
6
|
plugin, and optionally let payers pay BTCPay invoices with USDT, USDC, ETH or
|
|
@@ -164,13 +164,17 @@ them to install the plugin for you.
|
|
|
164
164
|
|
|
165
165
|
**1. Open the Plugins menu.** It is the plug icon in the top-right corner.
|
|
166
166
|
|
|
167
|
+
|
|
167
168
|
**2. Click Plugin Directory.**
|
|
168
169
|
|
|
170
|
+
|
|
169
171
|
**3. Search for `openreceive`** and click the **OpenReceive** result.
|
|
170
172
|
|
|
173
|
+
|
|
171
174
|
**4. Click Install in BTCPay Server.** Confirm when prompted, then click
|
|
172
175
|
**Restart now** and wait for BTCPay to come back.
|
|
173
176
|
|
|
177
|
+
|
|
174
178
|
At startup, BTCPay creates the plugin's two tables in its own Postgres
|
|
175
179
|
database: `openreceive_invoices` and `openreceive_swaps`, in the schema
|
|
176
180
|
`BTCPayServer.Plugins.OpenReceive`. Nothing else is created.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (Django)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Add OpenReceive to a Django project — the app you are already working in. You
|
|
6
6
|
do not need a copy of the OpenReceive source: the Python package is on PyPI
|
|
@@ -366,17 +366,18 @@ Then add the app, point it at a host class, and mount the routes:
|
|
|
366
366
|
INSTALLED_APPS += ["openreceive.django"]
|
|
367
367
|
|
|
368
368
|
OPENRECEIVE = {
|
|
369
|
-
"HOST": "shop.openreceive_host.Host",
|
|
369
|
+
"HOST": "shop.openreceive_host.Host", # the class with the three hooks (generated below)
|
|
370
370
|
"PRICE_CURRENCIES": ["USD"],
|
|
371
|
-
"RATE_LIMITING": False,
|
|
372
|
-
"OPPORTUNISTIC_RECONCILE": True,
|
|
373
|
-
"DATABASE": "default",
|
|
371
|
+
"RATE_LIMITING": False, # True for public web shops (see below)
|
|
372
|
+
"OPPORTUNISTIC_RECONCILE": True, # or {"min_interval_seconds": …}; False only with your own worker
|
|
373
|
+
"DATABASE": "default", # the DATABASES alias that holds the two engine tables
|
|
374
374
|
}
|
|
375
375
|
```
|
|
376
376
|
|
|
377
377
|
```python
|
|
378
378
|
# urls.py
|
|
379
379
|
from django.urls import include, path
|
|
380
|
+
|
|
380
381
|
urlpatterns += [path("openreceive/", include("openreceive.django.urls"))]
|
|
381
382
|
```
|
|
382
383
|
|
|
@@ -420,9 +421,9 @@ The generated host module explains this and shows the guarded transition:
|
|
|
420
421
|
|
|
421
422
|
```python
|
|
422
423
|
def on_paid(self, settlement: PaymentSettlement) -> None:
|
|
423
|
-
claimed = Order.objects.filter(
|
|
424
|
-
|
|
425
|
-
)
|
|
424
|
+
claimed = Order.objects.filter(pk=settlement.reference, state="awaiting_payment").update(
|
|
425
|
+
state="paid", paid_at=datetime.fromtimestamp(settlement.paid_at, tz=UTC)
|
|
426
|
+
)
|
|
426
427
|
if claimed == 0:
|
|
427
428
|
return # someone else already fulfilled it
|
|
428
429
|
|
|
@@ -450,7 +451,9 @@ instead:
|
|
|
450
451
|
|
|
451
452
|
```python
|
|
452
453
|
def on_paid(self, settlement: PaymentSettlement) -> None:
|
|
453
|
-
order =
|
|
454
|
+
order = (
|
|
455
|
+
Order.objects.select_for_update().filter(pk=settlement.reference).first()
|
|
456
|
+
) # SELECT … FOR UPDATE
|
|
454
457
|
if order is None or order.state != "awaiting_payment":
|
|
455
458
|
return
|
|
456
459
|
order.state = "paid"
|
|
@@ -533,8 +536,9 @@ from openreceive.server import HookContext
|
|
|
533
536
|
from openreceive.storage import PaymentSettlement
|
|
534
537
|
|
|
535
538
|
from shop.models import Order # YOUR model — it could be named anything. OpenReceive
|
|
536
|
-
|
|
537
|
-
|
|
539
|
+
# never sees it or touches its table; these hooks are the
|
|
540
|
+
# only bridge between the engine and your data.
|
|
541
|
+
|
|
538
542
|
|
|
539
543
|
class Host:
|
|
540
544
|
# Your policy, called before every checkout/payment/swap request. `context`
|
|
@@ -564,8 +568,11 @@ class Host:
|
|
|
564
568
|
order = Order.objects.filter(pk=reference).first()
|
|
565
569
|
if order is None:
|
|
566
570
|
return None
|
|
567
|
-
return {
|
|
568
|
-
|
|
571
|
+
return {
|
|
572
|
+
"currency": "USD",
|
|
573
|
+
"value": str(order.total),
|
|
574
|
+
"description": f"{order.items.count()} items",
|
|
575
|
+
}
|
|
569
576
|
|
|
570
577
|
# Runs inside the settlement transaction, only for the order's first settled
|
|
571
578
|
# attempt. The WHERE clause is the lock: a second fulfillment path of yours
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (FastAPI)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Add OpenReceive to a FastAPI application — the app you are already working in.
|
|
6
6
|
You do not need a copy of the OpenReceive source: the engine is on PyPI
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (Fastify)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Add OpenReceive to a Fastify application — the app you are already working in.
|
|
6
6
|
You do not need a copy of the OpenReceive source: the packages are on npm, and
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (Laravel)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Add OpenReceive to a Laravel application — the app you are already working in.
|
|
6
6
|
You do not need a copy of the OpenReceive source: the package is on Packagist
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (Next.js)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Add OpenReceive to a Next.js App Router application — the app you are already
|
|
6
6
|
working in. You do not need a copy of the OpenReceive source: the packages are
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (Node.js)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Add OpenReceive to a Node application — the app you are already working in. You
|
|
6
6
|
do not need a copy of the OpenReceive source: the packages are on npm, and the
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (PHP)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Add OpenReceive to a PHP application — the app you are already working in. You
|
|
6
6
|
do not need a copy of the OpenReceive source: the engine is on Packagist
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (Rails)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Add OpenReceive to a Rails application — the app you are already working in. You
|
|
6
6
|
do not need a copy of the OpenReceive source: the gem is on RubyGems, the
|
|
@@ -1,23 +1,53 @@
|
|
|
1
1
|
# OpenReceive agent directions (WordPress + WooCommerce)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.16.
|
|
4
4
|
|
|
5
5
|
Install and configure the OpenReceive gateway in the existing WooCommerce
|
|
6
6
|
store. Preserve its theme, checkout, customer accounts, order model and prices.
|
|
7
7
|
The plugin bundles the PHP engine and checkout assets; the merchant does not
|
|
8
8
|
install npm or Composer packages on the WordPress server.
|
|
9
9
|
|
|
10
|
-
## Step 0 —
|
|
10
|
+
## Step 0 — collect and save the codes, one at a time
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
For repository development, use the Docker demo's explicit testkit override.
|
|
12
|
+
Inspect WordPress, WooCommerce and PHP versions and GMP/sodium in both the web
|
|
13
|
+
and WP-CLI runtimes. If installed, use `wp openreceive doctor` to see which
|
|
14
|
+
credentials are set, without displaying their values. Skip codes already set.
|
|
15
|
+
Do not search other projects, container environments or deployment secrets.
|
|
17
16
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
the
|
|
17
|
+
Ask for the missing receive-only NWC code first, with this walkthrough:
|
|
18
|
+
|
|
19
|
+
> In Rizful, open the menu → NWC → Receive-only NWC code → Copy
|
|
20
|
+
> (https://openreceive.org/get_a_nwc_code_to_receive_payments). Alby Hub also
|
|
21
|
+
> works: Connections → Add Connection → Read Only. Paste the code here and
|
|
22
|
+
> I will save it for you.
|
|
23
|
+
|
|
24
|
+
Install the exact built plugin archive described below if needed. When the code
|
|
25
|
+
arrives, save it yourself with `wp openreceive configure --nwc-uri=-`, supplying
|
|
26
|
+
the code through the process's stdin. Never put it in shell arguments, shell
|
|
27
|
+
history, logs, source files or browser code. Do not ask the user to edit PHP or
|
|
28
|
+
an environment file. The command encrypts the code and runs wallet preflight
|
|
29
|
+
before saving; a failure preserves existing settings. Constants in wp-config.php
|
|
30
|
+
remain authoritative; if a constant must change, use the host's secret workflow.
|
|
31
|
+
|
|
32
|
+
Next ask whether customers should also pay with USDT, USDC, SOL and ETH, unless
|
|
33
|
+
the user already requested these. A configured swap provider converts payments
|
|
34
|
+
to BTC over Lightning in the merchant's connected wallet; available assets and
|
|
35
|
+
networks depend on the provider. Ask for the LSC code separately:
|
|
36
|
+
|
|
37
|
+
> Go to https://lightning-swap.com, sign in for API keys, create a key, and copy
|
|
38
|
+
> the whole URI (https://openreceive.org/set_up_swap_provider). Paste it here
|
|
39
|
+
> and I will save it, or say “Bitcoin only”.
|
|
40
|
+
|
|
41
|
+
Save it with `wp openreceive configure --lsc-uri-primary=-` through stdin.
|
|
42
|
+
Mention FixedFloat only if the merchant already uses it. Save an optional backup
|
|
43
|
+
separately with `--lsc-uri-backup=-`. Do not use generic `wp wc payment_gateway`
|
|
44
|
+
or REST settings writes for credentials: they are deliberately rejected.
|
|
45
|
+
|
|
46
|
+
Run `wp openreceive configure --enable`, then `wp openreceive doctor`. Resolve
|
|
47
|
+
failed checks before checkout testing. Create an unpaid test order and verify
|
|
48
|
+
that the order-pay page opens, lists the configured methods, and resumes its
|
|
49
|
+
Lightning invoice on reload. Ask the merchant to pay only if they want a real
|
|
50
|
+
settlement test.
|
|
21
51
|
|
|
22
52
|
The plugin owns only its payment-attempt tables in the WordPress database.
|
|
23
53
|
WooCommerce owns orders, totals, stock and email. Do not add an external
|
|
@@ -32,48 +62,13 @@ flows; a receive-only NWC wallet cannot send payments.
|
|
|
32
62
|
|
|
33
63
|
## Further reading
|
|
34
64
|
|
|
35
|
-
- [
|
|
36
|
-
- [Fastify Quickstart](https://openreceive.org/guides/quickstart-fastify.md)
|
|
37
|
-
- [FastAPI Quickstart](https://openreceive.org/guides/quickstart-fastapi.md)
|
|
38
|
-
- [Django Quickstart](https://openreceive.org/guides/quickstart-django.md)
|
|
39
|
-
- [Next.js Quickstart](https://openreceive.org/guides/quickstart-next.md)
|
|
40
|
-
- [Rails Quickstart](https://openreceive.org/guides/quickstart-rails.md)
|
|
41
|
-
- [PHP Quickstart (plain PHP)](https://openreceive.org/guides/quickstart-php.md)
|
|
42
|
-
- [Laravel Quickstart](https://openreceive.org/guides/quickstart-laravel.md)
|
|
43
|
-
- [BTCPay Server Quickstart](https://openreceive.org/guides/quickstart-btcpay.md)
|
|
44
|
-
- [BTCPay Plugin Reference](https://openreceive.org/guides/btcpay-reference.md)
|
|
45
|
-
- [Node ORM Recipes](https://openreceive.org/guides/node-orms.md)
|
|
46
|
-
- [Authorization](https://openreceive.org/guides/authorization.md)
|
|
47
|
-
- [Rate Limiting](https://openreceive.org/guides/rate-limiting.md)
|
|
48
|
-
- [Frontend Checkout](https://openreceive.org/guides/frontend-checkout.md)
|
|
49
|
-
- [Checkout UX](https://openreceive.org/guides/checkout-ux.md)
|
|
50
|
-
- [Headless Checkout](https://openreceive.org/guides/headless-checkout.md)
|
|
65
|
+
- [WordPress + WooCommerce Quickstart](https://openreceive.org/guides/quickstart-woocommerce.md)
|
|
51
66
|
- [Automated Swaps](https://openreceive.org/guides/automated-swaps.md)
|
|
52
67
|
- [Swap Refunds](https://openreceive.org/guides/swap-refunds.md)
|
|
53
68
|
- [Lightning Swap Connect URI](https://openreceive.org/guides/lightning-swap-connect.md)
|
|
54
|
-
- [Environment Variables](https://openreceive.org/guides/environment-variables.md)
|
|
55
|
-
- [Payment Storage](https://openreceive.org/guides/storage.md)
|
|
56
|
-
- [Deploying OpenReceive](https://openreceive.org/guides/deploying.md)
|
|
57
|
-
- [Testing Your OpenReceive Integration](https://openreceive.org/guides/host-testing.md)
|
|
58
|
-
- [API Reference](https://openreceive.org/guides/api-reference.md)
|
|
59
69
|
- [Security](https://openreceive.org/guides/security.md)
|
|
60
|
-
- [Provider Registry](https://openreceive.org/guides/provider-registry.md)
|
|
61
70
|
- [Price Feeds](https://openreceive.org/guides/price-feeds.md)
|
|
62
|
-
- [
|
|
63
|
-
- [Flask Recipe](https://openreceive.org/guides/flask-recipe.md)
|
|
64
|
-
- [Writing Your Own Checkout Route](https://openreceive.org/guides/custom-checkout-route.md)
|
|
65
|
-
- [Agent Directions: Node.js](https://openreceive.org/guides/agent-directions-node.md)
|
|
66
|
-
- [Agent Directions: Fastify](https://openreceive.org/guides/agent-directions-fastify.md)
|
|
67
|
-
- [Agent Directions: FastAPI](https://openreceive.org/guides/agent-directions-fastapi.md)
|
|
68
|
-
- [Agent Directions: Django](https://openreceive.org/guides/agent-directions-django.md)
|
|
69
|
-
- [Agent Directions: Next.js](https://openreceive.org/guides/agent-directions-next.md)
|
|
70
|
-
- [Agent Directions: Rails](https://openreceive.org/guides/agent-directions-rails.md)
|
|
71
|
-
- [Agent Directions: PHP](https://openreceive.org/guides/agent-directions-php.md)
|
|
72
|
-
- [Agent Directions: Laravel](https://openreceive.org/guides/agent-directions-laravel.md)
|
|
73
|
-
- [Agent Directions: BTCPay Server](https://openreceive.org/guides/agent-directions-btcpay.md)
|
|
74
|
-
- [WordPress + WooCommerce Quickstart](https://openreceive.org/guides/quickstart-woocommerce.md)
|
|
75
|
-
|
|
76
|
-
- https://openreceive.org/guides/payment-safety-upgrade.md — coordinated upgrades and reviewed repair of existing attempts
|
|
71
|
+
- [Payment Safety Upgrade](https://openreceive.org/guides/payment-safety-upgrade.md)
|
|
77
72
|
|
|
78
73
|
---
|
|
79
74
|
|
|
@@ -84,6 +79,10 @@ passes. The page it comes from is https://openreceive.org/guides/quickstart-wooc
|
|
|
84
79
|
|
|
85
80
|
## WordPress + WooCommerce quickstart
|
|
86
81
|
|
|
82
|
+
The [WordPress integration entry point](https://openreceive.org/integrations/wordpress)
|
|
83
|
+
redirects to the WooCommerce integration, which uses this same guide and agent
|
|
84
|
+
directions. OpenReceive checkout on WordPress requires WooCommerce.
|
|
85
|
+
|
|
87
86
|
Activate WooCommerce first. Then install the built OpenReceive plugin zip
|
|
88
87
|
through **Plugins → Add New → Upload Plugin**. You cannot upload the source
|
|
89
88
|
directory as-is. It needs a build first. The plugin is not yet submitted to
|
|
@@ -96,15 +95,16 @@ database or application.
|
|
|
96
95
|
|
|
97
96
|
### Get the installable archive
|
|
98
97
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
98
|
+
Download [openreceive-wordpress-0.4.16.zip](https://github.com/OpenReceive/openreceive/releases/download/v0.4.16/openreceive-wordpress-0.4.16.zip)
|
|
99
|
+
from the matching release. Historical releases may lack this asset. If that exact
|
|
100
|
+
URL returns 404, build the same tag below; never silently install an older ZIP.
|
|
101
|
+
The GitHub source-code ZIP is not an installable plugin. On a development machine
|
|
102
|
+
with Node 22+, PHP 8.2+ with GMP/sodium, Composer and WP-CLI:
|
|
103
103
|
|
|
104
104
|
```sh
|
|
105
105
|
git clone https://github.com/OpenReceive/openreceive.git
|
|
106
106
|
cd openreceive
|
|
107
|
-
git checkout
|
|
107
|
+
git checkout v0.4.16
|
|
108
108
|
npm ci
|
|
109
109
|
npm run build:packages
|
|
110
110
|
composer install --working-dir=packages/php/wordpress
|
|
@@ -116,6 +116,40 @@ needs WP-CLI on `PATH`. Otherwise, set `OPENRECEIVE_WP_CLI` to the absolute path
|
|
|
116
116
|
of its phar. Your WordPress server needs neither Node nor Composer. The built
|
|
117
117
|
plugin already bundles its dependencies and checkout assets.
|
|
118
118
|
|
|
119
|
+
### Enable GMP in both PHP runtimes
|
|
120
|
+
|
|
121
|
+
GMP is required by the bundled elliptic-curve dependency. Enable it for both
|
|
122
|
+
web PHP (Apache/FPM) and the PHP executable running WP-CLI. Installing it in
|
|
123
|
+
only the WordPress container does not update a separate CLI container.
|
|
124
|
+
|
|
125
|
+
For Debian-based official PHP/WordPress images, add to **each** Dockerfile:
|
|
126
|
+
|
|
127
|
+
```dockerfile
|
|
128
|
+
USER root
|
|
129
|
+
RUN apt-get update && apt-get install -y --no-install-recommends libgmp-dev \
|
|
130
|
+
&& docker-php-ext-install gmp \
|
|
131
|
+
&& rm -rf /var/lib/apt/lists/*
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
For Alpine-based PHP/CLI images:
|
|
135
|
+
|
|
136
|
+
```dockerfile
|
|
137
|
+
USER root
|
|
138
|
+
RUN apk add --no-cache gmp \
|
|
139
|
+
&& apk add --no-cache --virtual .gmp-build $PHPIZE_DEPS gmp-dev \
|
|
140
|
+
&& docker-php-ext-install gmp \
|
|
141
|
+
&& apk del .gmp-build
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
Restore the base image's original runtime user after installing extensions.
|
|
145
|
+
Rebuild and recreate both containers. On Debian/Ubuntu hosts, install the GMP
|
|
146
|
+
package matching the active PHP version (for example `php8.2-gmp` for PHP 8.2),
|
|
147
|
+
then restart that version's web PHP service. Verify `php --ri gmp` and
|
|
148
|
+
`wp openreceive doctor` for CLI, and the gateway Doctor panel for web PHP.
|
|
149
|
+
On managed WordPress hosting, ask the host to enable GMP and sodium in both
|
|
150
|
+
runtimes; if they cannot, this plugin cannot run there. Do not use Composer's
|
|
151
|
+
`--ignore-platform-reqs` to bypass the requirements.
|
|
152
|
+
|
|
119
153
|
### Configure the wallet
|
|
120
154
|
|
|
121
155
|
1. Open **WooCommerce → Settings → Payments → OpenReceive**.
|
|
@@ -134,6 +168,27 @@ providers, you can also set the `OPENRECEIVE_LSC_URI_PRIMARY` and
|
|
|
134
168
|
`OPENRECEIVE_LSC_URI_BACKUP` constants. Never put these values in browser code
|
|
135
169
|
or logs.
|
|
136
170
|
|
|
171
|
+
#### Configure through WP-CLI
|
|
172
|
+
|
|
173
|
+
`wp openreceive configure` accepts one credential at a time from stdin. Feed
|
|
174
|
+
stdin through your secret manager or an existing protected file, never a code
|
|
175
|
+
literal in the command line:
|
|
176
|
+
|
|
177
|
+
```sh
|
|
178
|
+
wp openreceive configure --nwc-uri=- < /secure/path/wallet-code
|
|
179
|
+
wp openreceive configure --lsc-uri-primary=- < /secure/path/swap-code
|
|
180
|
+
wp openreceive configure --enable
|
|
181
|
+
wp openreceive doctor
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
Omit the swap command for Bitcoin-only checkout. `--lsc-uri-backup=-` adds a
|
|
185
|
+
backup. These commands share admin preflight and encrypted storage. Credential
|
|
186
|
+
flags accept only `-`; blank input leaves settings intact. Generic WooCommerce
|
|
187
|
+
REST and `wp wc payment_gateway` credential updates are rejected. `doctor`
|
|
188
|
+
reports the failed check with credentials redacted and exits nonzero on failure.
|
|
189
|
+
The default payment title becomes “Bitcoin & crypto (OpenReceive)” with swaps;
|
|
190
|
+
a customized title is preserved.
|
|
191
|
+
|
|
137
192
|
### Checkout and settlement
|
|
138
193
|
|
|
139
194
|
Both WooCommerce checkout blocks and classic checkout send the customer to the
|