Pre25 release (#357)

mbwhite · web-flow · commit 0cc0915c8a69 · 2022-12-09T11:10:24.000Z
* Update dependencies

Signed-off-by: Matthew B White &lt;whitemat@uk.ibm.com&gt;

* Pre2.5 release

Update the build to use the prerelease version of the main fabric 2.5

Signed-off-by: Matthew B White &lt;whitemat@uk.ibm.com&gt;

Signed-off-by: Matthew B White &lt;whitemat@uk.ibm.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,19 @@
+## v2.5.0
+Thu Dec  8 09:19:10 GMT 2022
+
+* [b8cb8d72](https://github.com/hyperledger/fabric-chaincode-node/commit/b8cb8d72) Update dependencies
+* [bbd5b6f6](https://github.com/hyperledger/fabric-chaincode-node/commit/bbd5b6f6) Update MAINTAINERS.md (#352)
+* [d03fc721](https://github.com/hyperledger/fabric-chaincode-node/commit/d03fc721) Move inactive maintainers to emeritus status
+* [37b4256b](https://github.com/hyperledger/fabric-chaincode-node/commit/37b4256b) updated tutorial (#350)
+* [78a02ada](https://github.com/hyperledger/fabric-chaincode-node/commit/78a02ada) Add fv test chaincode deploy logging
+* [341956d4](https://github.com/hyperledger/fabric-chaincode-node/commit/341956d4) Enabled GHA with template workflow (#343)
+* [c02ca323](https://github.com/hyperledger/fabric-chaincode-node/commit/c02ca323) Add in short version docker tag (#342)
+* [ffa075ed](https://github.com/hyperledger/fabric-chaincode-node/commit/ffa075ed) added purgePrivateData function with tests
+* [501af57a](https://github.com/hyperledger/fabric-chaincode-node/commit/501af57a) Bump version to 2.5.0 (#340)
+* [eee58335](https://github.com/hyperledger/fabric-chaincode-node/commit/eee58335) Swap to using the published fabric-protos libraries (#320)
+* [ebf16ead](https://github.com/hyperledger/fabric-chaincode-node/commit/ebf16ead) Update README.md
+* [838b02fd](https://github.com/hyperledger/fabric-chaincode-node/commit/838b02fd) Bump version to 2.4.2 (#332)
+
 ## v2.4.2
 Wed  4 May 2022 11:30:35 BST
 
diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md
@@ -11,8 +11,10 @@ This table shows the summary of the compatibility of the Node modules at version
 | Node modules **v1.4.5**        | Yes                    | 8                | Yes                    |
 | Node modules **v2.2.x/v2.3.x** | Yes                    | 12               | Yes                    |
 | Node modules **v2.4.x**        | Yes                    | 16               | Yes                    |
+| Node modules **v2.5.x**        | Yes                    | 16               | Yes                    |
 
-By default a Fabric Peer v1.4 will create a Nodejs v8 runtime, and a Fabric Peer v2.2/2.3 will create a Nodejs 12 runtime. The Fabric v2.4 will create a Nodejs 16 runtime. Whilst these are defaults, the docker image used to host the chaincode and contracts can be altered. Set the environment variable `CORE_CHAINCODE_NODE_RUNTIME` on the peer to the name of the docker image.
+
+By default a Fabric Peer v1.4 will create a Nodejs v8 runtime, and a Fabric Peer v2.2/2.3 will create a Nodejs 12 runtime. The Fabric v2.5 will create a Nodejs 16 runtime. Whilst these are defaults, the docker image used to host the chaincode and contracts can be altered. Set the environment variable `CORE_CHAINCODE_NODE_RUNTIME` on the peer to the name of the docker image.
 
 For example `CORE_CHAINCODE_NODE_RUNTIME=hyperledger/fabric-nodeenv:2.1` will allow the use of the latest Node 12 runtime to be used within a Peer v1.4.
 
@@ -22,7 +24,7 @@ The Node modules will connect to the peer whilst running; this is referred to as
 
 Note that the `fabric-contract-api` & `fabric-shim` node modules must be at v1.4.5 or greater to work with Node version 12. If you therefore use a contract originally written to work with Fabric 1.4, check the node modules before deploying on Fabric v2.
 
-Also please note that that the v1.4 libraries WILL NOT work with Node16. Unless you configure a different node environment, any chaincode using the v1.4 libraries will need to move to v2.4 before being able to run with a Fabric v2.4 Peer.
+Also please note that that the v1.4 libraries WILL NOT work with Node16. Unless you configure a different node environment, any chaincode using the v1.4 libraries will need to move to v2.5 before being able to run with a Fabric v2.4 Peer.
 
 ## Compatibility
 
diff --git a/TUTORIAL.md b/TUTORIAL.md
@@ -28,8 +28,8 @@ The dependencies of `fabric-contract-api` and `fabric-shim` will be required.
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-contract-api": "^2.5.0-unstable",
-    "fabric-shim": "^2.5.0-unstable"
+    "fabric-contract-api": "^2.5.0",
+    "fabric-shim": "^2.5.0"
   }
 }
 
diff --git a/apis/fabric-contract-api/package.json b/apis/fabric-contract-api/package.json
@@ -1,7 +1,7 @@
 {
   "name": "fabric-contract-api",
-  "version": "2.5.0-unstable",
-  "tag": "unstable",
+  "version": "2.5.0",
+  "tag": "latest",
   "description": "A node.js implementation of Hyperledger Fabric chaincode shim, to allow endorsing peers and user-provided chaincodes to communicate with each other",
   "main": "index.js",
   "repository": {
@@ -46,7 +46,7 @@
     "lines": 100
   },
   "dependencies": {
-    "fabric-shim-api": "2.5.0-unstable",
+    "fabric-shim-api": "2.5.0",
     "class-transformer": "^0.4.0",
     "fast-safe-stringify": "^2.1.1",
     "get-params": "^0.1.2",
diff --git a/apis/fabric-shim-api/package.json b/apis/fabric-shim-api/package.json
@@ -1,7 +1,7 @@
 {
   "name": "fabric-shim-api",
-  "version": "2.5.0-unstable",
-  "tag": "unstable",
+  "version": "2.5.0",
+  "tag": "latest",
   "description": "A node.js API of Hyperledger Fabric chaincode shim, to allow endorsing peers and user-provided chaincodes to communicate with each other",
   "main": "index.js",
   "repository": {
diff --git a/ci/azure-pipelines.yml b/ci/azure-pipelines.yml
@@ -13,15 +13,15 @@ schedules:
     displayName: 'Chaincode Node Nightly Driver'
     branches:
       include:
-        - main
+        - 'release-2.5'
 
 # Trigger on the main branch
 # Standard Pull Request and Merge builds
 # Any git tag will also trigger a build that should do publishing
 trigger:
   branches:
     include:
-      - 'main'
+      - 'release-2.5'
   tags:
     include:
       - '*'
@@ -52,7 +52,7 @@ pool:
 #
 # Publish to NPM on release builds (they are the github tagged releases)
 # Publish to NPM on nightly builds when there is something to build
-# the ids will be of the format 2.5.0-unstable.{commitid}
+# the ids will be of the format 2.5.0.{commitid}
 #
 stages:
 
diff --git a/common/config/rush/command-line.json b/common/config/rush/command-line.json
@@ -60,7 +60,7 @@
             "name": "start-fabric",
             "summary": "Starts local Fabric test network ",
             "description": "Run this command to start local Fabric network for testing",
-            "shellCommand": "rm -rf ./fabric-samples && curl -sSL https://bit.ly/2ysbOFE | bash -s -- 2.4.5 1.5.5 -d && cd ./fabric-samples/test-network && ./network.sh down && ./network.sh up createChannel -ca -s couchdb && cd -"
+            "shellCommand": "./tools/scripts/startFabric.sh"
         },
         {
             "commandKind": "global",
diff --git a/docker/fabric-nodeenv/package.json b/docker/fabric-nodeenv/package.json
@@ -1,6 +1,6 @@
 {
   "name": "fabric-nodeenv",
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "description": "",
   "main": "docker.js",
   "scripts": {
@@ -11,6 +11,6 @@
   "license": "Apache-2.0",
   "dependencies": {
     "git-rev-sync": "3.0.1",
-    "toolchain": "2.5.0-unstable"
+    "toolchain": "2.5.0"
   }
 }
diff --git a/docs/_jsdoc/tutorials/using-chaincodeinterface.md b/docs/_jsdoc/tutorials/using-chaincodeinterface.md
@@ -8,7 +8,7 @@ cd mycc
 // create a new node project
 npm init
 // install fabric-shim at main branch
-npm install fabric-shim@2.5.0-unstable
+npm install fabric-shim@2.5.0
 // or using the released version
 npm install fabric-shim
 touch mychaincode.js
@@ -68,7 +68,7 @@ Finally, update the "start" script in package.json to "node mychaincode.js":
 	"engineStrict": true,
 	"license": "Apache-2.0",
 	"dependencies": {
-		"fabric-shim": "2.5.0-unstable"
+		"fabric-shim": "2.5.0"
 	}
 }
 ```
diff --git a/docs/_jsdoc/tutorials/using-contractinterface.md b/docs/_jsdoc/tutorials/using-contractinterface.md
@@ -28,8 +28,8 @@ The dependencies of `fabric-contract-api` and `fabric-shim` will be required.
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-contract-api": "^2.5.0-unstable",
-    "fabric-shim": "^2.5.0-unstable"
+    "fabric-contract-api": "^2.5.0",
+    "fabric-shim": "^2.5.0"
   }
 }
 
diff --git a/docs/package.json b/docs/package.json
@@ -1,14 +1,14 @@
 {
   "name": "fabric-shim-docs",
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "description": "",
   "private": true,
   "scripts": {
     "build": "npm run docs",
     "docs": "rimraf ./gen && jsdoc -c ./_jsdoc.json"
   },
   "dependencies": {
-    "fabric-ledger": "2.5.0-unstable"
+    "fabric-ledger": "2.5.0"
   },
   "devDependencies": {
     "ink-docstrap": "^1.3.2",
diff --git a/libraries/fabric-ledger/package.json b/libraries/fabric-ledger/package.json
@@ -1,7 +1,7 @@
 {
   "name": "fabric-ledger",
-  "version": "2.5.0-unstable",
-  "tag": "unstable",
+  "version": "2.5.0",
+  "tag": "latest",
   "description": "A node.js implementation of Hyperledger Fabric ledger api, to allow access to ledger data from smart contracts",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -49,7 +49,7 @@
     "lines": 100
   },
   "dependencies": {
-    "fabric-contract-api": "2.5.0-unstable",
+    "fabric-contract-api": "2.5.0",
     "winston": "^3.7.2"
   },
   "devDependencies": {
diff --git a/libraries/fabric-shim/package.json b/libraries/fabric-shim/package.json
@@ -1,7 +1,7 @@
 {
   "name": "fabric-shim",
-  "version": "2.5.0-unstable",
-  "tag": "unstable",
+  "version": "2.5.0",
+  "tag": "latest",
   "description": "A node.js implementation of Hyperledger Fabric chaincode shim, to allow endorsing peers and user-provided chaincodes to communicate with each other",
   "main": "index.js",
   "bin": {
@@ -60,8 +60,8 @@
     "@hyperledger/fabric-protos": "0.1.0-dev.2300102001.1",
     "@types/node": "^16.11.1",
     "ajv": "^6.12.2",
-    "fabric-contract-api": "2.5.0-unstable",
-    "fabric-shim-api": "2.5.0-unstable",
+    "fabric-contract-api": "2.5.0",
+    "fabric-shim-api": "2.5.0",
     "fs-extra": "^10.0.1",
     "reflect-metadata": "^0.1.13",
     "winston": "^3.7.2",
diff --git a/release_notes/v2.5.0.txt b/release_notes/v2.5.0.txt
@@ -0,0 +1,12 @@
+v2.5.0
+------
+
+Release Notes
+-------------
+This is the LTS Release of of the v2.5 Fabric Chaincode Node. It replaces the previous v2.2 LTS.
+
+- the PurgePrivateData feature is exposed via a new `PurgePrivateData` API 
+
+Change Log
+----------
+https://github.com/hyperledger/fabric-chaincode-node/blob/main/CHANGELOG.md#v2.5.0
diff --git a/test/chaincodes/annotations/package.json b/test/chaincodes/annotations/package.json
@@ -14,13 +14,13 @@
   "typings": "dist/index.d.ts",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "author": "",
   "license": "APACHE-2.0",
   "dependencies": {
     "@types/node": "^16.11.4",
-    "fabric-contract-api": "2.5.0-unstable",
-    "fabric-shim": "2.5.0-unstable",
+    "fabric-contract-api": "2.5.0",
+    "fabric-shim": "2.5.0",
     "ts-node": "^3.3.0",
     "tslint": "^5.6.0",
     "typescript": "^4.0.2"
diff --git a/test/chaincodes/annotations/src/test_contract/expected-metadata.json b/test/chaincodes/annotations/src/test_contract/expected-metadata.json
@@ -107,7 +107,7 @@
         }
     },
     "info": {
-        "version": "2.5.0-unstable",
+        "version": "2.5.0",
         "title": "ts_chaincode"
     },
     "components": {
diff --git a/test/chaincodes/clientidentity/package.json b/test/chaincodes/clientidentity/package.json
@@ -11,11 +11,11 @@
   "main": "index.js",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-shim": "2.5.0-unstable",
-    "fabric-contract-api": "2.5.0-unstable"
+    "fabric-shim": "2.5.0",
+    "fabric-contract-api": "2.5.0"
   }
 }
diff --git a/test/chaincodes/crosschaincode/package.json b/test/chaincodes/crosschaincode/package.json
@@ -11,11 +11,11 @@
   "main": "index.js",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-shim": "2.5.0-unstable",
-    "fabric-contract-api": "2.5.0-unstable"
+    "fabric-shim": "2.5.0",
+    "fabric-contract-api": "2.5.0"
   }
 }
diff --git a/test/chaincodes/crosschaincode2/package.json b/test/chaincodes/crosschaincode2/package.json
@@ -11,11 +11,11 @@
   "main": "index.js",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-shim": "2.5.0-unstable",
-    "fabric-contract-api": "2.5.0-unstable"
+    "fabric-shim": "2.5.0",
+    "fabric-contract-api": "2.5.0"
   }
 }
diff --git a/test/chaincodes/crud/package.json b/test/chaincodes/crud/package.json
@@ -11,11 +11,11 @@
   "main": "index.js",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-shim": "2.5.0-unstable",
-    "fabric-contract-api": "2.5.0-unstable"
+    "fabric-shim": "2.5.0",
+    "fabric-contract-api": "2.5.0"
   }
 }
diff --git a/test/chaincodes/events/package.json b/test/chaincodes/events/package.json
@@ -11,11 +11,11 @@
   "main": "index.js",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-shim": "2.5.0-unstable",
-    "fabric-contract-api": "2.5.0-unstable"
+    "fabric-shim": "2.5.0",
+    "fabric-contract-api": "2.5.0"
   }
 }
diff --git a/test/chaincodes/ledger/package.json b/test/chaincodes/ledger/package.json
@@ -11,12 +11,12 @@
   "main": "index.js",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-shim": "2.5.0-unstable",
-    "fabric-contract-api": "2.5.0-unstable",
-    "fabric-ledger": "2.5.0-unstable"
+    "fabric-shim": "2.5.0",
+    "fabric-contract-api": "2.5.0",
+    "fabric-ledger": "2.5.0"
   }
 }
diff --git a/test/chaincodes/privateData/package.json b/test/chaincodes/privateData/package.json
@@ -11,11 +11,11 @@
   "main": "index.js",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-shim": "2.5.0-unstable",
-    "fabric-contract-api": "2.5.0-unstable"
+    "fabric-shim": "2.5.0",
+    "fabric-contract-api": "2.5.0"
   }
 }
diff --git a/test/chaincodes/query/package.json b/test/chaincodes/query/package.json
@@ -11,11 +11,11 @@
   "main": "index.js",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0-latest",
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-shim": "2.5.0-unstable",
-    "fabric-contract-api": "2.5.0-unstable"
+    "fabric-shim": "2.5.0",
+    "fabric-contract-api": "2.5.0"
   }
 }
diff --git a/test/chaincodes/scenario/package.json b/test/chaincodes/scenario/package.json
@@ -11,11 +11,11 @@
   "main": "index.js",
   "engine-strict": true,
   "engineStrict": true,
-  "version": "2.5.0-unstable",
+  "version": "2.5.0",
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "fabric-shim": "2.5.0-unstable",
-    "fabric-contract-api": "2.5.0-unstable"
+    "fabric-shim": "2.5.0",
+    "fabric-contract-api": "2.5.0"
   }
 }
diff --git a/test/e2e/package.json b/test/e2e/package.json
diff --git a/test/e2e/scenario.js b/test/e2e/scenario.js
diff --git a/test/fv/package.json b/test/fv/package.json
diff --git a/tools/scripts/startFabric.sh b/tools/scripts/startFabric.sh
diff --git a/tools/toolchain/network/docker-compose/docker-compose-base.yaml b/tools/toolchain/network/docker-compose/docker-compose-base.yaml
diff --git a/tools/toolchain/package.json b/tools/toolchain/package.json

Original file line number	Diff line number	Diff line change
@@ -28,8 +28,8 @@ The dependencies of `fabric-contract-api` and `fabric-shim` will be required.
`28`	`28`	`"author": "",`
`29`	`29`	`"license": "Apache-2.0",`
`30`	`30`	`"dependencies": {`
`31`		`- "fabric-contract-api": "^2.5.0-unstable",`
`32`		`- "fabric-shim": "^2.5.0-unstable"`
	`31`	`+ "fabric-contract-api": "^2.5.0",`
	`32`	`+ "fabric-shim": "^2.5.0"`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@`
`60`	`60`	`"name": "start-fabric",`
`61`	`61`	`"summary": "Starts local Fabric test network ",`
`62`	`62`	`"description": "Run this command to start local Fabric network for testing",`
`63`		`- "shellCommand": "rm -rf ./fabric-samples && curl -sSL https://bit.ly/2ysbOFE \| bash -s -- 2.4.5 1.5.5 -d && cd ./fabric-samples/test-network && ./network.sh down && ./network.sh up createChannel -ca -s couchdb && cd -"`
	`63`	`+ "shellCommand": "./tools/scripts/startFabric.sh"`
`64`	`64`	`},`
`65`	`65`	`{`
`66`	`66`	`"commandKind": "global",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "fabric-nodeenv",`
`3`		`- "version": "2.5.0-unstable",`
	`3`	`+ "version": "2.5.0",`
`4`	`4`	`"description": "",`
`5`	`5`	`"main": "docker.js",`
`6`	`6`	`"scripts": {`
`@@ -11,6 +11,6 @@`
`11`	`11`	`"license": "Apache-2.0",`
`12`	`12`	`"dependencies": {`
`13`	`13`	`"git-rev-sync": "3.0.1",`
`14`		`- "toolchain": "2.5.0-unstable"`
	`14`	`+ "toolchain": "2.5.0"`
`15`	`15`	`}`
`16`	`16`	`}`