mostro

Crates.iomostro
lib.rsmostro
version0.11.3
sourcesrc
created_at2024-04-02 13:40:47.745996
updated_at2024-04-14 21:11:11.558748
descriptionLightning Network peer-to-peer nostr platform
homepage
repository
max_upload_size
id1193539
Francisco Calderón (grunch)

documentation

README

# Mostro 🧌 ![Mostro-logo](static/logo.png) ## Overview Due to the growing need to be able to operate with Bitcoin without giving up personal data, in 2021 I started a project to allows people to buy and sell Bitcoin through Lightning Network without funds custody and without KYC, this project is a telegram bot called @lnp2pbot. [@lnp2pBot](https://github.com/lnp2pBot/bot) is growing steadily and organically, it's being use in the whole world and is having a bigger impact in Latin-America, a place where there is no need to explain to people that money is broken, it's being used more and more in dictatorial regimes like Cuba and Venezuela, where people keep resisting tyranny and protesting using less the local currency and more Bitcoin. Although the bot works excellent, it's running on top of Telegram, a great platform but we do not know if one day it will be reached by the tentacles of a powerful government asking for political dissidents or simply awkward public person. At this point Nostr appears as a platform where a system like this can live without the possibility of being censored by a powerful entity. This document explains how we can create a censorship-resistant and non custodial lightning network peer-to-peer exchange without a single point of failure like a telegram bot. ## How it works? Mostro works with a p2p communication on top of Nostr, Mostro will be the escrow that will allow buyer and seller operate reducing the risk for both parties. Mostro will handle Bitcoin using a Lightning Network node, the node will create the hold invoices for sellers to pay and pays to the buyers lightning regular invoices. Mostro will need a private key to be able to create, sign and send events through Nostr network. In the next graphic we can see a very summarized version of how Mostro, the seller and the lightning node interact, a more detailed explanation can be found [here](https://mostro.network/messages): ```mermaid sequenceDiagram autonumber Seller->>Mostro: I want to sell Bitcoin Mostro-->>LN-Node: Give me a hold invoice LN-Node->>Mostro: Hold invoice Mostro->>Seller: Please pay this hold invoice Seller->>LN-Node: Paying through lightning LN-Node-->>Mostro: Payment received Mostro-->>Seller: Thanks! talk to buyer now ``` In this repository we are building a Mostro daemon on Rust. ## Client Buyers and sellers will need Mostro's clients in order to buy/sell Bitcoin and a Lightning Wallet, for this we need to build at least a web client to start, we plan to build mobile and desktop clients in the future. ## Removing the single point of failure For this idea to work we need to make it as easy as possible for anyone to be a Mostro, we don't need dozens of Mostros but we do need the ones that are running to be reliable, that's why with this implementation we encourage to create your own Mostro and give more options to users. To handle a Mostro is not going to be that easy, a Mostro admin needs to have a lightning node up and running, it will need to have enough liquidity for users to operate lightning fast, the node MUST have uptime closer to 99.9%, all this requires resources that can be obtained by the fee that sellers pay on each successful order, this is a percentage that can vary between Mostros. ## Mostro's reputation Users will be able to rate Mostros and Mostros will compete to obtain more users in order to survive. Bad Mostros should be rejected by users and will lose incentives to keep existing. ## Requirements: 0. You need Rust version 1.74 or higher to compile. 1. You will need a lightning network node. ## Install dependencies: To compile on Ubuntu/Pop!\_OS, please install [cargo](https://www.rust-lang.org/tools/install), then run the following commands: ``` $ sudo apt update $ sudo apt install -y cmake build-essential libsqlite3-dev pkg-config libssl-dev ``` ## Install Clone the repository and then create a new `settings.dev.toml` file based on `settings.tpl.toml` file. ``` $ git clone https://github.com/MostroP2P/mostro.git $ cd mostro $ cp settings.tpl.toml settings.dev.toml ``` To connect to an LND node, you must define 4 variables within the [lightning] section of the settings.dev.toml file. _lnd_cert_file:_ LND node TLS certificate file path. _lnd_macaroon_file:_ Macaroon file path, the macaroon file contains permission for doing actions on the lnd node. _lnd_grpc_host:_ IP address or domain name from the LND node, example: `127.0.0.1`. _lnd_grpc_port:_ LND node port to connect, example: `10009`. ### Database The data is saved in a sqlite db file named by default `mostro.db`, this file is saved on the root directory of the project and can be change just editing the `url` var on the `[database]` section in `settings.dev.toml` file. Before start building we need to initialize the database, for this we need to use `sqlx_cli`: ```bash $ cargo install sqlx-cli --version 0.6.2 $ ./init_db.sh ``` ### Running it: Before running it you need to set `nsec_privkey` in the `[nostr]` section of the `settings.dev.toml` file with the private key of your Mostro, if you don't have a nostr private key you can use [rana 🐸](https://github.com/grunch/rana) to generate a new one. You must create a .mostro directory in /home/user/ and copy the settings.dev.toml and mostro.db files inside. ```bash $ mkdir $HOME/.mostro/ && cp settings.dev.toml mostro.db $HOME/.mostro/ ``` Finnaly run it: ```bash $ cargo run ``` ## Connecting to relay ### Option 1: Run Mostro with a private dockerized relay ```bash cd relay docker compose up -d ``` This will spin a new docker container with an instance of [nostr-rs-relay](https://github.com/scsibug/nostr-rs-relay), that will listen at port `7000`. So the relay URL you want to connect to is: `ws://localhost:7000`. You need to set `relays` in the `[nostr]` section of the `settings.dev.toml` file: relays = ['ws://localhost:7000'] #### Troubleshooting: If in the relay logs the error appears: `unable to open database file: /usr/src/app/db/nostr.db` you need to modify the docker-compose.yml file in the relay directory with: ```bash version: '3.8' services: nostr-relay: image: scsibug/nostr-rs-relay container_name: nostr-relay ports: - '${MOSTRO_RELAY_LOCAL_PORT:-7000}:8080' volumes: - 'mostro_data:/usr/src/app/db:Z' - './config.toml:/usr/src/app/config.toml:ro,Z' volumes: mostro_data: ``` ### Option 2: Connect to any other relay You just need to set `relays` in the `[nostr]` section of the `settings.dev.toml` file with the relays you will use.
Commit count: 0

cargo fmt