fix(plugin-ledger-connector-iroha): running dockerfile locally

Primary Changes --------------- 1. Updated iroha package.json to include a missing dependency 2. Updated Dockerfile to include new api-server image and used yarn to install the iroha package 3. Updated README.md to include the newly changes to both the api-server as well as iroha connector plugin 4. Updated cmd-api-server README.md to include similar changes Fixes #1874 Signed-off-by: jagpreetsinghsasan <[email protected]>
hyperledger-cacti · Nov 20, 2022 · f5faaab · f5faaab
1 parent 148fe80
commit f5faaab
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 6 deletions.
diff --git a/packages/cactus-cmd-api-server/README.md b/packages/cactus-cmd-api-server/README.md
@@ -241,6 +241,9 @@ Once you've built the container, the following commands should work:
     --rm \
     --publish 3000:3000 \
     --publish 4000:4000 \
+    --env AUTHORIZATION_PROTOCOL='NONE' \
+    --env AUTHORIZATION_CONFIG_JSON='{}' \
+    --env GRPC_TLS_ENABLED=false \
     cas
   ```
 
@@ -251,6 +254,9 @@ Once you've built the container, the following commands should work:
     --rm \
     --publish 3000:3000 \
     --publish 4000:4000 \
+    --env AUTHORIZATION_PROTOCOL='NONE' \
+    --env AUTHORIZATION_CONFIG_JSON='{}' \
+    --env GRPC_TLS_ENABLED=false \
     cas \
       ./node_modules/.bin/cactusapi \
       --plugins='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-fabric", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": { "connectionProfile": {}, "instanceId": "some-unique-instance-id"}}]'
@@ -262,6 +268,9 @@ Once you've built the container, the following commands should work:
     --rm \
     --publish 3000:3000 \
     --publish 4000:4000 \
+    --env AUTHORIZATION_PROTOCOL='NONE' \
+    --env AUTHORIZATION_CONFIG_JSON='{}' \
+    --env GRPC_TLS_ENABLED=false \
     --env PLUGINS='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-besu", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"rpcApiHttpHost": "http://localhost:8545", "instanceId": "some-unique-besu-connector-instance-id"}}]' \
     cas
   ```
@@ -272,6 +281,9 @@ Once you've built the container, the following commands should work:
     --rm \
     --publish 3000:3000 \
     --publish 4000:4000 \
+    --env AUTHORIZATION_PROTOCOL='NONE' \
+    --env AUTHORIZATION_CONFIG_JSON='{}' \
+    --env GRPC_TLS_ENABLED=false \
     cas \
       ./node_modules/.bin/cactusapi \
       --plugins='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-besu", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"rpcApiHttpHost": "http://localhost:8545", "instanceId": "some-unique-besu-connector-instance-id"}}]'
@@ -286,6 +298,9 @@ Once you've built the container, the following commands should work:
     --rm \
     --publish 3000:3000 \
     --publish 4000:4000 \
+    --env AUTHORIZATION_PROTOCOL='NONE' \
+    --env AUTHORIZATION_CONFIG_JSON='{}' \
+    --env GRPC_TLS_ENABLED=false \
     --mount type=bind,source="$(pwd)"/cactus.json,target=/cactus.json \
     cas \
       ./node_modules/.bin/cactusapi \
@@ -308,6 +323,9 @@ Don't have a Besu network on hand to test with? Test or develop against our Besu
       --rm \
       --publish 3000:3000 \
       --publish 4000:4000 \
