openreceive 0.4.5 → 0.4.8
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +32 -18
- data/lib/openreceive/rates.rb +1 -1
- data/lib/openreceive/version.rb +1 -1
- data/skills/integrate-openreceive/references/btcpay.md +1 -1
- data/skills/integrate-openreceive/references/django.md +20 -6
- data/skills/integrate-openreceive/references/fastapi.md +20 -6
- data/skills/integrate-openreceive/references/fastify.md +20 -6
- data/skills/integrate-openreceive/references/laravel.md +20 -6
- data/skills/integrate-openreceive/references/next.md +20 -6
- data/skills/integrate-openreceive/references/node.md +20 -6
- data/skills/integrate-openreceive/references/php.md +20 -6
- data/skills/integrate-openreceive/references/rails.md +20 -6
- data/skills/integrate-openreceive/references/woocommerce.md +24 -1
- metadata +16 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 91206a8fbe28b94af9d340c6d7db1b1849ebd911be129e179bdc196e5f2c57d0
|
|
4
|
+
data.tar.gz: 0f46bb14b573b49927389504953280bd7f7e7e386a06ede642dbb9ee8f6ce715
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '08fba34e29b203ec89bc293e1d94de23791aa14f6e4078eee78fe3ba2a018ec109a56ab52340e86d9c9fce42c5869b7c08e006a72119b248e07a2c0b3e09d713'
|
|
7
|
+
data.tar.gz: 304a736573b2e1e1e1a78dd712942b9ba9e7fe411bececc229a9f3d81e3cc8b2d63d6363e98a5fba5569655c64fe5f09ab6fbd157a0d8afe36c75521f2e7e923
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.4.8 - 2026-09-14
|
|
4
|
+
|
|
5
|
+
Version alignment with the 0.4.8 checkout loading fix; no Ruby engine or
|
|
6
|
+
settlement changes.
|
|
7
|
+
|
|
8
|
+
## 0.4.7 - 2026-09-13
|
|
9
|
+
|
|
10
|
+
Version alignment for the BTCPay plugin release; no Ruby behavior changes.
|
|
11
|
+
|
|
12
|
+
## 0.4.6 - 2026-09-11
|
|
13
|
+
|
|
14
|
+
Remove obsolete VEF from live price-feed requests, matching the JavaScript,
|
|
15
|
+
Python and PHP engines. Refresh installation and quickstart documentation and
|
|
16
|
+
package metadata. Release in lockstep with the compact checkout and publishing
|
|
17
|
+
fixes in 0.4.6; no Ruby public API change.
|
|
18
|
+
|
|
3
19
|
## 0.4.5 - 2026-09-07
|
|
4
20
|
|
|
5
21
|
Release in lockstep with the Python/PHP publishing workflow fixes and complete
|
data/README.md
CHANGED
|
@@ -1,23 +1,34 @@
|
|
|
1
1
|
# openreceive
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
3
|
+
**Bitcoin Lightning payments for Ruby. Your app, your wallet.**
|
|
4
|
+
|
|
5
|
+
[OpenReceive](https://openreceive.org) helps you accept payments directly into
|
|
6
|
+
a wallet you control. Keep your orders, prices, and fulfillment in your own
|
|
7
|
+
application, with receive-only Nostr Wallet Connect (NWC) connecting your
|
|
8
|
+
server to your wallet.
|
|
9
|
+
|
|
10
|
+
OpenReceive supports optional swaps from **USDT, USDC, SOL, and ETH** through
|
|
11
|
+
a configured swap provider. The provider converts the payment to **BTC over
|
|
12
|
+
Lightning**, which settles into the merchant's connected wallet. Available
|
|
13
|
+
assets and networks depend on the provider; swaps are optional.
|
|
14
|
+
|
|
15
|
+
This gem is the lightweight Ruby foundation: exact money conversion, exchange
|
|
16
|
+
rates, wallet adapters, and shared settlement rules, with no database
|
|
17
|
+
dependency. Most applications should start with one of the integrations
|
|
18
|
+
built on it:
|
|
19
|
+
|
|
16
20
|
- [`openreceive-rails`](https://rubygems.org/gems/openreceive-rails) — the
|
|
17
|
-
|
|
21
|
+
complete Rails integration, with payment storage in your existing database,
|
|
22
|
+
reconciliation, and three application hooks. [Start with Rails](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/quickstart-rails.md).
|
|
23
|
+
- [`openreceive-server`](https://rubygems.org/gems/openreceive-server) — invoice
|
|
24
|
+
creation, payment checks, and a Rack handler for custom Ruby integrations
|
|
25
|
+
that provide their own payment persistence. [Explore the server gem](https://github.com/OpenReceive/openreceive/blob/master/packages/ruby/openreceive-server/README.md).
|
|
18
26
|
|
|
19
27
|
## Install
|
|
20
28
|
|
|
29
|
+
Requires Ruby 3.2 or later. Choose this gem directly when you need the payment
|
|
30
|
+
primitives rather than a mounted checkout integration.
|
|
31
|
+
|
|
21
32
|
```sh
|
|
22
33
|
gem install openreceive
|
|
23
34
|
```
|
|
@@ -39,6 +50,8 @@ gem "openreceive"
|
|
|
39
50
|
(`OpenReceive::Nwc.normalize_wallet_error`,
|
|
40
51
|
`OpenReceive::Nwc.normalize_transaction`).
|
|
41
52
|
- Settlement-authority rules: what counts as settled, and what never does.
|
|
53
|
+
Settlement requires `settled_at` or state `settled`; a preimage alone does
|
|
54
|
+
not settle a payment.
|
|
42
55
|
- The built-in price feed (`OpenReceive::Rates`): a static provider and the
|
|
43
56
|
cached live feed with primary/fallback failover, fail-closed windows, and
|
|
44
57
|
the shared currency list.
|
|
@@ -49,13 +62,14 @@ gem "openreceive"
|
|
|
49
62
|
(`subscribe_notifications`, forwarded to that gem's
|
|
50
63
|
`subscribe_to_notifications`).
|
|
51
64
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
decisions.
|
|
65
|
+
Money, wallet normalization, and settlement rules are tested against shared
|
|
66
|
+
cross-language vectors in `spec/test-vectors`.
|
|
55
67
|
|
|
56
68
|
## Links
|
|
57
69
|
|
|
58
|
-
-
|
|
70
|
+
- Rails quickstart: [Add checkout to your app](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/quickstart-rails.md)
|
|
71
|
+
- API reference: [Ruby and Rails APIs](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/api-reference.md)
|
|
72
|
+
- Website: <https://openreceive.org>
|
|
59
73
|
- Source: <https://github.com/openreceive/openreceive>
|
|
60
74
|
- Changelog: [CHANGELOG.md](CHANGELOG.md)
|
|
61
75
|
|
data/lib/openreceive/rates.rb
CHANGED
|
@@ -40,7 +40,7 @@ module OpenReceive
|
|
|
40
40
|
# The fixed fiat list both live feeds price Bitcoin against. Hard-coded so
|
|
41
41
|
# the primary and fallback URLs always request the same currencies.
|
|
42
42
|
PRICE_FEED_VS_CURRENCIES =
|
|
43
|
-
"usd,aed,ars,aud,bdt,bhd,bmd,brl,cad,chf,clp,cny,czk,dkk,eur,gbp,gel,hkd,huf,idr,ils,inr,jpy,krw,kwd,lkr,mmk,mxn,myr,ngn,nok,nzd,php,pkr,pln,rub,sar,sek,sgd,thb,try,twd,uah,
|
|
43
|
+
"usd,aed,ars,aud,bdt,bhd,bmd,brl,cad,chf,clp,cny,czk,dkk,eur,gbp,gel,hkd,huf,idr,ils,inr,jpy,krw,kwd,lkr,mmk,mxn,myr,ngn,nok,nzd,php,pkr,pln,rub,sar,sek,sgd,thb,try,twd,uah,vnd,zar"
|
|
44
44
|
|
|
45
45
|
PRICE_FEED_CURRENCIES = PRICE_FEED_VS_CURRENCIES.split(",").freeze
|
|
46
46
|
|
data/lib/openreceive/version.rb
CHANGED
|
@@ -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.8.
|
|
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
|
|
@@ -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.8.
|
|
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
|
|
@@ -245,11 +245,25 @@ built on `@openreceive/browser/headless`. Read that before writing components.
|
|
|
245
245
|
"switch payment method".
|
|
246
246
|
- No "Open wallet" button on desktop.
|
|
247
247
|
- Wallet suggestions: `getPaymentWizardRoutes()` +
|
|
248
|
-
`createWizardRouteDisplays`. Lightning only.
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
248
|
+
`createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
|
|
249
|
+
images load from a JavaScript chunk. For a custom headless UI, load it when
|
|
250
|
+
a tutorial opens and look up the returned table by the tutorial's `path`:
|
|
251
|
+
|
|
252
|
+
```js
|
|
253
|
+
import { loadPayTutorialImages } from "@openreceive/browser/headless";
|
|
254
|
+
|
|
255
|
+
const images = await loadPayTutorialImages();
|
|
256
|
+
const src = images[tutorial.path]; // data URI for the selected tutorial
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
Render `src` as the image source and update your UI after loading. Existing
|
|
260
|
+
display objects do not update: their `tutorial.image` stays `undefined` if
|
|
261
|
+
created before loading. Alternatively, await the loader, recreate the displays
|
|
262
|
+
with `createWizardRouteDisplays`, and render the new `tutorial.image`.
|
|
263
|
+
Show the caption while loading or if loading fails; never use an empty image
|
|
264
|
+
source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
|
|
265
|
+
For missing images, check CSP errors, failed chunks, and stale displays.
|
|
266
|
+
Registry paths are lookup keys; there is no asset option or image route.
|
|
253
267
|
The registry answers ~37 wallets: pass
|
|
254
268
|
`providerPreviewLimit` and build "show all" from `display.providerCount`,
|
|
255
269
|
or they push the QR off the screen.
|
|
@@ -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.8.
|
|
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
|
|
@@ -242,11 +242,25 @@ components.
|
|
|
242
242
|
"switch payment method".
|
|
243
243
|
- No "Open wallet" button on desktop.
|
|
244
244
|
- Wallet suggestions: `getPaymentWizardRoutes()` +
|
|
245
|
-
`createWizardRouteDisplays`. Lightning only.
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
245
|
+
`createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
|
|
246
|
+
images load from a JavaScript chunk. For a custom headless UI, load it when
|
|
247
|
+
a tutorial opens and look up the returned table by the tutorial's `path`:
|
|
248
|
+
|
|
249
|
+
```js
|
|
250
|
+
import { loadPayTutorialImages } from "@openreceive/browser/headless";
|
|
251
|
+
|
|
252
|
+
const images = await loadPayTutorialImages();
|
|
253
|
+
const src = images[tutorial.path]; // data URI for the selected tutorial
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
Render `src` as the image source and update your UI after loading. Existing
|
|
257
|
+
display objects do not update: their `tutorial.image` stays `undefined` if
|
|
258
|
+
created before loading. Alternatively, await the loader, recreate the displays
|
|
259
|
+
with `createWizardRouteDisplays`, and render the new `tutorial.image`.
|
|
260
|
+
Show the caption while loading or if loading fails; never use an empty image
|
|
261
|
+
source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
|
|
262
|
+
For missing images, check CSP errors, failed chunks, and stale displays.
|
|
263
|
+
Registry paths are lookup keys; there is no asset option or image route.
|
|
250
264
|
|
|
251
265
|
## More documentation
|
|
252
266
|
|
|
@@ -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.8.
|
|
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
|
|
@@ -225,11 +225,25 @@ components.
|
|
|
225
225
|
"switch payment method".
|
|
226
226
|
- No "Open wallet" button on desktop.
|
|
227
227
|
- Wallet suggestions: `getPaymentWizardRoutes()` +
|
|
228
|
-
`createWizardRouteDisplays`. Lightning only.
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
228
|
+
`createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
|
|
229
|
+
images load from a JavaScript chunk. For a custom headless UI, load it when
|
|
230
|
+
a tutorial opens and look up the returned table by the tutorial's `path`:
|
|
231
|
+
|
|
232
|
+
```js
|
|
233
|
+
import { loadPayTutorialImages } from "@openreceive/browser/headless";
|
|
234
|
+
|
|
235
|
+
const images = await loadPayTutorialImages();
|
|
236
|
+
const src = images[tutorial.path]; // data URI for the selected tutorial
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
Render `src` as the image source and update your UI after loading. Existing
|
|
240
|
+
display objects do not update: their `tutorial.image` stays `undefined` if
|
|
241
|
+
created before loading. Alternatively, await the loader, recreate the displays
|
|
242
|
+
with `createWizardRouteDisplays`, and render the new `tutorial.image`.
|
|
243
|
+
Show the caption while loading or if loading fails; never use an empty image
|
|
244
|
+
source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
|
|
245
|
+
For missing images, check CSP errors, failed chunks, and stale displays.
|
|
246
|
+
Registry paths are lookup keys; there is no asset option or image route.
|
|
233
247
|
|
|
234
248
|
## More documentation
|
|
235
249
|
|
|
@@ -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.8.
|
|
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
|
|
@@ -230,11 +230,25 @@ built on `@openreceive/browser/headless`. Read that before writing components.
|
|
|
230
230
|
"switch payment method".
|
|
231
231
|
- No "Open wallet" button on desktop.
|
|
232
232
|
- Wallet suggestions: `getPaymentWizardRoutes()` +
|
|
233
|
-
`createWizardRouteDisplays`. Lightning only.
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
233
|
+
`createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
|
|
234
|
+
images load from a JavaScript chunk. For a custom headless UI, load it when
|
|
235
|
+
a tutorial opens and look up the returned table by the tutorial's `path`:
|
|
236
|
+
|
|
237
|
+
```js
|
|
238
|
+
import { loadPayTutorialImages } from "@openreceive/browser/headless";
|
|
239
|
+
|
|
240
|
+
const images = await loadPayTutorialImages();
|
|
241
|
+
const src = images[tutorial.path]; // data URI for the selected tutorial
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
Render `src` as the image source and update your UI after loading. Existing
|
|
245
|
+
display objects do not update: their `tutorial.image` stays `undefined` if
|
|
246
|
+
created before loading. Alternatively, await the loader, recreate the displays
|
|
247
|
+
with `createWizardRouteDisplays`, and render the new `tutorial.image`.
|
|
248
|
+
Show the caption while loading or if loading fails; never use an empty image
|
|
249
|
+
source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
|
|
250
|
+
For missing images, check CSP errors, failed chunks, and stale displays.
|
|
251
|
+
Registry paths are lookup keys; there is no asset option or image route.
|
|
238
252
|
The registry answers ~37 wallets: pass
|
|
239
253
|
`providerPreviewLimit` and build "show all" from `display.providerCount`,
|
|
240
254
|
or they push the QR off the screen.
|
|
@@ -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.8.
|
|
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
|
|
@@ -231,11 +231,25 @@ components.
|
|
|
231
231
|
"switch payment method".
|
|
232
232
|
- No "Open wallet" button on desktop.
|
|
233
233
|
- Wallet suggestions: `getPaymentWizardRoutes()` +
|
|
234
|
-
`createWizardRouteDisplays`. Lightning only.
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
234
|
+
`createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
|
|
235
|
+
images load from a JavaScript chunk. For a custom headless UI, load it when
|
|
236
|
+
a tutorial opens and look up the returned table by the tutorial's `path`:
|
|
237
|
+
|
|
238
|
+
```js
|
|
239
|
+
import { loadPayTutorialImages } from "@openreceive/browser/headless";
|
|
240
|
+
|
|
241
|
+
const images = await loadPayTutorialImages();
|
|
242
|
+
const src = images[tutorial.path]; // data URI for the selected tutorial
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
Render `src` as the image source and update your UI after loading. Existing
|
|
246
|
+
display objects do not update: their `tutorial.image` stays `undefined` if
|
|
247
|
+
created before loading. Alternatively, await the loader, recreate the displays
|
|
248
|
+
with `createWizardRouteDisplays`, and render the new `tutorial.image`.
|
|
249
|
+
Show the caption while loading or if loading fails; never use an empty image
|
|
250
|
+
source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
|
|
251
|
+
For missing images, check CSP errors, failed chunks, and stale displays.
|
|
252
|
+
Registry paths are lookup keys; there is no asset option or image route.
|
|
239
253
|
|
|
240
254
|
## More documentation
|
|
241
255
|
|
|
@@ -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.8.
|
|
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
|
|
@@ -217,11 +217,25 @@ components.
|
|
|
217
217
|
"switch payment method".
|
|
218
218
|
- No "Open wallet" button on desktop.
|
|
219
219
|
- Wallet suggestions: `getPaymentWizardRoutes()` +
|
|
220
|
-
`createWizardRouteDisplays`. Lightning only.
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
220
|
+
`createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
|
|
221
|
+
images load from a JavaScript chunk. For a custom headless UI, load it when
|
|
222
|
+
a tutorial opens and look up the returned table by the tutorial's `path`:
|
|
223
|
+
|
|
224
|
+
```js
|
|
225
|
+
import { loadPayTutorialImages } from "@openreceive/browser/headless";
|
|
226
|
+
|
|
227
|
+
const images = await loadPayTutorialImages();
|
|
228
|
+
const src = images[tutorial.path]; // data URI for the selected tutorial
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
Render `src` as the image source and update your UI after loading. Existing
|
|
232
|
+
display objects do not update: their `tutorial.image` stays `undefined` if
|
|
233
|
+
created before loading. Alternatively, await the loader, recreate the displays
|
|
234
|
+
with `createWizardRouteDisplays`, and render the new `tutorial.image`.
|
|
235
|
+
Show the caption while loading or if loading fails; never use an empty image
|
|
236
|
+
source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
|
|
237
|
+
For missing images, check CSP errors, failed chunks, and stale displays.
|
|
238
|
+
Registry paths are lookup keys; there is no asset option or image route.
|
|
225
239
|
|
|
226
240
|
## More documentation
|
|
227
241
|
|
|
@@ -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.8.
|
|
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
|
|
@@ -243,11 +243,25 @@ of https://openreceive.org/guides/checkout-ux.md, for a UI built on
|
|
|
243
243
|
"switch payment method".
|
|
244
244
|
- No "Open wallet" button on desktop.
|
|
245
245
|
- Wallet suggestions: `getPaymentWizardRoutes()` +
|
|
246
|
-
`createWizardRouteDisplays`. Lightning only.
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
246
|
+
`createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
|
|
247
|
+
images load from a JavaScript chunk. For a custom headless UI, load it when
|
|
248
|
+
a tutorial opens and look up the returned table by the tutorial's `path`:
|
|
249
|
+
|
|
250
|
+
```js
|
|
251
|
+
import { loadPayTutorialImages } from "@openreceive/browser/headless";
|
|
252
|
+
|
|
253
|
+
const images = await loadPayTutorialImages();
|
|
254
|
+
const src = images[tutorial.path]; // data URI for the selected tutorial
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
Render `src` as the image source and update your UI after loading. Existing
|
|
258
|
+
display objects do not update: their `tutorial.image` stays `undefined` if
|
|
259
|
+
created before loading. Alternatively, await the loader, recreate the displays
|
|
260
|
+
with `createWizardRouteDisplays`, and render the new `tutorial.image`.
|
|
261
|
+
Show the caption while loading or if loading fails; never use an empty image
|
|
262
|
+
source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
|
|
263
|
+
For missing images, check CSP errors, failed chunks, and stale displays.
|
|
264
|
+
Registry paths are lookup keys; there is no asset option or image route.
|
|
251
265
|
|
|
252
266
|
## More documentation
|
|
253
267
|
|
|
@@ -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.8.
|
|
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
|
|
@@ -224,11 +224,25 @@ built on `@openreceive/browser/headless`. Read that before writing components.
|
|
|
224
224
|
"switch payment method".
|
|
225
225
|
- No "Open wallet" button on desktop.
|
|
226
226
|
- Wallet suggestions: `getPaymentWizardRoutes()` +
|
|
227
|
-
`createWizardRouteDisplays`. Lightning only.
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
227
|
+
`createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
|
|
228
|
+
images load from a JavaScript chunk. For a custom headless UI, load it when
|
|
229
|
+
a tutorial opens and look up the returned table by the tutorial's `path`:
|
|
230
|
+
|
|
231
|
+
```js
|
|
232
|
+
import { loadPayTutorialImages } from "@openreceive/browser/headless";
|
|
233
|
+
|
|
234
|
+
const images = await loadPayTutorialImages();
|
|
235
|
+
const src = images[tutorial.path]; // data URI for the selected tutorial
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
Render `src` as the image source and update your UI after loading. Existing
|
|
239
|
+
display objects do not update: their `tutorial.image` stays `undefined` if
|
|
240
|
+
created before loading. Alternatively, await the loader, recreate the displays
|
|
241
|
+
with `createWizardRouteDisplays`, and render the new `tutorial.image`.
|
|
242
|
+
Show the caption while loading or if loading fails; never use an empty image
|
|
243
|
+
source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
|
|
244
|
+
For missing images, check CSP errors, failed chunks, and stale displays.
|
|
245
|
+
Registry paths are lookup keys; there is no asset option or image route.
|
|
232
246
|
The registry answers ~37 wallets: pass
|
|
233
247
|
`providerPreviewLimit` and build "show all" from `display.providerCount`,
|
|
234
248
|
or they push the QR off the screen.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenReceive agent directions (WordPress + WooCommerce)
|
|
2
2
|
|
|
3
|
-
These directions describe OpenReceive 0.4.
|
|
3
|
+
These directions describe OpenReceive 0.4.8.
|
|
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.
|
|
@@ -90,6 +90,29 @@ Requirements: WordPress 6.6+, WooCommerce 9+, 64-bit PHP 8.2+ with GMP and sodiu
|
|
|
90
90
|
and MySQL 8 or MariaDB 10.5+. Activation creates payment-attempt tables in the
|
|
91
91
|
existing WordPress database. No separate database or application is required.
|
|
92
92
|
|
|
93
|
+
### Get the installable archive
|
|
94
|
+
|
|
95
|
+
Use `openreceive-wordpress-<version>.zip` from the selected
|
|
96
|
+
[OpenReceive GitHub release](https://github.com/OpenReceive/openreceive/releases)
|
|
97
|
+
when that asset is listed. A GitHub source-code zip is not the plugin archive.
|
|
98
|
+
If the release does not yet provide a built zip, build it on a development
|
|
99
|
+
machine with Node 22+, PHP 8.2+, Composer and WP-CLI:
|
|
100
|
+
|
|
101
|
+
```sh
|
|
102
|
+
git clone https://github.com/OpenReceive/openreceive.git
|
|
103
|
+
cd openreceive
|
|
104
|
+
git checkout <release-tag>
|
|
105
|
+
npm ci
|
|
106
|
+
npm run build:packages
|
|
107
|
+
composer install --working-dir=packages/php/wordpress
|
|
108
|
+
npm run release:wordpress:build
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Upload the resulting `dist/openreceive-wordpress-<version>.zip`. WP-CLI must be
|
|
112
|
+
on `PATH`, or set `OPENRECEIVE_WP_CLI` to the absolute path of its phar. The
|
|
113
|
+
WordPress server needs neither Node nor Composer: dependencies and checkout
|
|
114
|
+
assets are bundled inside the built plugin.
|
|
115
|
+
|
|
93
116
|
### Configure the wallet
|
|
94
117
|
|
|
95
118
|
Open **WooCommerce → Settings → Payments → OpenReceive**. Enter a receive-only
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: openreceive
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.4.
|
|
4
|
+
version: 0.4.8
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenReceive
|
|
@@ -23,7 +23,19 @@ dependencies:
|
|
|
23
23
|
- - ">="
|
|
24
24
|
- !ruby/object:Gem::Version
|
|
25
25
|
version: '0'
|
|
26
|
-
description:
|
|
26
|
+
description: |
|
|
27
|
+
Build Bitcoin Lightning payments into your Ruby application with OpenReceive.
|
|
28
|
+
Work with exact money amounts, normalize wallet responses, and apply consistent
|
|
29
|
+
settlement rules while keeping control of your wallet and application.
|
|
30
|
+
|
|
31
|
+
This lightweight core provides money conversion, exchange rates, Nostr Wallet
|
|
32
|
+
Connect (NWC) adapters, and swap-address validation without a database dependency.
|
|
33
|
+
For a complete Rails integration, install openreceive-rails. For a custom Ruby
|
|
34
|
+
or Rack integration, use openreceive-server.
|
|
35
|
+
|
|
36
|
+
OpenReceive integrations support optional swaps from USDT, USDC, SOL, and ETH
|
|
37
|
+
through a configured provider, settling as BTC over Lightning into your wallet.
|
|
38
|
+
Available assets and networks depend on the provider.
|
|
27
39
|
email:
|
|
28
40
|
- info@openreceive.org
|
|
29
41
|
executables: []
|
|
@@ -61,7 +73,7 @@ metadata:
|
|
|
61
73
|
source_code_uri: https://github.com/openreceive/openreceive
|
|
62
74
|
changelog_uri: https://github.com/openreceive/openreceive/blob/master/packages/ruby/openreceive/CHANGELOG.md
|
|
63
75
|
bug_tracker_uri: https://github.com/openreceive/openreceive/issues
|
|
64
|
-
documentation_uri: https://
|
|
76
|
+
documentation_uri: https://github.com/openreceive/openreceive/blob/master/packages/ruby/openreceive/README.md
|
|
65
77
|
rubygems_mfa_required: 'true'
|
|
66
78
|
rdoc_options: []
|
|
67
79
|
require_paths:
|
|
@@ -79,5 +91,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
79
91
|
requirements: []
|
|
80
92
|
rubygems_version: 3.6.9
|
|
81
93
|
specification_version: 4
|
|
82
|
-
summary:
|
|
94
|
+
summary: Bitcoin Lightning payment primitives for Ruby. Your app, your wallet.
|
|
83
95
|
test_files: []
|