mirror of
https://github.com/RoboSats/robosats.git
synced 2024-12-15 03:46:24 +00:00
88 lines
5.6 KiB
Markdown
88 lines
5.6 KiB
Markdown
## RoboSats - Buy and sell Satoshis Privately
|
|
[](https://github.com/RoboSats/robosats/actions/workflows/coordinator-image.yml)
|
|
[](https://github.com/RoboSats/robosats/actions/workflows/frontend-build.yml)
|
|
[](https://github.com/RoboSats/robosats/releases)
|
|
[](https://github.com/RoboSats/robosats/blob/main/LICENSE)
|
|
[](https://t.me/robosats)
|
|
|
|
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.
|
|
|
|
|
|
<div align="center">
|
|
<img width="75%" src="https://raw.githubusercontent.com/RoboSats/robosats/main/frontend/static/assets/images/robosats-0.1.1-banner.png">
|
|
</div>
|
|
|
|
## Try it out!
|
|
- **TOR URL:** [**RoboDex**arjwtfryec556cjdz3dfa7u47saek6lkftnkgshvgg2kcumqd.onion](http://robodexarjwtfryec556cjdz3dfa7u47saek6lkftnkgshvgg2kcumqd.onion) ( Open with [Tor Browser](https://www.torproject.org/download/))
|
|
- Clearnet URL: [dex.robosats.com](https://unsafe.robosats.com) (not recommended!)
|
|
|
|
*Always use [Tor Browser](https://www.torproject.org/download/) 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
|
|
https://user-images.githubusercontent.com/90936742/167310017-dc211a05-dd5e-4ef4-b93f-250f80bc5bca.mp4
|
|
|
|
### Written guides
|
|
- **[English](https://learn.robosats.com/read/en)**
|
|
- **[Español](https://learn.robosats.com/read/es)**
|
|
- **[Deutsch](https://learn.robosats.com/read/de)**
|
|
|
|
### Video guides
|
|
- **[English](https://learn.robosats.com/watch/en/)**
|
|
- **[Español](https://learn.robosats.com/watch/es/)**
|
|
- **[Deutsch](https://learn.robosats.com/watch/de)**
|
|
- **[Português](https://learn.robosats.com/watch/pt)**
|
|
- **[Polski](https://learn.robosats.com/watch/pl)**
|
|
|
|
## 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](https://learn.robosats.com/contribute/) 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](/setup.md)
|
|
|
|
Officially mantained docker orchestration for coordinators can be found in the repo [robosats-deploy](https://github.com/RoboSats/robosats-deploy)
|
|
### ⚡Developer Rewards ⚡
|
|
Check out the [Developer Rewards Panel](https://github.com/users/Reckless-Satoshi/projects/2/views/5) for tasks paid in Sats.
|
|
|
|
## Sponsors
|
|
<div align="center">
|
|
<img src="https://raw.githubusercontent.com/RoboSats/robosats/main/docs/assets/images/sponsors/hrf.png" width="300px">
|
|
</div>
|
|
|
|
## Reviews
|
|
- **[Athena Alpha](https://www.athena-alpha.com/robosats-review/)**
|
|
- **[Bitcoin Magazine](https://bitcoinmagazine.com/business/robosats-private-bitcoin-exchange)**
|
|
- **[KYC? Not Me!](https://kycnot.me/service/robosats)**
|
|
- **[H17N Bitcoin](https://h17n.com/exchange/robosats/)**
|
|
- **[blockdyor](https://blockdyor.com/robosats/)**
|
|
|
|
## Inspiration
|
|
The concept of a simple custody-minimized lightning exchange with hold invoices is inspired in [P2PLNBOT](https://github.com/grunch/p2plnbot) by @grunch
|
|
|
|
## License
|
|
|
|
The Robotic Satoshis Open Source Project is released under the terms of the AGPL3.0 license. See [LICENSE](LICENSE) for more details.
|