Add registry-cache docs (#110)

* Add registry-cache docs * Bump version to 1.1.6
GalaChain · Mar 20, 2024 · 0fc0483 · 0fc0483
1 parent 327f62d
commit 0fc0483
Show file tree

Hide file tree

Showing 13 changed files with 103 additions and 37 deletions.
diff --git a/chain-api/package.json b/chain-api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gala-chain/api",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Common types, DTOs (Data Transfer Objects), APIs, signatures, and utils for GalaChain.",
   "license": "Apache-2.0",
   "dependencies": {

diff --git a/chain-cli/README.md b/chain-cli/README.md
@@ -18,7 +18,7 @@ $ npm install -g @gala-chain/cli
 $ galachain COMMAND
 running command...
 $ galachain (--version)
-@gala-chain/cli/1.1.5 linux-x64 node-v18.17.1
+@gala-chain/cli/1.1.6 linux-x64 node-v18.17.1
 $ galachain --help [COMMAND]
 USAGE
   $ galachain COMMAND

diff --git a/chain-cli/chaincode-template/package.json b/chain-cli/chaincode-template/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@galachain/product",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Product Chaincode",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",
@@ -22,16 +22,16 @@
     "update-snapshot": "jest --updateSnapshot"
   },
   "dependencies": {
-    "@gala-chain/api": "1.1.5",
-    "@gala-chain/chaincode": "1.1.5",
+    "@gala-chain/api": "1.1.6",
+    "@gala-chain/chaincode": "1.1.6",
     "dotenv": "^16.0.1",
     "fabric-contract-api": "2.4.2",
     "fabric-shim": "2.4.2"
   },
   "devDependencies": {
-    "@gala-chain/cli": "1.1.5",
-    "@gala-chain/client": "1.1.5",
-    "@gala-chain/test": "1.1.5",
+    "@gala-chain/cli": "1.1.6",
+    "@gala-chain/client": "1.1.6",
+    "@gala-chain/test": "1.1.6",
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",
     "@types/axios": "^0.14.0",
     "@types/jest": "^29.5.12",

diff --git a/chain-cli/oclif.manifest.json b/chain-cli/oclif.manifest.json
@@ -1,5 +1,5 @@
 {
-  "version": "1.1.5",
+  "version": "1.1.6",
   "commands": {
     "connect": {
       "id": "connect",

diff --git a/chain-cli/package.json b/chain-cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gala-chain/cli",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "CLI for GalaChain to manage and deploy chaincodes",
   "license": "Apache-2.0",
   "bin": {
@@ -14,7 +14,7 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@gala-chain/api": "1.1.5",
+    "@gala-chain/api": "1.1.6",
     "@noble/secp256k1": "^1.7.1",
     "@oclif/core": "^2",
     "@oclif/plugin-help": "^2",

diff --git a/chain-client/package.json b/chain-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gala-chain/client",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "GalaChain client library",
   "license": "Apache-2.0",
   "scripts": {
@@ -21,7 +21,7 @@
     "lib"
   ],
   "dependencies": {
-    "@gala-chain/api": "1.1.5",
+    "@gala-chain/api": "1.1.6",
     "axios": "^1.6.0",
     "jsonschema": "^1.4.1",
     "tslib": "^2.6.2",

diff --git a/chain-test/package.json b/chain-test/package.json
@@ -1,18 +1,18 @@
 {
   "name": "@gala-chain/test",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Unit testing and integration testing for GalaChain",
   "license": "Apache-2.0",
   "dependencies": {
-    "@gala-chain/client": "1.1.5",
+    "@gala-chain/client": "1.1.6",
     "nanoid": "^3.3.6",
     "tslib": "^2.6.2",
     "path": "0.12.7",
     "process": "0.11.10",
     "@jest/globals": "29.7.0"
   },
   "peerDependencies": {
-    "@gala-chain/api": "1.1.5",
+    "@gala-chain/api": "1.1.6",
     "bignumber.js": "*",
     "class-transformer": "*",
     "elliptic": "*",

diff --git a/chaincode/package.json b/chaincode/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gala-chain/chaincode",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Framework for building chaincodes on GalaChain",
   "license": "Apache-2.0",
   "type": "commonjs",
@@ -21,7 +21,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@gala-chain/api": "1.1.5",
+    "@gala-chain/api": "1.1.6",
     "fabric-contract-api": "2.4.2",
     "fabric-shim": "2.4.2",
     "nanoid": "^3.3.6",

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,5 +1,8 @@
 # Getting started
 
+> ### In Person participants only:
+> **To help speed up the development process, it's recommended to follow the steps on [Hackathon Registry Cache](./registry-cache.md) before moving forward.**
+
 ---
 
 ## Local Environment (Linux, MacOS, or Windows with WSL)

diff --git a/docs/registry-cache.md b/docs/registry-cache.md
@@ -0,0 +1,63 @@
+# Using the local registry cache
+
+To save on bandwidth and to improve everyone's downloading speed and development experience we are asking everyone to update their Docker and NPM config to prioritize using a cache setup on our local network. If you have questions how a pull through cache works you can [read more here](https://docs.docker.com/docker-hub/mirror/#how-does-it-work).
+
+Below are instructions, NPM is the same on all environments but docker will be different per OS. 
+
+## NPM
+
+To use the local registry just run the below command.
+
+```sh
+    npm set registry http://172.23.0.79:4873
+
+```
+
+To remove the registry after the hackathon run this.
+
+```sh
+    npm config delete registry http://172.23.0.79:4873
+
+```
+
+## Docker
+
+### 1. Openining the config file.
+
+### Windows
+
+```
+C:\Users\<YourName>\.docker\daemon.json
+```
+
+### Mac
+
+```
+~/.docker/config.json
+```
+
+### Linux
+
+```sh
+sudo nano /etc/docker/daemon.json
+```
+
+## 2. Change to make
+
+```json
+{
+  "registry-mirrors": ["http://172.23.0.79:5000"]
+}
+```
+
+## 3. Restarting Docker
+
+### Windows/Mac
+
+End the process and close the program, then start it back up.
+
+### Linux
+
+```sh
+sudo systemctl restart docker
+```
diff --git a/licenses/licenses.csv b/licenses/licenses.csv
@@ -138,12 +138,12 @@
 "@eslint/[email protected]","@eslint/js","8.55.0","https://github.com/eslint/eslint","ESLint JavaScript language implementation","MIT"
 "@fidm/[email protected]","@fidm/asn1","1.0.4","https://github.com/fidm/asn1","ASN.1/DER, PEM for Node.js","MIT"
 "@fidm/[email protected]","@fidm/x509","1.2.1","https://github.com/fidm/x509","Pure JavaScript X509 certificate tools for Node.js","MIT"
-"@gala-chain/[email protected].5","@gala-chain/api","1.1.5","","Common types, DTOs (Data Transfer Objects), APIs, signatures, and utils for GalaChain.","Apache-2.0"
-"@gala-chain/[email protected].5","@gala-chain/chaincode","1.1.5","","Framework for building chaincodes on GalaChain","Apache-2.0"
-"@gala-chain/[email protected].5","@gala-chain/cli","1.1.5","","CLI for GalaChain to manage and deploy chaincodes","Apache-2.0"
-"@gala-chain/[email protected].5","@gala-chain/client","1.1.5","","GalaChain client library","Apache-2.0"
-"@gala-chain/[email protected].5","@gala-chain/sdk","1.1.5","","Welcome to developing with GalaChain! GalaChain SDK is a set of TS tools to help you develop on GalaChain:","UNLICENSED"
-"@gala-chain/[email protected].5","@gala-chain/test","1.1.5","","Unit testing and integration testing for GalaChain","Apache-2.0"
+"@gala-chain/[email protected].6","@gala-chain/api","1.1.6","","Common types, DTOs (Data Transfer Objects), APIs, signatures, and utils for GalaChain.","Apache-2.0"
+"@gala-chain/[email protected].6","@gala-chain/chaincode","1.1.6","","Framework for building chaincodes on GalaChain","Apache-2.0"
+"@gala-chain/[email protected].6","@gala-chain/cli","1.1.6","","CLI for GalaChain to manage and deploy chaincodes","Apache-2.0"
+"@gala-chain/[email protected].6","@gala-chain/client","1.1.6","","GalaChain client library","Apache-2.0"
+"@gala-chain/[email protected].6","@gala-chain/sdk","1.1.6","","Welcome to developing with GalaChain! GalaChain SDK is a set of TS tools to help you develop on GalaChain:","UNLICENSED"
+"@gala-chain/[email protected].6","@gala-chain/test","1.1.6","","Unit testing and integration testing for GalaChain","Apache-2.0"
 "@gar/[email protected]","@gar/promisify","1.1.3","https://github.com/wraithgar/gar-promisify","Promisify an entire class or object","MIT"
 "@grpc/[email protected]","@grpc/grpc-js","1.9.7","https://github.com/grpc/grpc-node/tree/master/packages/grpc-js","gRPC Library for Node - pure JS implementation","Apache-2.0"
 "@grpc/[email protected]","@grpc/proto-loader","0.6.13","https://github.com/grpc/grpc-node","gRPC utility library for loading .proto files","Apache-2.0"

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gala-chain/sdk",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "license": "Apache-2.0",
   "scripts": {
     "lint": "nx run-many -t lint",