Skip to content

Commit

Permalink
Flesh out the 'creating a wallet' and 'creating an account' documenta…
Browse files Browse the repository at this point in the history
…tion pages, using the Medium 'Migrating from 1.2.5' guide as source material.
  • Loading branch information
rt121212121 committed Sep 17, 2020
1 parent 96ff004 commit 688bef5
Show file tree
Hide file tree
Showing 14 changed files with 186 additions and 2 deletions.
68 changes: 67 additions & 1 deletion docs/standalone/getting-started/creating-a-wallet.rst
@@ -1,4 +1,70 @@
Creating a wallet
=================

This is a page that goes over the details of creating a new wallet in ElectrumSV.
From ElectrumSV 1.3 and beyond, a wallet is now a container for your accounts. This guide shows
you how to create an empty wallet with no accounts. After creating the wallet, you will of course
want to add an account to it, in order to be able to start using it.

Choosing the location and file name
-----------------------------------

The first step is to choose where to store your wallet, and what it’s file name should be.
If you choose not to store your wallet in the default location that ElectrumSV uses, it is
likely that you will quickly be able to find it again in the “Recently Opened Wallets” list
when you open it again in the future.

Start off at the wallet selection page.

.. figure:: images/creating-a-wallet-01-selection-page.png
:alt: blah
:align: center
:scale: 80%

The wallet selection page.

You will be presented with a file dialog that lets you choose where your wallet will be stored,
and what it will be named. It defaults to the standard ElectrumSV wallet location on your
operating system. Enter a file name, and click “Save” (or press the enter key).

.. figure:: images/creating-a-wallet-02-filename-dialog.png
:alt: blah
:align: center
:scale: 80%

The wallet file name dialog.


Add a mandatory password
------------------------

The next step is setting a password for your new wallet. We require a password and there is no
way to opt out, but you can always enter something like “password” or “123456” if you wish.
This is also required for hardware and watch-only wallets, where there is no key or seed word
data to encrypt.

.. figure:: images/creating-a-wallet-03-add-password-dialog.png
:alt: blah
:align: center
:scale: 80%

The wallet file name dialog.

Once you have entered a password, and confirmed it, the “OK” button will become enabled and you
can click it (or just press the enter key) to open the new wallet.

.. figure:: images/creating-a-wallet-04-new-wallet-window.png
:alt: blah
:align: center
:scale: 80%

The new wallet's wallet window.

Congratulations, you have created a new empty wallet. It will not be usable until you have
created an account, and various parts of the user interface will indicate this.

.. figure:: images/creating-a-wallet-05-wallet-window-receiving-disabled.png
:alt: blah
:align: center
:scale: 80%

The receiving tab is disabled.
120 changes: 119 additions & 1 deletion docs/standalone/getting-started/creating-an-account.rst
@@ -1,4 +1,122 @@
Creating an account
===================

This is a document where a user is creating an account.
If you are reading this, you likely have a new wallet that has no accounts, and you want to add
one to it.

We support addition of a wide variety of account types:

- A new “Standard” account. This is the equivalent of creating a new ElectrumSV seed-word
based wallet in 1.2.5 and earlier.
- A multi-signature account. Use this if you are creating a new multi-signature account, or
restoring an existing one from master public keys, seed words and so on.
- Importing from text. Use this to import your seed words, whether Electrum seed words, BIP39
seed words from another wallet, private keys, public keys, master public keys, master private
keys, and so on.
- Importing a hardware wallet. If you have an existing hardware wallet that has a seed set up on
it, then you can use this to add an account that links to it and uses it to sign. If you have
a hardware wallet that does not have a seed set up on it, you should also be able to use this
to set it up unless the device is a Ledger. Do not buy a Ledger.

This guide solely covers creating a "Standard" account.

Adding an account
-----------------

In the top-left-hand corner of your wallet window, you will see the “Add Account” button.
Click it and it will open the account wizard which allows all supported types of accounts to be
created.

.. figure:: images/creating-an-account-01-add-account-button.png
:alt: The "Add Account" button highlighted.
:align: center
:scale: 80%

The "Add Account" button highlighted.

The account wizard offers four different types of account addition, at the time of writing.

.. figure:: images/creating-an-account-02-account-wizard-types.png
:alt: The Account Types page in the Account Wizard.
:align: center
:scale: 80%

The Account Types page in the Account Wizard.

Creating a new “Standard” Account
---------------------------------

Double-click on the “Standard” entry to proceed. Or if you prefer to work for it, click the
“Next” button or press the enter key. You will be asked for your password so that the generated
seed words and private key data can be encrypted into your wallet. This also verifies you have
the ability to really use this wallet, and should able to add an account.

.. figure:: images/password-dialog.png
:alt: The password dialog.
:align: center
:scale: 80%

The password dialog.

You will immediately see that the account has been added to your wallet. You will note that at
no point did you have to copy down your new seed words, or confirm them. You will be reminded to
back them up by the wallet, and can do so at your leisure and own risk.

.. figure:: images/creating-an-account-03-wallet-window-receiving-tab.png
:alt: The new account's receiving tab.
:align: center
:scale: 80%

The new account's receiving tab.

Backing up your seed words
--------------------------

The wallet window now has a notification center, which is used to remind you to deal with
important events, and point out how you can do it.

.. figure:: images/creating-an-account-04-wallet-window-notifications-indicator.png
:alt: The wallet's notifications indicator.
:align: center
:scale: 80%

The wallet's notifications indicator.

The initial backup notification
-------------------------------

Clicking the notification icon will make the new “Notifications” tab the active one and show the
initial notification about backing up your data.

.. figure:: images/creating-an-account-05-wallet-window-notifications-tab.png
:alt: The initial backup notification in the wallet's notifications tab.
:align: center
:scale: 80%

The initial backup notification in the wallet's notifications tab.

Follow the link to your secured data
------------------------------------

If you click on the “account’s secured data” link, it will take you directly to that secured
data. But first it will need your password so it can decrypt that data for display.

.. figure:: images/password-dialog.png
:alt: The password dialog.
:align: center
:scale: 80%

The password dialog.

Having entered the correct password you will see the secured data.

.. figure:: images/creating-an-account-07-secured-data-dialog.png
:alt: The secured data dialog.
:align: center
:scale: 80%

The secured data dialog.

Congratulations, now write down the seed words somewhere safe. I recommend you look into
`SAFEWORDS <https://coinstorage.guru/>`_ to help you with this. You can dismiss the notification
by clicking on the “X” in it’s top right corner.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 688bef5

Please sign in to comment.