Skip to content
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

Add CryptoX to documentation #981

Merged
merged 46 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
af7d591
Add CryptoX to documentation
dg-concordium Feb 22, 2024
f4624d9
Updates
dg-concordium Feb 26, 2024
6f22f0f
Add table column
dg-concordium Feb 27, 2024
44b9aeb
Adjust table columns
dg-concordium Feb 27, 2024
c1b88c4
Merge branch 'main' into add--cryptox
TinaKT Aug 14, 2024
ae68b2b
Merge branch 'main' into add--cryptox
TinaKT Aug 16, 2024
c6de093
Added CryptoX
TinaKT Aug 30, 2024
fcc099f
Updated with CryptoX
TinaKT Sep 3, 2024
efb68cc
Continue on CryptoX
TinaKT Sep 5, 2024
d9ed026
Further updates to Cryptox
TinaKT Sep 9, 2024
4e3edf4
Further updates to cryptox
TinaKT Sep 11, 2024
96a55d3
Further addings to cryptox
TinaKT Sep 15, 2024
32f9cf7
Further addings of Cryptox
TinaKT Sep 17, 2024
16d00e1
Further addings for CryptoX
TinaKT Sep 18, 2024
70eb314
More addings for Cryptox
TinaKT Sep 19, 2024
c454881
Protocol 7 changes
TinaKT Sep 19, 2024
0d2958c
Merge branch 'main' into add--cryptox
TinaKT Sep 20, 2024
83e532b
Added review changes for Protocol 7
TinaKT Sep 22, 2024
f5db0ed
Merge branch 'add--cryptox' of github.com:Concordium/concordium.githu…
TinaKT Sep 22, 2024
b9439db
Update source/mainnet/net/guides/export-transaction-logs.rst
TinaKT Sep 22, 2024
2628e29
Update source/mainnet/net/guides/recover-wallet.rst
TinaKT Sep 22, 2024
46a9e15
Update source/mainnet/net/guides/tokens.rst
TinaKT Sep 22, 2024
6d01c24
Update source/mainnet/net/guides/recover-wallet.rst
TinaKT Sep 22, 2024
7f36e59
Added changes after review
TinaKT Sep 22, 2024
d4a2892
Merge branch 'add--cryptox' of github.com:Concordium/concordium.githu…
TinaKT Sep 22, 2024
e4563fb
Added changes after review
TinaKT Sep 23, 2024
6411f41
Updated after review comments
TinaKT Sep 23, 2024
92758d2
Update source/mainnet/net/guides/recover-wallet.rst
TinaKT Sep 23, 2024
74ab5e4
Updated after review comments
TinaKT Sep 23, 2024
4055f4a
Merge branch 'add--cryptox' of github.com:Concordium/concordium.githu…
TinaKT Sep 23, 2024
e0c5d68
Lint changes
TinaKT Sep 23, 2024
624129a
Build error fixed
TinaKT Sep 23, 2024
0959cf3
Build error fixed
TinaKT Sep 23, 2024
163cc33
Build error fixed
TinaKT Sep 23, 2024
ded3020
Build error fixed
TinaKT Sep 23, 2024
bb23791
Build error fixed
TinaKT Sep 23, 2024
9ddebf0
Build error fixed
TinaKT Sep 23, 2024
d7dc714
Build error fixed
TinaKT Sep 23, 2024
866e4a3
Merge branch 'main' into add--cryptox
Radiokot Sep 24, 2024
d0dfdec
Updated after review comments
TinaKT Sep 25, 2024
d716fac
Merge branch 'add--cryptox' of github.com:Concordium/concordium.githu…
TinaKT Sep 25, 2024
dc9c8f2
Updated after review comments
TinaKT Sep 25, 2024
7feba0f
Updated after review comments
TinaKT Sep 25, 2024
bc9849b
Deleted redundant line in CryptoX FAQ
TinaKT Sep 26, 2024
510f228
Note added about features affected by P7 not being fully implemented yet
TinaKT Sep 27, 2024
2065d6a
Merge branch 'main' into add--cryptox
TinaKT Sep 27, 2024
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
28 changes: 27 additions & 1 deletion source/mainnet/net/browser-wallet/connect-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,33 @@
Connect dApps to wallets
===================================

You can connect the |bw| and |mw-gen2| to a `dApp <https://en.wikipedia.org/wiki/Decentralized_application>`__ that has a frontend interface so that you can pay for services. You can initiate the request from within the |bw| or |mw-gen2|, or the dApp can initiate a connection request that you must confirm. Connection can be made by either scanning a QR code or from a link to the dApp service.
You can connect the |cryptox|, |bw|, and |mw-gen2| to a `dApp <https://en.wikipedia.org/wiki/Decentralized_application>`__ that has a frontend interface so that you can pay for services.
Connection can be made by either scanning a QR code or from a link to the dApp service.
Then, the dApp can initiate a request that you can confirm from within the wallet.

.. dropdown:: |cryptox|

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.

.. image:: ../images/cryptoX/cryptoX-connect-dapps1.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.

