Portal is a Nostr-based authentication and payment SDK allowing applications to authenticate users and process payments through Nostr and Lightning Network.
Documentation: portaltechnologiesinc.github.io/lib
| Crate / package | Description |
|---|---|
| portal-rest | API server (REST + WebSocket). Run with Docker or from source. |
| portal | Core protocol and conversation logic. |
| portal-app | App runtime and wallet integration. |
| portal-cli | CLI tools (JWT, invoices, Cashu, etc.). |
| portal-wallet | Wallet backends (NWC, Breez). |
| portal-rates | Fiat exchange rates for BTC/sats. |
| clients/ts | TypeScript SDK (npm). |
| Java SDK | PortalTechnologiesInc/java-sdk. |
Run the API (Docker):
docker run -d -p 3000:3000 \
-e PORTAL__AUTH__AUTH_TOKEN=your-secret-token \
-e PORTAL__NOSTR__PRIVATE_KEY=your-nostr-private-key-hex \
getportal/sdk-daemon:latestThen use ws://localhost:3000/ws and your token with the TypeScript or Java SDK. See Quick Start in the docs.
Build from source: Building from source — cargo build --package portal-rest --release or nix build .#rest.
License: MIT — LICENSE