Skip to content

Commit d6021b1

Browse files
committed
docs changes
Signed-off-by: sandeep.nishad1 <[email protected]>
1 parent c857604 commit d6021b1

File tree

6 files changed

+42
-43
lines changed

6 files changed

+42
-43
lines changed

docs/docs/external/getting-started/interop/asset-exchange.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -62,25 +62,25 @@ run the following steps:
6262
./bin/fabric-cli asset exchange-step --step=6 --recipient=bob --locker=alice --target-network=network1 --param=bond01:a03 --secret=<hash-pre-image>
6363
```
6464

65-
Above steps complete a successful asset exchange between two Fabric networks.
66-
In addition to above commands, following are the extra options:
67-
- _In case_, `alice` wants to unlock the bond asset, run the following to trigger `alice`'s re-claim for `bond01:a03` locked in `network1`:
65+
The above steps complete a successful asset exchange between two Fabric networks.
66+
In addition to the above commands, following are the extra options:
67+
- If `alice` wants to unlock the bond asset, run the following to trigger `alice`'s re-claim for `bond01:a03` locked in `network1`:
6868
```bash
6969
./bin/fabric-cli asset exchange-step --step=7 --locker=alice --recipient=bob --target-network=network1 --param=bond01:a03
7070
```
71-
- _In case_, `bob` wants to unlock the token asset, run the following to trigger `bob`'s re-claim for `token1:100` locked in `network2`:
71+
- If `bob` wants to unlock the token asset, run the following to trigger `bob`'s re-claim for `token1:100` locked in `network2`:
7272
```bash
7373
./bin/fabric-cli asset exchange-step --step=8 --locker=bob --recipient=alice --target-network=network2 --contract-id=<contract-id>
7474
```
7575

7676
## Fabric with Corda
7777

78-
We will demonstrate asset exchange of a bond in fabric `network1` with tokens on `Corda_Network`.
79-
For fabric commands, run from `samples/fabric/fabric-cli` folder, and for Corda commands, run from `samples/corda/corda-simple-application` folder. Here `Alice` and `Bob` in fabric `network1` correspond to `PartyA` (`CORDA_PORT=10006`) and `PartyB` (`CORDA_PORT=10009`) in `Corda_Network` respectively. Following are the step-by-step asset exchange process:
78+
We will demonstrate asset exchange of a bond in Fabric `network1` with tokens on `Corda_Network`.
79+
For Fabric commands, run from `samples/fabric/fabric-cli` folder, and for Corda commands, run from `samples/corda/corda-simple-application` folder. Here `Alice` and `Bob` in Fabric `network1` correspond to `PartyA` (`CORDA_PORT=10006`) and `PartyB` (`CORDA_PORT=10009`) in `Corda_Network` respectively. Following are the step-by-step asset exchange process:
8080

8181
(_Note: the hash pair used in following steps can be replaced by any valid `sha256` hash pair_)
8282

83-
- Run the following to verify the status of the bond assets owned by `alice` and `bob` in the fabric network `network1` from `samples/fabric/fabric-cli` folder:
83+
- Run the following to verify the status of the bond assets owned by `alice` and `bob` in the Fabric network `network1` from `samples/fabric/fabric-cli` folder:
8484
```bash
8585
./scripts/getAssetStatus.sh
8686
```
@@ -109,12 +109,12 @@ For fabric commands, run from `samples/fabric/fabric-cli` folder, and for Corda
109109
```bash
110110
CORDA_PORT=10006 ./clients/build/install/clients/bin/clients claim-asset --secret=secrettext --contract-id=<contract-id>
111111
```
112-
(_Note: Here the `PartyB` can see the node's log to get the revealed the hash preimage, to use it to claim bond in fabric network._)
112+
(_Note: Here the `PartyB` can see the node's log to get the revealed the hash preimage, to use it to claim bond in Fabric network._)
113113
- Run the following to trigger `bob`'s claim for `bond01:a03` locked by `alice` in `network1`:
114114
```bash
115115
./bin/fabric-cli asset exchange-step --step=6 --recipient=bob --locker=alice --target-network=network1 --param=bond01:a03 --secret=secrettext
116116
```
117-
- Run the following to verify the status of the bond assets owned by `alice` and `bob` in the fabric network `network1` from `samples/fabric/fabric-cli` folder:
117+
- Run the following to verify the status of the bond assets owned by `alice` and `bob` in the Fabric network `network1` from `samples/fabric/fabric-cli` folder:
118118
```bash
119119
./scripts/getAssetStatus.sh
120120
```
@@ -123,14 +123,13 @@ For fabric commands, run from `samples/fabric/fabric-cli` folder, and for Corda
123123
./scripts/getAssetStatus.sh
124124
```
125125
126-
127-
Above steps complete a successful asset exchange between Fabric and Corda networks.
128-
In addition to above commands, following are the extra options:
129-
- _In case_, `alice` wants to unlock the bond asset, run the following to trigger `alice`'s re-claim for `bond01:a03` locked in `network1`:
126+
The above steps complete a successful asset exchange between Fabric and Corda networks.
127+
In addition to the above commands, following are the extra options:
128+
- If `alice` wants to unlock the bond asset, run the following to trigger `alice`'s re-claim for `bond01:a03` locked in `network1`:
130129
```bash
131130
./bin/fabric-cli asset exchange-step --step=7 --locker=alice --recipient=bob --target-network=network1 --param=bond01:a03
132131
```
133-
- _In case_, `PartyB` wants to unlock the token asset, run the following to trigger unlock for `t1:50` locked in `Corda_Network`:
132+
- If `PartyB` wants to unlock the token asset, run the following to trigger unlock for `t1:50` locked in `Corda_Network`:
134133
```bash
135134
CORDA_PORT=10009 ./clients/build/install/clients/bin/clients unlock-asset --contract-id=<contract-id>
136135
```
@@ -167,7 +166,7 @@ We will demonstrate asset exchange of a tokens in `Corda_Network` with tokens on
167166
```bash
168167
CORDA_PORT=30006 ./clients/build/install/clients/bin/clients claim-asset --secret=secrettext --contract-id=<contract-id-2>
169168
```
170-
(_Note: Here the `PartyB` can see the node's log to get the revealed the hash preimage, to use it to claim bond in fabric network._)
169+
(_Note: Here the `PartyB` can see the node's log to get the revealed the hash preimage, to use it to claim bond in Fabric network._)
171170
- Run the following to trigger `PartyB`'s claim for `30` units of token type `t1` locked by `PartyA` in `Corda_Network`:
172171
```bash
173172
CORDA_PORT=10006 ./clients/build/install/clients/bin/clients claim-asset --secret=secrettext --contract-id=<contract-id-1>
@@ -178,13 +177,13 @@ We will demonstrate asset exchange of a tokens in `Corda_Network` with tokens on
178177
```
179178
180179
181-
Above steps complete a successful asset exchange between two Corda networks.
182-
In addition to above commands, following are the extra options:
183-
- _In case_, `PartyA` wants to unlock the token `t1:30` asset, run the following to trigger `PartyA`'s re-claim in `Corda_Network`:
180+
The above steps complete a successful asset exchange between two Corda networks.
181+
In addition to the above commands, following are the extra options:
182+
- If `PartyA` wants to unlock the token `t1:30` asset, run the following to trigger `PartyA`'s re-claim in `Corda_Network`:
184183
```bash
185184
CORDA_PORT=10006 ./clients/build/install/clients/bin/clients unlock-asset --contract-id=<contract-id-1>
186185
```
187-
- _In case_, `PartyB` wants to unlock the token `t2:50` asset, run the following to trigger `PartyB`'s re-claim in `Corda_Network2`:
186+
- If `PartyB` wants to unlock the token `t2:50` asset, run the following to trigger `PartyB`'s re-claim in `Corda_Network2`:
188187
```bash
189188
CORDA_PORT=30009 ./clients/build/install/clients/bin/clients unlock-asset --contract-id=<contract-id-2>
190189
```

docs/docs/external/getting-started/interop/data-sharing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: Data Sharing
1111

1212
This document lists sample ways in which you can exercise the data-sharing interoperation protocol on the test network [launched earlier](../test-network/overview).
1313

14-
Once the networks, relays, and drivers have been launched, and the ledgers bootstrapped, you can trigger three different interoperation flows corresponding to distinct data-sharing combinations as follows:
14+
Once the networks, relays, and drivers have been launched, and the ledgers bootstrapped, you can trigger four different interoperation flows corresponding to distinct data-sharing combinations as follows:
1515
1. **Corda to Corda**: Either Corda network requests state and proof from another Corda network
1616
2. **Corda to Fabric**: The Corda network requests state and proof from either Fabric network
1717
3. **Fabric to Corda**: Either Fabric network requests state and proof from the Corda network
@@ -31,11 +31,11 @@ To test the scenario where `Corda_Network` requests the value of the state (key)
3131
```bash
3232
NETWORK_NAME=Corda_Network CORDA_PORT=10006 ./clients/build/install/clients/bin/clients request-state localhost:9081 localhost:9082/Corda_Network2/localhost:30006#com.cordaSimpleApplication.flow.GetStateByKey:H
3333
```
34-
* If Relays and Drivers are deployed in the Docker containers:
34+
* If Relays and Drivers are deployed in Docker containers:
3535
```bash
3636
NETWORK_NAME=Corda_Network CORDA_PORT=10006 ./clients/build/install/clients/bin/clients request-state localhost:9081 relay-corda2:9082/Corda_Network2/corda_network2_partya_1:10003#com.cordaSimpleApplication.flow.GetStateByKey:H
3737
```
38-
- Query the value of the requested state, using key `H` in `Corda_Network` by running the following command:
38+
- Query the value of the requested state using key `H` in `Corda_Network` by running the following command:
3939
```bash
4040
NETWORK_NAME=Corda_Network CORDA_PORT=10006 ./clients/build/install/clients/bin/clients get-state H
4141
```
@@ -93,7 +93,7 @@ To test the scenario where `Corda_Network` requests the value of the state (key)
9393
NETWORK_NAME=Corda_Network CORDA_PORT=10006 ./clients/build/install/clients/bin/clients get-state Arcturus
9494
```
9595

96-
**Note:** You can perform the same data transfer between `Corda_Network2` and either Fabric networks, by setting the env `CORDA_PORT=30006` (the `Corda_Network2` node's RPC port), `NETWORK_NAME=Corda_Network2`, and using `localhost:9082` (the local relay address) as the first argument.
96+
**Note:** You can perform the same data transfer between `Corda_Network2` and either Fabric networks, by setting the env `CORDA_PORT=30006` (the `Corda_Network2` node's RPC port), `NETWORK_NAME=Corda_Network2`, and using `localhost:9082` (the local relay address) as the argument following request-state.
9797
9898
## Fabric to Corda
9999

docs/docs/external/getting-started/test-network/setup-local-docker.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -255,11 +255,11 @@ Build the `corda-simple-application` Cordapp as follows:
255255

256256
### Corda Network
257257

258-
The Corda network code lies in the `tests/network-setups/corda` folder. You can launch two corda networks (`Corda_Network` and `Corda_Network2`). The networks use `samples/corda/corda-simple-application` by default, which maintains a state of type `SimpleState`, which is a set of key-value pairs (of strings).
258+
The Corda network code lies in the `tests/network-setups/corda` folder. You can launch two Corda networks (`Corda_Network` and `Corda_Network2`). The networks use `samples/corda/corda-simple-application` by default, which maintains a state of type `SimpleState`, which is a set of key-value pairs (of strings).
259259

260260
Follow the instructions below to build and launch the network:
261261
- Navigate to the `tests/network-setups/corda` folder.
262-
- To spin up the Corda networks with the interoperation Cordapp:
262+
- To spin up the Corda networks with the Interoperation Cordapps:
263263
- Each consisting of 1 node and a notary (for data-transfer), run:
264264
```bash
265265
make start-local
@@ -320,11 +320,11 @@ Run a Corda driver as follows:
320320
```
321321
DOCKER_IMAGE_NAME=weaver-corda-driver
322322
```
323-
- To deploy corda driver for `Corda_Network`, run:
323+
- To deploy Corda driver for `Corda_Network`, run:
324324
```bash
325325
make deploy COMPOSE_ARG='--env-file docker-testnet-envs/.env.corda'
326326
```
327-
- To deploy corda driver for `Corda_Network2`, run:
327+
- To deploy Corda driver for `Corda_Network2`, run:
328328
```bash
329329
make deploy COMPOSE_ARG='--env-file docker-testnet-envs/.env.corda2'
330330
```

docs/docs/external/getting-started/test-network/setup-local.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -277,11 +277,11 @@ Build the `corda-simple-application` Cordapp as follows:
277277

278278
### Corda Network
279279

280-
The Corda network code lies in the `tests/network-setups/corda` folder. You can launch two corda networks (`Corda_Network` and `Corda_Network2`). This networks use `samples/corda/corda-simple-application` by default, which maintains a state of type `SimpleState`, which is a set of key-value pairs (of strings).
280+
The Corda network code lies in the `tests/network-setups/corda` folder. You can launch two Corda networks (`Corda_Network` and `Corda_Network2`). These networks use `samples/corda/corda-simple-application` by default, which maintains a state of type `SimpleState`, which is a set of key-value pairs (of strings).
281281

282282
Follow the instructions below to build and launch the network:
283283
- Navigate to the `tests/network-setups/corda` folder.
284-
- To spin up the Corda networks with the interoperation Cordapp:
284+
- To spin up the Corda networks with the Interoperation Cordapps:
285285
- Each consisting of 1 node and a notary (for data-transfer), run:
286286
```bash
287287
make start-local
@@ -313,7 +313,7 @@ The relay was built earlier, so you just need to use a different configuration f
313313
Run a relay in host as follows:
314314
- Navigate to the `core/relay` folder.
315315
- (Make sure you've already built the relay by running `make`.)
316-
- Run the following, to start relay for `Corda_Network`:
316+
- Run the following to start relay for `Corda_Network`:
317317
```bash
318318
RELAY_CONFIG=config/Corda_Relay.toml cargo run --bin server
319319
```
@@ -324,7 +324,7 @@ Run a relay in host as follows:
324324
Relay Name: "Corda_Relay"
325325
RelayServer listening on [::1]:9081
326326
```
327-
- Run the following, to start relay for `Corda_Network2`:
327+
- Run the following to start relay for `Corda_Network2`:
328328
```bash
329329
RELAY_CONFIG=config/Corda_Relay2.toml cargo run --bin server
330330
```
@@ -353,15 +353,15 @@ Build the Corda driver module as follows:
353353

354354
Run a Corda driver as follows:
355355
- Navigate to the `core/drivers/corda-driver` folder.
356-
- Run the following, to start corda driver for `Corda_Network`:
356+
- Run the following to start Corda driver for `Corda_Network`:
357357
```bash
358358
./build/install/corda-driver/bin/corda-driver
359359
```
360360
If the driver starts successfully, it should log the following message on your terminal:
361361
```
362362
Corda driver gRPC server started. Listening on port 9099
363363
```
364-
- Run the following, to start corda driver for `Corda_Network2`:
364+
- Run the following to start Corda driver for `Corda_Network2`:
365365
```bash
366366
DRIVER_PORT=9098 ./build/install/corda-driver/bin/corda-driver
367367
```

docs/docs/external/getting-started/test-network/setup-packages-docker.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Using the sequence of instructions below, you can start a Corda network and run
145145

146146
### Corda Network
147147

148-
The Corda network code lies in the `tests/network-setups/corda` folder. You can launch two corda networks (`Corda_Network` and `Corda_Network2`). This networks use `samples/corda/corda-simple-application` by default, which maintains a state of type `SimpleState`, which is a set of key-value pairs (of strings).
148+
The Corda network code lies in the `tests/network-setups/corda` folder. You can launch two Corda networks (`Corda_Network` and `Corda_Network2`). These networks use `samples/corda/corda-simple-application` by default, which maintains a state of type `SimpleState`, which is a set of key-value pairs (of strings).
149149
Following steps will build above cordapp and a corda-client as well in `samples/corda/client`.
150150

151151
#### Running with Interoperation Cordapp from Github Packages
@@ -154,7 +154,7 @@ Follow the instructions below to build and launch the network:
154154
- Navigate to the `tests/network-setups/corda` folder.
155155
- Create copy of `github.properties.template` as `github.properties`.
156156
- Replace `<GITHUB email>` with your github email, and `<GITHUB Personal Access Token>` with the access token created [above](#package-access-token).
157-
- To spin up the Corda networks with the interoperation Cordapp:
157+
- To spin up the Corda networks with the Interoperation Cordapps:
158158
- Each consisting of 1 node and a notary (for data-transfer), run:
159159
```bash
160160
make start
@@ -198,11 +198,11 @@ Navigate to the `core/relay` folder and run a relay for `Corda_Network` in docke
198198
Run a Corda driver as follows:
199199
- Navigate to the `core/drivers/corda-driver` folder.
200200
- There's a `.env.corda` file in `docker-testnet-envs` directory, that will be used to start a corda driver in docker.
201-
- To deploy corda driver for `Corda_Network`, run:
201+
- To deploy Corda driver for `Corda_Network`, run:
202202
```bash
203203
make deploy COMPOSE_ARG='--env-file docker-testnet-envs/.env.corda'
204204
```
205-
- To deploy corda driver for `Corda_Network2`, run:
205+
- To deploy Corda driver for `Corda_Network2`, run:
206206
```bash
207207
make deploy COMPOSE_ARG='--env-file docker-testnet-envs/.env.corda2'
208208
```

docs/docs/external/getting-started/test-network/setup-packages.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Using the sequence of instructions below, you can start a Corda network and run
193193

194194
### Corda Network
195195

196-
The Corda network code lies in the `tests/network-setups/corda` folder. You can launch two corda networks (`Corda_Network` and `Corda_Network2`). This networks use `samples/corda/corda-simple-application` by default, which maintains a state of type `SimpleState`, which is a set of key-value pairs (of strings).
196+
The Corda network code lies in the `tests/network-setups/corda` folder. You can launch two Corda networks (`Corda_Network` and `Corda_Network2`). These networks use `samples/corda/corda-simple-application` by default, which maintains a state of type `SimpleState`, which is a set of key-value pairs (of strings).
197197
Following steps will build above cordapp and a corda-client as well in `samples/corda/client`.
198198

199199
#### Running with Interoperation Cordapp from Github Packages
@@ -202,7 +202,7 @@ Follow the instructions below to build and launch the network:
202202
- Navigate to the `tests/network-setups/corda` folder.
203203
- Create a copy of `github.properties.template` as `github.properties`.
204204
- Replace `<GITHUB email>` with your github email, and `<GITHUB Personal Access Token>` with the access token created [above](#package-access-token).
205-
- To spin up the Corda networks with the interoperation Cordapp:
205+
- To spin up the Corda networks with the Interoperation Cordapps:
206206
- Each consisting of 1 node and a notary (for data-transfer), run:
207207
```bash
208208
make start
@@ -233,7 +233,7 @@ The relay was built earlier, so you just need to use a different configuration f
233233

234234
Run a relay in host as follows:
235235
- Navigate to the `core/relay` folder.
236-
- Run the following, to start relay for `Corda_Network`:
236+
- Run the following to start relay for `Corda_Network`:
237237
```bash
238238
RELAY_CONFIG=config/Corda_Relay.toml cargo run --bin server
239239
```
@@ -244,7 +244,7 @@ Run a relay in host as follows:
244244
Relay Name: "Corda_Relay"
245245
RelayServer listening on [::1]:9081
246246
```
247-
- Run the following, to start relay for `Corda_Network2`:
247+
- Run the following to start relay for `Corda_Network2`:
248248
```bash
249249
RELAY_CONFIG=config/Corda_Relay2.toml cargo run --bin server
250250
```
@@ -275,15 +275,15 @@ Build the Corda driver module as follows:
275275

276276
Run a Corda driver as follows:
277277
- Navigate to the `core/drivers/corda-driver` folder.
278-
- Run the following, to start corda driver for `Corda_Network`:
278+
- Run the following to start Corda driver for `Corda_Network`:
279279
```bash
280280
./build/install/corda-driver/bin/corda-driver
281281
```
282282
If the driver starts successfully, it should log the following message on your terminal:
283283
```
284284
Corda driver gRPC server started. Listening on port 9099
285285
```
286-
- Run the following, to start corda driver for `Corda_Network2`:
286+
- Run the following to start Corda driver for `Corda_Network2`:
287287
```bash
288288
DRIVER_PORT=9098 ./build/install/corda-driver/bin/corda-driver
289289
```

0 commit comments

Comments
 (0)