Skip to content

Update send and earn workflows and related pages in documentation #1339

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

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 7 additions & 17 deletions source/mainnet/docs/browser-wallet/connect-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@ Then, the dApp can initiate a request that you can confirm from within the walle

To connect your |cryptox| to a dApp:

#. Tap the scan QR code button in the Accounts overview |scan-qr-overview|.
#. On the next screen, you can choose the account you want to use. Tap **Allow** to continue using your account with the dApp.
#. Tap the scan QR code button in the upper right of the main screen.
#. When prompted to connect, tap **Allow** to continue using your account with the dApp.

.. image:: ../images/cryptoX/cryptoX-connect-dapps1.png
.. image:: ../images/cryptoX/cryptox-connect-dapps1a.png
:alt: screen with text boxes for each account
:width: 50%

#. After making your purchase in a dApp, confirm the purchase in the |cryptox|. On the sign transaction screen review the transaction details. Tap **Sign** if you approve the transaction.
#. After making your purchase in a dApp, confirm the purchase in the |cryptox|. On the sign transaction screen, review the transaction details. Tap **Sign** if you approve the transaction.

.. image:: ../images/cryptoX/cryptoX-connect-dapps2.png
.. image:: ../images/cryptoX/cryptox-connect-dapps2a.png
:alt: screen with information about session and options to accept or decline
:width: 50%

#. When the transaction is submitted, tap **Finish** to teturn to the account screen.
#. When the transaction is submitted, tap **Finish** to return to the main screen.

.. image:: ../images/cryptoX/cryptox-connect-dapps3.png
.. image:: ../images/cryptoX/cryptox-connect-dapps3a.png
:alt: screen with information about session and options to accept or decline
:width: 50%

Expand Down Expand Up @@ -67,13 +67,3 @@ Then, the dApp can initiate a request that you can confirm from within the walle

../guides/proofs


.. |scan-qr-acct| image:: ../images/scan-qr-acct.png
:alt: qr code scanner symbol on blue background
:width: 50px
.. |scan-qr-overview| image:: ../images/scan-qr-overview.png
:alt: qr code scanner symbol
:width: 50px
.. |gear| image:: ../images/browser-wallet/account-settings.png
:alt: gear wheel
:width: 50px
2 changes: 1 addition & 1 deletion source/mainnet/docs/guides/account-activities-lp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you need to know how to send CCDs, connect dApps, manage fungible and non-fun
tokens
shield-ccd-wallets
scheduled-release
export-key
export-account-private-key
export-transaction-logs
../mobile-wallet/add-baker-mw
../mobile-wallet/update-baker-mw
Expand Down
25 changes: 10 additions & 15 deletions source/mainnet/docs/guides/add-delegation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,32 +20,27 @@ When you delegate some stake to a staking pool, it can influence the chances of

.. dropdown:: |cryptox|

#. In the dropdown list, select the account that you want to delegate from and tap **Earn**.
#. Tap the **Earn** button on the main screen.

#. Tap **Continue to delegation setup**
#. Tap **Read more** to go to an informational screen explaining the key concepts of delegation on the Concordium blockchain, or tap **Start earning** to go directly to registering your delegation.

.. image:: ../images/cryptoX/cryptoX-earning-rewards.png
.. image:: ../images/cryptoX/cryptox-add-validator1.png
:width: 50%
:alt: screen with earning options

#. You can now go through informational screens explaining the key concepts of delegation on the Concordium blockchain, including the delegator role, delegation models, pay days, lock-in and cooldowns, and delegation updates. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to registering your delegation.
#. On the next screen, enter the amount you want to delegate. You can see your available balance. Tap **Staking mode** to specify wheter you want to set up passive delegation or delegation to a specific pool. In the latter case, you must also enter validatoe pool ID. Tap **Continue** to return to the previous screen. Toggle the **Restake rewards** switch if you want to automatically add your rewards to your stake amount. If disabled, rewards will be deposited to your disposable balance at each pay day. Tap **Continue** to proceed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

validatoe



#. On the **Register delegation** screen, you have two options: If you want to delegate to a specific pool, tap **Validator** and enter the Validator ID of the pool owner. If you want to register a passive delegation, tap **Passive**. Tap **Continue**.

.. image:: ../images/cryptoX/cryptoX-register-delegation.png
.. image:: ../images/cryptoX/cryptox-register-delegation1.png
:width: 50%
:alt: screen with earning options

#. You can see your balance available to delegate. Enter the amount you want to delegate in the field. Tap **Yes, add** to restake any rewards, or tap **No, don't add** if you don’t want to restake rewards. In this case, rewards are deposited to your disposable balance at each pay day. Then, tap **Continue**.
#. Review the information in the transaction overview. When you are satisfied, Swipe right on the **Submit delegation** slider to submit the transaction.

.. image:: ../images/cryptoX/cryptox-register-delegation-add-rewards-new.png
:width: 50%
:alt: screen to register delegation amount and restake preference

