Skip to content

bitweb-project/api

 
 

Repository files navigation

ShockAPI

GitHub last commit PRs Welcome Chat Twitter Follow

This is an alpha release of the Shockwallet backend service, providing a wrapper for LND and a daemon for a decentralized social graph over GUN.

Run this service on your Lightning node and connect with a mobile device or desktop browser.

Easy Installation

For easy setup on your Laptop/Desktop, a node wizard is available here.

Manual Installation

Notes:

  • The service defaults to port 9835
  • Looks for local LND in its default path
  • Default gun peer is gun.shock.network
  • Change defaults in defaults.js
  • Requires Node.js 14

Steps:

  1. Run LND - Example mainnet startup:

(Neutrino example requires builds with experimental flags, our binaries include them.)

./lnd --bitcoin.active --bitcoin.mainnet --bitcoin.node=neutrino --neutrino.connect=neutrino.shock.network --routing.assumechanvalid --accept-keysend --allow-circular-route --feeurl=https://nodes.lightning.computer/fees/v1/btc-fee-estimates.json
  1. Download and Install API
git clone https://github.com/shocknet/api
cd api
yarn install
  1. Run with yarn start
  2. Connect with Shockwallet (Provide your nodes IP manually or scan QR from ShockWizard)

Optionally, add the --tunnel flag to create an ssh connection through a tunnel.rip webserver for zero-configuration networking. All communication between the api and wallet is end-to-end encrypted and your privacy is protected.

Docker for Raspberry Pi

About

Backend daemon for for Shockwallet, provides endpoints for LND and GUN

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 95.6%
  • TypeScript 2.9%
  • HTML 1.1%
  • Other 0.4%