Skip to content

Update documentation of identity and account creation and of backup and recovery for CryptoX #1330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Mar 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions source/mainnet/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -642,4 +642,6 @@
"docs/protocol/company-identities" : "/en/mainnet/tutorials/company-identity/company-identities.html",
"docs/network/query-node" : "/en/mainnet/tools/query-node.html",
"net/references/net/references/grpc2" : "/en/mainnet/tools/grpc2.html",
"guides/export-import": "/en/mainnet/docs/guides/recovery.html",
"guides/recover-wallet": "/en/mainnet/docs/guides/recovery.html"
}
14 changes: 6 additions & 8 deletions source/mainnet/docs/browser-wallet/browser-wallet-faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

If you accidentally throw away the paper your secret recovery phrase is written on, forget where you hid it, or do not pass it on to an heir, you no longer have the ability to recover your wallet and can lose access to your CCDs. If someone steals your secret recovery phrase, they can access your CCDs. **If you lose your secret recovery phrase you lose access to your CCDs.**

As long as you have your secret recovery phrase, you have your CCDs. If you break a device containing your wallet, you haven’t lost your CCDs. You can simply :ref:`enter your secret recovery phrase<recover-wallet>` into a newly downloaded |mw-gen2| or |bw|.
As long as you have your secret recovery phrase, you have your CCDs. If you break a device containing your wallet, you haven’t lost your CCDs. You can simply :ref:`enter your secret recovery phrase<backup-import-recover>` into a newly downloaded |cryptox| or |bw|.

.. dropdown:: How can I keep my secret recovery phrase secure?

Expand All @@ -52,15 +52,13 @@

#. Download the |bw| and set it up so you have a :term:`secret recovery phrase`, a verified identity, and at least one account.
#. Open the |mw-gen1| and send your funds from it to your new account(s) in the |bw|.
#. Once you are sure that all of your funds have been transferred and you have no incoming transfers, you can delete the |mw-gen1| on your phone. You can also keep the |mw-gen1| and use both wallets. Just make sure that you continue to make :ref:`backups<export-import>` if you continue using the |mw-gen1|.

Identity and account creation is disabled in |mw-gen1|.
#. Once you are sure that all of your funds have been transferred and you have no incoming transfers, you can delete the |mw-gen1| on your phone.

.. dropdown:: Can I access my wallet on multiple devices with the secret recovery phrase?

Yes, you can access your wallet concurrently using |mw-gen2| and |bw|. You can :ref:`recover<recover-wallet>` your wallet in a device that uses either of these. Be aware that any names you have given to identities and accounts are **specific to the device**, so if you have used special names for them, they will not appear when you recover the wallet on another device. You can edit the account name and edit the identity name, if desired.
Yes, you can access your wallet concurrently using |cryptox| and |bw|. You can :ref:`recover<backup-import-recover>` your wallet in a device that uses either of these. Be aware that any names you have given to identities and accounts are **specific to the device**, so if you have used special names for them, they will not appear when you recover the wallet on another device. You can edit the account name and edit the identity name, if desired.

It is also important to note that if, for example, you add an account on one wallet that is recovered on two devices in parallel (from the same recovery phrase), nothing is dynamically updated across wallets from the same recovery phrase except balances. To get updates such as a new account or new identity, it is necessary to :ref:`recover<recover-wallet>` from your recovery phrase again; however you do not need to enter the recovery phrase again as the wallet will remember it.
It is also important to note that if, for example, you add an account on one wallet that is recovered on two devices in parallel (from the same recovery phrase), nothing is dynamically updated across wallets from the same recovery phrase except balances. To get updates such as a new account or new identity, it is necessary to :ref:`recover<backup-import-recover>` from your recovery phrase again; however you do not need to enter the recovery phrase again as the wallet will remember it.

.. dropdown:: Can I use my secret recovery phrase to restore my accounts in third-party wallets?

Expand All @@ -82,8 +80,8 @@

.. dropdown:: Can I access the same accounts on different devices?

