Mirror/robosats
1
0
Fork 0
mirror of https://github.com/RoboSats/robosats.git synced 2024-12-13 19:06:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
c3d1cd2472
robosats/README.md

88 lines
5.6 KiB
Markdown
Raw Normal View History

Add penalty live countdown. Fix unilateral cancellation after escrow
2022-01-26 11:44:45 +00:00
## RoboSats - Buy and sell Satoshis Privately
Rename repository
2023-05-09 13:07:16 +00:00
[![Coordinator CI](https://github.com/RoboSats/robosats/actions/workflows/coordinator-image.yml/badge.svg?branch=main)](https://github.com/RoboSats/robosats/actions/workflows/coordinator-image.yml)
[![Frontend Build](https://github.com/RoboSats/robosats/actions/workflows/frontend-build.yml/badge.svg?branch=main)](https://github.com/RoboSats/robosats/actions/workflows/frontend-build.yml)
[![release](https://img.shields.io/badge/release-v0.1.0%20MVP-red)](https://github.com/RoboSats/robosats/releases)
[![AGPL-3.0 license](https://img.shields.io/badge/license-AGPL--3.0-blue)](https://github.com/RoboSats/robosats/blob/main/LICENSE)
Update readme
2022-01-19 13:32:54 +00:00
[![Telegram](https://img.shields.io/badge/chat-telegram-brightgreen)](https://t.me/robosats)
Add concept for BTC <> Fiat p2p swap using Lightning. - Motivation 1) It is widely recognized that one of the main attack vectors for the Bitcoin network is the ability of states to control the fiat on/off-ramps. 2) While there exists peer-to-peer alternatives to centralized exchanges, these are rather technical, slow and more costly. 3) Most users prefer the convenience of a centralized exchange at the cost of a difficult of the risk for their privacy and a difficult initial setup (ID, selfie-video, etc). - Opportunities Using the Lightning Network and hodl invoices it is possible to create a more user friendly, faster and cheaper peer-to-peer market. This vision was first enacted by @grunch on the p2plnbot telegam bot project. - Challenges 1) Ideally the seller hodl invoice and the payment to the buyer invoice would be atomic. Given that this is not technically possible, the proposed concept relies on the need of trust on the service provider. There are reasons to believe that challenging centralized solutions both in user experience and cost is possible. This commit adds a rough concept for thefrontend, backend and design. This project, tentatively named RoboSats (short for Robotic Satoshis) and licensed at launch under AGPL3.0.
2022-01-01 14:57:10 +00:00
Fix all files with pre-commit
2022-10-25 18:04:12 +00:00
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.
Add concept for BTC <> Fiat p2p swap using Lightning. - Motivation 1) It is widely recognized that one of the main attack vectors for the Bitcoin network is the ability of states to control the fiat on/off-ramps. 2) While there exists peer-to-peer alternatives to centralized exchanges, these are rather technical, slow and more costly. 3) Most users prefer the convenience of a centralized exchange at the cost of a difficult of the risk for their privacy and a difficult initial setup (ID, selfie-video, etc). - Opportunities Using the Lightning Network and hodl invoices it is possible to create a more user friendly, faster and cheaper peer-to-peer market. This vision was first enacted by @grunch on the p2plnbot telegam bot project. - Challenges 1) Ideally the seller hodl invoice and the payment to the buyer invoice would be atomic. Given that this is not technically possible, the proposed concept relies on the need of trust on the service provider. There are reasons to believe that challenging centralized solutions both in user experience and cost is possible. This commit adds a rough concept for thefrontend, backend and design. This project, tentatively named RoboSats (short for Robotic Satoshis) and licensed at launch under AGPL3.0.
2022-01-01 14:57:10 +00:00
Merge branch 'main' of https://github.com/dsitti/robosats into main
2022-03-17 01:03:43 +00:00
Update README.md
2022-01-31 13:57:39 +00:00
<div align="center">
Rename repository
2023-05-09 13:07:16 +00:00
<img width="75%" src="https://raw.githubusercontent.com/RoboSats/robosats/main/frontend/static/assets/images/robosats-0.1.1-banner.png">
Update README.md
2022-01-31 13:57:39 +00:00
</div>
Add concept for BTC <> Fiat p2p swap using Lightning. - Motivation 1) It is widely recognized that one of the main attack vectors for the Bitcoin network is the ability of states to control the fiat on/off-ramps. 2) While there exists peer-to-peer alternatives to centralized exchanges, these are rather technical, slow and more costly. 3) Most users prefer the convenience of a centralized exchange at the cost of a difficult of the risk for their privacy and a difficult initial setup (ID, selfie-video, etc). - Opportunities Using the Lightning Network and hodl invoices it is possible to create a more user friendly, faster and cheaper peer-to-peer market. This vision was first enacted by @grunch on the p2plnbot telegam bot project. - Challenges 1) Ideally the seller hodl invoice and the payment to the buyer invoice would be atomic. Given that this is not technically possible, the proposed concept relies on the need of trust on the service provider. There are reasons to believe that challenging centralized solutions both in user experience and cost is possible. This commit adds a rough concept for thefrontend, backend and design. This project, tentatively named RoboSats (short for Robotic Satoshis) and licensed at launch under AGPL3.0.
2022-01-01 14:57:10 +00:00
Fix all files with pre-commit
2022-10-25 18:04:12 +00:00
## Try it out!
update URLs onREADME (#1120) Update README.md
2024-02-09 16:30:41 +00:00
- **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!)
Add concept for BTC <> Fiat p2p swap using Lightning. - Motivation 1) It is widely recognized that one of the main attack vectors for the Bitcoin network is the ability of states to control the fiat on/off-ramps. 2) While there exists peer-to-peer alternatives to centralized exchanges, these are rather technical, slow and more costly. 3) Most users prefer the convenience of a centralized exchange at the cost of a difficult of the risk for their privacy and a difficult initial setup (ID, selfie-video, etc). - Opportunities Using the Lightning Network and hodl invoices it is possible to create a more user friendly, faster and cheaper peer-to-peer market. This vision was first enacted by @grunch on the p2plnbot telegam bot project. - Challenges 1) Ideally the seller hodl invoice and the payment to the buyer invoice would be atomic. Given that this is not technically possible, the proposed concept relies on the need of trust on the service provider. There are reasons to believe that challenging centralized solutions both in user experience and cost is possible. This commit adds a rough concept for thefrontend, backend and design. This project, tentatively named RoboSats (short for Robotic Satoshis) and licensed at launch under AGPL3.0.
2022-01-01 14:57:10 +00:00
Include all docs svg icons, Fix links, Add pages
2022-05-21 23:09:25 +00:00
*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!*
Add concept for BTC <> Fiat p2p swap using Lightning. - Motivation 1) It is widely recognized that one of the main attack vectors for the Bitcoin network is the ability of states to control the fiat on/off-ramps. 2) While there exists peer-to-peer alternatives to centralized exchanges, these are rather technical, slow and more costly. 3) Most users prefer the convenience of a centralized exchange at the cost of a difficult of the risk for their privacy and a difficult initial setup (ID, selfie-video, etc). - Opportunities Using the Lightning Network and hodl invoices it is possible to create a more user friendly, faster and cheaper peer-to-peer market. This vision was first enacted by @grunch on the p2plnbot telegam bot project. - Challenges 1) Ideally the seller hodl invoice and the payment to the buyer invoice would be atomic. Given that this is not technically possible, the proposed concept relies on the need of trust on the service provider. There are reasons to believe that challenging centralized solutions both in user experience and cost is possible. This commit adds a rough concept for thefrontend, backend and design. This project, tentatively named RoboSats (short for Robotic Satoshis) and licensed at launch under AGPL3.0.
2022-01-01 14:57:10 +00:00
update URLs onREADME (#1120) Update README.md
2024-02-09 16:30:41 +00:00
*You can use Testnet Bitcoin by going to the Settings page and switching to Testnet*
Add concept for BTC <> Fiat p2p swap using Lightning. - Motivation 1) It is widely recognized that one of the main attack vectors for the Bitcoin network is the ability of states to control the fiat on/off-ramps. 2) While there exists peer-to-peer alternatives to centralized exchanges, these are rather technical, slow and more costly. 3) Most users prefer the convenience of a centralized exchange at the cost of a difficult of the risk for their privacy and a difficult initial setup (ID, selfie-video, etc). - Opportunities Using the Lightning Network and hodl invoices it is possible to create a more user friendly, faster and cheaper peer-to-peer market. This vision was first enacted by @grunch on the p2plnbot telegam bot project. - Challenges 1) Ideally the seller hodl invoice and the payment to the buyer invoice would be atomic. Given that this is not technically possible, the proposed concept relies on the need of trust on the service provider. There are reasons to believe that challenging centralized solutions both in user experience and cost is possible. This commit adds a rough concept for thefrontend, backend and design. This project, tentatively named RoboSats (short for Robotic Satoshis) and licensed at launch under AGPL3.0.
2022-01-01 14:57:10 +00:00
Update README.md
2022-02-18 09:41:16 +00:00
## How to use it
Add video walktroughts and tutorials to README.md
2022-05-08 18:26:14 +00:00
https://user-images.githubusercontent.com/90936742/167310017-dc211a05-dd5e-4ef4-b93f-250f80bc5bca.mp4
Added new How To guide (#349) * Added new How To guide * Removed "latest version" * Update README.md
2023-02-12 14:46:58 +00:00
### 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)**
Add video walktroughts and tutorials to README.md
2022-05-08 18:26:14 +00:00
Update readme
2022-01-19 13:32:54 +00:00
## 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.
Update README.md (#901) Grammatical error replace "by" with "with"
2023-10-19 23:13:26 +00:00
10. Bob and Alice's bonds return automatically, since they complied with the rules.
Update readme
2022-01-19 13:32:54 +00:00
11. The bonds would be charged (lost) in case of unilateral cancellation or cheating (lost dispute).
Add concept for BTC <> Fiat p2p swap using Lightning. - Motivation 1) It is widely recognized that one of the main attack vectors for the Bitcoin network is the ability of states to control the fiat on/off-ramps. 2) While there exists peer-to-peer alternatives to centralized exchanges, these are rather technical, slow and more costly. 3) Most users prefer the convenience of a centralized exchange at the cost of a difficult of the risk for their privacy and a difficult initial setup (ID, selfie-video, etc). - Opportunities Using the Lightning Network and hodl invoices it is possible to create a more user friendly, faster and cheaper peer-to-peer market. This vision was first enacted by @grunch on the p2plnbot telegam bot project. - Challenges 1) Ideally the seller hodl invoice and the payment to the buyer invoice would be atomic. Given that this is not technically possible, the proposed concept relies on the need of trust on the service provider. There are reasons to believe that challenging centralized solutions both in user experience and cost is possible. This commit adds a rough concept for thefrontend, backend and design. This project, tentatively named RoboSats (short for Robotic Satoshis) and licensed at launch under AGPL3.0.
2022-01-01 14:57:10 +00:00
## Contribute to the Robotic Satoshis Open Source Project
Update README.md
2022-07-29 09:12:20 +00:00
Check out our [Contribution Guide](https://learn.robosats.com/contribute/) to find how you can make RoboSats great.
Add concept for BTC <> Fiat p2p swap using Lightning. - Motivation 1) It is widely recognized that one of the main attack vectors for the Bitcoin network is the ability of states to control the fiat on/off-ramps. 2) While there exists peer-to-peer alternatives to centralized exchanges, these are rather technical, slow and more costly. 3) Most users prefer the convenience of a centralized exchange at the cost of a difficult of the risk for their privacy and a difficult initial setup (ID, selfie-video, etc). - Opportunities Using the Lightning Network and hodl invoices it is possible to create a more user friendly, faster and cheaper peer-to-peer market. This vision was first enacted by @grunch on the p2plnbot telegam bot project. - Challenges 1) Ideally the seller hodl invoice and the payment to the buyer invoice would be atomic. Given that this is not technically possible, the proposed concept relies on the need of trust on the service provider. There are reasons to believe that challenging centralized solutions both in user experience and cost is possible. This commit adds a rough concept for thefrontend, backend and design. This project, tentatively named RoboSats (short for Robotic Satoshis) and licensed at launch under AGPL3.0.
2022-01-01 14:57:10 +00:00
chore: explain monorepo architecture on readme.md
2024-04-20 19:44:16 +00:00
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)
Update README.md
2022-07-29 09:12:20 +00:00
### ⚡Developer Rewards ⚡
Update broken link to developer rewards panel (#902)
2023-10-19 20:11:16 +00:00
Check out the [Developer Rewards Panel](https://github.com/users/Reckless-Satoshi/projects/2/views/5) for tasks paid in Sats.
Users stay logged in when re-entering home if there is an active order or is an old account
2022-01-18 17:42:45 +00:00
Fix all files with pre-commit
2022-10-25 18:04:12 +00:00
## Sponsors
Add HRF sponsorship
2022-09-09 18:33:59 +00:00
<div align="center">
Rename repository
2023-05-09 13:07:16 +00:00
<img src="https://raw.githubusercontent.com/RoboSats/robosats/main/docs/assets/images/sponsors/hrf.png" width="300px">
Add HRF sponsorship
2022-09-09 18:33:59 +00:00
</div>
Add Reviews section to home in learn.robosats (#605) * Added new Reviews section to README * Updated version number number to latest for Athena Alpha guide * Update README.md * Added proposed Reviews section * Added reviews section with a few starter sites * Added Reviews section with a few starter sites * Update home.md * Added styles to align things --------- Co-authored-by: Reckless_Satoshi <90936742+Reckless-Satoshi@users.noreply.github.com>
2023-05-23 21:49:45 +00:00
## Reviews
- **[Athena Alpha](https://www.athena-alpha.com/robosats-review/)**
- **[Bitcoin Magazine](https://bitcoinmagazine.com/business/robosats-private-bitcoin-exchange)**
fix: kycnot.me url (#973) fix kycnot.me url
2023-11-29 11:08:48 +00:00
- **[KYC? Not Me!](https://kycnot.me/service/robosats)**
Add Reviews section to home in learn.robosats (#605) * Added new Reviews section to README * Updated version number number to latest for Athena Alpha guide * Update README.md * Added proposed Reviews section * Added reviews section with a few starter sites * Added Reviews section with a few starter sites * Update home.md * Added styles to align things --------- Co-authored-by: Reckless_Satoshi <90936742+Reckless-Satoshi@users.noreply.github.com>
2023-05-23 21:49:45 +00:00
- **[H17N Bitcoin](https://h17n.com/exchange/robosats/)**
Update README.md (#999) Added Robosats review published on blockdyor.com
2023-12-15 15:10:09 +00:00
- **[blockdyor](https://blockdyor.com/robosats/)**
Add Reviews section to home in learn.robosats (#605) * Added new Reviews section to README * Updated version number number to latest for Athena Alpha guide * Update README.md * Added proposed Reviews section * Added reviews section with a few starter sites * Added Reviews section with a few starter sites * Update home.md * Added styles to align things --------- Co-authored-by: Reckless_Satoshi <90936742+Reckless-Satoshi@users.noreply.github.com>
2023-05-23 21:49:45 +00:00
Rectify inspiration paragraph on README.md @grunch I did not like the previous wording "# Original Idea (...) by @grunch", given that most original ideas within RoboSats right now do not relate to lnp2pbot. I took the easy route and simple deleted the paragraph instead of re-wording it, as I considered this paragraph to be a nice mention to have, but not mandatory, specially in the readme as it is already located in other places. As of now the projects only share being a lightning with hodl invoices: but I did in fact get a lot of inspiration from your work, and you totally deserve the mention! I see how this was probably a bad decision and damaging (... probably stupid too). Thanks for pointing it out and my sincere apologies.
2022-07-30 11:30:22 +00:00
## Inspiration
The concept of a simple custody-minimized lightning exchange with hold invoices is inspired in [P2PLNBOT](https://github.com/grunch/p2plnbot) by @grunch
Add concept for BTC <> Fiat p2p swap using Lightning. - Motivation 1) It is widely recognized that one of the main attack vectors for the Bitcoin network is the ability of states to control the fiat on/off-ramps. 2) While there exists peer-to-peer alternatives to centralized exchanges, these are rather technical, slow and more costly. 3) Most users prefer the convenience of a centralized exchange at the cost of a difficult of the risk for their privacy and a difficult initial setup (ID, selfie-video, etc). - Opportunities Using the Lightning Network and hodl invoices it is possible to create a more user friendly, faster and cheaper peer-to-peer market. This vision was first enacted by @grunch on the p2plnbot telegam bot project. - Challenges 1) Ideally the seller hodl invoice and the payment to the buyer invoice would be atomic. Given that this is not technically possible, the proposed concept relies on the need of trust on the service provider. There are reasons to believe that challenging centralized solutions both in user experience and cost is possible. This commit adds a rough concept for thefrontend, backend and design. This project, tentatively named RoboSats (short for Robotic Satoshis) and licensed at launch under AGPL3.0.
2022-01-01 14:57:10 +00:00
## License
Add dynamic refresh rate to OrderPage based on order status
2022-01-15 12:00:11 +00:00
The Robotic Satoshis Open Source Project is released under the terms of the AGPL3.0 license. See [LICENSE](LICENSE) for more details.
Reference in New Issue Copy Permalink