Skip to content

Commit 444fb0b

Browse files
committed
Review for grammar, readability
1 parent bc9c0b3 commit 444fb0b

File tree

6 files changed

+49
-57
lines changed

6 files changed

+49
-57
lines changed

source/mainnet/net/guides/wallet-sdk/wallet-sdk-account-transaction.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
.. _wallet-sdk-account-transaction:
22

3-
=============================================
4-
Submitting a transaction to a Concordium node
5-
=============================================
3+
=========================================
4+
Submit a transaction to a Concordium node
5+
=========================================
66

7-
The following sections document the requirements for creating an account transaction, signing it and
8-
finally sending it to a Concordium node.
7+
The following sections document the requirements for creating an account transaction, signing it, and
8+
sending it to a Concordium node.
99

1010
* `Construct an account transaction`_
1111
* `Sign an account transaction`_
@@ -15,8 +15,7 @@ finally sending it to a Concordium node.
1515
Construct an account transaction
1616
++++++++++++++++++++++++++++++++
1717

18-
For the sake of this example we will be constructing a simple transfer, which is an account transaction that moves an amount of CCD from one account to another. For other transaction types the steps are similar,
19-
but the exact fields that must be provided for the payload will be different.
18+
This example constructs a simple transfer, which is an account transaction that moves an amount of CCD from one account to another. For other transaction types, the steps are similar, but the exact fields that must be provided for the payload will be different.
2019

2120
.. tabs::
2221

@@ -90,9 +89,9 @@ but the exact fields that must be provided for the payload will be different.
9089
Sign an account transaction
9190
+++++++++++++++++++++++++++
9291

93-
Having constructed an account transaction the next step is to sign it. It is important that the key used to sign an account transaction matches the sender address provided in the account transaction header. We note here that Concordium as a whole supports multi-signature transactions, but for the purpose of this example we will demonstrate how to do it for an account with a single credential that has a single key.
92+
Having constructed an account transaction, the next step is to sign it. It is important that the key used to sign an account transaction matches the sender address provided in the account transaction header. Note that Concordium as a whole supports multi-signature transactions, but for the purpose of this example it will demonstrate how to do it for an account with a single credential that has a single key.
9493

95-
Please note that when the transaction has been signed anyone with the signature and the transaction will be able to send it to a Concordium node. Therefore it is very important that a wallet requests user approval before utilizing their signing keys.
94+
Note that when the transaction has been signed anyone with the signature and the transaction will be able to send it to a Concordium node. Therefore it is very important that a wallet requests user approval before utilizing their signing keys.
9695

9796
.. tabs::
9897

source/mainnet/net/guides/wallet-sdk/wallet-sdk-credential-deployment.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
.. _wallet-sdk-credential-deployment:
22

3-
===================
4-
Creating an account
5-
===================
3+
=================
4+
Create an account
5+
=================
66

7-
Having created an identity the next step is to create an account. On Concordium an account is an entity that can hold multiple credentials, but for the sake of keeping the example simple, the following
8-
guide will describe how to create an account with a single credential.
7+
Having created an identity, the next step is to create an account. On Concordium, an account is an entity that can hold multiple credentials, but for the sake of keeping the example simple, the following guide will describe how to create an account with a single credential.
98

109
* `Create a credential deployment transaction`_
1110
* `Sign a credential deployment transaction`_
@@ -15,8 +14,7 @@ guide will describe how to create an account with a single credential.
1514
Create a credential deployment transaction
1615
++++++++++++++++++++++++++++++++++++++++++
1716

18-
The following example demonstrates how a credential deployment transaction is created. Note that you must have saved the identity object and the identity provider that was used to create that identity, as they are required
19-
input for this transaction type.
17+
The following example demonstrates how a credential deployment transaction is created. Note that you must have saved the identity object and the identity provider that was used to create that identity, as they are required input for this transaction type.
2018

2119
.. tabs::
2220

