diff --git a/docs/_config.yml b/docs/_config.yml index 03dede83..e27562fc 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -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" diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 49708a46..5a6702d1 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -1,22 +1,22 @@ main: - - title: "Docs" + - title: " Docs" url: /docs/how-to-use/ - - title: "Tutorials" + - title: " Tutorials" url: /docs/tutorials/ - - title: "Contribute" + - title: " Contribute" url: /contribute/ - - title: "Blog" + - title: " Blog" url: /blog/ docs: - title: "Docs" url: /docs/how-to-use/ children: - - title: "How to use" + - title: " How to use" url: /docs/how-to-use/ - - title: "Easy PGP Encryption" + - title: " Easy PGP Encryption" url: /docs/pgp-encryption/ - - title: "Fiat Best Practices" + - title: " Fiat Best Practices" url: /docs/fiat-payment-best-practices/ - - title: "Wallets" + - title: " Wallets" url: /docs/wallets/ \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 5abd9645..40a6856f 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -12,6 +12,7 @@ {% include head.html %} {% include head/custom.html %} + diff --git a/docs/_pages/fiat-payment-methods.md b/docs/_pages/fiat-payment-methods.md index 54ed3cc8..413a1d89 100644 --- a/docs/_pages/fiat-payment-methods.md +++ b/docs/_pages/fiat-payment-methods.md @@ -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: " 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 Bisq wiki. ## General recommendation diff --git a/docs/_pages/how-to-use.md b/docs/_pages/how-to-use.md index 70129c47..e8ed3ed1 100644 --- a/docs/_pages/how-to-use.md +++ b/docs/_pages/how-to-use.md @@ -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: " 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 diff --git a/docs/_pages/sensitive-data-PGP-guide.md b/docs/_pages/sensitive-data-PGP-guide.md index e0f510e3..ebbb8acf 100644 --- a/docs/_pages/sensitive-data-PGP-guide.md +++ b/docs/_pages/sensitive-data-PGP-guide.md @@ -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: " 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? diff --git a/docs/_pages/wallets.md b/docs/_pages/wallets.md new file mode 100644 index 00000000..505c11b2 --- /dev/null +++ b/docs/_pages/wallets.md @@ -0,0 +1,75 @@ +--- +layout: single +classes: wide +title: Wallets +permalink: /docs/wallets/ +toc: true +toc_stickly: true +sidebar: + title: " Wallets" + nav: docs + +# Icons +good: "" +soso: "" +bad: "" +phone: "" +laptop: "" +cli: "" +laptop_phone: "" +remote: "" +thumbsup: "" +thumbsdown: "" +unclear: "" +--- +## Wallet Compatibility Table + +| Wallet | Version | Device | UX1 | Bonds2 | Payout3 | Compatible4 | Recommended5 | +|---|---|---|---|---|---|---|---| +|[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. + + +## 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) + diff --git a/docs/_posts/2022-05-14-welcome-to-jekyll.markdown b/docs/_posts/2022-05-14-welcome-to-jekyll.markdown deleted file mode 100644 index c644a8a3..00000000 --- a/docs/_posts/2022-05-14-welcome-to-jekyll.markdown +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: post -title: "Welcome to Jekyll!" -date: 2022-05-14 06:28:14 -0500 -categories: jekyll update ---- -You’ll 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 [Jekyll’s 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/ diff --git a/docs/_posts/2022-05-14-welcome-to-learn-robosats.md b/docs/_posts/2022-05-14-welcome-to-learn-robosats.md new file mode 100644 index 00000000..9d099799 --- /dev/null +++ b/docs/_posts/2022-05-14-welcome-to-learn-robosats.md @@ -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! diff --git a/docs/_sass/minimal-mistakes/skins/_default.scss b/docs/_sass/minimal-mistakes/skins/_default.scss index 7489b584..3cbf8291 100644 --- a/docs/_sass/minimal-mistakes/skins/_default.scss +++ b/docs/_sass/minimal-mistakes/skins/_default.scss @@ -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; +} diff --git a/docs/_sass/minimal-mistakes/skins/_robosats.scss b/docs/_sass/minimal-mistakes/skins/_robosats.scss new file mode 100644 index 00000000..4b2bccfa --- /dev/null +++ b/docs/_sass/minimal-mistakes/skins/_robosats.scss @@ -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; +} diff --git a/docs/_sass/minimal-mistakes/skins/_dark.scss b/docs/_sass/minimal-mistakes/skins/_robosats_dark.scss similarity index 81% rename from docs/_sass/minimal-mistakes/skins/_dark.scss rename to docs/_sass/minimal-mistakes/skins/_robosats_dark.scss index 38053493..09debfa6 100644 --- a/docs/_sass/minimal-mistakes/skins/_dark.scss +++ b/docs/_sass/minimal-mistakes/skins/_robosats_dark.scss @@ -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; diff --git a/docs/assets/images/misc/recksato.png b/docs/assets/images/misc/recksato.png new file mode 100644 index 00000000..7667384f Binary files /dev/null and b/docs/assets/images/misc/recksato.png differ diff --git a/docs/favicon.ico b/docs/favicon.ico index 35638f23..62167a9e 100644 Binary files a/docs/favicon.ico and b/docs/favicon.ico differ diff --git a/docs/home.md b/docs/home.md index e43395d4..6eae26ea 100644 --- a/docs/home.md +++ b/docs/home.md @@ -7,25 +7,25 @@ header: cta_label: " Learn How to Use Now" cta_url: "/docs/how-to-use/" caption: -excerpt: 'A simple and private way to exchange bitcoin for national currencies.
Use RoboSats now with Tor Browser
GitHub Project Page' +excerpt: 'A simple and private way to exchange bitcoin for national currencies.
Use RoboSats with Tor Browser
GitHub Project Page' 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....

" + title: "Absolutely Private" + excerpt: "TODO... non-KYC... Tor Only...no identity reuse....Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod
" 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}

{:/nomarkdown}' url: "https://github.com/Reckless-Satoshi/robosats/blob/main/LICENSE" btn_class: "btn--primary"