From ed062416db343ff444cdcbb1d3768a828d3cd014 Mon Sep 17 00:00:00 2001
From: okada-blue <105159960+okada-blue@users.noreply.github.com>
Date: Mon, 24 Jul 2023 17:50:17 +0000
Subject: [PATCH] Edit Multiple docs (#712)
* Update 01-development.md
Update Communication Channels channels to reflect removal of Twitter and Telegram, and emphasize SimpleX, Nostr, and Matrix chats
* Update 02-languages.md
Update Telegram verbiage to reference SimpleX instead.
* Update 04-guides.md
Update Telegram verbiage to reference SimpleX instead.
* Update 05-art.md
Update Telegram verbiage to reference SimpleX instead.
* Update 06-outreach.md
Update Twitter verbiage and reference Nostr instead
* Update 00-quicks-start-guide.md
Update verbiage slightly. Add more info and links.
* Update 01-lightning.md
Add rough draft to provide overview of Lightning Network and its relation to RoboSats
* Update 02-tor.md
Provide rough draft of introduction to TOR.
* Update 03-access.md
Add access method via Android app APK. Adjust slight typos and some wording for clarity.
* Update 01-trade-pipeline.md
Add TOC, swap steps and pictures placement, adjust small typos and wording.
Picture was swapped with the steps because I think the picture can be slightly overwhelming versus a simple list of steps. The pictures are great but they are a lot to throw at someone right when they open the very first doc under "Understand" to learn about RoboSats.
* Update 02-robots.md
Clean up hyperlinks, adjust grammar slightly.
* Update 03-premium.md
Update verbiage, adjust grammar slightly.
* Update 03-premium.md
Add paragraphs on advice for choosing a premium
* Update 04-bonds.md
Various changes to verbiage and adding/updating information. Grammar fixes, remove reference to Telegram.
* Update 05-trade-escrow.md
Clean up hyperlinks, adjust some wording
* Update 06-disputes.md
Rough draft of disputes section. Committed changes are a placeholder for a longer and more detailed version of the dispute process.
* Update 07-wallets.md
Fix typos, grammar edits, add new section at bottom
* Update 08-limits.md
Rough draft of new content in the limits docs
* Update 09-swaps.md
Adjust "on-chain" to "on chain" and "sats" to "Sats" for consistency across other docs. Slight grammar fixes.
* Update 10-telegram.md
Small grammar fixes, clean up formatting and add table of contents
* Update 12-prices.md
Add verbiage note about explicit pricing method, clean up hyperlinks
* Update 13-fees.md
Clean up hyperlinks, small spelling fixes
* Update 14-on-chain-payouts.md
Add table of contents, small grammar fixes, adjust formatting
* Update 07-wallets.md
Change "on chain" to "on-chain"
* Update 09-swaps.md
Change "on chain" to "on-chain"
* Update 02-tor.md
Add note when using TOR and experiencing connection issues
---
docs/_pages/contribute/01-development.md | 16 ++----
docs/_pages/contribute/02-languages.md | 6 +-
docs/_pages/contribute/04-guides.md | 2 +-
docs/_pages/contribute/05-art.md | 2 +-
docs/_pages/contribute/06-outreach.md | 2 +-
.../00-quick-start/00-quicks-start-guide.md | 10 ++--
.../docs/00-quick-start/01-lightning.md | 25 +++++++-
docs/_pages/docs/00-quick-start/02-tor.md | 15 ++++-
docs/_pages/docs/00-quick-start/03-access.md | 40 ++++++++-----
.../docs/03-understand/01-trade-pipeline.md | 40 +++++++------
docs/_pages/docs/03-understand/02-robots.md | 6 +-
docs/_pages/docs/03-understand/03-premium.md | 14 ++++-
docs/_pages/docs/03-understand/04-bonds.md | 41 ++++++-------
.../docs/03-understand/05-trade-escrow.md | 16 +++---
docs/_pages/docs/03-understand/06-disputes.md | 18 +++++-
docs/_pages/docs/03-understand/07-wallets.md | 29 ++++++----
docs/_pages/docs/03-understand/08-limits.md | 18 +++++-
docs/_pages/docs/03-understand/09-swaps.md | 49 +++++-----------
docs/_pages/docs/03-understand/10-telegram.md | 57 ++++++++++---------
docs/_pages/docs/03-understand/12-prices.md | 6 +-
docs/_pages/docs/03-understand/13-fees.md | 16 +++---
.../docs/03-understand/14-on-chain-payouts.md | 35 ++++--------
22 files changed, 264 insertions(+), 199 deletions(-)
diff --git a/docs/_pages/contribute/01-development.md b/docs/_pages/contribute/01-development.md
index e48a6ffd..2e5f9575 100644
--- a/docs/_pages/contribute/01-development.md
+++ b/docs/_pages/contribute/01-development.md
@@ -10,25 +10,19 @@ toc_sticky: true
src: "_pages/contribute/01-development.md"
---
-Everyone can contribute to the development of the Robotic Satoshis (RoboSats) open source project. If you're looking for somewhere to start contributing, then check out the issue list sharing the ["good first issue"](https://github.com/RoboSats/robosats/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") label; such issues are good for newcomers.
+Everyone can contribute to the development of the RoboSats open source project. If you're looking for somewhere to start contributing, then check out the issue list sharing the ["good first issue"](https://github.com/RoboSats/robosats/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") label; such issues are good for newcomers.
This contributing guide is based on the [Bisq contributing guide](https://github.com/bisq-network/bisq/blob/master/CONTRIBUTING.md). Following best FOSS practices helps development remain organized as the project grows with new features and is continually optimized. Future contibutors will thank you for following these best practices and making your work easier to build on!
## Communication Channels
-- **Matrix:** [RoboSats Development Group](https://matrix.to/#/#robosats:matrix.org). Main developer communication group chat.
+*!!! Beware of scammers impersonating RoboSats admins. Admins will NEVER privately message/call you.*
-- **Telegram:** [RoboSats Main Group EN🇬🇧](https://t.me/robosats). General discussion about RoboSats and any community-driven support happens publicly in the main Telegram group (English). If you're wanting to hang out with other cool robots and/or have questions about RoboSats, then those discussions happen in Telegram. There are more groups available for public, community-driven support in other languages:
- - ES🇪🇸 [t.me/robosats_es](https://t.me/robosats_es)
- - RU🇷🇺 [t.me/robosats_ru](https://t.me/robosats_ru)
- - PT🇵🇹 [t.me/robosats_pt](https://t.me/robosats_pt)
- - CN🇨🇳 [t.me/robosats_cn](https://t.me/robosats_cn)
+- **Simplex:** [RoboSats Main Group](https://simplex.chat/contact#/?v=1-2&smp=smp%3A%2F%2F0YuTwO05YJWS8rkjn9eLJDjQhFKvIYd8d4xG8X1blIU%3D%40smp8.simplex.im%2FyEX_vdhWew_FkovCQC3mRYRWZB1j_cBq%23%2F%3Fv%3D1-2%26dh%3DMCowBQYDK2VuAyEAnrf9Jw3Ajdp4EQw71kqA64VgsIIzw8YNn68WjF09jFY%253D%26srv%3Dbeccx4yfxxbvyhqypaavemqurytl6hozr47wfc7uuecacjqdvwpw2xid.onion&data=%7B%22type%22%3A%22group%22%2C%22groupLinkId%22%3A%22hWnMVPnJl-KT3-virDk0JA%3D%3D%22%7D). Got questions or a problem? Find community-driven support in the public SimpleX group chat. If you're wanting to hang out with other cool robots and learn more about RoboSats, then those discussions happen in SimpleX, Nostr, and Matrix group chats.
-- **Twitter:** [RoboSats](https://twitter.com/RoboSats). Provides important project updates, tips and tricks of using RoboSats, and other privacy-centric commentary. Questions may be asked to the Twitter account; however, Twitter limits the number of characters in a tweet and makes responding to questions restrictive. It's best to direct your questions to the aforementioned public Telegram support group for a faster and more detailed response from community members!
+- **Nostr:** [RoboSats General Group](https://snort.social/e/note1tfwvglg8xz8420pfgav0dc9mqekv02nkpck2axefklrema7lk6wszmwxdy). Hang out with other cool robots and do not hesitate to ask questions about RoboSats! Also, the [RoboSats Nostr account](https://snort.social/p/npub1p2psats79rypr8lpnl9t5qdekfp700x660qsgw284xvq4s09lqrqqk3m82) (npub1p2psats79rypr8lpnl9t5qdekfp700x660qsgw284xvq4s09lqrqqk3m82) provides important project updates, tips and tricks of using RoboSats, and other privacy-centric commentary. Questions and engagement are welcome. Keep in mind: problems requiring RoboSats staff support should be directed to the main SimpleX group chat instead, where responses are quicker and staff can further investigate your problem.
-- **Nostr:** [npub1p2psats79rypr8lpnl9t5qdekfp700x660qsgw284xvq4s09lqrqqk3m82](https://snort.social/p/npub1p2psats79rypr8lpnl9t5qdekfp700x660qsgw284xvq4s09lqrqqk3m82). Relays Twitter tweets and similarly responds to questions. While character limit is no issue, it's still best to direct your questions to the aforementioned public Telegram support group for a faster response from community members!
-
-Discussion about code changes happens in GitHub issues and pull requests (PRs).
+- **Matrix:** [RoboSats Development Group](https://matrix.to/#/#robosats:matrix.org). Main developer communication group chat where open and technical discussions about development takes place. Discussion about code changes happens in GitHub issues and pull requests (PRs).
## Contributor Workflow
diff --git a/docs/_pages/contribute/02-languages.md b/docs/_pages/contribute/02-languages.md
index e82c292f..55c8a582 100644
--- a/docs/_pages/contribute/02-languages.md
+++ b/docs/_pages/contribute/02-languages.md
@@ -11,9 +11,9 @@ src: "_pages/contribute/02-languages.md"
---
-RoboSats is a way to exchange BTC for **any currency of the world**. As such, many users might only find this tool useful if it is available in a language they understand. Translating RoboSats into a new language is one of the most valuable contributions to the project! It makes the platform available to new audiences, increases the reach of this cool freedom tool, and subsequently increases order book liquidity for even more users to stack Sats privately.
+RoboSats is a way to exchange bitcoin for **any currency of the world**. As such, many users might only find this tool useful if it is available in a language they understand. Translating RoboSats into a new language is one of the most valuable contributions to the project! It makes the platform available to new audiences, increases the reach of this cool freedom tool, and subsequently increases order book liquidity for even more users to stack Sats privately.
-There isn't a lot of text in RoboSats; however, it might be best to split the work with another contributor. You can reach out to the [Telegram communities](https://learn.robosats.com/contribute/code/#communication-channels) and find users willing to split the task.
+There isn't a lot of text in RoboSats; however, it might be best to split the work with another contributor. You can reach out to the [RoboSats communities](https://learn.robosats.com/contribute/code/#communication-channels) and find users willing to split the task.
## How To Contribute a New Translation
@@ -45,7 +45,7 @@ Some text is high priority, other text is low priority. Some keys are likely to
Yes, please! 😉
### 8. **Understand the context; where will this string be displayed?**
-Literal translations might not work well in some languages. While in English the wording is always similar regardless of the position in the UI, in some languages it might be very different if you are translating a button (the user is taking an action) or if you are simply translating a tooltip. It might be clever to translate the strings while looking at the app. However, many strings can only be found while trading. The testnet RoboSats site is great for this use! You can explore the whole app by simply interacting with it using a testnet Lightning wallet. However, if you cannot find where a string is displayed, it might be faster to simply write a message on the [Telegram group](https://t.me/robosats).
+Literal translations might not work well in some languages. While in English the wording is always similar regardless of the position in the UI, in some languages it might be very different if you are translating a button (the user is taking an action) or if you are simply translating a tooltip. It might be clever to translate the strings while looking at the app. However, many strings can only be found while trading. The testnet RoboSats site is great for this use! You can explore the whole app by simply interacting with it using a testnet Lightning wallet. However, if you cannot find where a string is displayed, it might be faster to simply write a message on the [SimpleX group](https://simplex.chat/contact#/?v=1-2&smp=smp%3A%2F%2F0YuTwO05YJWS8rkjn9eLJDjQhFKvIYd8d4xG8X1blIU%3D%40smp8.simplex.im%2FyEX_vdhWew_FkovCQC3mRYRWZB1j_cBq%23%2F%3Fv%3D1-2%26dh%3DMCowBQYDK2VuAyEAnrf9Jw3Ajdp4EQw71kqA64VgsIIzw8YNn68WjF09jFY%253D%26srv%3Dbeccx4yfxxbvyhqypaavemqurytl6hozr47wfc7uuecacjqdvwpw2xid.onion&data=%7B%22type%22%3A%22group%22%2C%22groupLinkId%22%3A%22hWnMVPnJl-KT3-virDk0JA%3D%3D%22%7D).
### 9. **Congratulate yourself!!**
Seriously. It's so awesome you are helping build freedom tools!
diff --git a/docs/_pages/contribute/04-guides.md b/docs/_pages/contribute/04-guides.md
index 1d1c0186..8c6dd207 100644
--- a/docs/_pages/contribute/04-guides.md
+++ b/docs/_pages/contribute/04-guides.md
@@ -19,7 +19,7 @@ Guides, tutorials, demos, etc. are invaluable additions to the RoboSats website.
In order to provide your readers/viewers the most accurate information about the platform, consider briefly checking out the RoboSats documentation here on [learn.robosats.com](https://learn.robosats.com). There you will find many characteristics and aspects of RoboSats in fine detail, as well as some [previously created tutorials](https://learn.robosats.com/watch/en/) which may help serve as reference for your tutorial.
-If you have lingering questions that are not answered in the documentation, then please do not hesitate to reach out and ask in the [public Telegram support groups](https://learn.robosats.com/contribute/code/#communication-channels).
+If you have lingering questions that are not answered in the documentation, then please do not hesitate to reach out and ask in the [public SimpleX support group](https://learn.robosats.com/contribute/code/#communication-channels).
If you are trying to do a live demonstration of RoboSats for a meetup or conference event, there are willing robot peers in the aforementioned Telegram groups who would be thrilled to lend a robotic hand! There is nothing cooler (and more helpful) for first-timers than seeing RoboSats live and in action!
diff --git a/docs/_pages/contribute/05-art.md b/docs/_pages/contribute/05-art.md
index a5225b73..9ac18782 100644
--- a/docs/_pages/contribute/05-art.md
+++ b/docs/_pages/contribute/05-art.md
@@ -15,7 +15,7 @@ Got artistic talent? Consider drawing fan art and promoting RoboSats through swe
## Ideas
-There really is no limit here! If you want to brainstorm, feel free to message the [public Telegram support groups](https://learn.robosats.com/contribute/code/#communication-channels). The coordinator for RoboSats art is [Red_Purdy](https://twitter.com/Red_Purdy) and can help provide ideas!
+There really is no limit here! If you want to brainstorm, feel free to message the [public SimpleX support groups](https://learn.robosats.com/contribute/code/#communication-channels). The coordinator for RoboSats art is [@Red_Purdy](https://twitter.com/Red_Purdy) and can help provide ideas!
One example of using art to create community engagement includes [Telegram stickers](https://t.me/addstickers/Robosats1). The linked stickers features the quasi mascot Robotoshi.
diff --git a/docs/_pages/contribute/06-outreach.md b/docs/_pages/contribute/06-outreach.md
index 8e1451f8..8195fb77 100644
--- a/docs/_pages/contribute/06-outreach.md
+++ b/docs/_pages/contribute/06-outreach.md
@@ -19,7 +19,7 @@ The best we can do is reason with users of why they should value their privacy a
Social media is a great opportunity for word-of-mouth advertising of RoboSats. If you had a great experience using RoboSats or have interesting insight to share about the project, please do say something! Shout it from the robo-heavens!
-For example, you could create a tweet and tag the [RoboSats Twitter](https://twitter.com/RoboSats) account so that we can retweet it! Note that not all tweets are guaranteed retweets. Similarly, you could post on Nostr and tag RoboSats Nostr (npub1p2psats79rypr8lpnl9t5qdekfp700x660qsgw284xvq4s09lqrqqk3m82) account so that it can be shared with others.
+For example, you could post on Nostr and tag the RoboSats Nostr account (npub1p2psats79rypr8lpnl9t5qdekfp700x660qsgw284xvq4s09lqrqqk3m82) so that it can be shared with others!
Any help would be greatly appreciated in this sector! More order book liquidity attracts more users and thus more users get to take advantage of buying and selling bitcoin privately!
diff --git a/docs/_pages/docs/00-quick-start/00-quicks-start-guide.md b/docs/_pages/docs/00-quick-start/00-quicks-start-guide.md
index 861f40d3..1eab1630 100644
--- a/docs/_pages/docs/00-quick-start/00-quicks-start-guide.md
+++ b/docs/_pages/docs/00-quick-start/00-quicks-start-guide.md
@@ -6,12 +6,12 @@ sidebar:
title: 'Quick Start'
nav: docs
---
-RoboSats is an easy way to privately exchange Bitcoin for national currencies It simplifies the peer-to-peer experience and makes use lightning hold invoices to minimize custody and trust requirements.
+RoboSats is an easy way to privately exchange bitcoin for national currencies. It simplifies the peer-to-peer experience and makes use of [lightning hold invoices](/docs/escrow/#what-is-a-hold-invoice) to minimize custody and trust requirements between peers. You can also use RoboSats to perform peer-to-peer [swaps](/docs/swaps/).
-**Let's go!** To start using RoboSats you only need a [ Lightning Wallet](/docs/wallets/) and a [TOR enabled browser](/docs/tor/).
+**Let's go!** To start using RoboSats, you only need a [ Lightning Wallet](/docs/wallets/) and a [TOR-enabled browser](/docs/tor/).
{: .notice--primary}
1. Get a Lightning [Wallet](/docs/wallets/)
-2. Get [Tor Browser](https://www.torproject.org/download/)
-3. Access [RoboSats](/docs/access/)
-4. Check the [tutorials](/watch/en/)
\ No newline at end of file
+2. Get [TOR browser](https://www.torproject.org/download/), or a supported [alternative](/docs/acces/)
+3. Access [RoboSats](/docs/acces/)
+4. Check the [tutorials](/watch/en/) as needed!
diff --git a/docs/_pages/docs/00-quick-start/01-lightning.md b/docs/_pages/docs/00-quick-start/01-lightning.md
index 31e55bf1..57fb5c09 100644
--- a/docs/_pages/docs/00-quick-start/01-lightning.md
+++ b/docs/_pages/docs/00-quick-start/01-lightning.md
@@ -2,9 +2,32 @@
layout: single
title: "The Lightning Network"
permalink: /docs/lightning/
+toc: true
+toc_sticky: true
sidebar:
title: 'Lightning Network'
nav: docs
src: "_pages/docs/00-quick-start/01-lightning.md"
---
-{% include wip %}
\ No newline at end of file
+
+The Lightning Network, or simply referred to as LN, is an off chain (layer two) micropayment network featuring low fees and instant payments. RoboSats leverages the advantages of transacting off chain to provide users a quick and inexpensive experience! There are many great resources out there to learn more about how the Lightning Network works. Check out ["Mastering the Lightning Network"](https://github.com/lnbook/lnbook) for one such great resource.
+
+RoboSats is experimental, and as such is currently supported by an [experimental coordinator node](https://amboss.space/node/0282eb467bc073833a039940392592bf10cf338a830ba4e392c1667d7697654c7e). The upcoming [federation upgrade](https://github.com/RoboSats/robosats/pull/601) allows anyone to become a coordinator node and support the RoboSats federation, thereby creating a decentralized but unified order book consisting of federation members competing against each other to attract traders.
+
+## **Using the Lightning Network**
+
+A prerequisite to using LN is a wallet. It is highly recommended to use a non-custodial and FOSS wallet where only you hold the keys. Custodial and closed source wallets can collect information on your transactions, account information, and potentially other metadata. Also remember that any funds kept on LN are not considered cold storage, but are in a "hot" wallet connected to the internet. For the purpose of using RoboSats, it is recommended to use a wallet that plays well with [Lightning hold invoices](/docs/escrow/#what-is-a-hold-invoice), refer to [Understand > Wallets](/docs/wallets/) for a non-exhaustive list of LN wallet compatibility.
+
+When using Lightning, payments are done via invoices. The receiver of Sats gives an invoice to the sender of Sats, often in the form of a QR code, requesting the sender to pay the specific amount of Sats requested by the invoice. The invoice begins with the prefix "lnbc" and can be decoded to inspect the contents of it, like the amount of Sats sent, the node ID the Sats were sent to, any descriptions that were provided, etc.
+
+Lightning as it stands is not completely private. Users should take care to not reveal sensitive information when sending and receiving payments on LN. Do not trust a closed source and custodial wallet to respect your information, you can gain a greater degree of privacy if using a non-custodial wallet. As well, refer to [Best Practices > Proxy Wallets](/docs/proxy-wallets/) for more information on privacy concerns when receiving Sats over LN.
+
+## **Lightning Network "Shenanigans"**
+
+While very infrequent, it can happen that some intermediary routing node goes offline or the transaction becomes "stuck" while attempting a payment. Informally referred to as Lightning Network shenanigans, issues like this are due to current limitations of LN. It solves by itself after a few hours or maximum of a couple days.
+
+When buying bitcoin (receiving Sats on LN), the invoice you provide can fail in routing and take many retries. RoboSats attempts to send the Sats three times and, if it fails, will request a new invoice to try again. Rinse and repeat until it sends! During this time, your funds are considered safe.
+
+In the event of such a scenario, securely back up your robot's private token and check back on your order payout from time to time. If the issue persists, do not hesitate to reach out to the [SimpleX support group](/contribute/code/#communication-channels) so that RoboSats staff can investigate.
+
+{% include improve %}
diff --git a/docs/_pages/docs/00-quick-start/02-tor.md b/docs/_pages/docs/00-quick-start/02-tor.md
index f9511b1c..d66b8384 100644
--- a/docs/_pages/docs/00-quick-start/02-tor.md
+++ b/docs/_pages/docs/00-quick-start/02-tor.md
@@ -2,9 +2,22 @@
layout: single
title: "The TOR Network"
permalink: /docs/tor/
+toc: true
+toc_sticky: true
sidebar:
title: 'TOR'
nav: docs
src: "_pages/docs/00-quick-start/02-tor.md"
---
-{% include wip %}
\ No newline at end of file
+
+[The Onion Router](https://www.torproject.org/download/), or TOR for short, is a FOSS and privacy-oriented internet browser that enables anonymous communication. Thousands of volunteer relays make up the network to direct internet traffic worldwide for free. RoboSats utilizes TOR as a layer of privacy and therefore [accessing RoboSats](/docs/access/#-privately-with-tor) via TOR is strongly recommended.
+
+A supported alternative to TOR is the [I2P project](/docs/access/#-privately-with-i2p). You can also use a TOR-compatible browser, like Brave, but users should always assume they are being spied on and take care to access RoboSats safely.
+
+## **Issues With TOR**
+
+Utilizing TOR has drawbacks such as lower network connection speeds, sporadic [downtime](https://status.torproject.org/) due to DDoS, and imperfect privacy with regards to website fingerprinting techniques.
+
+Keep this in mind when using RoboSats. It is important to back up your robot's secret token in the event TOR network experiences connection issues.
+
+{% include improve %}
diff --git a/docs/_pages/docs/00-quick-start/03-access.md b/docs/_pages/docs/00-quick-start/03-access.md
index 82d14052..800d6b33 100644
--- a/docs/_pages/docs/00-quick-start/03-access.md
+++ b/docs/_pages/docs/00-quick-start/03-access.md
@@ -11,57 +11,68 @@ src: "_pages/docs/00-quick-start/03-access.md"
---
## Privately with TOR
-A safe and very private way to use RoboSats is through the Onion address. You need [Tor Browser](/docs/tor/).
+
+A safe and very private way to access RoboSats is through the Onion address. You need [TOR browser](/docs/tor/) and access via the link:
> [robosats6tkf3eva7x2voqso3a5wcorsnw34j
veyxfqi2fu7oyheasid.onion](http://robosats6tkf3eva7x2voqso3a5wcorsnw34jveyxfqi2fu7oyheasid.onion/)
-**Private:** your connection will be encrypted end-to-end and relaid by several layers of nodes making tracking harder.
+**Private:** Your connection is encrypted end-to-end and relaid by several layers of nodes, thus making tracking harder.
{: .notice--primary}
+## Privately with TOR-enabled Android App
+
+RoboSats can be safely and privately accessed via the Android app. The app is available via the RoboSats GitHub release page:
+
+> [Download the latest release of the universal RoboSats APK for Android](https://github.com/RoboSats/robosats/releases)
+
## Privately with I2P
-I2P is another safe and private way to use RoboSats. You need to install [I2P](https://geti2p.com/en/download).
+
+I2P is another safe and private way to access RoboSats. You need [I2P browser](https://geti2p.com/en/download) and access via the link:
> [robosats.i2p?i2paddresshelper=r7r4sckft
6ptmk4r2jajiuqbowqyxiwsle4iyg4fijtoordc6z7a.b32.i2p](http://robosats.i2p?i2paddresshelper=r7r4sckft6ptmk4r2jajiuqbowqyxiwsle4iyg4fijtoordc6z7a.b32.i2p)
## Unsafely in Clearnet
-There is an unsafe way to view RoboSats without TOR that relies on third party tor2web services. With this URL you can access RoboSats from any browser, but using this URL is **highly unrecommended!**
+
+There is an unsafe way to view the RoboSats order book without TOR that relies on third party tor2web services. With this URL, you can access RoboSats from any browser, but using this URL is **strongly ill-advised!**
> [unsafe.robosats.com](https://unsafe.robosats.com)
-**Unsafe:** your privacy can be compromised if you use the unsafe clearnet url in a regular web browser.
+**Unsafe:** Your privacy can be compromised if you use the unsafe clearnet URL in a regular web browser.
{: .notice--secondary}
-TIf you use the clearnet url, you should assume are being spied on. However, most sensitive RoboSats features are disabled (e.g. the chat) so users cannot give away sensitive personal data. Use this URL only to have a quick look to the book orders. Never use it for trading or logging into active Robot avatars.
+If you use the clearnet URL, you should assume you are being spied on. However, most sensitive features on RoboSats are disabled (e.g., the P2P chat) so users cannot give away sensitive personal data. Only use the clearnet URL to take a quick peek at the order book. Never use it for trading or logging into manage active orders.
-## All in one
+## All-in-One URL
-In order to more easily remember how to access, we have set up robosats.com . If you are using Tor Browser, it will directly take you to the Onion Site. Otherwise, it will take you to the unsafe site.
+To keep it simple, the URL "robosats.com" has been created to serve as an easy-to-remember and all-in-one link for browsers. If you are using TOR or I2P browser, then you are directed to the Onion or I2P site, respectively. Otherwise, you are directed to the unsafe clearnet site.
> [robosats.com](https://robosats.com)
-
## Others
+
### Testnet
-You can practice and test all of the functionalities in RoboSats without of losing funds by using [Testnet Bitcoin](https://en.bitcoin.it/wiki/Testnet). All you need is a Testnet Lightning wallet and access the testnet platform
+
+You can practice and test all of the functionalities in RoboSats without risk of losing funds by using [testnet bitcoin](https://en.bitcoin.it/wiki/Testnet). All you need is a testnet Lightning wallet and to access the testnet platform via the link:
> [robotestagw3dcxmd66r4rgksb4nmmr43fh7
7bzn2ia2eucduyeafnyd.onion](http://robotestagw3dcxmd66r4rgksb4nmmr43fh77bzn2ia2eucduyeafnyd.onion/)
-Or unsafely on the testnet clearnet bridge.
+Or, unsafely access the testnet clearnet bridge via the link:
> [unsafe.testnet.robosats.com](http://unsafe.testnet.robosats.com)
### Onion Mirrors
-It is possible to access the **testnet** platform on the port 8001 of the mainnet onion
+It is possible to access the **testnet** platform on the port 8001 of the mainnet Onion:
> [robosats6tkf3eva7x2voqso3a5wcorsnw34j
veyxfqi2fu7oyheasid.onion:8001](http://robosats6tkf3eva7x2voqso3a5wcorsnw34jveyxfqi2fu7oyheasid.onion:8001)
-It is also possible to access the **mainnet** platform on the port 8001 of the testnet onion
+It is also possible to access the **mainnet** platform on the port 8001 of the testnet Onion:
> [robotestagw3dcxmd66r4rgksb4nmmr43fh7
7bzn2ia2eucduyeafnyd.onion:8001](http://robotestagw3dcxmd66r4rgksb4nmmr43fh77bzn2ia2eucduyeafnyd.onion:8001)
### Clearnet Mirrors
-There are several tor2web services that serve as mirrors in case one of them is unavailable
+
+There are several tor2web services that serve as mirrors in case one of them is unavailable:
> [unsafe.robosats.com](https://unsafe.robosats.com/)
> [unsafe2.robosats.com](https://unsafe2.robosats.com/)
@@ -69,5 +80,4 @@ There are several tor2web services that serve as mirrors in case one of them is
> [unsafe.testnet.robosats.com](http://unsafe.testnet.robosats.com/)
> [unsafe2.testnet.robosats.com](http://unsafe2.testnet.robosats.com/)
-
{% include improve %}
diff --git a/docs/_pages/docs/03-understand/01-trade-pipeline.md b/docs/_pages/docs/03-understand/01-trade-pipeline.md
index b2d7b74a..5b5e468e 100644
--- a/docs/_pages/docs/03-understand/01-trade-pipeline.md
+++ b/docs/_pages/docs/03-understand/01-trade-pipeline.md
@@ -3,13 +3,33 @@ layout: single
classes: wide
title: "Trade Pipeline"
permalink: /docs/trade-pipeline/
+toc: true
+toc_sticky: true
sidebar:
title: 'Trade Pipeline'
nav: docs
src: "_pages/docs/03-understand/01-trade-pipeline.md"
---
-# In images
+The RoboSats trade pipeline is straightforward and streamlined. The general order flow when making and taking orders is laid out below in numerical steps and in a flowchart.
+
+## Order Flow in Numerical Steps
+
+Alice wants to buy Sats privately. This is step-by-step what happens when she buys using RoboSats:
+
+1. Alice generates an avatar (AdequateAlice01) using her private random token.
+2. Alice safely stores 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 Sats, 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 Sats with a hold invoice. While Alice submits her payout invoice.
+7. In 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 Sats are sent to Alice.
+10. Bob and Alice's bonds return automatically, since they complied by the rules.
+11. The bonds would be charged (lost) in case of unilateral cancellation or cheating (lost dispute).
+
+## Order Flow in Flowchart
@@ -18,20 +38,4 @@ src: "_pages/docs/03-understand/01-trade-pipeline.md"
-# In simple words
-Alice wants to buy Sats privately. This is step-by-step what happens when she buys using RoboSats.
-
-
-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 by the rules.
-11. The bonds would be charged (lost) in case of unilateral cancellation or cheating (lost dispute).
-
-{% include improve %}
\ No newline at end of file
+{% include improve %}
diff --git a/docs/_pages/docs/03-understand/02-robots.md b/docs/_pages/docs/03-understand/02-robots.md
index 7c5244eb..be6e6f5a 100644
--- a/docs/_pages/docs/03-understand/02-robots.md
+++ b/docs/_pages/docs/03-understand/02-robots.md
@@ -24,7 +24,7 @@ Prioritizing absolute privacy for the end-user provides the highest degree of pr
Platforms collecting personal information present a real risk to the end-user. Data breaches in just the past decade have altogether leaked billions of users' sensitive information through a combination of hackings and poor platform security.
-Privacy is extremely important for RoboSats; however, your transactions on RoboSats are only as private as you make them. Users should take care to use privacy-preserving methods when interacting with RoboSats and your robot peers. Refer to [Quick Start > Access](https://learn.robosats.com/docs/access/) for additional information.
+Privacy is extremely important for RoboSats; however, your transactions on RoboSats are only as private as you make them. Users should take care to use privacy-preserving methods when interacting with RoboSats and your robot peers. Refer to [Quick Start > Access](/docs/access/) for additional information.
## **Robot Re-Use: Not Recommended**
@@ -42,7 +42,7 @@ As stated, robot re-use is ill-advised and can ultimately become a detriment to
RoboSats references the source code for RoboHash.org as a quick way to generate fresh avatars for a website. Your robot is "built" from a unique token, a random string of characters (ZD3I7XH...), where only those characters in their exact order can generate that exact robot avatar.
-A token is automatically generated for you each time the RoboSats webpage is accessed. Users may re-generate as many randomized tokens as they'd like, which is strongly encouraged after each trade. As a note, you can enter a token of sufficient entropy created by yourself instead of relying on RoboSats. Because only you know the token, it is wise to safely back up your token.
+A token is automatically generated for you each time the RoboSats webpage is accessed. Users may re-generate as many randomized tokens as they'd like, which is strongly encouraged after each trade. As a note, you can enter a token of sufficient entropy created by yourself instead of relying on RoboSats; but because only you know the token, it is wise to safely back up your token.
Under the hood, token creation in the RoboSats homepage is the process of generating and encrypting your PGP private key with your token on the client side of the app. The end-user requests from the RoboSats node an avatar and nickname generated from your encrypted token and returns to you the corresponding robot identity. See the graphic below:
@@ -52,6 +52,6 @@ Under the hood, token creation in the RoboSats homepage is the process of genera
Your identity may be concealed by a robot identity, yet that is no excuse for being a difficult peer during trades. Other robots have robo-feelings too! Be succinct and respectful when chatting with peers; this will make for an easier and smoother experience on RoboSats. Never share more information than is absolutely necessary to complete the order.
-All communications in RoboSats are PGP encrypted. The encrypted peer-to-peer chat messages are signed by each robot peer which proves no one intercepted the chat and is useful for resolving disputes. Refer to [Best Practices > PGP Encryption](https://learn.robosats.com/docs/pgp-encryption/) for additional information.
+All communications in RoboSats are PGP encrypted. The encrypted peer-to-peer chat messages are signed by each robot peer which proves no one intercepted the chat and is useful for resolving disputes. Refer to [Best Practices > PGP Encryption](/docs/pgp-encryption/) for additional information.
{% include improve %}
diff --git a/docs/_pages/docs/03-understand/03-premium.md b/docs/_pages/docs/03-understand/03-premium.md
index 3411c8ad..6c88d8d3 100644
--- a/docs/_pages/docs/03-understand/03-premium.md
+++ b/docs/_pages/docs/03-understand/03-premium.md
@@ -22,7 +22,7 @@ Choose a competitive premium and incentivize fellow robots to provide liquidity
Create an order, then input the "Premium over Market (%)" which can be a positive, negative, or zero percentage value. By default, the order premium is priced relative to the bitcoin-fiat market rate.
-Or, instead of the default setting, makers can select the explicit pricing method by choosing an exact amount of satoshis to exchange for the fiat amount given.
+Or, instead of the default setting, makers can select the explicit pricing method** by choosing an exact amount of Sats to exchange for the fiat amount given.
When selecting a premium, consider the payment method(s) and amount you have chosen; these, along with your desired premium, will compete with other live orders to incentivize and entice robot takers. Experiment with different premiums to find what works best for your specific orders.
@@ -33,15 +33,23 @@ In short:
* **Negative** premium: trade BTC at a discount with respect to the average price in centralized exchanges.
* **Zero** premium: trade BTC at no price difference with respect to the average price in centralized exchanges.
* **Relative** pricing method: let the price premium move with the bitcoin-fiat market rate.
-* **Explicit** pricing method: set a price premium using a fixed amount of satoshis.
+* **Explicit** pricing method: set a price premium using a fixed amount of Sats.
* **Premium Rank**: indicates how your order premium ranks among all public orders with the same currency, ranging from 0% (smallest premium) to 100% (largest premium).
-When making the order, you will see a text summary describing your order below the "Create Order" button. For example, buying bitcoin for $100 at a +5.00% premium relative to the market rate would read: "Create a BTC buy order for 100 USD at a 5% premium."
+When making the order, you will see a text summary describing your order below the "Create Order" button. For example, buying bitcoin for $100 at a +5.00% premium relative to the market rate would read: "Buy BTC for 100 USD at a 5% premium"
If a mistake is made when selecting a premium, or the order is not taken within your time preference, then the order can be easily cancelled to make a new one.
Note that the percent value is limited to within two decimal places. Furthermore, format the decimal values using "." (point) and not "," (comma) as the decimal separator.
+So... what *should* you choose for a premium? Generally speaking, most robots want their order taken fast. A simple approach when deciding a competitive premium is to first take a peek at the existing order book. Review the existing offers and notice the premiums that are associated with your desired currency and payment method. Make your order more desirable than others by choosing a premium that is slightly higher (buyer) or lower (seller) than any existing order premium associated with your desired currency and payment method.
+
+For example, you (buyer) find that the highest premium across existing orders associated with your desired currency and payment method is at 5% premium. Create an order with the exact same conditions but a slightly higher premium than your competitor. Now, sellers browsing the order book will compare orders and notice that your order gives them more fiat for their precious Sats and will be more tempted to take your order!
+
+But your competing order makers might notice their existing order no longer has the highest premium on the order book and thus cancel their order to create a new one for some premium higher than yours... Watch out for a premium war!
+
+***The explicit pricing method has been removed as an option for technical reasons, but could potentially come back in future updates. Currently, order pricing is only relative to the market rate.*
+
## **Why Have Premiums?**
Naturally, many robots want to buy bitcoin but very few want to sell; subsequently, there is high demand for exchanging bitcoin privately. Premiums are simply the byproduct of that supply and demand relationship in an anonymous, peer-to-peer marketplace.
diff --git a/docs/_pages/docs/03-understand/04-bonds.md b/docs/_pages/docs/03-understand/04-bonds.md
index c4ab6b71..6d3de559 100644
--- a/docs/_pages/docs/03-understand/04-bonds.md
+++ b/docs/_pages/docs/03-understand/04-bonds.md
@@ -12,59 +12,62 @@ src: "_pages/docs/03-understand/04-bonds.md"
The fidelity bond is a small deposit that the user "locks" which will become unlocked after the trade is completed; however, users can lose their bond if they fail to follow the obligations of the contract.
-The RoboSats trade pipeline utilizes fidelity bonds to incentivize both the order maker and taker to play by the rules and not cheat their fellow robot. More specifically, the bonds are [hold invoices](https://github.com/lightningnetwork/lnd/pull/2022) using the Lightning Network; it's the tech that makes RoboSats possible!
+The RoboSats trade pipeline utilizes fidelity bonds to incentivize both the order maker and taker to play by the rules and not cheat their fellow robot. More specifically, the bonds are [hold invoices](https://github.com/lightningnetwork/lnd/pull/2022) using the Lightning Network; it's the tech that makes RoboSats possible! Refer to [Understand > Trade Escrow > What is a Hold Invoice?](/docs/escrow/#what-is-a-hold-invoice) for understanding how hold invoices work in practice.
By default, the bond is {{site.robosats.default_bond_size}}% of the total trade amount. Alternatively, order makers can customize this amount to be anywhere from {{site.robosats.min_bond_size}}% to {{site.robosats.max_bond_size}}%. Larger bonds mean more "skin in the game" that is required to trade.
-The bond does not leave your Lightning wallet, but please know some wallets play nicer with RoboSats than others due to the nature of the Lightning hold invoice mechanic. Refer to [Understand > Wallets](https://learn.robosats.com/docs/wallets/) for additional information.
+The bond does not leave your Lightning wallet, but please know some wallets play nicer with RoboSats than others due to the nature of the Lightning hold invoice mechanic. Refer to [Understand > Wallets](/docs/wallets/) for additional information.
-*Note: The option allowing "Bondless Takers" is in the works but not available at the moment.*
+*Note: The option allowing "Bondless Takers" is not available.*
## **How to Lock a Bond**
-First, refer to [Understand > Wallets](https://learn.robosats.com/docs/wallets/) for compatible Lightning wallets that will help make using RoboSats a smoother experience. Depending on the wallet, the invoice might show as a payment that is in transit, frozen, or even appearing to fail. Check the wallet compatability list!
+First, refer to [Understand > Wallets](/docs/wallets/) for compatible Lightning wallets that will help make using RoboSats a smoother experience. Depending on the wallet, the invoice might show as a payment that is in transit, frozen, or even appearing to fail. Check the wallet compatability list!
+
+Bonds are not linked to orders. You can use any Sats to fund the bond invoice. There is no link between the bond and your order, nor any link between the bond and your payout invoice.
Read the relevant guide depending on if you are making or taking the order:
-* **Maker**: Select "Make Order" and modify the order conditions to your liking. The order can be customized to require a fidelity bond other than the default {{site.robosats.default_bond_size}}% of the total trade amount, ranging anywhere from {{site.robosats.min_bond_size}}% to {{site.robosats.max_bond_size}}%. Once complete, confirm with "Create Order" and then use the following QR code found in the "Contract Box" with your Lightning wallet to lock the indicated amount of sats for your fidelity bond. You can always cancel the untaken order while it is live and the bond will automatically unlock; however, if you try to cancel the order after it gets taken, you will forfeit your bond. *Note: Be prepared with your wallet beforehand because the order box expires in ten minutes.*
-* **Taker**: Browse the order book and find an order to your liking. Simply select the "Take Order" option and then use the following QR code found in the "Contract Box" with your Lightning wallet to lock the indicated amount of sats for your fidelity bond. *Note: Be prepared with your wallet beforehand because the order box expires in four minutes. If you do not proceed, the taken order is made public again.*
+* **Maker**: Select "Make Order" and modify the order conditions to your liking. The order can be customized to require a fidelity bond other than the default {{site.robosats.default_bond_size}}% of the total trade amount, ranging anywhere from {{site.robosats.min_bond_size}}% to {{site.robosats.max_bond_size}}%. Once complete, confirm with "Create Order" and then use the QR code presented to you with your Lightning wallet to lock the indicated amount of Sats for your fidelity bond. You can always cancel the untaken order while it is live and the bond will automatically unlock; however, if you try to cancel the order after it gets taken, you will forfeit your bond. *Note: Be prepared with your wallet beforehand because the order box expires in ten minutes.*
+* **Taker**: Browse the order book and find an order to your liking. Simply select the "Take Order" option and then use the QR code presented to you with your Lightning wallet to lock the indicated amount of sats for your fidelity bond. *Note: Be prepared with your wallet beforehand because the order box expires in four minutes. If you do not proceed, the taken order is made public again.*
-After the trade is completed and both robots are satisfied, the maker and taker bonds are unlocked. Technically, the locked bond never left your wallet; but take caution, if you fail to follow the contract obligations by trying to cheat or cancelling unilaterally, you will forfeit your fidelity bond.
+After the trade is completed and both robots held up to their end of the deal, the maker and taker bonds are unlocked. Technically, the locked bond never left your wallet; but take heed, if you fail to follow the contract obligations by trying to cheat or cancelling unilaterally, you will forfeit your fidelity bond.
Your wallet may take a while for funds to show as unlocked on your account balance. Some wallets have difficulty with recognizing the Lightning hold invoice as a temporary hold on your funds.
-If the issue persists, please reach out to the RoboSats Telegram group; but beware of scammers that may directly contact you and impersonate RoboSats staff! RoboSats staff will never directly contact you first. See [Contribute > Code > Communication Channels](https://learn.robosats.com/contribute/code/#communication-channels) for available Telegram groups.
+If the issue persists, please reach out to the RoboSats SimpleX group; but beware of scammers that may directly contact you and impersonate RoboSats staff! RoboSats staff will never directly contact you first. See [Contribute > Code > Communication Channels](/contribute/code/#communication-channels) for the public SimpleX support group.
## **Losing Your Bond**
-There are basically five conditions that causes a user to lose their bond:
+There are basically four conditions that causes a user to lose their bond:
* Cheat or deceive your peer (and lose the order dispute)
-* Unilaterally cancel the order without your peer's collaboration
-* Fail to submit the payment invoice as the bitcoin buyer within the given time limit
-* Fail to submit the trade escrow as the bitcoin seller within the given time limit
+* Unilaterally cancel the order without your peer's collaboration during the peer-to-peer chat stage
+* Fail to submit the escrow invoice (seller) or payment invoice (buyer) within the given time limit
* Fail to confirm the fiat was received as the bitcoin seller
-The conditions above are expanded upon in additional detail below.
+Note that you do not lose your bond as an order maker if you cancel your order *before* it has been taken by a peer. The conditions above are expanded upon in additional detail below.
If the time limit for submitting the invoice (buyer) or locking the escrow (seller) runs out, then the order will expire and the robot who did not hold up to their end of the deal will lose the bond. Half of the lost bond goes to the honest robot as compensation for wasted time.
-Therefore, don't forget about your order because once a robot takes it and locks their fidelity bond, you could lose your bond since the timer might expire. Take care to remember your order and back up your robot's unique token!
+Therefore, don't forget about your order because once a robot takes it and locks their fidelity bond, you could lose your bond since the timer might expire. Take care to remember your order and back up your robot's unique token! Keep in mind this token is only known by you and, without it, your unique robot avatar is not recoverable.
If you received fiat but neglect to click "Confirm Fiat Received" on your end, then you risk losing your bond since a dispute is automatically opened and the RoboSats staff will find you failed to follow the rules of the contract.
-Due to the time limits involved in the order process, it is recommended to use instant fiat payment methods which help reduce the chances of losing your bond. Refer to [Best Practices > Payment Methods](https://learn.robosats.com/docs/payment-methods/) for additional information.
+Due to the time limits involved in the order process, it is recommended to use instant fiat payment methods which help reduce the chances of losing your bond. Refer to [Best Practices > Payment Methods](/docs/payment-methods/) for additional information.
Opening a dispute just to cancel an order is not recommended because one of the two traders will lose their fidelity bond, barring exceptional cases that are up to the discretion of the RoboSats staff.
+For orders that allow takers to choose from a range, peers only risk losing an amount of Sats proportional to the amount of Sats taken in the order.
+
As a sidenote, if RoboSats suddenly vanished or was shutdown, then bonds are automatically unlocked since they technically never left your wallet.
## **Don't Have Any Bitcoin for Bonds?**
-Because the bonds require a Lightning hold invoice, what are you to do if you have no bitcoin to begin with? Even though the bond is typically just {{site.robosats.default_bond_size}}% of your total trade amount, this presents a real barrier to using RoboSats for the first time if your sat stack is non-existent.
+Because the bonds require a Lightning hold invoice, what are you to do if you have no bitcoin to begin with? Even though the bond is typically just {{site.robosats.default_bond_size}}% of your total trade amount, this presents a real barrier to using RoboSats for the first time if your Sat stack is non-existent.
-Currently, bondless takers are not available; however, please know this is in the works! Bondless takers present a greater risk to the order maker since the taker has no skin in the game. It can be reasonable to expect higher premiums on orders that allow bondless takers.
+Currently, bondless takers are not available but are in consideration for a future update. Bondless takers present a greater risk to the order maker since the taker has no skin in the game. It would be reasonable to expect higher premiums on orders that allow bondless takers.
-There are a myriad of available apps and services where very small amounts of bitcoin can be earned. RoboSats does not endorse a specific app, but users have reported success with apps like [Stacker News](https://stacker.news/), [Fountain](https://www.fountain.fm/), [Carrot](https://www.earncarrot.com/), [THNDR](https://www.thndr.games/), etc.
+There are a myriad of available apps and services where very small amounts of bitcoin can be earned. RoboSats does not endorse a specific app, but users have reported success with apps like [Stacker News](https://stacker.news/), [Fountain](https://www.fountain.fm/), [Bitcoin Magazine App](https://app.bitcoinmagazine.com/), [THNDR](https://www.thndr.games/), etc.
-Since the bond is a temporary hold on your funds, you could even borrow satoshis from a friend just for the fidelity bond. After the bond is unlocked from a successful trade, simply return the funds to your friend!
+Since the bond is just a temporary hold on funds, you could have a friend cover the fidelity bond by paying the QR code for you. The bond is instantly unlocked following a successful trade!
{% include improve %}
diff --git a/docs/_pages/docs/03-understand/05-trade-escrow.md b/docs/_pages/docs/03-understand/05-trade-escrow.md
index a5a10b52..408fb25c 100644
--- a/docs/_pages/docs/03-understand/05-trade-escrow.md
+++ b/docs/_pages/docs/03-understand/05-trade-escrow.md
@@ -14,9 +14,9 @@ When selling bitcoin, a trade escrow is used as an assurance of security. RoboSa
The alotted time to pay (lock) a trade escrow is determined by the order maker. The escrow's expiry timer defaults to {{site.robosats.hours_submit_escrow}} hours; however, this can be customized to range anywhere from 1 to 8 hours.
-If the seller fails to lock their trade escrow within the given time limit, then the seller forfeits their fidelity bond. Refer to [Understand > Bonds](https://learn.robosats.com/docs/bonds/) for additional information on fidelity bonds. In addition, if a dispute is opened, then the Satoshis in escrow are released to the dispute winner.
+If the seller fails to lock their trade escrow within the given time limit, then the seller forfeits their fidelity bond. Refer to [Understand > Bonds](/docs/bonds/) for additional information on fidelity bonds. In addition, if a dispute is opened, then the Satoshis in escrow are released to the dispute winner.
-Be sure to use a Lightning wallet that plays well with RoboSats, refer to [Understand > Wallets](https://learn.robosats.com/docs/wallets/) for additional information.
+Be sure to use a Lightning wallet that plays well with RoboSats, refer to [Understand > Wallets](/docs/wallets/) for additional information.
*Note: The term "seller" refers to selling bitcoin while "buyer" refers to buying bitcoin.*
@@ -32,11 +32,11 @@ This method is, at the moment, the safest approach to ensuring peers hold up to
## **How to Submit a Trade Escrow**
-First, refer to [Understand > Wallets](https://learn.robosats.com/docs/wallets/) for compatible Lightning wallets that will help make using RoboSats a smoother experience. Depending on the wallet, the locked funds might show as a payment that is in transit, frozen, or even appearing to fail. Check the wallet compatability list!
+First, refer to [Understand > Wallets](/docs/wallets/) for compatible Lightning wallets that will help make using RoboSats a smoother experience. Depending on the wallet, the locked funds might show as a payment that is in transit, frozen, or even appearing to fail. Check the wallet compatability list!
Read the relevant guide depending on if you are making or taking an order to sell bitcoin:
-* **Maker**: Create an order and modify the order conditions to your liking. The order can be customized to require an "Escrow/Invoice Timer" (expiry timer) other than the default of {{site.robosats.hours_submit_escrow}} hours, ranging anywhere from 1 to 8 hours. When your published order gets taken and the taker has submitted their fidelity bond, use the shown QR code found in the "Contract Box" with your Lightning wallet to lock the indicated amount of sats as collateral (escrow). *Note: Escrow funds are released to the buyer once you select "Confirm Fiat Received" which settles the order. Only confirm after the fiat has arrived in your account.*
-* **Taker**: Browse the order book and find an order to your liking. Click "Take Order" and lock your fidelity bond. Immediately after submitting the bond, use the following QR code found in the "Contract Box" with your Lightning wallet to lock the indicated amount of sats as collateral (escrow). *Note: Escrow funds are released to the buyer once you select "Confirm Fiat Received" which settles the order. Only confirm after the fiat has arrived in your account.*
+* **Maker**: Create an order and modify the order conditions to your liking. The order can be customized to require an "Escrow/Invoice Timer" (expiry timer) other than the default of {{site.robosats.hours_submit_escrow}} hours, ranging anywhere from 1 to 8 hours. When your published order gets taken and the taker has submitted their fidelity bond, use the shown QR code with your Lightning wallet to lock the indicated amount of sats as collateral (escrow). *Note: Escrow funds are released to the buyer once you select "Confirm Fiat Received" which settles the order. Only confirm after the fiat has arrived in your account.*
+* **Taker**: Browse the order book and find an order to your liking. Click "Take Order" and lock your fidelity bond. Immediately after submitting the bond, use the shown QR code with your Lightning wallet to lock the indicated amount of sats as collateral (escrow). *Note: Escrow funds are released to the buyer once you select "Confirm Fiat Received" which settles the order. Only confirm after the fiat has arrived in your account.*
As soon as the order taker locks their bond, the buyer and seller are required to submit the payout invoice and trade escrow, respectively, within the given time limit.
@@ -46,7 +46,7 @@ If the seller locks the escrow funds before the buyer has provided the payout in
If the seller doesn't lock the escrow funds at all, then the order will expire and the seller forfeits their bond. Half of the lost bond goes to the buyer as compensation for wasted time. Similarly, if the buyer does not provide the payout invoice within the given time limit, then the buyer forfeits their bond where half goes to the seller. The remaining half of a forfeitted bond is "donated" to RoboSats!
-After the order is taken, it cannot be cancelled except if both the maker and taker agree to collaboratively cancel during the peer-to-peer chat stage. More importantly, after the seller clicks "Confirm Fiat Received", the order is considered successful and cannot enter into dispute nor be collaboratively cancelled anymore.
+After the order is taken, it cannot be cancelled except if both the maker and taker agree to collaboratively cancel during the peer-to-peer chat stage. More importantly, after the seller clicks "Confirm Fiat Received", the order is considered successful and cannot enter into dispute nor be collaboratively cancelled anymore. Therefore, it is strongly recommended to use a payment method without chargeback risk (irreversible).
## **How and When the Escrow is Released**
@@ -64,7 +64,7 @@ The cheating robot will risk losing that dispute and consequently forfeit their
Don't forget about your order! If your peer sent the fiat and the order timer expires before you confirm the fiat was received, then you will risk losing the following dispute which will in turn cause your bond to be forfeitted. Take care to remember your order and back up your robot’s unique token!
-Due to the time limits involved in the order process, it is recommended to use instant fiat payment methods to avoid exceeding the expiry timer. Be aware of fiat payment methods that allow the buyer to contact their fiat institution and chargeback the transaction. It is recommended to use payment methods that are irreversible. Refer to [Best Practices > Payment Methods](https://learn.robosats.com/docs/payment-methods/) for additional information.
+Due to the time limits involved in the order process, it is recommended to use instant fiat payment methods to avoid exceeding the expiry timer. Be aware of fiat payment methods that allow the buyer to contact their fiat institution and chargeback the transaction. It is recommended to use payment methods that are irreversible. Refer to [Best Practices > Payment Methods](/docs/payment-methods/) for additional information.
Although a very small window of time (about one second), the trade escrow could be permanently lost if RoboSats were shutdown or suddenly disappeared between the seller confirming fiat was received and the moment the buyer's Lightning wallet registers the released escrow funds. Use a well-connected Lightning wallet with sufficient inbound liquidity to help avoid routing failures and subsequently minimize any such window of opportunity.
@@ -72,6 +72,6 @@ Although a very small window of time (about one second), the trade escrow could
Some Lightning wallets have difficulty with recognizing the Lightning hold invoice as a hold on your funds. As the seller, it is necessary to use a wallet that allows for multiple pending HTLCs since you will need to lock funds for a bond and then an escrow.
-If issues arise, please reach out to the RoboSats SimpleX group; but beware of scammers that may directly contact you and impersonate RoboSats staff! RoboSats staff will never directly contact you first. See [Contribute > Code > Communication Channels](https://learn.robosats.com/contribute/code/#communication-channels) for the SimpleX group link.
+If issues arise, please reach out to the RoboSats SimpleX group; but beware of scammers that may directly contact you and impersonate RoboSats staff! RoboSats staff will never directly contact you first. See [Contribute > Code > Communication Channels](/contribute/code/#communication-channels) for the SimpleX group link.
{% include improve %}
diff --git a/docs/_pages/docs/03-understand/06-disputes.md b/docs/_pages/docs/03-understand/06-disputes.md
index 41ffba0a..4450ae9b 100644
--- a/docs/_pages/docs/03-understand/06-disputes.md
+++ b/docs/_pages/docs/03-understand/06-disputes.md
@@ -2,10 +2,26 @@
layout: single
title: Disputes
permalink: /docs/disputes/
+toc: true
+toc_sticky: true
sidebar:
title: 'Disputes'
nav: docs
src: "_pages/docs/03-understand/06-disputes.md"
---
-{% include wip %}
\ No newline at end of file
+More often than not, disputes arise due to a miscommunication between peers. Very rarely are there actually instances of attempted fraud. Regardless, it's comforting to know there is a process in place to resolve disputes and protect the honest robot!
+
+## **Support**
+
+Support and dispute mediation is available through the public RoboSats SimpleX group chat. Refer to [Contribute > Code > Communication Channels](/contribute/code/#communication-channels) for the SimpleX invite link.
+
+There are other public group chats available, but issues relating to disputes should be brought to the SimpleX group chat.
+
+*Note: RoboSats staff will NEVER directly message you in private. Watch out for scammers impersonating RoboSats staff and group admins. You should always be wary when someone asks you to send them bitcoin in order to receive help.*
+
+## **Example Dispute**
+
+Refer to [Tutorials > Read (English) > Disputes](/read/en/#disputes) for an example overview of the dispute process.
+
+{% include improve %}
diff --git a/docs/_pages/docs/03-understand/07-wallets.md b/docs/_pages/docs/03-understand/07-wallets.md
index 20c7f432..01c74759 100644
--- a/docs/_pages/docs/03-understand/07-wallets.md
+++ b/docs/_pages/docs/03-understand/07-wallets.md
@@ -44,7 +44,7 @@ This is a non-exhaustive compilation based on past experience of users. We have
1. **UX:** Does the wallet convey clearly that there is an "ongoing" payment (hodl invoice)?
2. **Bonds:** Can the wallet lock the invoices with long expiry time needed for the bonds?
3. **Payout:** Can the wallet receive payouts from RoboSats after the user buys Sats?
-4. **Compatible:** Is the wallet overally compatible end-to-end with RoboSats?
+4. **Compatible:** Is the wallet overall compatible end-to-end with RoboSats?
5. **Total:** Is the wallet compatible and stable enough to be used consistently without issues?
### Alby (browser extension)
@@ -55,35 +55,44 @@ Instructions to install Alby in Tor Browser:
2. Click on the Alby extension and follow the prompts to setup your wallet.
### Blixt (Android/iOS, LND light backend on device)
-Most development testing for Robosats has been done using Blixt. This is one of the most complete lightning wallets around. However, it does lead to misunderstanding when hold invoices are locked, as it shows a spinner with payment in transit. The user needs to check on the website for confirmation. Blixt allows for multiple pending HTLCs, this is necessary as a seller since you need to lock a taker/maker bond and then a trade escrow (2 pending concurrent HTLCs). It might eventually also display as paid/charged invoices that are still pending, specially if the user force closes blixt and reopens it. Occasionally can display as charged fidelity bonds that have in fact been returned.
+Most development testing for RoboSats has been done using Blixt. This is one of the most complete Lightning wallets around. However, it does lead to misunderstanding when hold invoices are locked, as it shows a spinner with payment in transit. The user needs to check on the website for confirmation. Blixt allows for multiple pending HTLCs; this is necessary as a seller since you need to lock a taker/maker bond and then a trade escrow (2 pending concurrent HTLCs). It might eventually also display as paid/charged invoices that are still pending, especially if the user force closes Blixt and reopens it. Occasionally, it can display fidelity bonds as charged that have in fact been returned.
### Electrum (Desktop)
-Experience using Electrum is limited. It does not seem to support more than one pending HTLCs (even if there is multiple channels). This wallet is not recommended to use with RoboSats. However, it works well if you are a buyer, as only one hold invoice for the fidelity bond is needed. The payment shows as pending with a spinner for the duration of the locktime.
+Experience using Electrum is limited. It does not seem to support more than one pending HTLC (even if there are multiple channels). This wallet is not recommended to use with RoboSats. However, it works well if you are a buyer, as only one hold invoice for the fidelity bond is needed. The payment shows as pending with a spinner for the duration of the locktime.
### LND (CLI Interface)
-Raw, it shows exactly what is happening and what it knows "IN_FLIGHT". It is not user friendly and therefore not recommended to interact with Robosats by beginners. However, everything works just. If you are using LNCLI regularly, you will find no issue to use it with RoboSats.
+Raw; it shows exactly what is happening and what it knows "IN_FLIGHT". It is not user friendly and therefore not recommended to interact with RoboSats by beginners. However, everything works just fine. If you are using LNCLI regularly, then you will find no issue using it with RoboSats.
### Core Lightning / CLN (CLI Interface)
Works as expected. The `lightning-cli pay ` command does not conclude while the payment is pending, but can use `lightning-cli paystatus ` to monitor the state.
### Zeus (Mobile, LND, CLN, Eclair remote backend)
-It is an interface to LND, CLN and Eclair. It works as expected. It is extremely misleading with a full red screen "TIME OUT" a few seconds after sending the HTLC. Yet, if the user checks on the website, the invoice is correctly locked.
+It is an interface to LND, CLN and Eclair. It works as expected. It is extremely misleading with a full red screen "TIME OUT" a few seconds after sending the HTLC. Yet, if the user checks on the website, then the invoice is correctly locked.
### Muun (Mobile)
-Muun plays same nicely with hold invoices as Blixt or LND. You can be a seller in RoboSats using Muun and the user experience will be great. However, in order to be a buyer, you need to submit an onchain address for the payout, a lightning invoice won't work. Muun is _fee siphoning attacking_ any sender to Muun wallet. There is a mandatory hop trough a private channel with a fee of +1500ppm. RoboSats will strictly not route a buyer payout for a net loss. Given that RoboSats trading fees are {{site.robosats.total_fee}}% and it needs to cover the routing fees, **RoboSats will never find a suitable route to a Muun wallet user**. At the moment, RoboSats will scan your invoice for routing hints that can potentially encode a _fee siphoning attack_.If this trick is found, the invoice will be rejected: submit an onchain address instead for an on-the-fly swap.
+Similar to Blixt or LND, Muun plays nicely with hold invoices. You can be a seller in RoboSats using Muun and the user experience will be great. However, in order to be a buyer when using Muun, you need to submit an on-chain address for the payout as a Lightning invoice won't work. Muun is _fee siphoning attacking_ any sender to Muun wallet. There is a mandatory hop through a private channel with a fee of +1500ppm. RoboSats will strictly not route a buyer payout for a net loss. Given that RoboSats trading fees are {{site.robosats.total_fee}}% and it needs to cover the routing fees, **RoboSats will never find a suitable route to a Muun wallet user**. At the moment, RoboSats will scan your invoice for routing hints that can potentially encode a _fee siphoning attack_. If this trick is found, then the invoice will be rejected: submit an on-chain address instead for an on-the-fly swap. Refer to [Understand > On-Chain Payouts](/docs/on-chain-payouts/) for more information about on-the-fly swaps.
### Phoenix (Mobile)
-Phoenix works very well as an order taker. Phoenix will also work well as an order maker as long as the order settings `public duration` + `deposit duration` are lower than 10 hours. Otherwise you might have problems locking the maker bond. If the total duraton of bonds/escrow invoices exceeds 450 blocks, Phoenix will not allow users to lock the bond (`Cannot add htlc (...) reason=expiry too big`).
+Phoenix works very well as an order taker. Phoenix will also work well as an order maker as long as the order settings `public duration` + `deposit duration` are lower than 10 hours. Otherwise, you might have problems locking the maker bond. If the total duraton of bonds/escrow invoices exceeds 450 blocks, then Phoenix will not allow users to lock the bond (`Cannot add htlc (...) reason=expiry too big`).
### Bluewallet (Mobile)
-It works well. But they are having issues in the custodial mode. Escrows that RoboSats returns are charged to users (so Bluewallet is keeping that balance?). Bonds that are slashed...are charged twice by Blue! More info once they reply to us. EDIT: Blue has confirmed they are working to soon solve these accounting bugs!
+It works well. But they are having issues in the custodial mode. Escrows that RoboSats returns are charged to users (so Bluewallet is keeping that balance?). Bonds that are slashed... are charged twice by Blue! More info once they reply to us. EDIT: Blue has confirmed they are working to soon solve these accounting bugs!
### Blink (Mobile, former Bitcoin Beach Wallet)
-Works well with Robosats. Hodl invoices (Bonds) show as "Pending" in the transaction history. Payouts to the Blink wallet function as intended. Custodial wallet by Galoy which originated from the Bitcoin Beach project in El Salvador (formerly known as "Bitcoin Beach Wallet").
+Works well with RoboSats. Hodl invoices (Bonds) show as "Pending" in the transaction history. Payouts to the Blink wallet function as intended. Custodial wallet by Galoy which originated from the Bitcoin Beach project in El Salvador (formerly known as "Bitcoin Beach Wallet").
### OBW (Mobile)
-One of the simplest and one of the best. The hodl invoice shows as "on fly", it is no custodial and it allows to create our own channels, to buy one from a liquidity provider or use Hosted Channels. It is maintained by the great Fiatjaf and it is a fork of the abandoned SBW.
+One of the simplest and one of the best. The hodl invoice shows as "on fly", it is not custodial and can create your own channels. Buy one from a liquidity provider or use Hosted Channels. It is maintained by the great Fiatjaf and it is a fork of the abandoned SBW.
## Help keep this page updated
There are many wallets and all of them keep improving at lightning speed. You can contribute to the RoboSats Open Source Project by testing wallets, editing [the content of this page](https://github.com/RoboSats/robosats/tree/main/docs/{{page.src}}) and opening a [Pull Request](https://github.com/RoboSats/robosats/pulls)
+## Additional Information
+
+Receiving Sats over Lightning is not completely private. Refer to [Best Practices > Proxy Wallets](/docs/proxy-wallets/) for more information on receiving Sats privately.
+
+If you are experiencing issues receiving funds to your wallet (due to channel management issues, routing issues, wallet-side issues, etc.), then a quick solution for the sake of receiving a fast payout would be to have a second wallet on hand that is well-connected and with sufficient channel capacity. You could receive Sats to your second wallet and, once issues are resolved, then send to your primary wallet.
+
+Do not hesitate to reach out to the public RoboSats [SimpleX](/contribute/code/#communication-channels) group chat for advice or help in using wallets!
+
+{% include improve %}
diff --git a/docs/_pages/docs/03-understand/08-limits.md b/docs/_pages/docs/03-understand/08-limits.md
index 8d79cc2f..eb0a5dce 100644
--- a/docs/_pages/docs/03-understand/08-limits.md
+++ b/docs/_pages/docs/03-understand/08-limits.md
@@ -2,10 +2,26 @@
layout: single
title: Exchange Limits
permalink: /docs/limits/
+toc: true
+toc_sticky: true
sidebar:
title: 'Limits'
nav: docs
src: "_pages/docs/03-understand/08-limits.md"
---
-{% include wip %}
\ No newline at end of file
+RoboSats is built on the Lightning Network, a micropayment network. Therefore, amounts sent and received over the Lightning Network must be small enough to successfully find a suitable route.
+
+The maximum single trade size is {{site.robosats.max_trade_limit}} Sats and the minimum single trade size is {{site.robosats.min_trade_limit}} Sats.
+
+However, there are no limits to the quantity of trades you can make/take on RoboSats (although it is strongly recommended to limit one order per robot identity). Generate and manage multiple robot identities using the Robot Garage feature. Just be certain to securely back up your secret robot tokens!
+
+## **Why Have Limits?**
+
+The reason for having a limit on the amount of Sats you can send/receive with RoboSats is due minimizing Lightning routing failure. This makes the end-user experience with RoboSats much smoother to ensure funds get reliably paid out.
+
+The more Sats you try to push through LN, the harder it is to find a path. If there were no limits on an order, then a user might try to receive sats that will never find a suitable route.
+
+To reduce headaches and streamline the experience, a limit is in place that is sensible to the realities of the average channel capacity across the Lightning Network. For example, trying to receive 10M Sats might never payout when the network's average channel capacity is [well below 10M Sats](https://1ml.com/statistics).
+
+{% include improve %}
diff --git a/docs/_pages/docs/03-understand/09-swaps.md b/docs/_pages/docs/03-understand/09-swaps.md
index 40750df3..8eb67784 100644
--- a/docs/_pages/docs/03-understand/09-swaps.md
+++ b/docs/_pages/docs/03-understand/09-swaps.md
@@ -2,18 +2,17 @@
layout: single
title: P2P Swaps
permalink: /docs/swaps/
+toc: true
+toc_sticky: true
sidebar:
title: 'Swaps'
nav: docs
src: "_pages/docs/03-understand/09-swaps.md"
---
-Apart from the various fiat payment methods available, there are something
-called *Swap Destinations* as well. These are payment methods, but for BTC, on
-a network other than the Lightning Network. This is useful if you want to
-exchange lightning satoshis for on-chain satoshis (or on any other network like
-Liquid BTC if you prefer). This process of exchanging satoshis on the Lightning
-Network for on-chain satoshis is usually referred to as a "swap".
+Apart from the various fiat payment methods available, there are something called *Swap Destinations* as well. These are payment methods, but for BTC, on a network other than the Lightning Network.
+
+This is useful if you want to exchange Lightning Sats for on-chain Sats (or on any other network like Liquid BTC if you prefer). This process of exchanging Sats on the Lightning Network for on-chain Sats is usually referred to as a "swap".
The table below makes it simple to understand swap in terms of "buyer" and "seller":
@@ -22,14 +21,9 @@ The table below makes it simple to understand swap in terms of "buyer" and "sell
| Seller | ⚡BTC | 🔗 BTC | Swap out |
| Buyer | 🔗 BTC | ⚡BTC | Swap in |
-
### How to do a P2P Swap
-Remember, in RoboSats you always buy or sell Lightning Network satoshis. If you
-want to receive satoshis over the Lightning Network in exchange for your
-on-chain satoshis, then you create a **BUY** order. On the contrary, if you
-want to receive satoshis on-chain in exchange for your Lightning Network
-satoshis, then create a *SELL* order.
+Remember, in RoboSats you always buy or sell Lightning Network Sats. If you want to receive Sats over the Lightning Network in exchange for your on-chain Sats, then you create a **BUY** order. On the contrary, if you want to receive Sats on-chain in exchange for your Lightning Network Sats, then create a *SELL* order.
In the Order Create screen, select "BTC" from the currency dropdown menu:
@@ -43,41 +37,24 @@ Select your Swap Destination from the dropdown:
-You then set the amount or range you want to swap for. Remember that if you
-are a seller, then you will receive on-chain BTC and if you are the buyer, you
-will be sending on-chain BTC:
+You then set the amount or range you want to swap for. Remember that if you are a seller, then you will receive on-chain BTC and if you are the buyer, you will be sending on-chain BTC:
-You then simply create the order and wait for a taker to take your order. In
-the chatroom you move forward as usual, but this time the payment method is
-simply an on-chain bitcoin address.
-
+You then simply create the order and wait for a taker to take your order. In the chatroom you move forward as usual, but this time the payment method is simply an on-chain bitcoin address.
### Order amount and mining fees
-The amount to be sent on-chain must be the exact value mentioned in the order
-amount. The sender of on-chain sats needs to cover for mining fees (on-chain
-transaction fees).
+The amount to be sent on-chain must be the exact value mentioned in the order amount. The sender of on-chain sats needs to cover for mining fees (on-chain transaction fees).
### What premium do I set?
-In case of a swap it's better to keep premium to 0% but if you want to make the
-offer a little more attractive to your counterparty you can follow the below
-recommendations:
+In case of a swap, it's better to keep the premium at 0%; but if you want to make the offer a little more attractive to your counterparty, then you can follow the below recommendations:
+1. If you are the **seller** - you will be **receiving** on-chain BTC; setting the premium slightly below 0% (e.g., -0.1%, -0.5%) will make your offer more attractive. The taker already pays {{site.robosats.taker_fee}}% fees on the trade plus they have to pay mining fees for sending the on-chain BTC.
+2. If you are the **buyer** - you will be **sending** on-chain BTC; setting the premium slightly above 0% (e.g., 0.1%, 0.5%) will make your offer more attractive.
-1. If you are the **seller** - you will be **receiving** on-chain BTC; setting
- the premium slightly below 0% (eg. -0.1%, -0.5%) will make your offer
- attractive. The taker already pays {{site.robosats.taker_fee}}% fees on the trade plus they have
- to pay mining fees for sending the on-chain BTC.
-
-2. If you are the **buyer** - you will be **sending** on-chain BTC; setting the
- premium slightly above 0% (eg. 0.1%, 0.5%) will make your offer attractive.
-
-These are just general recommendations about what premium to set to get started
-with swaps, but at the end of the day, the price is what the market sets, so
-experiment and see what works for you.
+These are just general recommendations about what premium to set to get started with swaps, but at the end of the day, the price is what the market sets... So, experiment and see what works for you!
{% include improve %}
diff --git a/docs/_pages/docs/03-understand/10-telegram.md b/docs/_pages/docs/03-understand/10-telegram.md
index 6a527232..ec46ed55 100644
--- a/docs/_pages/docs/03-understand/10-telegram.md
+++ b/docs/_pages/docs/03-understand/10-telegram.md
@@ -2,6 +2,8 @@
layout: single
title: Telegram Notifications, Alert and Groups
permalink: /docs/telegram/
+toc: true
+toc_sticky: true
sidebar:
title: 'Telegram'
nav: docs
@@ -10,70 +12,69 @@ src: "_pages/docs/03-understand/10-telegram.md"
-{% include wip %}
+## **RoboSats Alert bot 🔔**
-**Robots Alert bot 🔔**
+You can find it on Telegram with the username @RobosatsAlertBot, whose admin is @jakyhack.
-You can find it on telegram with the username @RobosatsAlertBot, whose admin is @jakyhack.
+## **What Can I Do with @RobosatsAlertBot?**
-**What can I do with @RobosatsAlertBot?**
-It is a bot designed to notify you when an order that meets your requirements is posted on robosats.
+It is a bot designed to notify you when an order that meets your requirements is posted on RoboSats.
-This means that if you want to "BUY" satoshis with "EUROS" with a maximum premium of "5%" through the payment methods "BIZUM,PAYPAL,SEPA,STRIKE", tell @RobosatsAlertBot and he will take care of it to notify you when a trade that meets these requirements is published in robosats.
+This means that if you want to "BUY" Sats with "EUROS" with a maximum premium of "5%" through the payment methods "BIZUM,PAYPAL,SEPA,STRIKE", tell @RobosatsAlertBot and he will take care of it to notify you when a trade that meets these requirements is published on RoboSats.
-**User's Guide**
+## **User Guide**
-Access @RobosatsAlertBot and start the bot with the /start command
+Access @RobosatsAlertBot and start the bot with the /start command.
-Next, it will give you a choice between 2 options, add a new alert or list the alerts that you already have configured (Obviously when you start the bot for the first time you will not have any.)
+Next, it will give you a choice between 2 options: add a new alert or list the alerts that you already have configured. Obviously, when you start the bot for the first time, you will not have any alerts configured.
![image](https://user-images.githubusercontent.com/47178010/170114653-f1d22f61-1db3-4a6a-b38c-5542a1b76648.png)
-Proceed to create a new alert by clicking on the "+ Add new alert" button or using the /new command
+Proceed to create a new alert by clicking on the "+ Add new alert" button or using the /new command.
-From that moment the bot is ready to save your preferences, it will ask you 4 questions:
-- What do you want to do? You will be able to choose between buying or selling, this means telling the bot what you want to do within Robosats.
+From that moment, the bot is ready to save your preferences. It will ask you 4 questions:
+- What do you want to do? You will be able to choose between buying or selling; this means telling the bot what you want to do within RoboSats.
![image](https://user-images.githubusercontent.com/47178010/170114706-a4226028-50a5-414e-8ae8-c44f90833ff6.png)
-- What is your FIAT currency? It will give you a list of FIAT currencies, just choose yours
+- What is your fiat currency? It will give you a list of fiat currencies, just choose yours.
![image](https://user-images.githubusercontent.com/47178010/170114837-3e83f1c9-035a-4b59-8c8e-043f77995a33.png)
-- What is the maximum premium you are willing to pay? or What is the minimum premium you are willing to accept? Depending on whether you want to buy or sell satoshis, it will ask you one question or another.
+- What is the maximum premium you are willing to pay? Or, what is the minimum premium you are willing to accept? Depending on whether you want to buy or sell Sats, it will ask you one question or another.
![image](https://user-images.githubusercontent.com/47178010/170115618-66117113-e702-4faa-b02d-a8101244f7da.png)
-- What payment methods do you accept to make/receive payment with FIAT? Simply tell the bot what payment methods you would be willing to accept for your trade. Inform them in the following format: "Révolut,SEPA,Strike,Bizum" (without quotes). If you are indifferent to the FIAT payment method, simply send it: "Any" (without quotes).
+- What payment methods do you accept to make/receive payment with fiat? Simply tell the bot what payment methods you would be willing to accept for your trade. Inform them in the following format: "Révolut,SEPA,Strike,Bizum" (without quotes). If you are indifferent to the fiat payment method, simply send it: "Any" (without quotes).
![image](https://user-images.githubusercontent.com/47178010/170115693-7378b25a-93af-4ad3-ad7e-d0185364003d.png)
-
-Once all this has been reported, your alert is configured correctly. In case an order is posted on Robosats that meets your conditions, @RobosatsAlertBot will notify you via telegram with a link to the order book so you can proceed with your trade if you wish. Below is an example of an alert.
+Once all this has been reported, your alert is configured correctly. In the event an order is posted on RoboSats that meets your conditions, @RobosatsAlertBot will notify you via Telegram with a link to the order book so you can proceed with your trade if you wish. Below is an example of an alert.
![image](https://user-images.githubusercontent.com/47178010/170116003-6316c10a-0c6f-44bc-8eb6-17a1df8e1f3f.png)
-**How often does robosats look at the order book?**
+## **How Often Does RoboSats Look at the Order Book?**
-Robosats checks the order book every minute, this means that the maximum time that will pass from when an order that meets your conditions is published until @RobosatsAlertBot notifies you will be 1 minute.
+RoboSats checks the order book every minute; this means that the maximum time that will pass from when an order that meets your conditions is published until @RobosatsAlertBot notifies you will be 1 minute.
-**Once @RobosatsAlertBot has notified me, can I use that same alert again?**
+## **Once @RobosatsAlertBot Has Notified Me, Can I Use that Same Alert Again?**
Yes, once @RobosatsAlertBot notifies you, your alert stays in the disabled state, simply turn it back on and @RobosatsAlertBot will notify you again when an order meets your conditions.
-**What can go wrong?**
+## **What Can Go Wrong?**
-Nothing wrong, but there can be disappointments, it is possible that the conditions of your alert are conditions shared by many users, this means that there are many users who want to find a trade with the same (or very similar) conditions as you. This means that an order with very restrictive conditions may be in the order book for a very short time because some other user accepts it before you do, which is why the bot's creator recommends always having it with sound
+Nothing wrong, but there can be disappointments. It is possible that the conditions of your alert are conditions shared by many users, this means that there are many users who want to find a trade with the same (or very similar) conditions as you. This means that an order with very restrictive conditions may be in the order book for a very short time because some other user accepts it before you do, which is why the bot's creator recommends always having it with sound.
-**LOSS OF PRIVACY**
+## **LOSS OF PRIVACY**
-Robosats is an exchange focused on user privacy, that is why KYC is not used and its optimal use is oriented to be used with the TOR browser.
+RoboSats is an exchange focused on user privacy because personal information is not required. The optimal setup for RoboSats is through a recommended access method like the private TOR browser.
-Once you leave TOR to a third party application (Telegram in this case) you are losing privacy.
+Once you leave TOR to a third party application (i.e., Telegram) you lose privacy.
-This bot, like any other, will store your Telegram user ID, as it is necessary to contact the user. It will also store the data of your alert.
+This bot, like any other, will store your Telegram user ID as it is necessary to contact the user. It will also store the data of your alert.
-That is, the bot will know that user 123456789 has an alert to buy sats with euros with a maximum of 5% premium through bizum or paypal or strike.
+That is, the bot will know that user 123456789 has an alert to buy Sats with EUROS with a maximum of 5% premium through Bizum, PayPal, or Strike.
-It is important to always keep this in mind. We must not be obsessed with privacy, but we must take into account what we give and what we do not give of it.
+It is important to always keep this in mind. Some are willing to sacrifice a degree of privacy in favor of convenient notifications, but you must consider the tradeoffs associated with revealing the aforementioned information. Privacy is what we choose to selectively reveal and is ultimately up to the end-user as to how private they want to make their RoboSats experience.
+{% include improve %}
diff --git a/docs/_pages/docs/03-understand/12-prices.md b/docs/_pages/docs/03-understand/12-prices.md
index af3d25ff..e92f6da0 100644
--- a/docs/_pages/docs/03-understand/12-prices.md
+++ b/docs/_pages/docs/03-understand/12-prices.md
@@ -14,12 +14,14 @@ The price is the fiat rate at which bitcoin was last traded on an exchange. In o
When making an order, there are two different pricing methods available:
* **Relative** pricing method: let the order price move with the market over time (dynamic).
-* **Explicit** pricing method: set the order price using a fixed amount of satoshis (static).
+* **Explicit**** pricing method: set the order price using a fixed amount of satoshis (static).
-When browsing the order book, the bitcoin-fiat price of live orders you see are automatically adjusted to include the order’s corresponding premium. Refer to [Understand > Premium](https://learn.robosats.com/docs/premium/) for additional information on premiums.
+When browsing the order book, the bitcoin-fiat price of live orders you see are automatically adjusted to include the order’s corresponding premium. Refer to [Understand > Premium](/docs/premium/) for additional information on premiums.
If a fiat currency isn't available on RoboSats, then one can easily add a new currency by opening a pull request on [GitHub](https://github.com/RoboSats/robosats)!
+***The explicit pricing method has been removed as an option for technical reasons, but could potentially come back in future updates. Currently, order pricing is only relative to the market rate.*
+
## **Prices in Practice**
If the order pricing is *relative*, then the amount of satoshis being traded relative to the fiat exchange rate (we'll call `trade_sats`) becomes "locked" once the order taker locks their bond. Until the taker bond is locked, the order's price continues to move with the market over time.
diff --git a/docs/_pages/docs/03-understand/13-fees.md b/docs/_pages/docs/03-understand/13-fees.md
index 27462e37..1c9a3135 100644
--- a/docs/_pages/docs/03-understand/13-fees.md
+++ b/docs/_pages/docs/03-understand/13-fees.md
@@ -12,7 +12,7 @@ src: "_pages/docs/03-understand/13-fees.md"
RoboSats charges a {{site.robosats.total_fee}}% fee of the total trade amount; this fee is distributed between the order maker and the order taker who pay {{site.robosats.maker_fee}}% and {{site.robosats.taker_fee}}%, respectively.
-The platform fees are summarized in the table below to emphasize the fee percentage depends on whether you make or take the order, not if you are the buyer or seller:
+The platform fees are summarized in the table below to emphasize the fee percentage depends on whether you make or take the order:
| Side | Maker | Taker |
|--------|------------------------------|------------------------------|
@@ -27,16 +27,16 @@ The total fee ({{site.robosats.total_fee}}%) is split between the maker and take
In practice, the fees are applied when the user is presented with submitting the trade escrow (seller) or payout invoice (buyer) after the taker bond is locked.
-If the order pricing is *relative*, then the amount of satoshis being traded relative to the fiat exchange rate (we'll call `trade_sats`) fluctuates until the taker bond is locked. In cases of *explicit* order pricing, the amount of satoshis being traded is fixed. Refer to [Understand > Prices](https://learn.robosats.com/docs/prices/) for additional information regarding relative and explicit pricing methods.
+If the order pricing is *relative*, then the amount of Sats being traded relative to the fiat exchange rate (we'll call `trade_sats`) fluctuates until the taker bond is locked. In cases of *explicit* order pricing, the amount of Sats being traded is fixed. Refer to [Understand > Prices](/docs/prices/) for additional information regarding relative and explicit pricing methods.
-Until the taker bond is locked, the order's price continues to move with the market over time. Once the taker bond is locked for a relatively priced order, the amount of satoshis being traded is calculated as follows:
+Until the taker bond is locked, the order's price continues to move with the market over time. Once the taker bond is locked for a relatively priced order, the amount of Sats being traded is calculated as follows:
````
premium_rate = CEX_rate * (1 + (premium / 100))
trade_sats = amount / premium_rate
````
-where `trade_sats` is the satoshis to be traded, `premium` is what the order maker defined during order creation, and `CEX_rate` is the current bitcoin exchange price given the currency you are using.
+where `trade_sats` is the Sats to be traded, `premium` is what the order maker defined during order creation, and `CEX_rate` is the current bitcoin exchange price given the currency you are using.
The platform fees (`fee_sats`) associated with your order are calculated using the `trade_sats` variable:
* For maker:
@@ -70,7 +70,7 @@ In essence, RoboSats adds to the `escrow_amount`, deducts from the `payout_amoun
Fees work to improve the platform's end-user experience through continuing development, offering multilingual support, and building out guides for interacting with the platform.
-Fees in turn reward the volunteer GitHub developers and contributors for completing tasks that are [elligible for earning bitcoin](https://github.com/users/Reckless-Satoshi/projects/2). Check it out! If you earn satoshis for your contributions, then fees incurred while using RoboSats would be sufficiently covered!
+Fees in turn reward the volunteer GitHub developers and contributors for completing tasks that are [elligible for earning bitcoin](https://github.com/users/Reckless-Satoshi/projects/2). Check it out! If you earn Sats for your contributions, then fees incurred while using RoboSats would be sufficiently covered!
Implementing fees also helps mitigate the opportunity for denial of service attacks by malicious bots congesting the RoboSats coordinator.
@@ -84,12 +84,12 @@ When choosing to receive bitcoin on-chain, an overview of the mining fee (`fee_m
payout_amount = trade_sats - fee_sats - fee_mining - fee_swap
````
-The swap fee is an additional fee that RoboSats charges for making the on-chain payment and the mining fee is the on-chain fee rate in sats/vbyte which can be customized to suit your needs. Refer to [Understand > On-Chain Payouts](https://learn.robosats.com/docs/on-chain-payouts/) for additional information regarding on-chain payouts.
+The swap fee is an additional fee that RoboSats charges for making the on-chain payment and the mining fee is the on-chain fee rate in sats/vbyte which can be customized to suit your needs. Refer to [Understand > On-Chain Payouts](/docs/on-chain-payouts/) for additional information regarding on-chain payouts.
RoboSats leverages the speed and security of the Lightning Network, therefore payments sent through the Lightning Network may incur fees depending on the necessary "path" that payment must take.
-Users can receive payments privately through [lnproxy](https://lnproxy.org/), a simple Lightning Network privacy tool, but your routing budget may increase to cover extra fees incurred by the lnproxy server. Refer to [Best Practices > Proxy Wallets](https://learn.robosats.com/docs/proxy-wallets/) for more on receiving privately.
+Users can receive payments privately through [lnproxy](https://lnproxy.org/), a simple Lightning Network privacy tool, but your routing budget may increase to cover extra fees incurred by the lnproxy server. Refer to [Best Practices > Proxy Wallets](/docs/proxy-wallets/) for more on receiving privately.
-The user has the option to specify the Lightning Network routing budget which may help reduce routing failures. Refer to [Quick Start > Lightning Network](https://learn.robosats.com/docs/lightning/) for additional information on routing failures.
+The user has the option to specify the Lightning Network routing budget which may help reduce routing failures. Refer to [Quick Start > Lightning Network](/docs/lightning/) for additional information on routing failures.
{% include improve %}
diff --git a/docs/_pages/docs/03-understand/14-on-chain-payouts.md b/docs/_pages/docs/03-understand/14-on-chain-payouts.md
index 00130e93..ac37379e 100644
--- a/docs/_pages/docs/03-understand/14-on-chain-payouts.md
+++ b/docs/_pages/docs/03-understand/14-on-chain-payouts.md
@@ -2,19 +2,17 @@
layout: single
title: On-chain Payouts
permalink: /docs/on-chain-payouts/
+toc: true
+toc_sticky: true
sidebar:
title: 'On-chain Payouts'
nav: docs
src: "_pages/docs/03-understand/14-on-chain-payouts.md"
---
-Although Robosats is an exchange built on top of the lightning network, there
-is an option however, for the buyer to receive their sats to an on-chain
-bitcoin address. This is referred to as an on-chain payout or sometimes,
-on-chain swap (not to be confused with [P2P Swaps](/docs/swaps)). On the UI,
-this option is available after the taker has locked their bond. When the order
-status is on "Waiting for buyer invoice", you should see two options -
-"Lightning" and "Onchain":
+Although RoboSats is an exchange built on top of the Lightning Network, there is an option for the buyer to receive their Sats to an on-chain bitcoin address. This is referred to as an on-chain payout or, sometimes, an on-chain swap (not to be confused with [P2P Swaps](/docs/swaps)).
+
+In the UI, this option is available after the taker has locked their bond. When the order status is on "Waiting for buyer invoice", you should see two options: "Lightning" and "Onchain"
@@ -26,34 +24,25 @@ When you click on the on-chain address option you see the following:
-An overview of the fees is displayed and you can enter an on-chain bitcoin
-address for the payout and also enter the mining fees. The *Swap fee* is an
-additional fee that Robosats charges for making the on-chain payment. This does
-not include the taker/maker fees. The Swap fee is charged on the amount after
-deducting the taker/maker fees. In addition to the swap fee, there's also the
-mining fee for the on-chain transaction. You can choose the mining fee that
-suits your need of the hour. The *Mining Fee* input let's you choose the fee
-rate in sats/vbyte.
+An overview of the fees is displayed and you can enter an on-chain bitcoin address for the payout and also enter the mining fees. The *swap fee* is an additional fee that RoboSats charges for making the on-chain payment. This does not include the taker/maker fees. The swap fee is charged on the amount after deducting the taker/maker fees.
-If the on-chain address is valid, then the order moves to the next stage as
-usual. At the end, if the trade was successful you should see a screen
-something like this with the transaction id of the payout transaction:
+In addition to the swap fee, there's also the mining fee for the on-chain transaction. You can choose the mining fee that suits your need of the hour. The *mining fee* input let's you choose the fee rate in sats/vbyte.
+
+If the on-chain address is valid, then the order moves to the next stage as usual. At the end, if the trade was successful, then you should see a screen something like this with the transaction ID of the payout:
-### On-chain payout fees
+## On-chain Payout Fees
-The on-chain payout fees (aka Swap fees) keeps changing from time to time. It
-may range from 1% to 10%. To get the current on-chain fees you can check the
-exchange summary by clicking on the "%" button from the home screen:
+The on-chain payout fees (AKA swap fees) keep changing from time to time. It may range from 1% to 10%. To get the current on-chain fees, you can check the exchange summary by clicking on the "%" button from the home screen:
-The exchange summary dialog displays the current value of the on-chain payout fees:
+The exchange summary dialogue displays the current value of the on-chain payout fees: