Skip to content

RoboSats/robosats

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RoboSats - Buy and sell Satoshis Privately

Coordinator CI Frontend Build release AGPL-3.0 license Telegram

RoboSats is a simple and private way to exchange bitcoin for national currencies. Robosats simplifies the peer-to-peer user experience and uses lightning hold invoices to minimize custody and trust requirements. The deterministically generated avatars help users stick to best privacy practices.

Try it out!

Always use Tor Browser and .onion for best privacy. The Clearnet URL redirects to a third party Tor2web service. Your privacy cannot be guaranteed to be respected. Use clearnet only to check around the app, never use for trading!

You can use Testnet Bitcoin by going to the Settings page and switching to Testnet

How to use it

ROBOSATS_EN_small.mp4

Written guides

Video guides

How it works

Alice wants to buy satoshis privately:

  1. Alice generates an avatar (AdequateAlice01) using her private random token.
  2. Alice stores safely the token in case she needs to recover AdequateAlice01 in the future.
  3. Alice makes a new order and locks a small hold invoice to publish it (maker bond).
  4. Bob wants to sell satoshis, sees Alice's order in the book and takes it.
  5. Bob scans a small hold invoice as his taker bond. The contract is final.
  6. Bob posts the traded satoshis with a hold invoice. While Alice submits her payout invoice.
  7. On a private chat, Bob tells Alice how to send him fiat.
  8. Alice pays Bob, then they confirm the fiat has been sent and received.
  9. Bob's trade hold invoice is charged and the satoshis are sent to Alice.
  10. Bob and Alice's bonds return automatically, since they complied with the rules.
  11. The bonds would be charged (lost) in case of unilateral cancellation or cheating (lost dispute).

Contribute to the Robotic Satoshis Open Source Project

Check out our Contribution Guide to find how you can make RoboSats great.

RoboSats is a monorepo, arguably a messy one at the moment.

  • The top level is a Django application (the coordinator backend) with apps /api, /control, and /chat. Django settings are in /robosats and /tests has integration tests for the RoboSats backend.
  • The /frontend directory contains the ReactJS client.
  • The /nodeapp directory contains the docker orchestration and utilities for the self-hosted application (Umbrel, StartOS, etc)
  • The /mobile directory contains our React Native app (a wrapper around our ReactJS app in /frontend)
  • The /docs directory has the learn.robosats.com static Jekyll site markdown docs.
  • The /web directory is a light wrapper around our client app /frontend intended to host a RoboSats dex client to be used for the public. We use this one in dex.robosats.com

You can run the whole stack for local development following the instructions in setup.md

Officially mantained docker orchestration for coordinators can be found in the repo robosats-deploy

⚡Developer Rewards ⚡

Check out the Developer Rewards Panel for tasks paid in Sats.

Sponsors

Reviews

Inspiration

The concept of a simple custody-minimized lightning exchange with hold invoices is inspired in P2PLNBOT by @grunch

License

The Robotic Satoshis Open Source Project is released under the terms of the AGPL3.0 license. See LICENSE for more details.