openreceive-server 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e257329d76d96f9ca09bc133fa231563a61c6beedce0aaedef266ae2f00a09f
-  data.tar.gz: 4842001e2e42d242a3c3ffdf47ce569831df63c5543d79ba1f49eaab76f21d61
+  metadata.gz: e2a6f6628a84d20dca3757b9017ba6e40c0fac41e016257e988173533be5d650
+  data.tar.gz: 5d9fd1babd45564b31274141c2af4875a339cb21d7fef33997442e6b39b1ee44
 SHA512:
-  metadata.gz: af97510aae69684a50cc170c5f9d9ab07b94fed9ada6b3af136f088fa44ec05a8611f8f59a50ea5a18e3d59d20d531f94c0263da92f463b2c0a2f8101d68f289
-  data.tar.gz: fbf53b4d0313aecca1bf2738b3e05b8c4973ad869e7c825993162e62fa70af369c9e2e6fd0de288ed62bcd97b1fc7f3b3fbf52d13081a89af4515df778a5882e
+  metadata.gz: da0988ee975768e373de725c7417c821df8c46d159186e0993ee3b3273f658c54622e21410c7b46baf6b65892155d9c8b29e7343145b83bffc6580a7e453cd42
+  data.tar.gz: fb1518e4924dfb4dab17b32178f056ac78a80d849ca6d4e97502da653189e2411e3115167dd14669c7c1800195c31f2d1ffa04f4abb9d2982773d7c662bc31f8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.4.6 - 2026-09-11
+
+Refresh installation and quickstart documentation and package metadata.
+Release in lockstep with openreceive 0.4.6, including the live-price request fix
+that removes obsolete VEF. No server adapter API change.
+
 ## 0.4.5 - 2026-09-07
 
 Release in lockstep with the Python/PHP publishing workflow fixes and complete

data/README.md

@@ -1,6 +1,41 @@
 # openreceive-server
 
-Storage-free Ruby service and Rack handler. Configure a receive-only NWC client. The host
+**Accept Bitcoin Lightning payments in Ruby and Rack. Your app, your wallet.**
+
+[OpenReceive](https://openreceive.org) brings Lightning checkout to your existing
+Ruby application. Receive payments directly into a wallet you control, while
+keeping your orders, prices, and fulfillment in your own code.
+
+OpenReceive supports optional swaps from **USDT, USDC, SOL, and ETH** through
+a configured swap provider. The provider converts the payment to **BTC over
+Lightning**, which settles into the merchant's connected wallet. Available
+assets and networks depend on the provider; swaps are optional.
+
+- Create invoices and check payments through a receive-only Nostr Wallet
+  Connect (NWC) client.
+- Use the payment service directly or mount the framework-agnostic Rack handler.
+- Reconcile pending payments with shared settlement rules and exact money math.
+- Keep your existing persistence stack, with no separate OpenReceive service
+  or database to deploy.
+
+**Building with Rails?** Start with
+[`openreceive-rails`](https://github.com/OpenReceive/openreceive/blob/master/packages/ruby/openreceive-rails/README.md): it adds payment storage,
+reconciliation, and an install generator on top of this gem.
+
+## Install
+
+Requires Ruby 3.2 or later. Add to your Gemfile and run `bundle install`:
+
+```ruby
+gem "openreceive-server"
+```
+
+For a custom integration, provide your NWC client, payment repository, and
+application hooks. The service itself has no persistence dependency.
+
+## Connect your application
+
+Configure a receive-only NWC client. The host
 authorizes requests, resolves order amounts, commits payment hashes before responding, and
 consumes at-least-once verified payment events by hash. The service refuses to start when the
 NWC connection advertises spend methods (`pay_invoice`, `multi_pay_invoice`,
@@ -46,3 +81,12 @@ they store to `service.reconcile_payments({ attempts:, max_pages:, deadline: })`
 and apply the per-hash results through `on_paid` — `RackApp` deliberately has
 no built-in hook, and the durable-gate convenience (`OpenReceive.maybe_reconcile!`)
 ships only with the Rails engine.
+
+## Links
+
+- API reference: [Ruby and Rails APIs](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/api-reference.md)
+- Rails quickstart: [Use the engine with built-in persistence](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/quickstart-rails.md)
+- Source and issues: <https://github.com/openreceive/openreceive>
+- Changelog: [CHANGELOG.md](CHANGELOG.md)
+
+MIT license.

data/lib/openreceive/server/version.rb

@@ -2,6 +2,6 @@
 
 module OpenReceive
   module Server
-    VERSION = "0.4.5"
+    VERSION = "0.4.6"
   end
 end

data/skills/integrate-openreceive/references/btcpay.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (BTCPay Server)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Connect a BTCPay Server store to a receive-only NWC wallet with the OpenReceive
 plugin, and optionally let payers pay BTCPay invoices with USDT, USDC, ETH or

data/skills/integrate-openreceive/references/django.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Django)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Django project — the app you are already working in. You
 do not need a copy of the OpenReceive source: the Python package is on PyPI

data/skills/integrate-openreceive/references/fastapi.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (FastAPI)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a FastAPI application — the app you are already working in.
 You do not need a copy of the OpenReceive source: the engine is on PyPI

data/skills/integrate-openreceive/references/fastify.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Fastify)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Fastify application — the app you are already working in.
 You do not need a copy of the OpenReceive source: the packages are on npm, and

data/skills/integrate-openreceive/references/laravel.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Laravel)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Laravel application — the app you are already working in.
 You do not need a copy of the OpenReceive source: the package is on Packagist