If you are using |bw| and the |mw-gen2|, you can because the |mw-gen2| also uses the :term:`secret recovery phrase`. You simply enter your :ref:`recovery phrase<recover-wallet>` into the wallet to see the same identities and accounts on both. Note that the account and identity names are specific to the device and are not the same between devices.
If you are using |bw| and |cryptox|, you can because the |cryptox| also uses the :term:`secret recovery phrase`. You simply enter your :ref:`recovery phrase<backup-import-recover>` into the wallet to see the same identities and accounts on both. Note that the account and identity names are specific to the device and are not the same between devices.

.. dropdown:: What do I do if I forget my passcode on the |bw|?

If you forget your passcode for your installed |bw|, you will need to :ref:`remove the extension in your internet browswer and reinstall it<setup-browser-wallet>`, choosing the option to :ref:`recover<recover-wallet>` your wallet. Use your :term:`secret recovery phrase` to recover the wallet.
If you forget your passcode for your installed |bw|, you will need to :ref:`remove the extension in your internet browswer and reinstall it<setup-browser-wallet>`, choosing the option to :ref:`recover<backup-import-recover>` your wallet. Use your :term:`secret recovery phrase` to recover the wallet.
10 changes: 5 additions & 5 deletions source/mainnet/docs/browser-wallet/setup-browser-wallet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Get started
:alt: screen for setting up passcode
:width: 50%

#. Choose whether you are creating a new wallet or :ref:`recovering an existing one<recover-wallet>`.
#. Choose whether you are creating a new wallet or :ref:`recovering an existing one<backup-import-recover>`.

.. image:: ../images/browser-wallet/new/create_restore.png
:alt: screen with option to create or restore
Expand Down Expand Up @@ -77,7 +77,7 @@ Get started
:alt: screen for setting up passcode
:width: 50%

#. Choose whether you are creating a new wallet or :ref:`recovering an existing one<recover-wallet>`.
#. Choose whether you are creating a new wallet or :ref:`recovering an existing one<backup-import-recover>`.

.. image:: ../images/browser-wallet/new/create_restore.png
:alt: screen with option to create or restore
Expand Down Expand Up @@ -107,7 +107,7 @@ Get started
:alt: screen for setting up passcode
:width: 50%

#. Choose whether you are creating a new wallet or :ref:`recovering an existing one<recover-wallet>`.
#. Choose whether you are creating a new wallet or :ref:`recovering an existing one<backup-import-recover>`.

.. image:: ../images/browser-wallet/new/create_restore.png
:alt: screen with option to create or restore
Expand Down Expand Up @@ -135,7 +135,7 @@ Get started
:alt: screen for setting up passcode
:width: 50%

#. Choose whether you are creating a new wallet or :ref:`recovering an existing one<recover-wallet>`.
#. Choose whether you are creating a new wallet or :ref:`recovering an existing one<backup-import-recover>`.

.. image:: ../images/browser-wallet/new/create_restore.png
:alt: screen with option to create or restore
Expand Down Expand Up @@ -341,7 +341,7 @@ Removing your wallet does not remove your data on the Concordium blockchain.

.. Note::

If you forget your passcode for your installed |bw|, you will need to remove the extension in your internet browswer and reinstall it, choosing the option to :ref:`recover your wallet<recover-wallet>`. Use your secret recovery phrase to recover the wallet.
If you forget your passcode for your installed |bw|, you will need to remove the extension in your internet browswer and reinstall it, choosing the option to :ref:`recover your wallet<backup-import-recover>`. Use your secret recovery phrase to recover the wallet.

.. |chrome-ext| image:: ../images/browser-wallet/chrome-extensions-icon.png
:width: 20px
Expand Down
4 changes: 2 additions & 2 deletions source/mainnet/docs/desktop-wallet/reset-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ All the local data of the desktop wallet is stored in a database in the user's a

The desktop wallet does not remove your user data when it is uninstalled; this avoids users losing their data, and simplifies the update process for the application.

Occasionally, it might be necessary to delete the user data. The following steps describe the process of deleting this user data. Make sure that you have a :ref:`backup <export-import>` with your data before starting this process.
Occasionally, it might be necessary to delete the user data. The following steps describe the process of deleting this user data. Make sure that you have a :ref:`backup <backup-import-recover>` with your data before starting this process.

