@openreceive/core
v0.4.35
Published
Money and wallet primitives for OpenReceive Bitcoin Lightning checkout and optional USDT, USDC, SOL and ETH swaps.
Maintainers
Readme
@openreceive/core
Build on the shared payment primitives behind OpenReceive: exact money conversion, exchange rates, wallet response normalization, and settlement rules. Use this package when building a custom integration; most applications should start with an OpenReceive server adapter.
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.
Install
This package is ESM-only and requires Node >= 22.
npm install @openreceive/coreStart with the integration quickstart and the payment storage guide.
Most applications never import this package directly: @openreceive/node,
@openreceive/http, and the framework adapters re-export what a host needs. Reach
for it when you are building your own integration and want the shared primitives
on their own — chiefly parseNwcUri, classifyTransactionSettlement and the
settlement finality rule, the money/decimal helpers, and CachedPriceFeed.
The API reference documents the host-facing surface (node, adapters, Rails) rather than these primitives; the exported types are the source of truth for them.
Part of OpenReceive. Start with the Node quickstart.
Agent skills
Run npx openreceive skills install from your application after installing an
OpenReceive server adapter. The offline copy ships in @openreceive/node, a
server-adapter dependency. For a frontend-only project, use
npx skills add OpenReceive/openreceive.
See agent setup. The bundled installers write
to .agents/skills/; use --dir .claude/skills for Claude Code. They replace
only integrate-openreceive and debug-openreceive-payment, preserving
unrelated skills.
