From 3e14c9a36fbf69dfb53d137dedbd815aa7c87d0c Mon Sep 17 00:00:00 2001 From: ncoelho Date: Fri, 5 Mar 2021 11:24:11 +0100 Subject: [PATCH] improved docs --- _data/navigation_docs.yml | 6 +- _docs/backup-wallet.md | 4 +- _docs/create-bitcoin-wallet.md | 44 +- _docs/create-lightning-wallet.md | 9 +- _docs/import-wallet.md | 28 + _docs/recover-wallet.md | 8 +- _docs/sign-offline.md | 21 + _site/404.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- .../Bluewallet-4-2-0-d31c7c4487fa/index.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- _site/about/index.html | 26 +- _site/bitcoin-wallet/index.html | 26 +- _site/blog/2/index.html | 26 +- _site/blog/index.html | 26 +- _site/changelog-posts/index.html | 26 +- _site/changelog-timeline/index.html | 26 +- _site/contact/index.html | 26 +- _site/desktop-bitcoin-wallet/index.html | 26 +- _site/docs/alerts/index.html | 62 +- _site/docs/analytics/index.html | 80 +- _site/docs/backup-wallet/index.html | 90 +- _site/docs/batching/index.html | 74 +- _site/docs/boxes/index.html | 62 +- _site/docs/changelog/index.html | 66 +- _site/docs/cobo-vault/index.html | 73 +- _site/docs/coldcard-dropbox/index.html | 80 +- _site/docs/coldcard-watch/index.html | 80 +- _site/docs/coldcard/index.html | 80 +- _site/docs/comments/index.html | 80 +- _site/docs/contact/index.html | 66 +- _site/docs/create-bitcoin-wallet/index.html | 125 +-- _site/docs/create-lightning-wallet/index.html | 88 +- _site/docs/cta/index.html | 62 +- _site/docs/customize/index.html | 80 +- _site/docs/development/index.html | 80 +- _site/docs/docs/index.html | 66 +- _site/docs/faq/index.html | 62 +- _site/docs/featured/index.html | 62 +- _site/docs/footer/index.html | 66 +- _site/docs/hero/index.html | 62 +- _site/docs/import-wallet/index.html | 800 +++++++++++++++ _site/docs/installation/index.html | 66 +- _site/docs/intro/index.html | 62 +- _site/docs/lndhub-macos/index.html | 80 +- _site/docs/lndhub-raspibolt/index.html | 80 +- _site/docs/lndhub-ubuntu/index.html | 80 +- _site/docs/local-trader/index.html | 73 +- _site/docs/manual-entropy/index.html | 65 +- _site/docs/media/index.html | 62 +- _site/docs/multisig-spend/index.html | 77 +- _site/docs/navigation/index.html | 66 +- _site/docs/pages/index.html | 80 +- _site/docs/posts/index.html | 80 +- _site/docs/recover-wallet/index.html | 90 +- _site/docs/setup/index.html | 66 +- _site/docs/sign-offline/index.html | 939 ++++++++++++++++++ _site/docs/sources/index.html | 80 +- _site/docs/support/index.html | 80 +- _site/docs/team/index.html | 62 +- _site/docs/toc/index.html | 62 +- _site/docs/translation/index.html | 80 +- _site/docs/videos/index.html | 62 +- _site/features/index.html | 28 +- _site/index.html | 30 +- .../index.html | 26 +- _site/jekyll-feed/CODE_OF_CONDUCT.md | 74 -- _site/jekyll-feed/Gemfile | 6 - _site/jekyll-feed/LICENSE.txt | 21 - _site/jekyll-feed/README.md | 43 - _site/jekyll-feed/Rakefile | 2 - _site/jekyll-feed/bin/console | 14 - _site/jekyll-feed/bin/setup | 8 - _site/jekyll-feed/jekyll-feed.gemspec | 41 - _site/jekyll-feed/lib/jekyll/feed.rb | 8 - _site/jekyll-feed/lib/jekyll/feed/version.rb | 5 - _site/jekyll-seo-tag/CODE_OF_CONDUCT.md | 74 -- _site/jekyll-seo-tag/Gemfile | 6 - _site/jekyll-seo-tag/LICENSE.txt | 21 - _site/jekyll-seo-tag/README.md | 43 - _site/jekyll-seo-tag/Rakefile | 2 - _site/jekyll-seo-tag/bin/console | 14 - _site/jekyll-seo-tag/bin/setup | 8 - _site/jekyll-seo-tag/jekyll-seo-tag.gemspec | 41 - _site/jekyll-seo-tag/lib/jekyll/seo/tag.rb | 10 - .../lib/jekyll/seo/tag/version.rb | 7 - _site/lightning/index.html | 26 +- _site/lndhub/index.html | 26 +- _site/local-trader/index.html | 26 +- _site/marketplace-btc/img/silent.link.png | Bin 0 -> 6841 bytes _site/marketplace-btc/index.html | 14 +- _site/marketplace/img/silent.link.png | Bin 0 -> 6841 bytes _site/marketplace/img/stekking.png | Bin 0 -> 28043 bytes _site/marketplace/index.html | 26 + _site/multisig-wallet/index.html | 28 +- _site/privacy/index.html | 26 +- _site/search.json | 108 +- _site/thanks/index.html | 26 +- _site/tos/index.html | 26 +- .../index.html | 26 +- .../v5-0-0-coldcard-wallet-support/index.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- .../index.html | 26 +- _site/watch-app/index.html | 26 +- _site/watch-only/index.html | 26 +- 114 files changed, 4682 insertions(+), 1842 deletions(-) create mode 100644 _docs/import-wallet.md create mode 100644 _docs/sign-offline.md create mode 100644 _site/docs/import-wallet/index.html create mode 100644 _site/docs/sign-offline/index.html delete mode 100644 _site/jekyll-feed/CODE_OF_CONDUCT.md delete mode 100644 _site/jekyll-feed/Gemfile delete mode 100644 _site/jekyll-feed/LICENSE.txt delete mode 100644 _site/jekyll-feed/README.md delete mode 100644 _site/jekyll-feed/Rakefile delete mode 100755 _site/jekyll-feed/bin/console delete mode 100755 _site/jekyll-feed/bin/setup delete mode 100644 _site/jekyll-feed/jekyll-feed.gemspec delete mode 100644 _site/jekyll-feed/lib/jekyll/feed.rb delete mode 100644 _site/jekyll-feed/lib/jekyll/feed/version.rb delete mode 100644 _site/jekyll-seo-tag/CODE_OF_CONDUCT.md delete mode 100644 _site/jekyll-seo-tag/Gemfile delete mode 100644 _site/jekyll-seo-tag/LICENSE.txt delete mode 100644 _site/jekyll-seo-tag/README.md delete mode 100644 _site/jekyll-seo-tag/Rakefile delete mode 100755 _site/jekyll-seo-tag/bin/console delete mode 100755 _site/jekyll-seo-tag/bin/setup delete mode 100644 _site/jekyll-seo-tag/jekyll-seo-tag.gemspec delete mode 100644 _site/jekyll-seo-tag/lib/jekyll/seo/tag.rb delete mode 100644 _site/jekyll-seo-tag/lib/jekyll/seo/tag/version.rb create mode 100644 _site/marketplace-btc/img/silent.link.png create mode 100644 _site/marketplace/img/silent.link.png create mode 100644 _site/marketplace/img/stekking.png diff --git a/_data/navigation_docs.yml b/_data/navigation_docs.yml index 7983fe6..b2ab8e7 100644 --- a/_data/navigation_docs.yml +++ b/_data/navigation_docs.yml @@ -2,15 +2,17 @@ docs: - intro - create-bitcoin-wallet + - import-wallet - create-lightning-wallet - backup-wallet - recover-wallet - manual-entropy - batching - - multisig-spend -- title: Hardware Wallets +- title: Cold storage docs: + - sign-offline + - multisig-spend - coldcard - coldcard-dropbox - coldcard-watch diff --git a/_docs/backup-wallet.md b/_docs/backup-wallet.md index 8406c59..32c9298 100644 --- a/_docs/backup-wallet.md +++ b/_docs/backup-wallet.md @@ -1,10 +1,10 @@ --- -title: How to backup/export a wallet +title: Backup/export a wallet subtitle: Access to private keys and recover of wallets tags: [usage] --- -To backup or export your wallet is pretty simple. This backup is the "key", usually a mnemonic (set of 24 words) or just a "text" that will give you access to your wallet if you lose your device, uninstall the app, etc. In short, if something wrong happens and you want/need to get access to your wallet again. +To backup or export your wallet is pretty simple. This backup is the "key", usually a mnemonic (set of 12 or 24 words) or just a "text" that will give you access to your wallet if you lose your device, uninstall the app, etc. In short, if something wrong happens and you want/need to get access to your wallet again. ### Things to know On bluewallet every wallet has its own backup and there's no global backup for all wallets that you can create, this is something you need to do individually for each wallet. We advise to backup all wallets. diff --git a/_docs/create-bitcoin-wallet.md b/_docs/create-bitcoin-wallet.md index bcc2463..cdb01e8 100644 --- a/_docs/create-bitcoin-wallet.md +++ b/_docs/create-bitcoin-wallet.md @@ -1,5 +1,5 @@ --- -title: How to create a Bitcoin wallet +title: Create a Bitcoin wallet tags: - setup --- @@ -34,17 +34,18 @@ you'll see more options for creating the wallet. The first group of options is for the wallet type: -##### HD SegWit (BIP84 Bech32 Native) +##### SegWit HD (BIP84 Bech32 - Native) -??? +Is the latest bitcoin address type. It will save the most on fees and it will give you multiple addresses for best practice when it comes to protect your privacy. + +##### SegWit HD (BIP49 PS2H - Wrapped) + +It is a compromise to the new addresses type above, it provides better compatibility with older addrress types and most services like exchanges, but a smaller save on fees. ##### SegWit (P2SH) -??? +This is a single address wallet, in case you want a wallet with just one address. The others will give you a new address every time you make a transaction. This is not good for privacy for instance, only use it if you know what you are doing. -###### HD SegWit (BIP49 PS2H) - -??? #### Manual entropy @@ -52,32 +53,3 @@ BlueWallet supports manual entropy. See [here](./manual-entropy.md) for more det When you're ready, you can click on "Create" to make your new wallet. -### Importing a wallet - -Instead of creating a new wallet, you can chose to import a wallet from another source or a wallet that you've previously created on BlueWallet. - -Click on "Import wallet" to open the import screen. - -{% include phone-screenshot-image.html img="import-wallet.png" alt="Import wallet" %} - -In this text area you can post your: mnemonic, private key or WIF. - -#### Mnemonic - -??? - -#### Private key - -??? - -#### WIF - -??? - -#### ??? What else can the user import - -After you've entered your import source in the text area, click "Import" to create an imported wallet. - -#### Scanning or importing a file - -What is this feature for??? What can you scan? What type of file can you import? \ No newline at end of file diff --git a/_docs/create-lightning-wallet.md b/_docs/create-lightning-wallet.md index 0bf3df0..7195c7f 100644 --- a/_docs/create-lightning-wallet.md +++ b/_docs/create-lightning-wallet.md @@ -1,5 +1,5 @@ --- -title: How to create a Lightning wallet +title: Create a Lightning wallet tags: [setup] --- @@ -34,16 +34,11 @@ you'll see one more option for creating the wallet. Lightning functionality in BlueWallet is powered by [LNDHub](http://lndhub.io/), an open source service that we created for this purpose. We host our own instance of this service and BlueWallet connects to it by default. However, for more privacy you can host your own instance and connect to it. -To do that, you can add the address of your node in the specified text field. +To do that, you can add the address of your lndhub instance in the specified text field. -#### Provide entropy - -Is the "Provide entropy" feature applicable to Lightning wallets??? When you're ready, you can click on "Create" to make your new wallet. -### Importing a wallet -??? is it possible to import a Lightning wallet? diff --git a/_docs/import-wallet.md b/_docs/import-wallet.md new file mode 100644 index 0000000..822ecfe --- /dev/null +++ b/_docs/import-wallet.md @@ -0,0 +1,28 @@ +--- +title: Import a wallet +tags: + - setup +--- + +Instead of creating a new wallet, you can chose to import a wallet from another source or a wallet that you've previously created on BlueWallet. + +Click on "Import wallet" to open the import screen. + +{% include phone-screenshot-image.html img="import-wallet.png" alt="Import wallet" %} + +In this text area you can post your: mnemonic, private key or WIF. + +#### Mnemonic Seed + +You would need to write your seed words. Like a sentence, without numbers, in the order it was given and with a space in between each word. + +For instance: clock boat sunshine + +In case you have doubts on any word, here's the list of words: +[https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt](https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt) + +After you've entered your import source in the text area, click "Import" to recover an imported wallet. + +#### Scanning or importing a file + +You can also scan a QR code or use a file format to import your wallet. \ No newline at end of file diff --git a/_docs/recover-wallet.md b/_docs/recover-wallet.md index 0f99578..6b9e577 100644 --- a/_docs/recover-wallet.md +++ b/_docs/recover-wallet.md @@ -1,5 +1,5 @@ --- -title: How to recover your wallet +title: Recover your wallet subtitle: Recover your wallet on external software tags: - usage @@ -8,15 +8,15 @@ BlueWallet provides 12 or 24 word mnemonic seeds for onchain Segwit wallets. The ### BIP44 -{% include alert.html style="success" text="m/44'" %} +{% include alert.html style="success" text="m/44'/0'/0'" %} ### BIP49 -{% include alert.html style="success" text="m/49'" %} +{% include alert.html style="success" text="m/49'/0'/0'" %} ### BIP84 -{% include alert.html style="success" text="m/84'/0'/0''" %} +{% include alert.html style="success" text="m/84'/0'/0'" %} You can use Electrum wallet on desktop (electrum.org) to recover this wallets at any moment. diff --git a/_docs/sign-offline.md b/_docs/sign-offline.md new file mode 100644 index 0000000..9eca743 --- /dev/null +++ b/_docs/sign-offline.md @@ -0,0 +1,21 @@ +--- +title: Sign a transaction offline +tags: [usage] +--- + +To sign an offline transaction you will need a watch-only (zpub) wallet on a device and a wallet with the seed on the other to sign it. + +On the watch-only you build your transaction. This will generate a QR code that you will be able to scan or a file that you can export. + +On the wallet with the seed, you go to send → top options → sign transaction. +Then scan the QR code or import the file. That's it the transaction is not signed and ready to be broadcasted. + +To import back to the online device, you just reserve the process and import the transaction from the watch-only wallet. + +
+
+
+ +
+
+
\ No newline at end of file diff --git a/_site/404.html b/_site/404.html index c2e0b0b..69f39f5 100644 --- a/_site/404.html +++ b/_site/404.html @@ -239,19 +239,23 @@ -
  • How to create a Bitcoin wallet
    • +
  • Create a Bitcoin wallet
    • -
  • How to create a Lightning wallet
    • +
  • Import a wallet
    • -
  • How to backup/export a wallet
    • +
  • Create a Lightning wallet
    • -
  • How to recover your wallet
    • +
  • Backup/export a wallet
    • + + + +
  • Recover your wallet
    • @@ -261,15 +265,19 @@
  • Send to many or Batching
    • + + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    - + +
    Cold storage
    + - -
    Hardware Wallets
    -