.. warning:: Deleting the user data without a :ref:`backup <export-import>` will mean you can only recover what is recoverable with :ref:`account recovery <export-import>` (under "Recover accounts without a backup file"), which does not include your identities, address book, names or notes.
.. warning:: Deleting the user data without a :ref:`backup <backup-import-recover>` will mean you can only recover what is recoverable with :ref:`account recovery <backup-import-recover>` (under "Recover accounts without a backup file"), which does not include your identities, address book, names or notes.

Delete the user data
=========================================================
Expand Down
6 changes: 4 additions & 2 deletions source/mainnet/docs/guides/address-book.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@ The address book helps you select a recipient quickly for transactions.

.. dropdown:: |cryptox|

#. In the **More** menu tap **Address Book**.
#. Open *Wallet Settings* by tapping the gear icon in the lower right of the main screen.

#. Tap **Address Book**.

#. You can search in the address book or scan the QR code of another account.


.. image:: ../images/cryptoX/Addressbook.png
.. image:: ../images/cryptoX/cryptox-address-book.png
:width: 50%


Expand Down
6 changes: 3 additions & 3 deletions source/mainnet/docs/guides/change-account-name.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Change account name

.. dropdown:: |cryptox|

#. On the Accounts screen, tap the account you want to rename.
#. Go to the Your Accounts screen (tap the account identifier on the main screen).

#. On the Account balance screen, tap |cryptoX-acct-settings|.
#. Select the account to rename and tap the gear icon in the upper right corner.

#. Tap **Change account name**.
#. On the Account settings screen, tap **Change account name**.

#. Enter the new name and tap **Save**.

Expand Down
6 changes: 4 additions & 2 deletions source/mainnet/docs/guides/change-identity-name.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ Change identity name

.. dropdown:: |cryptox|

#. In the **More** menu tap **Identities**.
#. Open *Wallet Settings* by tapping the gear icon in the lower right of the main screen.

#. Tap **Identities**.

#. Tap the identity you want to edit.

#. On the identity card tap |cryptoX-edit| next to the identity name.
#. On the identity card, tap the edit icon next to the identity name.

#. Enter the new identity name and tap **Save**.

Expand Down
18 changes: 7 additions & 11 deletions source/mainnet/docs/guides/create-account.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,25 @@ To learn more about identities and accounts, see :ref:`Identities <reference-id-

.. dropdown:: |cryptox|

#. Go to the Accounts screen.
#. Go to the Your Accounts screen (tap the account identifier on the main screen).

#. Tap the **+** in the upper left corner.
#. Tap **Create new account**.

#. Enter the name of the account and tap **Continue**.

.. image:: ../images/cryptoX/create-acct-set-name.png
.. image:: ../images/cryptoX/create-account.png
:width: 50%

#. Tap the identity you want to use for the new account.

.. image:: ../images/cryptoX/create-acct-select-identity.png
.. image:: ../images/cryptoX/cryptox-create-account-identity.png
:width: 50%

#. Tap **Done** to finalize the account.
#. Tap **Create account**.

.. image:: ../images/cryptoX/create-acct-finalize.png
:width: 50%


Your new account is now visible on the Accounts screen . It might take a little while for it to finalize on the chain.
It might take a few seconds for your new account to finalize on the chain. After that, it will be visible in the account list on the Your Accounts screen .

You can edit the account name after it has been created so that it is more descriptive in your wallet. For more information, see :ref:`Change account name<change-mw-acct-name>`.
You can access settings for your new account by tapping the gear icon in the upper right corner.

.. dropdown:: Desktop Wallet

Expand Down
2 changes: 1 addition & 1 deletion source/mainnet/docs/guides/create-identity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To learn more about identities and accounts, see :ref:`Identities <reference-id-

You can submit requests for additional :term:`identities<identity>` in the |cryptox|. You do this from the **Identities** screen.

#. Tap **More** in the lower right corner.
#. Open *Wallet Settings* by tapping the gear icon in the lower right of the main screen.