#. Review the information in the transaction overview. When you are satisfied, tap **Submit delegation transaction**.
.. image:: ../images/cryptoX/cryptox-register-delegation2.png
:width: 50%
:alt: screen with transaction overview

#. Once the transaction is submitted, you see a confirmation screen. Tap **Finish**.
#. The wallet shows a confirmation screen with a green checkmark indicating that your delegation registration has been successfully submitted to the chain. You can see the amount you’re delegating. You can click **Transaction details** to view more information about the transaction, or **Close** to return to the main screen.

Once the transaction is finalized, the delegation is effective from the next pay day.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
.. include:: ../../variables.rst
.. _export-key:

====================
Export a private key
====================
==========================
Export account private key
==========================

In certain situations, such as testing interaction with smart contracts, you may need to export your private key for an account in your wallet. The file format of the key export is specifically for :ref:`import<concordium-client-import-accounts-keys>` to ``concordium-client``. If you just copy the key to the clipboard, it's just the key itself and can be used for other purposes.


.. dropdown:: |cryptox|

#. Tap the account you wish to to export the private key for.
#. Go to the Your Accounts screen (tap the account identifier on the main screen).

#. On the Account screen, tap |cryptoX-acct-settings| to open the Account settings screen.
#. Open Account Settings by tapping the gear icon in the upper right of the screen.

#. Tap **Export private key**.

Expand Down
14 changes: 4 additions & 10 deletions source/mainnet/docs/guides/export-transaction-logs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,13 @@ It is possible to export tansaction logs with :ref:`CCD Scan<ccd-scan>` from the

.. dropdown:: |cryptox|

#. Tap the account.

#. On the Account screen, tap |cryptoX-acct-settings| to open the Account settings menu.
#. Go to the Your Accounts screen (tap the account identifier on the main screen).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then "Open Account Settings by tapping the gear icon in the upper right of the screen."


#. Tap **Export transaction logs**.

.. image:: ../images/cryptoX/cryptoX-export-transaction-logs.png
#. Tap **Save transaction logs** and browse to the saving location.

.. image:: ../images/cryptoX/cryptoX-export-transaction-logs.png
:width: 50%
:alt: screen with seed phrase


#. Tap **Save transaction logs** and browse to the saving location.

.. |cryptoX-acct-settings| image:: ../images/cryptoX/cryptoX-acct-settings.png
:alt: gear wheel on blue background
:width: 50px
15 changes: 5 additions & 10 deletions source/mainnet/docs/guides/remove-delegation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,15 @@ If you remove the delegation, there is a :term:`cool-down period` before the amo

.. dropdown:: |cryptox|

#. In the dropdown list, select the account from which you want to remove delegation and tap **Earn**.
#. Tap the **Earn** button on the main screen.

#. On the delegation status screen, tap **Stop delegation**.
#. On the earning status screen, tap **Stop**.

.. image:: ../images/cryptoX/cryptoX-delegation-status.png
:width: 50%
:alt: screen showing current delegation status with options to update or stop
#. You will see a screen explaining the implications of stopping your delegation, tap **Continue** to proceed.

#. On the overview screen, review the information. Swipe right on the **Stop staking** slider to submit the delegation stop.

#. After the screen explaining the implications of stopping your delegation, tap **Continue** to proceed.

#. Review the information in the transaction overview. When you are satisfied, tap **Submit delegation transaction**.

#. Once the transaction is submitted, you see a confirmation screen. Tap **Finish**.
#. The wallet shows a confirmation screen with a green checkmark indicating that your delegation update has been successfully submitted to the chain. You can click **Transaction details** to view more information about the transaction, or **Close** to return to the main screen.


.. dropdown:: Desktop Wallet
Expand Down
23 changes: 9 additions & 14 deletions source/mainnet/docs/guides/send-ccd-wallets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,35 +20,30 @@ This topic describes how you can send CCD from an account when only one particip

.. dropdown:: |cryptox|

#. On the Accounts screen tap |cryptoX-send| on the account from which you want to send CCD. You can also tap |cryptoX-send| on the account's balance screen.
#. Tap **Send** on the main screen.

#. Enter the amount you want to transfer.
#. Enter the amount you want to transfer and specify the recipient. You can paste the recipient address, choose a recipient that already exists in your address book, or tap the Scan QR icon to add a new one.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Scanning QR doesn't add a new recipient to the address book. It just lets the scanned account to be the recipient of this transfer


.. image:: ../images/cryptoX/cryptoX-send-funds1.png
.. image:: ../images/cryptoX/cryptox-send-funds1a.png
:width: 50%

#. You can paste the recipient address, choose a recipient that already exists in your **Address Book**, or tap **Scan QR** to add a new one.
#. Optionally you can add a memo to your transaction by tapping the **Add memo** field. A memo is a short message that will be shown with the transaction. Memos are publicly visible on the chain, so be careful what you write. Adding a memo will also increase the transaction fee.