@@ -158,8 +156,8 @@ Having created and signed the credential deployment transaction, the final step
158156
utility function that does this by simply providing it the credential deployment transaction and the signature on the transaction. The result
159157
of the call is a transaction hash that can then be used to monitor the status of the transaction.
160158

161-
If successful, the credential will have been deployed, and it is now possible to start creating account transactions. Go to
162-
:ref:`wallet-sdk-account-transaction` for a guide on how that is done.
159+
If successful, the credential will be deployed, and it is now possible to start creating account transactions. Go to
160+
:ref:`wallet-sdk-account-transaction` for a guide about creating account transactions.
163161

164162
.. tabs::
165163

source/mainnet/net/guides/wallet-sdk/wallet-sdk-identity-creation.rst

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
.. _wallet-sdk-identity-creation:
22

3-
====================
4-
Creating an identity
5-
====================
3+
==================
4+
Create an identity
5+
==================
66

7-
To create an account on the Concordium blockchain, one must first acquire an identity. Therefore, as an initial step, a user of a wallet will always have to create an identity before being able to send account transactions.
7+
To create an account on the Concordium blockchain, a user must first acquire an identity. Therefore, as an initial step, a wallet user will always have to create an identity before being able to send account transactions.
88

99
An identity is acquired by generating an identity request and sending it to an identity provider. The user will then be taken through the identity verification
1010
process that is specific for that chosen identity provider. This happens outside of the wallet application.
1111

12-
* `Creating an identity request`_
13-
* `Sending an identity request`_
14-
* `Retrieving the identity after creation`_
12+
* `Create an identity request`_
13+
* `Send an identity request`_
14+
* `Retrieve the identity after creation`_
1515

16-
++++++++++++++++++++++++++++
17-
Creating an identity request
18-
++++++++++++++++++++++++++++
16+
++++++++++++++++++++++++++
17+
Create an identity request
18+
++++++++++++++++++++++++++
1919

2020
The first step is to create the actual identity request. To do this, you need the list of identity providers. Refer to :ref:`Identity Provider List` to understand how to retrieve it.
2121

@@ -91,16 +91,13 @@ The first step is to create the actual identity request. To do this, you need th
9191

9292
The Swift SDK for iOS is still in development.
9393

94-
+++++++++++++++++++++++++++
95-
Sending an identity request
96-
+++++++++++++++++++++++++++
94+
++++++++++++++++++++++++
95+
Send an identity request
96+
++++++++++++++++++++++++
9797

9898
Once the identity request has been created, the next step is to send it to the corresponding identity provider. There are multiple ways to accomplish this, and it will depend on the technologies you choose. Below is an example of how it can be done.
9999

100-
A part of the request is a `redirectUri`, which tells the identity provider where to redirect the user when the identity verification flow has been completed. A wallet application has to
101-
choose this in such a way that the user is sent back into the wallet application, where the
102-
actual identity object can then be retrieved from the information provided in the hash property
103-
of the redirect URL.
100+
A part of the request is a `redirectUri`, which tells the identity provider where to redirect the user when the identity verification flow has been completed. A wallet application has to choose this in such a way that the user is sent back into the wallet application, where the actual identity object can then be retrieved from the information provided in the hash property of the redirect URL.
104101

105102
.. tabs::
106103

@@ -163,13 +160,11 @@ of the redirect URL.
163160

164161
The Swift SDK for iOS is still in development.
165162

166-
++++++++++++++++++++++++++++++++++++++
167-
Retrieving the identity after creation
168-
++++++++++++++++++++++++++++++++++++++
163+
++++++++++++++++++++++++++++++++++++
164+
Retrieve the identity after creation
165+
++++++++++++++++++++++++++++++++++++
169166