+      --env AUTHORIZATION_PROTOCOL='NONE' \
+      --env AUTHORIZATION_CONFIG_JSON='{}' \
+      --env GRPC_TLS_ENABLED=false \
       --env PLUGINS='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-besu", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"rpcApiHttpHost": "http://localhost:8545", "instanceId": "some-unique-besu-connector-instance-id"}}]' \
       cas
     ```

diff --git a/packages/cactus-plugin-ledger-connector-iroha/Dockerfile b/packages/cactus-plugin-ledger-connector-iroha/Dockerfile
@@ -1,5 +1,7 @@
-FROM ghcr.io/hyperledger/cactus-cmd-api-server:2021-08-15--refactor-1222
+FROM ghcr.io/hyperledger/cactus-cmd-api-server:2022-11-14-6ff6aac
+RUN npm install -g [email protected]
 
+ENV NODE_ENV=production
 ARG NPM_PKG_VERSION=latest
 
-RUN npm i @hyperledger/cactus-plugin-ledger-connector-iroha@${NPM_PKG_VERSION} --production
+RUN yarn add @hyperledger/cactus-plugin-ledger-connector-iroha@${NPM_PKG_VERSION} --production --ignore-engines
diff --git a/packages/cactus-plugin-ledger-connector-iroha/README.md b/packages/cactus-plugin-ledger-connector-iroha/README.md
@@ -126,7 +126,10 @@ docker run \
   --publish 3000:3000 \
   --publish 4000:4000 \
   --publish 5000:5000 \
-  --env PLUGINS='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-iroha", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"rpcApiHttpHost": "http://localhost:8545", "instanceId": "some-unique-iroha-connector-instance-id"}}]' \
+  --env AUTHORIZATION_PROTOCOL='NONE' \
+  --env AUTHORIZATION_CONFIG_JSON='{}' \
+  --env GRPC_TLS_ENABLED=false \
+  --env PLUGINS='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-iroha", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"rpcApiHttpHost": "http://localhost:8545", "rpcToriiPortHost": "http://localhost:8545", "instanceId": "some-unique-iroha-connector-instance-id"}}]' \
   cplcb
 ```
 
@@ -137,21 +140,27 @@ docker run \
   --publish 3000:3000 \
   --publish 4000:4000 \
   --publish 5000:5000 \
+  --env AUTHORIZATION_PROTOCOL='NONE' \
+  --env AUTHORIZATION_CONFIG_JSON='{}' \
+  --env GRPC_TLS_ENABLED=false \
   cplcb \
     ./node_modules/.bin/cactusapi \
-    --plugins='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-iroha", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"rpcApiHttpHost": "http://localhost:8545", "instanceId": "some-unique-iroha-connector-instance-id"}}]'
+    --plugins='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-iroha", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"rpcApiHttpHost": "http://localhost:8545", "rpcToriiPortHost": "http://localhost:8545", "instanceId": "some-unique-iroha-connector-instance-id"}}]'
 ```
 
 Launch container with **configuration file** mounted from host machine:
 ```sh
 
-echo '[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-iroha", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL", "options": {"rpcApiHttpHost": "http://localhost:8545", "instanceId": "some-unique-iroha-connector-instance-id"}}]' > cactus.json
+echo '[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-iroha", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL", "options": {"rpcApiHttpHost": "http://localhost:8545", "rpcToriiPortHost": "http://localhost:8545", "instanceId": "some-unique-iroha-connector-instance-id"}}]' > cactus.json
 
 docker run \
   --rm \
   --publish 3000:3000 \
   --publish 4000:4000 \
   --publish 5000:5000 \
+  --env AUTHORIZATION_PROTOCOL='NONE' \
+  --env AUTHORIZATION_CONFIG_JSON='{}' \
+  --env GRPC_TLS_ENABLED=false \
   --mount type=bind,source="$(pwd)"/cactus.json,target=/cactus.json \
   cplcb \
     ./node_modules/.bin/cactusapi \
@@ -175,7 +184,10 @@ docker run \
   --publish 3000:3000 \
   --publish 4000:4000 \
   --publish 5000:5000 \
-  --env PLUGINS='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-iroha", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL", "options": {"rpcApiHttpHost": "http://localhost:8545", "instanceId": "some-unique-iroha-connector-instance-id"}}]' \
+  --env AUTHORIZATION_PROTOCOL='NONE' \
+  --env AUTHORIZATION_CONFIG_JSON='{}' \
+  --env GRPC_TLS_ENABLED=false \
+  --env PLUGINS='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-iroha", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL", "options": {"rpcApiHttpHost": "http://localhost:8545", "rpcToriiPortHost": "http://localhost:8545", "instanceId": "some-unique-iroha-connector-instance-id"}}]' \
   cplcb
 ```
 

diff --git a/packages/cactus-plugin-ledger-connector-iroha/package.json b/packages/cactus-plugin-ledger-connector-iroha/package.json
@@ -63,6 +63,7 @@
     "fast-safe-stringify": "2.1.1",
     "grpc": "1.24.11",
     "iroha-helpers": "1.5.0",
+    "run-time-error": "1.4.0",
     "openapi-types": "7.0.1",
     "prom-client": "13.1.0",
     "sanitize-html": "2.7.0",