Add wallets.md, tweak skin and theme

This commit is contained in:
Reckless_Satoshi 2022-05-14 19:01:21 -07:00
parent 008feda087
commit ce2e562aa5
No known key found for this signature in database
GPG Key ID: 9C4585B561315571
15 changed files with 162 additions and 66 deletions

View File

@ -12,13 +12,13 @@
# theme : "minimal-mistakes-jekyll"
# remote_theme : "mmistakes/minimal-mistakes"
minimal_mistakes_skin : "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"
minimal_mistakes_skin : "robosats_dark" # "default", "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"
# Site Settings
locale : "en-US"
title : "Learn RoboSats"
title_separator : "-"
subtitle : "Simple and Private LN P2P Exchange" # site tagline that appears below site title in masthead
subtitle : "A Simple and Private Lightning P2P Exchange" # site tagline that appears below site title in masthead
name : "RoboSats"
description : "Documentation, Guides and Tutorials of the RoboSats Exchange"
url : https://docs.robosats.com # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
@ -103,7 +103,7 @@ analytics:
# Site Author
author:
name : "Reckless_Satoshi"
avatar : # path of avatar image, e.g. "/assets/images/bio-photo.jpg"
avatar : "/assets/images/misc/recksato.png" # path of avatar image, e.g. "/assets/images/bio-photo.jpg"
bio : "PGP: B4AB 5F19 113D 4125 DDF2 1773 9C45 85B5 6131 5571"
location : "Somewhere in the world"
email :
@ -112,7 +112,7 @@ author:
icon: "fab fa-fw fa-twitter-square"
url: "https://twitter.com/recksato"
- label: "Telegram"
icon: "fa fa-telegram"
icon: "fa-brands fa-telegram"
url: "https://t.me/Reckless_Satoshi"
- label: "GitHub"
icon: "fab fa-fw fa-github"
@ -125,7 +125,7 @@ footer:
icon: "fab fa-fw fa-twitter-square"
url: "https://twitter.com/robosats"
- label: "Telegram"
icon: "fa fa-telegram"
icon: "fa-brands fa-telegram"
url: "https://t.me/robosats"
- label: "GitHub"
icon: "fab fa-fw fa-github"

View File

@ -1,22 +1,22 @@
main:
- title: "Docs"
- title: "<i class='fa-solid fa-book'></i> Docs"
url: /docs/how-to-use/
- title: "Tutorials"
- title: "<i class='fa-solid fa-circle-play'></i> Tutorials"
url: /docs/tutorials/
- title: "Contribute"
- title: "<i class='fa-solid fa-handshake-angle'></i> Contribute"
url: /contribute/
- title: "Blog"
- title: "<i class='fa-solid fa-blog'></i> Blog"
url: /blog/
docs:
- title: "Docs"
url: /docs/how-to-use/
children:
- title: "How to use"
- title: "<i class='fa-solid fa-chalkboard-user'></i> How to use"
url: /docs/how-to-use/
- title: "Easy PGP Encryption"
- title: "<i class='fa-solid fa-fingerprint'></i> Easy PGP Encryption"
url: /docs/pgp-encryption/
- title: "Fiat Best Practices"
- title: "<i class='fa-solid fa-hand-peace'></i> Fiat Best Practices"
url: /docs/fiat-payment-best-practices/
- title: "Wallets"
- title: "<i class='fa-solid fa-wallet'></i> Wallets"
url: /docs/wallets/

View File

@ -12,6 +12,7 @@
<head>
{% include head.html %}
{% include head/custom.html %}
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v6.1.1/css/all.css" crossorigin="anonymous"/>
</head>
<body class="layout--{{ page.layout | default: layout.layout }}{% if page.classes or layout.classes %}{{ page.classes | default: layout.classes | join: ' ' | prepend: ' ' }}{% endif %}">

View File

@ -1,16 +1,14 @@
---
layout: single
title: RoboSats - Fiat Best Practices
title: Fiat Best Practices
permalink: /docs/fiat-payment-best-practices/
toc: true
toc_stickly: true
sidebar:
title: "Fiat Best Practices"
title: "<i class='fa-solid fa-hand-peace'></i> Fiat Best Practices"
nav: docs
---
# Fiat payment method
Currently, there are no restrictions on the fiat payment method. You can pay with any method that both you and your peer agree on. This includes the higher risk method such as PayPal, Venmo, and Cash apps. However, the payment method with lower risk is recommended, you can learn more details about the characteristics and differences of each fiat payment method from <a href = "https://bisq.wiki/Payment_methods#Payment_method_guides">Bisq wiki</a>.
## General recommendation