170-
Upon completing identity verification at the identity provider, the identity provider does a
171-
redirect of the user back to the `redirectUri` that was provided when sending the identity request to the identity provider. The hash property of the URL that the identity provider
172-
redirects the user to contains the URL where the identity object can be retrieved from, in the format `redirectUri#code_uri=`, where the URL will be after the equals sign.
167+
Upon completing identity verification with the identity provider, the identity provider does a redirect of the user back to the `redirectUri` that was provided when sending the identity request to the identity provider. The hash property of the URL that the identity provider redirects the user to contains the URL where the identity object can be retrieved from in the format `redirectUri#code_uri=`, where the URL will be after the equals sign.
173168

174169
.. tabs::
175170

source/mainnet/net/guides/wallet-sdk/wallet-sdk-identity-provider.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _wallet-sdk-identity-provider:
22

3-
======================================
4-
Getting the list of identity providers
5-
======================================
3+
==================================
4+
Get the list of identity providers
5+
==================================
66

77
The list of identity providers can be retrieved from a Concordium node; however, the provided list lacks the necessary metadata for creating or recovering an identity from an identity provider. Therefore, Concordium hosts a service called the wallet-proxy that serves this information to wallets.
88

source/mainnet/net/guides/wallet-sdk/wallet-sdk-identity-recovery.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
.. _wallet-sdk-identity-recovery:
22

3-
======================
4-
Recovering an identity
5-
======================
3+
===================
4+
Recover an identity
5+
===================
66

77
The following sections demonstrate the process of creating a request to recover an identity from an identity provider. While accounts are stored on the Concordium blockchain, identities are stored by the selected identity provider during the creation process, and recovery is initiated by sending a request to that specific identity provider.
88

9-
* `Generating an identity recovery request`_
10-
* `Sending an identity recovery request`_
9+
* `Generate an identity recovery request`_
10+
* `Send an identity recovery request`_
1111

12-
+++++++++++++++++++++++++++++++++++++++
13-
Generating an identity recovery request
14-
+++++++++++++++++++++++++++++++++++++++
12+
+++++++++++++++++++++++++++++++++++++
13+
Generate an identity recovery request
14+
+++++++++++++++++++++++++++++++++++++
1515

1616
The following example demonstrates the process of generating an identity recovery request. Part of the input to the request is a secret value derived from the seed phrase, and this value should be kept secret in a similar manner as the seed phrase and account signing keys.
1717

18-
In the example below, functionality for retrieving the list of identity providers is present. To see an example of how to implement this function, please check out :ref:`Identity Provider List`.
18+
In the example below, functionality for retrieving the list of identity providers is present. To see an example of how to implement this function, see :ref:`Identity Provider List`.
1919

2020
.. tabs::
2121

@@ -67,9 +67,9 @@ In the example below, functionality for retrieving the list of identity provider
6767

6868
The Swift SDK for iOS is still in development.
6969

70-
++++++++++++++++++++++++++++++++++++
71-
Sending an identity recovery request
72-
++++++++++++++++++++++++++++++++++++
70+
+++++++++++++++++++++++++++++++++
71+
Send an identity recovery request
72+
+++++++++++++++++++++++++++++++++
7373

7474
The next step is to send the generated identity recovery request to the associated identity provider. If successful, the identity provider will return a redirect to the location from which the identity can be fetched.
7575

source/mainnet/net/guides/wallet-sdk/wallet-sdk.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This integration guide is directed towards developers who want to implement thei
88
This typically means either a mobile wallet (iOS or Android), or a solution building on TypeScript or JavaScript.
99

1010
The SDK provides the necessary functions to derive the correct Concordium keys from a secret recovery phrase, to
11-
generate the Concordium specific requests to create and recover identities, to create and deploy a credential and
11+
generate the Concordium specific requests to create and recover identities, to create and deploy a credential, and
1212
to create and send transactions to a Concordium node.
1313

1414
Below, you can find a link to the SDK package for your chosen technology, and an example wallet that demonstrates its usage.

0 commit comments

Comments
 (0)