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

Update how-to-use.md

Browse Source
This commit is contained in:
Reckless_Satoshi 2022-02-14 14:41:06 +00:00 committed by GitHub
parent 106cac967d
commit f9c0692d55
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/how-to-use.md
View File

@ -10,11 +10,11 @@ RoboSats help users preserve their privacy by using newly generated avatars in e
<img src="images/how-to-use/homepage-1.png" width="370" /> <img src="images/how-to-use/homepage-1.png" width="370" />
</div> </div>
RoboSats welcomes you with right away with yout new unique robot avatar. The robot is deterministically generated based on the token you see below it. This token is all you need to recover the avatar in the future, so make sure to **back it up safely!** RoboSats welcomes you right away with your unique robot avatar. The robot is deterministically generated based on the token you see below it. This token is all you need to recover the avatar in the future, so make sure to **back it up safely!**
The tokens are generated in your own browser. However, if you do not trust your machine randomness, you can also input your own entropy token. *Note that low entropy tokens are not valid.* The tokens are generated in your own browser. However, if you do not trust your machine randomness, you can also input your own entropy token. *Note that low entropy tokens are not valid.*
On this example, I was really really not happy of being "HomelessCash"! :D So I just click on the dice icon to generate a new token and tap `Generate avatar` to get a new one I was really not happy of being "HomelessCash"! :D So I just click on the dice icon to generate a new token and tap `Generate avatar` to get a new one
<div align="center"> <div align="center">
<img src="images/how-to-use/homepage-2.png" width="370" /> <img src="images/how-to-use/homepage-2.png" width="370" />
@ -35,9 +35,11 @@ In RoboSats you can make new orders or take orders made by others. To be an _ord
### Exploring the Order Book ### Exploring the Order Book
We click in View book and have a look to the orders in the book page. We click on "View book" and have a look at the orders in the book page.
![](images/how-to-use/book-desktop.png) <div align="center">
<img src="images/how-to-use/book-desktop.png"/>
</div>
On a desktop browser, you can see at a glance all of the revelant information about the orders so you can decide which one to take. By default, the book will show "ANY" type of order (buy and sell) and "ANY" currency. Use the drop down menus at the top to select your preferences. On a desktop browser, you can see at a glance all of the revelant information about the orders so you can decide which one to take. By default, the book will show "ANY" type of order (buy and sell) and "ANY" currency. Use the drop down menus at the top to select your preferences.
@ -45,7 +47,7 @@ On a desktop browser, you can see at a glance all of the revelant information ab
<img src="images/how-to-use/book-phone.png" width="370" /> <img src="images/how-to-use/book-phone.png" width="370" />
</div> </div>
On a smartphone, however, not all of the columns fits on the screen. The nicknames, the type of order, the payment method and the exchange rate are hidden by default. You can tap on any column and tap "Show columns" to select what columns to make visible. On a smartphone, however, not all of the columns fit on the screen. The nicknames, the type of order, the payment method and the exchange rate are hidden by default. You can tap on any column and tap "Show columns" to select what columns to make visible.
<div align="center"> <div align="center">
<img src="images/how-to-use/book-show-columns.png" width="230" /> <img src="images/how-to-use/book-show-columns.png" width="230" />
@ -76,7 +78,7 @@ You can also tap on any order to see the full order page:
Every order has an expiration counter. By default, in RoboSats v0.1.0 new orders will stay public in the book for 6 hours. Every order has an expiration counter. By default, in RoboSats v0.1.0 new orders will stay public in the book for 6 hours.
### Taking an order as a buyer (1) ### Walktrough-1: Taking an order as a buyer
When you are decided for an order to take simply tap the "Take Order" button. You will see the contract box. Follow the contract box indications until you complete the trade! :) When you are decided for an order to take simply tap the "Take Order" button. You will see the contract box. Follow the contract box indications until you complete the trade! :)
@ -86,16 +88,16 @@ First thing is to lock a fidelity bond, so the seller knows you can be trusted.
<img src="images/how-to-use/contract-box-1.png" width="370" /> <img src="images/how-to-use/contract-box-1.png" width="370" />
</div> </div>
Scan or copy the invoice into your lightning wallet. It might show as a payment that is on transit, freeze or even apparently break your wallet. You should always check on the RoboSats website whether the bond has been locked (your wallet will probably not tell you! Check [wallet compatibility list](https://github.com/Reckless-Satoshi/robosats/issues/44)) Scan or copy the invoice into your lightning wallet. It might show as a payment that is on transit, freeze or even seemenly break your wallet. You should always check on the RoboSats website whether the bond has been locked (your wallet will probably not tell you! Check [wallet compatibility list](https://github.com/Reckless-Satoshi/robosats/issues/44))
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-2.png" width="370" /> <img src="images/how-to-use/contract-box-2.png" width="370" />
</div> </div>
As soon as or bond is locked, RoboSats will ask you to provide a lightning invoice to send you the satoshis. Generate an invoice with the exact amount in your lightning wallet and submit it. As soon as our bond is locked, RoboSats will ask you to provide a lightning invoice to send you the satoshis. Generate an invoice with the exact amount in your lightning wallet and submit it.
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-1.png" width="370" /> <img src="images/how-to-use/contract-box-3.png" width="370" />
</div> </div>
While you are submitting your payout invoice, the seller is asked to lock the trade escrow hold invoice. If you are faster than him, you would have to wait. Otherwise, you would already be able to chat with him. While you are submitting your payout invoice, the seller is asked to lock the trade escrow hold invoice. If you are faster than him, you would have to wait. Otherwise, you would already be able to chat with him.
@ -103,38 +105,38 @@ While you are submitting your payout invoice, the seller is asked to lock the tr
There is a time limit of 30 minutes to submit the invoice (buyer) and lock the trade escrow (seller). If the time runs out, the order will expire and the robot who did not follow with the contract obligations will lose the bond. This is a mechanism that helps prevent fake order spamming, wasting time of counterparts and DDOSing the order book. There is a time limit of 30 minutes to submit the invoice (buyer) and lock the trade escrow (seller). If the time runs out, the order will expire and the robot who did not follow with the contract obligations will lose the bond. This is a mechanism that helps prevent fake order spamming, wasting time of counterparts and DDOSing the order book.
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-2.png" width="370" /> <img src="images/how-to-use/contract-box-4.png" width="370" />
</div> </div>
As soon as the seller locks the satoshis, it is safe to send the fiat currency! As a buyer, you will have to ask the seller for the details to send fiat. Remember to only share the information needed about yourself to not compromise your privacy. Remember, in RoboSats v0.1.0 this chat is memoryless, so the conversation will be lost if you refresh the browser. As soon as the seller locks the satoshis, it is safe to send the fiat currency! As a buyer, you will have to ask the seller for the details to send fiat. Remember to only share the information needed about yourself to not compromise your privacy. Remember, in RoboSats v0.1.0 this chat is memoryless, so the conversation will be lost if you refresh the browser.
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-3.png" width="370" /> <img src="images/how-to-use/contract-box-5.png" width="370" />
</div> </div>
As soon as you have sent the fiat, you should tap on "Confirm fiat sent" button! After that, the seller will have to confirm the fiat was received. As soon as he confirms the trade is finished and you will be paid out to your lightning wallet. You might see that it is "sending satoshis to buyer" but usually it is so fast you will simply see this screen. Enjoy your sats! As soon as you have sent the fiat, you should tap on "Confirm fiat sent" button! After that, the seller will have to confirm the fiat was received. As soon as he confirms the trade is finished and you will be paid out to your lightning wallet. You might see that it is "sending satoshis to buyer" but usually it is so fast you will simply see this screen. Enjoy your sats!
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-4.png" width="370" /> <img src="images/how-to-use/contract-box-6.png" width="370" />
</div> </div>
Rating the platform and leaving tips for improvement in our Telegram group or Github Issues is super appreciated! Rating the platform and leaving tips for improvement in our Telegram group or Github Issues is super appreciated!
### Making an order as a seller (2) ### Walktrough-2: Making an order as a seller
It might happen that there are no active orders for the positioning and currency you want. In this case, there is no orders to SELL bitcoin for GBP. It might happen that there are no active orders for the positioning and currency you want. In this case, there is no orders to SELL bitcoin for GBP.
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-5.png" width="370" /> <img src="images/how-to-use/book-no-orders.png" width="370" />
</div> </div>
We can create ourself the order exactly has we want it. But mind that you need to publish an order that others want to take too! We can create the order exactly has we want it. But mind that you need to publish an order that others want to take too!
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-6.png" width="370" /> <img src="images/how-to-use/maker-page.png" width="370" />
</div> </div>
In the maker page you are only required to enter the currency, order type (buy/sell) and amount. However, it is best practice to specify the payment methods you allow. It might be also helpful to set a premium/discount for your order to be taken faster. Remember that as a seller you can incentivze buyers of taking your order by lowering the premium. If there are too many buyers, however, you can increase the premium to have a trading profit. Alternatively, you can set a fix amount of Satoshis. In the maker page you are only required to enter the currency, order type (buy/sell) and amount. However, it is best practice to specify the payment methods you allow. It might be also helpful to set a premium/discount for your order to be taken faster. Remember that as a seller you can incentivze buyers to take your order by lowering the premium. If there are too many buyers, however, you can increase the premium to have a trading profit. Alternatively, you can set a fixed amount of Satoshis.
*Limits: in Robosats v0.1.0 an order cannot be smaller than 10.000 Satoshis. It cannot be larger than 500.000 Satoshis in order to avoid lightning routing failures. This limit will be increased in the future.* *Limits: in Robosats v0.1.0 an order cannot be smaller than 10.000 Satoshis. It cannot be larger than 500.000 Satoshis in order to avoid lightning routing failures. This limit will be increased in the future.*
@ -142,7 +144,7 @@ In the maker page you are only required to enter the currency, order type (buy/s
<img src="images/how-to-use/contract-box-7.png" width="370" /> <img src="images/how-to-use/contract-box-7.png" width="370" />
</div> </div>
You have to copy or scan the invoice with your lightning wallet in order to lock your fidelity maker bond. By locking this bond, the takers know you can be trusted and are committed to follow with this trade. In your wallet it might show as a payment that is on transit, freeze or even apparently break your wallet. You should always check on the RoboSats website whether the bond has been locked (your wallet will probably not tell you! Check [wallet compatibility list](https://github.com/Reckless-Satoshi/robosats/issues/44)) You have to copy or scan the invoice with your lightning wallet in order to lock your fidelity maker bond. By locking this bond, the takers know you can be trusted and are committed to follow with this trade. In your wallet it might show as a payment that is on transit, freeze or even seemingly break your wallet. You should always check on the RoboSats website whether the bond has been locked (your wallet will probably not tell you! Check [wallet compatibility list](https://github.com/Reckless-Satoshi/robosats/issues/44))
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-8.png" width="370" /> <img src="images/how-to-use/contract-box-8.png" width="370" />
@ -180,7 +182,7 @@ The buyer has just confirmed he did his part! Now check until the fiat is in you
<img src="images/how-to-use/contract-box-13.png" width="370" /> <img src="images/how-to-use/contract-box-13.png" width="370" />
</div> </div>
By confirming that you received the fiat, the escrow will be charged and send to the buyer. So only do this once you are 100% sure the fiat is with you! By confirming that you received the fiat, the escrow will be charged and sent to the buyer. So only do this once you are 100% sure the fiat is with you!
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-14.png" width="370" /> <img src="images/how-to-use/contract-box-14.png" width="370" />
@ -198,9 +200,9 @@ After the trade escrow has been posted and before the buyer confirms he sent the
This is totally not recommended, one of the two traders would lose his fidelity bond except in exceptional cases (up to the discretion of the staff) This is totally not recommended, one of the two traders would lose his fidelity bond except in exceptional cases (up to the discretion of the staff)
## Collaborative cancellation ## Disputes
Missunderstandings happen. But also, there might be people willing to try to scam others. In this case *MakeshiftSource875* thought he could get away by not confirming he received the fiat, as if he was going to be able to keep the satoshis. Misunderstandings happen. But also, there might be people willing to try to scam others. In this case *MakeshiftSource875* thought he could get away by not confirming he received the fiat, as if he was going to be able to keep the satoshis.
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-16.png" width="370" /> <img src="images/how-to-use/contract-box-16.png" width="370" />
@ -212,7 +214,7 @@ This is in fact not possible, as a dispute will be automatically open at expirat
<img src="images/how-to-use/contract-box-17.png" width="370" /> <img src="images/how-to-use/contract-box-17.png" width="370" />
</div> </div>
In RoboSats v0.1.0 the dispute pipeline is not fully implemented in the web. Therefore, most contact and resolution has to happen trough alternative methods. Be sure to send a contact method to the staff. You will have to write down full statement of facts, remember that the staff cannot read your private chat to judge about what happened. It is useful to send images/screenshots. For maximum privacy, these can be encrypted via PGP key and uploaded into any anonymous file sharing system. In RoboSats v0.1.0 the dispute pipeline is not fully implemented in the web. Therefore, most contact and resolution has to happen through alternative methods. Be sure to send a contact method to the staff. You will have to write down full statement of facts, remember that the staff cannot read your private chat to judge about what happened. It is useful to send images/screenshots. For maximum privacy, these can be encrypted via PGP key and uploaded into any anonymous file sharing system.
<div align="center"> <div align="center">
<img src="images/how-to-use/contract-box-18.png" width="370" /> <img src="images/how-to-use/contract-box-18.png" width="370" />