View File

@ -1,15 +1,13 @@
---
layout: single
title: RoboSats - How to Use
title: How to Use (v0.1.0)
permalink: /docs/how-to-use/
toc: true
toc_stickly: true
sidebar:
title: "How to use"
title: "<i class='fa-solid fa-chalkboard-user'></i> How to use"
nav: docs
---
# How to use RoboSats (v0.1.0)
---
RoboSats is focused on user friendliness. The platform is totally self-explanatory, so one could say a tutorial is really not necessary. However, it really helps to feel comfortable when trading if you already know what are the next steps to come so nothing surprises you. After all, bitcoin p2p exchanges are very intimidating! Fear no more, RoboSats keeps it really simple and you simply cannot do things wrong! :D

View File

@ -1,15 +1,15 @@
---
layout: single
title: RoboSats - Easy PGP Encryption
title: Easy PGP Encryption
permalink: /docs/pgp-encryption/
toc: true
toc_stickly: true
sidebar:
title: "Easy PGP"
title: "<i class='fa-solid fa-fingerprint'></i> Easy PGP Encryption"
nav: docs
---
# How to use OpenKeychain for cipher sensible data during RoboSats trade.
Learn how to use OpenKeychain to cipher sensible data during RoboSats trade.
## Why encryption is needed?

75
docs/_pages/wallets.md Normal file
View File