#. Tap **Identities**.

Expand Down
14 changes: 7 additions & 7 deletions source/mainnet/docs/guides/cryptox-faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
The |cryptox| is the third generation of the Concordium mobile wallets. It offers a comprehensive set of features for interacting with the Concordium blockchain.
It includes most of the functionality from the previous generations, but also introduces new capabilities like :term:`dApp connectivity`, support for Protocol7 and an improved user interface.

It offers :ref:`recovery from both backup file and seed phrase<recover-wallet>`.
It offers :ref:`recovery from both backup file and seed phrase<backup-import-recover>`.

|cryptox| is the wallet where ongoing development and new features will be continually introduced. If you want to stay updated, this is the version to use.

Expand All @@ -26,12 +26,12 @@

.. dropdown:: What happens if I lose my seed phrase?

If you accidentally throw away the paper your :term:`seed phrase` is written on, forget where you hid it, or do not pass it on to an heir, you no longer have the ability to :ref:`recover your wallet<recover-wallet>`
If you accidentally throw away the paper your :term:`seed phrase` is written on, forget where you hid it, or do not pass it on to an heir, you no longer have the ability to :ref:`recover your wallet<backup-import-recover>`
and can lose access to your funds.
While you still have access to your wallet, the seed phrase can be revealed from the **More** screen.
If someone steals your seed phrase, they can access your funds. **If you lose your seed phrase, you lose access to your funds.**

As long as you have your seed phrase, you have your funds. If you break a phone containing your wallet, nothing is lost. You can simply :ref:`enter your seed phrase<recover-wallet>` into a newly downloaded |cryptox| or |bw|.
As long as you have your seed phrase, you have your funds. If you break a phone containing your wallet, nothing is lost. You can simply :ref:`enter your seed phrase<backup-import-recover>` into a newly downloaded |cryptox| or |bw|.

.. dropdown:: How can I keep my seed phrase secure?

Expand All @@ -42,27 +42,27 @@

.. dropdown:: Do I still need to make backups of my wallet?

For |cryptox| and |bw| you don't need to make backups. Your :term:`seed phrase` that you write down is the only way to :ref:`recover your accounts and identities<recover-wallet>`.
For |cryptox| and |bw| you don't need to make backups. Your :term:`seed phrase` that you write down is the only way to :ref:`recover your accounts and identities<backup-import-recover>`.

However, if you migrated your wallet from a |mw-gen1| (deprecated) backup file, you'll need to maintain file-based backups of your |cryptox| as well. This is due to potential legacy dependencies that might still exist within your wallet.

.. _wallet-migrate:

.. dropdown:: Can I migrate from |mw-gen1| to |cryptox|?

Yes. |cryptox| supports both :ref:`seed phrase recovery and file based recovery <recover-wallet>` so you can easily import your |mw-gen1| wallet. You just need your |mw-gen1| backup file and the password you created when exporting it.
Yes. |cryptox| supports both :ref:`seed phrase recovery and file based recovery <backup-import-recover>` so you can easily import your |mw-gen1| wallet. You just need your |mw-gen1| backup file and the password you created when exporting it.

.. dropdown:: As a validator, what do I need to do to migrate from |mw-gen1| to |cryptox|?

You only need your backup file and the password you created when exporting the file.

Then, download |cryptox| and :ref:`recover your wallet<recover-wallet>` with your backup file and password.
Then, download |cryptox| and :ref:`recover your wallet<backup-import-recover>` with your backup file and password.

Your validator status and staking pool participation will remain unchanged after the migration. Your rewards will continue to be distributed as usual.

.. dropdown:: If I am awaiting scheduled transfers in an account in |mw-gen1|, how should I migrate to |cryptox|?

Just download |cryptox| and :ref:`recover your wallet<recover-wallet>` with your backup file and password.
Just download |cryptox| and :ref:`recover your wallet<backup-import-recover>` with your backup file and password.
All of your scheduled transfers, along with your accounts and identities, will be transferred to your new |cryptox|.

.. dropdown:: Can I access my wallet on multiple devices with the seed phrase?
Expand Down
Loading