openreceive
v0.4.11
Published
CLI setup and diagnostics for OpenReceive Bitcoin Lightning checkout and optional USDT, USDC, SOL and ETH swaps.
Maintainers
Readme
openreceive
Set up and inspect your OpenReceive payment integration from the command
line. Generate payment-table migrations for your ORM and check your
receive-only wallet connection with openreceive scaffold and
openreceive doctor. The payment libraries ship as the @openreceive/*
packages; choose the adapter for your server and the UI for your frontend.
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.
npm install @openreceive/express @openreceive/reactThose two are an example, not a requirement. Swap @openreceive/express for
@openreceive/fastify or @openreceive/next, and @openreceive/react for
@openreceive/vue, @openreceive/svelte, @openreceive/angular, or
@openreceive/elements (framework-free custom element). On Rails, use the
openreceive-rails gem instead of a Node adapter.
See the Node quickstart.
This package is ESM-only and requires Node >= 22.
Use
No install needed:
npx openreceive scaffold payments --orm prisma # or drizzle | typeorm | sequelize | knex
npx openreceive doctorscaffold paymentsemits theopenreceive_paymentsandopenreceive_metaschema/migration for your ORM plus a wiring guide; it never touches a database.doctorchecks the environment and the receive-only NWC connection.
The command is implemented in @openreceive/node (@openreceive/node/cli).
This package exists so that npx openreceive resolves under every package
manager, including the ones that never hoist a transitive dependency's bin.
License
MIT
