Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 1.65 KB

README.md

File metadata and controls

71 lines (49 loc) · 1.65 KB
Raw

Satsbox

Nostr friendly bitcoin lightning custodial wallet service.

Features

  • No-registration multi-user service based on nostr pubkey
  • NIP-47: Nostr Wallet Connect
  • NIP-57: Nostr Lightning Zaps
  • LNURL support: 01 06 09 12 16 18
  • Api using NIP-98 HTTP Auth
  • LndHub api compatible
  • Supported backends: LND and CLN 23.08+
  • Easily create private non-custodial multi-account wallet service by setting up whitelist

Usage

Requirement

LND or CLN 23.08+

Docker

# Create data dir
mkdir ./data
# Refer to satsbox.example.toml edit configuration file
touch satsbox.toml

docker run -it --rm -p 8080:8080 \
  --user=$(id -u) \
  -v $(pwd)/data:/satsbox/data \
  -v $(pwd)/satsbox.toml:/satsbox/satsbox.toml \
  --name satsbox rnostr/satsbox:latest

Development

git clone https://github.com/rnostr/satsbox.git

# start dependencies
cd satsbox/contrib
docker compose up -d

# init regtest lightning network
sh dev.sh test

# copy cert file from docker to local
sh dev.sh copy_cert

# run test
cd ../
cargo test

# build ui
cd ui/
yarn build

# run dev use config satsbox.example.toml
cd ../
cargo run --example dev

# run ui dev
cd ui/
yarn dev