#. Optionally you can add a memo to your transaction. A memo is a short message that will be shown with the transaction. Memos are publicly visible on the chain, so be careful what you write. Adding a memo will also increase the transaction fee.

.. Warning::
.. Warning::
Transaction memos are public, permanent and visible to everyone on the blockchain. Therefore, carefully review all information before you submit the memo to the blockchain.

#. Tap **Continue**.

#. Tap **Send funds**.
#. Review the transaction. If you need to correct something, use the arrow to go back to the previous screen. When ready, swipe to submit the transaction.

.. image:: ../images/cryptoX/cryptoX-send-funds2.png
.. image:: ../images/cryptoX/cryptox-send-funds2a.png
:width: 50%

#. Tap **Finish**.
#. The confirmation screen shows the sent amount. You can now view transaction details or tap **Close** to return to the main screen.

.. image:: ../images/cryptoX/cryptoX-send-funds3.png
.. image:: ../images/cryptoX/cryptox-send-funds3a.png
:width: 50%

.. |cryptoX-send| image:: ../images/cryptoX/cryptoX-send.png
:alt: Paper airplane
:width: 30px

.. |send-w-text| image:: ../images/send-w-text.png
:alt: Paper airplane with text send
Expand Down
2 changes: 1 addition & 1 deletion source/mainnet/docs/guides/tokens.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can add, inspect, and send tokens in |cryptox| and |bw|.

.. dropdown:: |cryptox|

To access tokens and token transactions, tap on an account then tap **Tokens**.
To access this functionality, tap **Manage token list** at the bottom of the token list.

.. dropdown:: Add tokens

Expand Down
26 changes: 8 additions & 18 deletions source/mainnet/docs/guides/update-delegation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Before delegating stake to a staking pool, it is important to research the pool

Updating delegation from a suspended validator
----------------------------------------------
If a validator you've delegated to becomes suspended, you'll see a warning banner in your wallet interface indicating *Your validator has been suspended*. When a validator is suspended, both the validator and its delegators stop earning rewards.
If a validator you've delegated to becomes suspended, you'll see a warning banner on your wallet indicating that *Your validator has been suspended*. When a validator is suspended, both the validator and its delegators stop earning rewards.
To maintain your earning potential, you may consider moving your delegation to another active validator or to passive delegation.

.. image:: ../images/browser-wallet/new/validator_suspended_banner.png
Expand All @@ -42,32 +42,22 @@ Update delegation

.. dropdown:: |cryptox|

#. In the dropdown list, select the account from which you want to change your delegation preferences and tap **Earn**.
#. Tap the **Earn** button on the main screen.

#. On the delegation status screen, tap **Update current delegation**.
#. On the earning status screen, tap **Update**.

.. image:: ../images/cryptoX/cryptoX-delegation-status.png
:width: 50%
:alt: screen showing current delegation with options to stop or update

#. You can now go through informational screens explaining the update options for delegation. Tap **Next** to navigate through the screens. Tap **Skip** to proceed directly to updating.

#. If you want to delegate to a specific pool, select **Validator** and enter the validator ID of the desired pool owner. If you want to delegate to passive delegation, select **Passive**. Tap **Continue**.

.. image:: ../images/cryptoX/cryptoX-update-delegation.png
:width: 50%
:alt: screen with options to choose delegation type
#. This will open an informational screen explaining the update options for delegation. Tap **Update delegation** to proceed.

#. On the next screen you can see your balance available for delegation and the amount of your current delegation. If you want to change the amount, tap on the field **Optional: Type the new amount** and enter the amount. Tap **Yes, add** to restake any rewards or tap **No, don't add** if you don’t want to restake rewards. If you do not restake, rewards are deposited to your disposable balance at each payday. When satisfied with your settings, tap **Continue**.
#. On the next screen you can see your balance available for delegation and your current delegation amount. If you want to change the amount, tap on the field and update the amount. Tap on the delegation field to change delegation model, and toggle the **Restake rewards** switch if you want to change your restaking preferences. Tap **Continue** to proceed.

.. image:: ../images/cryptoX/cryptox-update-delegation2-new.png
.. image:: ../images/cryptoX/cryptox-update-delegation1.png
:width: 50%
:alt: screen with options to choose delegation type

#. On the overview screen, review the information. Swipe right on the **Update delegation** slider to submit the delegation update.

#. Review the information in the transaction overview. When you are satisfied, tap **Submit delegation transaction**.
#. The wallet shows a confirmation screen with a green checkmark indicating that your delegation update has been successfully submitted to the chain. You can click **Transaction details** to view more information about the transaction, or **Close** to return to the main screen.

#. Once the transaction is submitted you see a confirmation screen. Tap **Finish** to complete the action.

.. dropdown:: Desktop Wallet

Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Diff not rendered.
Loading