@ -0,0 +1,75 @@
---
layout: single
classes: wide
title: Wallets
permalink: /docs/wallets/
toc: true
toc_stickly: true
sidebar:
title: "<i class='fa-solid fa-wallet'></i> Wallets"
nav: docs
# Icons
good: "<i style='color:#4caf50' class='fa-solid fa-square-check fa-2xl'></i>"
soso: "<i style='color:#ff9800' class='fa fa-triangle-exclamation fa-2xl'></i>"
bad: "<i style='color:#ef5350' class='fa-solid fa-xmark fa-3x'></i>"
phone: "<i class='fa-solid fa-mobile-screen fa-xl'></i>"
laptop: "<i class='fa-solid fa-laptop fa-xl'></i>"
cli: "<i class='fa-solid fa-terminal fa-xl'></i>"
laptop_phone: "<i class='fa-solid fa-laptop-mobile fa-xl'></i>"
remote: "<i class='fa-solid fa-house fa-xl'></i>"
thumbsup: "<i style='color:#4caf50' class='fa-solid fa-thumbs-up fa-2xl'></i>"
thumbsdown: "<i style='color:#ef5350' class='fa-solid fa-thumbs-down fa-2xl'></i>"
unclear: "<i style='color:#ff9800' class='fa-solid fa-question fa-2xl'></i>"
---
## Wallet Compatibility Table
| Wallet | Version | Device | UX<sup>1</sup> | Bonds<sup>2</sup> | Payout<sup>3</sup> | Compatible<sup>4</sup> | Recommended<sup>5</sup> |
|---|---|---|---|---|---|---|---|
|[Blixt](#blixt-androidios-lnd-light-backend-on-device)|[v0.4.1](https://github.com/hsjoberg/blixt-wallet)|{{page.phone}}|{{page.soso}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.thumbsup}}|
|[Electrum](#electrum-desktop)|[4.1.4](https://github.com/spesmilo/electrum)|{{page.laptop}}|{{page.good}}|{{page.soso}}|{{page.soso}}|{{page.soso}}|{{page.unclear}}||
|[LND](#zeus-mobile-lnd-remote-backend)|[v0.14.2](https://github.com/LightningNetwork/lnd)|{{page.cli}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.thumbsup}}|
|[Zeus](#zeus-mobile-lnd-remote-backend)|[v0.6.0-rc3](https://github.com/ZeusLN/zeus)|{{page.phone}}{{page.remote}}|{{page.soso}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.thumbsup}}|
|[SBW](#wallet-compatibility-table)|[2.4.27](https://github.com/btcontract/wallet/)|{{page.phone}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.thumbsup}}|
|[Muun](https://muun.com/)|[47.3](https://muun.com/)|{{page.phone}}|{{page.good}}|{{page.good}}|{{page.bad}}|{{page.bad}}|{{page.thumbsdown}}|
|[lntxbot](https://github.com/Reckless-Satoshi/robosats/issues/44#issuecomment-1054607956)|[NA](https://t.me/lntxbot)|{{page.laptop}}{{page.phone}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.good}} | {{page.thumbsup}} [(info)](https://github.com/Reckless-Satoshi/robosats/issues/44#issuecomment-1054607956)|
|[BlueWallet](https://bluewallet.io/)|[1.4.4](https://bluewallet.io/)|{{page.phone}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.unclear}} (buggy)|
|[WalletOfSatoshi](#wallet-compatibility-table)|[1.15.0](https://www.walletofsatoshi.com/)|{{page.phone}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.thumbsup}}|
|[Phoenix](#phoenix-mobile)|[35-1.4.20](https://phoenix.acinq.co/)|{{page.phone}}|{{page.good}}|{{page.bad}}|{{page.good}}|{{page.bad}}|{{page.thumbsdown}}|
|[Bitcoin Beach](#phoenix-mobile)|[v1.7.7](https://galoy.io/bitcoin-beach-wallet/)|{{page.phone}}|{{page.good}}|{{page.good}}|{{page.good}}|{{page.good}} |{{page.thumbsup}} [(info)](https://github.com/Reckless-Satoshi/robosats/issues/44#issuecomment-1126318591)|
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?
5. **Recommended:** Is the wallet compatible and stable enough to be used consistently without issues?
### 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. I recommend it to use with RoboSats. 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). Might show 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 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.
### 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.
### Zeus (Mobile, LND remote backend)
It is an interface to LND. 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.
### 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, 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 0.2% and it needs to cover the routing fees, **RoboSats will never find a suitable route to a Muun wallet user**.
### Phoenix (Mobile)
Phoenix worked well when full trade pipeline was limited to 10 hours. Now that it is 24 hours of public order plus 24 hours for the fiat exchange step it will not allow users lock the bond (`Cannot add htlc (...) reason=expiry too big`). Might become compatible with RoboSats again once trades are shortened.
### 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!
### Bitcoin Beach (Mobile)
The hodl invoice shows as a grey icon while waiting. Need to tap the back obvious back button to return to the main screen while the payment is pending.
## <i class="fa-solid fa-code-pull-request"></i> 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/Reckless-Satoshi/robosats/tree/main/docs/_pages/wallets.md) and opening a [Pull Request](https://github.com/Reckless-Satoshi/robosats/pulls)

View File

@ -1,29 +0,0 @@
---
layout: post
title: "Welcome to Jekyll!"
date: 2022-05-14 06:28:14 -0500
categories: jekyll update
---
Youll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
Jekyll requires blog post files to be named according to the following format:
`YEAR-MONTH-DAY-title.MARKUP`
Where `YEAR` is a fur-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works.
Jekyll also offers powerful support for code snippets:
{% highlight ruby %}
def print_hi(name)
puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.
{% endhighlight %}
Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekylls GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
[jekyll-docs]: https://jekyllrb.com/docs/home
[jekyll-gh]: https://github.com/jekyll/jekyll
[jekyll-talk]: https://talk.jekyllrb.com/

View File

@ -0,0 +1,10 @@
---
layout: home
author_profile: true
title: "Welcome to Learn.RoboSats!"
date: 2022-05-14 06:28:14 -0500
categories: robosats update
---
Sovereignty is scary at first, then liberating. Buying your first Sats from a peer looks intimidating but is very empowering. In Learn.RoboSats you can find all of the documentation and resources so you feel comfortable using a P2P exchange. From easy to follow video tutorials, to technical deep-dives into how the exchange protects your privacy.
This site is under construction, just like the exchange itself. Have fun!

View File

@ -3,3 +3,23 @@
========================================================================== */
// Intentionally left blank
/* Colors */
$background-color: #eeeeee !default;
$text-color: #222831 !default;
$muted-text-color: #393e46 !default;
$primary-color: #0092ca !default;
$border-color: mix(#fff, #393e46, 75%) !default;
$footer-background-color: $primary-color !default;
$link-color: #393e46 !default;
$masthead-link-color: $text-color !default;
$masthead-link-color-hover: $text-color !default;
$navicon-link-color-hover: mix(#fff, $text-color, 80%) !default;
.page__footer {
color: #fff !important; // override
}
.page__footer-follow .social-icons .svg-inline--fa {
color: inherit;
}

View File

@ -0,0 +1,23 @@
/* ==========================================================================
RoboSats skin
========================================================================== */
/* Colors */
$background-color: #ffffff !default;
$text-color: #2c2c2c !default;
$muted-text-color: #393e46 !default;
$primary-color: #1976d2 !default;
$border-color: mix(#fff, #393e46, 75%) !default;
$footer-background-color: $primary-color !default;
$link-color: #42a5f5 !default;
$masthead-link-color: $text-color !default;
$masthead-link-color-hover: $text-color !default;
$navicon-link-color-hover: mix(#fff, $text-color, 80%) !default;
.page__footer {
color: #fff !important; // override
}
.page__footer-follow .social-icons .svg-inline--fa {
color: inherit;
}

View File

@ -1,19 +1,19 @@
/* ==========================================================================
Dark skin
RoboSats Dark skin
========================================================================== */
/* Colors */
$background-color: #252a34 !default;
$text-color: #eaeaea !default;
$primary-color: #00adb5 !default;
$background-color: #222222 !default;
$text-color: #d6d6d6 !default;
$primary-color: #90caf9 !default;
$border-color: mix(#fff, $background-color, 20%) !default;
$code-background-color: mix(#000, $background-color, 15%) !default;
$code-background-color-dark: mix(#000, $background-color, 20%) !default;
$form-background-color: mix(#000, $background-color, 15%) !default;
$footer-background-color: mix(#000, $background-color, 30%) !default;
$link-color: mix($primary-color, $text-color, 40%) !default;
$link-color-hover: mix(#fff, $link-color, 25%) !default;
$link-color-visited: mix(#000, $link-color, 25%) !default;
$link-color-hover: mix(#1976d2, $link-color, 25%) !default;
$link-color-visited: #ce93d8 !default;
$masthead-link-color: $text-color !default;
$masthead-link-color-hover: mix(#000, $text-color, 20%) !default;
$navicon-link-color-hover: mix(#000, $background-color, 30%) !default;

Binary file not shown.

After

Width:  |  Height:  |  Size: 310 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.5 KiB

After

Width:  |  Height:  |  Size: 121 KiB

View File

@ -7,25 +7,25 @@ header:
cta_label: "<i class='fa-solid fa-lines-leaning'></i> Learn How to Use Now"
cta_url: "/docs/how-to-use/"
caption:
excerpt: 'A simple and private way to exchange bitcoin for national currencies.<br /> <small><a href="https://robosats.com">Use RoboSats now with Tor Browser</a></small><br /> <small><a href="https://github.com/reckless-satoshi/robosats">GitHub Project Page</a></small>'
excerpt: 'A simple and private way to exchange bitcoin for national currencies.<br /> <i class="fa-solid fa-bolt"></i> <small><a href="https://robosats.com">Use RoboSats with Tor Browser</a></small><br /> <i class="fa-brands fa-github-alt"></i> <small><a href="https://github.com/reckless-satoshi/robosats">GitHub Project Page</a></small>'
feature_row:
- image_path: /assets/images/misc/feature-fast.png
alt: "fast"
title: "Lightning fast"
excerpt: "TODO... lightning... hodl... faster than a block...."
title: "Lightning Fast"
excerpt: "TODO... lightning... hodl... faster than a block....Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore"
url: "/docs/lightning-features/"
btn_class: "btn--primary"
btn_label: "Learn more"
- image_path: /assets/images/misc/feature-private.png
alt: "private"
title: "Totally private"
excerpt: "TODO... non-KYC... Tor Only...no identity reuse....<br /><br />"
title: "Absolutely Private"
excerpt: "TODO... non-KYC... Tor Only...no identity reuse....Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod<br/>"
url: "/docs/privacy-features/"
btn_class: "btn--primary"
btn_label: "Learn more"
- image_path: /assets/images/misc/feature-open-source.png
alt: "FLOSS"
title: "Open source"
title: "Open Source"
excerpt: 'RoboSats is fully open source and will always be.{::nomarkdown}<p style="margin-top: -5px;margin-bottom: 0px"><iframe style="display: inline-block;" src="https://ghbtns.com/github-btn.html?user=reckless-satoshi&repo=robosats&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe><iframe style="display: inline-block;" src="https://ghbtns.com/github-btn.html?user=reckless-satoshi&repo=robosats&type=fork&count=true&size=large" frameborder="0" scrolling="0" width="158px" height="30px"></iframe></p>{:/nomarkdown}'
url: "https://github.com/Reckless-Satoshi/robosats/blob/main/LICENSE"
btn_class: "btn--primary"