data/skills/integrate-openreceive/references/next.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Next.js)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Next.js App Router application — the app you are already
 working in. You do not need a copy of the OpenReceive source: the packages are

data/skills/integrate-openreceive/references/node.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Node.js)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Node application — the app you are already working in. You
 do not need a copy of the OpenReceive source: the packages are on npm, and the

data/skills/integrate-openreceive/references/php.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (PHP)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a PHP application — the app you are already working in. You
 do not need a copy of the OpenReceive source: the engine is on Packagist

data/skills/integrate-openreceive/references/rails.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Rails)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Rails application — the app you are already working in. You
 do not need a copy of the OpenReceive source: the gem is on RubyGems, the

data/skills/integrate-openreceive/references/woocommerce.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (WordPress + WooCommerce)
 
-These directions describe OpenReceive 0.4.5.
+These directions describe OpenReceive 0.4.6.
 
 Install and configure the OpenReceive gateway in the existing WooCommerce
 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
 and MySQL 8 or MariaDB 10.5+. Activation creates payment-attempt tables in the
 existing WordPress database. No separate database or application is required.
 
+### Get the installable archive
+
+Use `openreceive-wordpress-<version>.zip` from the selected
+[OpenReceive GitHub release](https://github.com/OpenReceive/openreceive/releases)
+when that asset is listed. A GitHub source-code zip is not the plugin archive.
+If the release does not yet provide a built zip, build it on a development
+machine with Node 22+, PHP 8.2+, Composer and WP-CLI:
+
+```sh
+git clone https://github.com/OpenReceive/openreceive.git
+cd openreceive
+git checkout <release-tag>
+npm ci
+npm run build:packages
+composer install --working-dir=packages/php/wordpress
+npm run release:wordpress:build
+```
+
+Upload the resulting `dist/openreceive-wordpress-<version>.zip`. WP-CLI must be
+on `PATH`, or set `OPENRECEIVE_WP_CLI` to the absolute path of its phar. The
+WordPress server needs neither Node nor Composer: dependencies and checkout
+assets are bundled inside the built plugin.
+
 ### Configure the wallet
 
 Open **WooCommerce → Settings → Payments → OpenReceive**. Enter a receive-only

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openreceive-server
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - OpenReceive
@@ -15,18 +15,27 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 0.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.5
-description: 'Server building blocks for OpenReceive: a storage-free Service that
-  mirrors the Node engine and a framework-agnostic Rack app implementing the shipped
-  HTTP routes while the host owns order and payment persistence. Receive-only: it
-  never exposes a spend path and the NWC secret never leaves the server.'
+        version: 0.4.6
+description: |
+  Accept Bitcoin Lightning payments directly into a wallet you control, from your
+  Ruby or Rack application. OpenReceive provides invoice creation, payment checks,
+  and settlement reconciliation through a receive-only Nostr Wallet Connect
+  (NWC) client. Optional swaps let customers pay with USDT, USDC, SOL, and ETH
+  through a configured provider; you receive BTC over Lightning in your wallet.
+  Available assets and networks depend on the provider.
+
+  Bring your own wallet client, authorization, and payment persistence. The service
+  and Rack handler fit into your existing application, with no separate OpenReceive
+  service or database to deploy. Your app keeps control of orders, prices, and
+  fulfillment; wallet credentials stay on the server. Rails developers can use
+  openreceive-rails for built-in payment storage and reconciliation.
 email:
 - info@openreceive.org
 executables: []
@@ -73,7 +82,7 @@ metadata:
   source_code_uri: https://github.com/openreceive/openreceive
   changelog_uri: https://github.com/openreceive/openreceive/blob/master/packages/ruby/openreceive-server/CHANGELOG.md
   bug_tracker_uri: https://github.com/openreceive/openreceive/issues
-  documentation_uri: https://rubydoc.info/gems/openreceive-server
+  documentation_uri: https://github.com/openreceive/openreceive/blob/master/packages/ruby/openreceive-server/README.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -91,5 +100,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Storage-free OpenReceive receive-only service and HTTP routes for Ruby.
+summary: Accept Bitcoin Lightning payments in Ruby and Rack. Your app, your wallet.
 test_files: []