Super early version of a web client for the Mostro P2P System.
This project is a web interface that facilitates peer-to-peer bitcoin trading over the lightning network ⚡️ using nostr 🦩. The lightning network is a layer 2 scaling solution for bitcoin that enables fast and low-cost transactions.
Node.js: Recommended version: v20.15.1
NPM: Recommended version: 10.7.0
git clone [email protected]:MostroP2P/mostro-web.git
npm install
-
Create a new environment file by
cp .env-sample .env
. Here you'll want to set 2 environment variables: -
RELAYS
: A comma separated list of relays URLs. For example:
RELAYS=wss:https://relay.mostro.network,wss:https://relay.nostr.net
MOSTRO_PUB_KEY
: This is the identity of the mostro daemon you want to interact with and should match the private key (nsec) you specified inmostro
. For example:
MOSTRO_PUB_KEY=npub19m9laul6k463czdacwx5ta4ap43nlf3lr0p99mqugnz8mdz7wtvskkm5wg
Once this is set, just run source .env
to load these environment variables.
Obs. It is also possible, and sometimes desirable to run a private relay. There are instructions on how to do this with a docker container in the mostro repository.
$ npm run dev
That's it! 🎉
For detailed explanation on how things work, check out the documentation.
- Posts Orders (Buy & Sell)
- Displays order list
- Decodes DMs from mostro
- Buy flow (maker / market rate)
- Buy flow (maker / fixed price)
- Sell flow (maker / market rate)
- Sell flow (maker / fixed price)
- Buy flow (taker / market rate)
- Buy flow (taker / fixed price)
- Sell flow (taker / market rate)
- Sell flow (taker / fixed price)
- Handling multiple relays
- NIP-07 for key management
- Persisting old events
- Direct message with peers
- Disputes
- NIP59 support
This is a Nuxt 3 project, and as such you have these scripts to build an SSR ready version and/or generate a static release.
# Production build and version generation
# There's no need to run this every time, but run this at least once
# before running `npm run dev`
$ npm run build
# serve with hot reload at localhost:3000
$ npm run dev
# build for production and launch server
$ npm run build
$ npm run start
# generate static project
$ npm run generate
This project is licensed under the MIT License 📜. See the LICENSE
file for more information.