.. image:: ../images/cryptoX/cryptoX-connect-dapps2.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.

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


.. dropdown:: |bw|

Expand Down
17 changes: 9 additions & 8 deletions source/mainnet/net/concepts/concepts-baker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. _baker-concept:

==========
Validators
Validation
==========

Validation is key to the Concordium blockchain. A :term:`node` is a validator node when it participates actively in the network by creating new :term:`blocks<block>` that are added to the chain. The blockchain consists of multiple :term:`validator` nodes. A :term:`validator` collects, orders, and validates the :term:`transactions<transaction>` that are included in a block to maintain the integrity of the blockchain. The validators sign each block that they produce so that the block can be verified and executed by the other validators in the network.
Expand Down Expand Up @@ -78,13 +78,13 @@ Validator account

Each account can use a set of validator keys to register a validator. Whenever a validator produces a valid block that gets included in the chain, a reward is paid to the validator's account (and the staking pool delegators if they have a pool) at :term:`pay day`. The reward is derived from transaction fees paid for transactions included in the block and its predecessors, as well as from newly-minted CCDs.

The account can be viewed in the Desktop Wallet, the |mw-gen2|, the |mw-gen1|, or the |bw| depending on where the account was created.
The account can be viewed in the |cryptox|, the Desktop Wallet, the |mw-gen2|, the |mw-gen1|, or the |bw| depending on where the account was created.

Rewards are added to the staked amount by default. However, you can choose to receive the rewards in the account balance instead of staking them automatically.

.. Note::

It is not possible to have multi-signature validator accounts in |mw-gen2|, |mw-gen1|, or |bw|. If you need this functionality, you need to run the Desktop Wallet.
It is not possible to have multi-signature validator accounts in |cryptox|, |mw-gen2|, |mw-gen1|, or |bw|. If you need this functionality, you need to run the Desktop Wallet.

Staking pool
============
Expand All @@ -107,7 +107,7 @@ A block is final at a minimum of two seconds after its creation. A new block has
Tools to be a validator
=======================

Validation is possible with |bw|, |mw-gen2|, |mw-gen1|, ``Concordium-client``, and Desktop Wallet, however the process differs between them. The overviews below give a brief description of the process.
Validation is possible with |cryptox|, |bw|, |mw-gen2|, |mw-gen1|, ``Concordium-client``, and Desktop Wallet, however the process differs between them. The overviews below give a brief description of the process.

.. Attention::

Expand Down Expand Up @@ -191,18 +191,19 @@ This overview describes the recommended scenario for running a node and becoming

For information about how to update your validator or stop validation, see :ref:`Change validator options<update-baker-mw>`.

Validation with |mw-gen1| and |mw-gen2|
---------------------------------------

This overview describes the recommended scenario for running a node and becoming a validator on the Concordium blockchain when using |mw-gen1| or |mw-gen2| and running a node.
Validation with |mw-gen1|, |mw-gen2|, and |cryptox|
---------------------------------------------------

This overview describes the recommended scenario for running a node and becoming a validator on the Concordium blockchain when using |mw-gen1|, |mw-gen2|, or |cryptox|.

.. dropdown:: Step 1: Set up the node

For validation you must be running a node on the Concordium blockchain. You can run a node :ref:`on Windows<run-node-windows>`, :ref:`on macOS<run-node-macos>`, :ref:`on Ubuntu<run-node-ubuntu>` or using :ref:`Docker<run-a-node>`. You can also have a third-party run a node on your behalf.

.. dropdown:: Step 2: Set up the Wallet

The |mw-gen1| and |mw-gen2| are available for iOS and Android devices. For instructions about download and setup of |mw-gen2|, see :ref:`setup-g2-mobile-wallet`.
The |mw-gen1|, |mw-gen2|, and |cryptox| are available for iOS and Android devices. For instructions about download and setup of |mw-gen2|, see :ref:`setup-g2-mobile-wallet`. For instructions about download and setup of |cryptox|, see :ref:`setup-cryptox-wallet`.

.. dropdown:: Step 3: Set up an identity and account

Expand Down
2 changes: 1 addition & 1 deletion source/mainnet/net/concepts/concepts-delegation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ When decreasing or removing the stake (whether for delegators or validators), th
Where delegation is available
=============================

You can :ref:`delegate CCDs<add-delegation>` in the Desktop Wallet, |mw-gen1|, |mw-gen2|, and |bw|. You can also delegate from :ref:`Concordium Client<transactions>`. It is recommended that you use :ref:`CCDScan<ccd-scan>` to research the various validators and pools prior to delegation if you plan to delegate to a specific pool.
You can :ref:`delegate CCDs<add-delegation>` in the Desktop Wallet, |cryptox|, |mw-gen1|, |mw-gen2|, and |bw|. You can also delegate from :ref:`Concordium Client<transactions>`. It is recommended that you use :ref:`CCDScan<ccd-scan>` to research the various validators and pools prior to delegation if you plan to delegate to a specific pool.

