You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: high-throughput/README.md
+37-48Lines changed: 37 additions & 48 deletions
Original file line number
Diff line number
Diff line change
@@ -94,75 +94,56 @@ and assumed to be correct and at minimal risk to either company simply due to Am
94
94
must be verified before approval and admittance to the chain.
95
95
96
96
## How
97
-
This sample provides the chaincode and scripts required to run a high-throughput application. For ease of use, it runs on the same network which is brought
98
-
up by `byfn.sh` in the `first-network` folder within `fabric-samples`, albeit with a few small modifications. The instructions to build the network
99
-
and run some invocations are provided below.
97
+
This sample provides the chaincode and scripts required to run a high-throughput application on the Fabric test network.
100
98
101
-
### Build your network
102
-
1.`cd` into the `first-network` folder within `fabric-samples`, e.g. `cd ~/fabric-samples/first-network`
103
-
2. Open `docker-compose-cli.yaml` in your favorite editor, and edit the following lines:
104
-
* In the `volumes` section of the `cli` container, edit the second line which refers to the chaincode folder to point to the chaincode folder
1. Change into the chaincode directory, e.g. `cd ~/fabric-samples/high-throughput/chaincode`
101
+
2. Vendor the Go dependencies by running the following command: `GO111MODULE=on go mod vendor`
102
+
3. The chaincode directory will now contain a `vendor` directory.
114
103
115
-
* Finally, comment out the `docker exec cli scripts/script.sh` command from the `byfn.sh` script by placing a `#` before it so that the standard BYFN end to end script doesn't run, e.g.
You can use the `startFabric.sh` script to create an instance of the Fabric test network with a single channel named `mychannel`. The script then deploys the `high-throughput` chaincode to the channel by installing it on the test network peers and committing the chaincode definition to the channel.
118
107
119
-
3. We can now bring our network up by typing in `./byfn.sh up -c mychannel`
120
-
4. Open a new terminal window and enter the CLI container using `docker exec -it cli bash`, all operations on the network will happen within
121
-
this container from now on.
108
+
Change back into the `high-throughput` directory in `fabic-samples`. Start the network and deploy the chaincode by issuing the following command:
109
+
```
110
+
./startFabric.sh
111
+
```
122
112
123
-
### Vendor the chaincode dependencies
124
-
1. Outside of the CLI container, change into the chaincode directory, e.g. `cd ~/fabric-samples/high-throughput/chaincode`
125
-
2. Vendor the Go dependencies by running the following command: `GO111MODULE=on go mod vendor`
126
-
3. The chaincode directory will now contain a `vendor` directory.
113
+
If successful, you will see messages of the Fabric test network being created and the chaincode being deployed, followed by the execution time of the script:
114
+
```
115
+
Total setup execution time : 141 secs ...
116
+
```
127
117
128
-
### Install and define the chaincode
129
-
1. Once you're in the CLI container run `cd scripts` to enter the `scripts` folder
130
-
2. Set-up the environment variables by running `source setclienv.sh`
131
-
3. Set-up your channels and anchor peers by running `./channel-setup.sh`
132
-
4. Package and install your chaincode by running `./install-chaincode.sh 1`. The only argument is a number representing the chaincode version, every time
133
-
you want to install and upgrade to a new chaincode version simply increment this value by 1 when running the command, e.g. `./install-chaincode.sh 2`
134
-
5. Define your chaincode on the channel by running `./approve-commit-chaincode.sh 1`. The version argument serves the same purpose as in `./install-chaincode.sh 1`
135
-
and should match the version of the chaincode you just installed. This script also invokes the chaincode `Init` function to start the chaincode container.
136
-
You can also upgrade the chaincode to a newer version by running `./approve-commit-chaincode.sh 2`.
137
-
6. Your chaincode is now installed and ready to receive invocations
118
+
The `high-throughput` chaincode is now ready to receive invocations.
138
119
139
120
### Invoke the chaincode
140
-
All invocations are provided as scripts in `scripts` folder; these are detailed below.
121
+
All invocations are provided as scripts in `scripts` folder. You can use these scripts to create and remove assets that you put on the ledger.
141
122
142
123
#### Update
143
-
The format for update is: `./update-invoke.sh name value operation` where `name` is the name of the variable to update, `value` is the value to
124
+
The format for update is: `./scripts/update-invoke.sh name value operation` where `name` is the name of the variable to update, `value` is the value to
144
125
add to the variable, and `operation` is either `+` or `-` depending on what type of operation you'd like to add to the variable. In the future,
145
126
multiply/divide operations will be supported (or add them yourself to the chaincode as an exercise!)
146
127
147
-
Example: `./update-invoke.sh myvar 100 +`
128
+
Example: `./scripts/update-invoke.sh myvar 100 +`
148
129
149
130
#### Get
150
131
The format for get is: `./get-invoke.sh name` where `name` is the name of the variable to get.
151
132
152
-
Example: `./get-invoke.sh myvar`
153
-
154
-
#### Delete
155
-
The format for delete is: `./delete-invoke.sh name` where `name` is the name of the variable to delete.
156
-
157
-
Example: `./delete-invoke.sh myvar`
133
+
Example: `./scripts/get-invoke.sh myvar`
158
134
159
135
#### Prune
160
136
Pruning takes all the deltas generated for a variable and combines them all into a single row, deleting all previous rows. This helps cleanup
161
137
the ledger when many updates have been performed.
162
138
163
-
The format for pruning is: `./prune-invoke.sh name` where `name` is the name of the variable to prune.
139
+
The format for pruning is: `./scripts/prune-invoke.sh name` where `name` is the name of the variable to prune.
140
+
141
+
Example: `./scripts/prune-invoke.sh myvar`
164
142
165
-
Example: `./prune-invoke.sh myvar`
143
+
#### Delete
144
+
The format for delete is: `./delete-invoke.sh name` where `name` is the name of the variable to delete.
145
+
146
+
Example: `./scripts/delete-invoke.sh myvar`
166
147
167
148
### Test the Network
168
149
Two scripts are provided to show the advantage of using this system when running many parallel transactions at once: `many-updates.sh` and
@@ -178,6 +159,14 @@ errors in the peer and orderer logs.
178
159
There are two other scripts, `get-traditional.sh`, which simply gets the value of a row in the traditional way, with no deltas, and `del-traditional.sh` will delete an asset in the traditional way.
179
160
180
161
Examples:
181
-
`./many-updates.sh testvar 100 +` --> final value from `./get-invoke.sh testvar` should be 100000
162
+
`./scripts/many-updates.sh testvar 100 +` --> final value from `./scripts/get-invoke.sh testvar` should be 100000
163
+
164
+
`./scripts/many-updates-traditional.sh testvar` --> final value from `./scripts/get-traditional.sh testvar` is undefined
165
+
166
+
### Clean up
167
+
168
+
When you are finished using the `high-throughput` chaincode, you can bring down the network and remove any accompanying artifacts using the `networkDown.sh` script.
182
169
183
-
`./many-updates-traditional.sh testvar` --> final value from `./get-traditional.sh testvar` is undefined
0 commit comments