Summary
=======
Expand Down
72 changes: 40 additions & 32 deletions source/mainnet/net/concepts/concepts-transactions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,39 @@ A transaction on the Concordium blockchain is an operation which applies some ch

The most basic transaction is the CCD transfer that is used to send CCD from one account to another. However, there are several transaction types on the Concordium blockchain.

You can make transactions using either the Desktop Wallet, the |mw-gen2|, |mw-gen1|, |bw|, or the Concordium Client. Note that the |mw-gen1|, |mw-gen2|, and |bw| don’t support all transaction types, and that you need a LEDGER device to submit transactions from the Desktop Wallet.

+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| | |mw-gen1| | |mw-gen2| | |bw| |Desktop Wallet | Concordium Client |
+============================+===============+================+===================+===============+===================+
| Send CCD | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Send CCD with a schedule | | | | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Unshield CCD | |check| | |check| | | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Add validator | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Remove validator | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Update validator stake | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Update restake earnings | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Update validator keys | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Update account credentials | | |check| | | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Connect to dApps | | |check| | |check| | | |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Delegation | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+
| Smart contract transactions| | | | | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+

You can make transactions using either the Desktop Wallet, the |cryptox|, |mw-gen2|, |mw-gen1|, |bw|, or the Concordium Client. Note that the |mw-gen1|, |mw-gen2|, |cryptox|, and |bw| don’t support all transaction types, and that you need a LEDGER device to submit transactions from the Desktop Wallet.

+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| | |mw-gen1| | |mw-gen2| | |bw| |Desktop Wallet | Concordium Client | |cryptox| |
+============================+===============+================+===================+===============+===================+===========+
| Send CCD | |check| | |check| | |check| | |check| | |check| ||check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Send CCD with a schedule | | | | |check| | |check| | |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Unshield CCD | | | | | | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Add validator | |check| | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Remove validator | |check| | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Update validator stake | |check| | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Update restake earnings | |check| | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Update validator keys | |check| | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Update account credentials | | |check| | | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Connect to dApps | | |check| | |check| | | | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Delegation | |check| | |check| | |check| | |check| | |check| | |check| |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Smart contract transactions| | | | | |check| | |
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+
| Manage tokens | | |check| | | |check| + |check| + |check| +
+----------------------------+---------------+----------------+-------------------+---------------+-------------------+-----------+

- |cryptox|: supports send CCD, receive CCD, validator management, delegation, connect to dApps, add and manage tokens, and unshielding.
- |bw|: supports send CCD, receive CCD, connect to dApps, validator management, delegation.
- |mw-gen2|: supports send CCD, receive CCD, unshield CCD (:ref:`deprecated<shielded-balance-feature-deprecation>`), validator management, delegation, connect to dApps, add and manage tokens.
- |mw-gen1|: supports send CCD, receive CCD, unshield CCD (:ref:`deprecated<shielded-balance-feature-deprecation>`), validator management, delegation
Expand Down Expand Up @@ -66,6 +69,11 @@ You can see the fee in the transaction log.
Tools
=====

The |cryptox|
------------------

The |cryptox| is a digital smartphone wallet with a simpler onboarding process that enables you to create and manage your Concordium identities and accounts, to create simple transactions, validate and delegate, add and manage tokens, connect to dApps, and to export and import your accounts and identities.

The Desktop Wallet
------------------

Expand All @@ -84,7 +92,7 @@ The |bw| is a web wallet extension that enables you to create and manage your Co
The |mw-gen1|
-----------------

The |mw-gen1| is a digital smartphone wallet that enables you to create and manage your Concordium identities and accounts, to create simple and shielded transactions, validate and delegate, and to export and import your accounts and identities. If you are a validator who runs a staking pool, it is not possible for pool owners to set the commissions in the |mw-gen1|; they are fixed at 10%. If you want to be able to adjust commissions, you must use the |mw-gen2| or |bw|. For information about the process, see :ref:`the delegation FAQ<wallet-migrate>`.
The |mw-gen1| is a digital smartphone wallet that enables you to create and manage your Concordium identities and accounts, to create simple and shielded transactions, validate and delegate, and to export and import your accounts and identities. If you are a validator who runs a staking pool, it is not possible for pool owners to set the commissions in the |mw-gen1|; they are fixed at 10%. If you want to be able to adjust commissions, you must use the |cryptox|, |mw-gen2|, or |bw|. For information about the process, see :ref:`the delegation FAQ<wallet-migrate>`.

Command-line tool
-----------------
Expand All @@ -99,6 +107,6 @@ To learn more about the differences between the wallets, see :ref:`Deciding betw
.. Warning::
Because of the difference in the way private keys are handled between |mw-gen2| / |bw| and the first generation wallets (|mw-gen1| and Desktop Wallet), you cannot exchange identities and accounts between them.

It is possible to exchange accounts and identities between the |mw-gen2| and the |bw|.
It is possible to exchange accounts and identities between the |cryptox|, |mw-gen2|, and the |bw|. Additionally, |mw-gen1| users can import backup files to |cryptox|.

.. |check| unicode:: U+2713 .. CHECKMARK
Loading
Loading