feat(polkadot): update new changes

packages/cactus-plugin-ledger-connector-polkadot/Dockerfile

@@ -1,7 +1,10 @@
 FROM ghcr.io/hyperledger/cactus-cmd-api-server:2024-01-02-1fb2551
-RUN npm install -g [email protected]
+
+RUN npm install -g yarn \
+    && yarn set version 3.6.3 \
+    && yarn config set nodeLinker node-modules
 
 ENV NODE_ENV=production
 ARG NPM_PKG_VERSION=latest
 
-RUN yarn add @hyperledger/cactus-plugin-ledger-connector-polkadot@${NPM_PKG_VERSION} --production --ignore-engines
+RUN yarn add @hyperledger/cactus-plugin-ledger-connector-polkadot@${NPM_PKG_VERSION}

packages/cactus-plugin-ledger-connector-polkadot/README.md

@@ -134,19 +134,48 @@ DOCKER_BUILDKIT=1 docker build -f ./packages/cactus-plugin-ledger-connector-polk
 
 Build with a specific version of the npm package:
 ```sh
-DOCKER_BUILDKIT=1 docker build --build-arg NPM_PKG_VERSION=0.4.1 -f ./packages/cactus-plugin-ledger-connector-polkadot/Dockerfile . -t cplcb
+DOCKER_BUILDKIT=1 docker build --build-arg NPM_PKG_VERSION=2.0.0-lfx-connector.163 -f ./packages/cactus-plugin-ledger-connector-polkadot/Dockerfile . -t cplcb
 ```
 
 ### 3.2. Running the container
 
-Launch container:
+Launch container with plugin configuration as an **environment variable**:
+
 ```sh
 docker run \
   --rm \
-  --publish 9944:9944 \
+  --publish 3000:3000 \
+  --publish 4000:4000 \
+  --env PLUGINS='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-polkadot", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"wsProviderUrl":"ws://127.0.0.1:9944", "instanceId": "some-unique-polkadot-connector-instance-id"}}]' \
   cplcb
 ```
 
+Launch container with plugin configuration as a **CLI argument**:
+```sh
+docker run \
+  --rm \
+  --publish 3000:3000 \
+   --publish 4000:4000 \
+  cplcb \
+    ./node_modules/.bin/cactusapi \
+    --plugins='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-polkadot", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"wsProviderUrl":"ws://127.0.0.1:9944", "instanceId": "some-unique-polkadot-connector-instance-id"}}]'
+```
+
+Launch container with **configuration file** mounted from host machine:
+```sh
+
+echo '[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-polkadot", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": {"wsProviderUrl":"ws://127.0.0.1:9944", "instanceId": "some-unique-polkadot-connector-instance-id"}}]' > cactus.json
+
+docker run \
+  --rm \
+  --publish 3000:3000 \
+  --publish 4000:4000 \
+  --mount type=bind,source="$(pwd)"/cactus.json,target=/cactus.json \
+  cplcb \
+    ./node_modules/.bin/cactusapi \
+    --config-file=/cactus.json
+```
+
 ## 4. Prometheus Exporter
 
 This class creates a Prometheus exporter, which scraps the transactions (total transaction count) for the use cases incorporating the use of Fabric connector plugin.

packages/cactus-plugin-ledger-connector-polkadot/src/main/typescript/plugin-factory-ledger-connector-polkadot.ts

@@ -8,7 +8,7 @@ import {
   PluginLedgerConnectorPolkadot,
 } from "./plugin-ledger-connector-polkadot";
 
-export class PluginFactoryLedgerConnectorPolkadot extends PluginFactory<
+export class PluginFactoryLedgerConnector extends PluginFactory<
   PluginLedgerConnectorPolkadot,
   IPluginLedgerConnectorPolkadotOptions,
   IPluginFactoryOptions

packages/cactus-plugin-ledger-connector-polkadot/src/main/typescript/plugin-ledger-connector-polkadot.ts

@@ -167,15 +167,6 @@ export class PluginLedgerConnectorPolkadot
     }
   }
 
-  public async createAPI(): Promise<void> {
-    try {
-      this.api = await ApiPromise.create({ provider: this.wsProvider });
-    } catch (err) {
-      const errorMessage = `Could not create API. InnerException: + ${err}`;
-      throw createHttpError[500](errorMessage);
-    }
-  }
-
   public async getOrCreateWebServices(): Promise<IWebServiceEndpoint[]> {
     if (Array.isArray(this.endpoints)) {
       return this.endpoints;
@@ -282,8 +273,13 @@ export class PluginLedgerConnectorPolkadot
     return Optional.empty();
   }
 
-  public async onPluginInit(): Promise<unknown> {
-    return;
+  public async onPluginInit(): Promise<void> {
+    try {
+      this.api = await ApiPromise.create({ provider: this.wsProvider });
+    } catch (err) {
+      const errorMessage = `Could not create API. InnerException: + ${err}`;
+      throw createHttpError[500](errorMessage);
+    }
   }
 
   public async getConsensusAlgorithmFamily(): Promise<ConsensusAlgorithmFamily> {
@@ -326,9 +322,9 @@ export class PluginLedgerConnectorPolkadot
       };
       return response;
     } catch (err) {
-      const errorMessage = 
+      const errorMessage =
         `${fnTag} Obtaining raw transaction has failed. ` +
-          `InnerException: ${err}`;
+        `InnerException: ${err}`;
       throw createHttpError[500](errorMessage);
     }
   }
@@ -358,9 +354,9 @@ export class PluginLedgerConnectorPolkadot
       };
       return response;
     } catch (err) {
-      const errorMessage = 
+      const errorMessage =
         `${fnTag} signing raw transaction has failed. ` +
-          `InnerException: ${err}`;
+        `InnerException: ${err}`;
       throw createHttpError[500](errorMessage);
     }
   }
@@ -383,17 +379,17 @@ export class PluginLedgerConnectorPolkadot
         } else {
           const errorMessage =
             `${fnTag} Expected pre-signed raw transaction ` +
-              ` since signing credential is specified as` +
-              `Web3SigningCredentialType.NONE`;
+            ` since signing credential is specified as` +
+            `Web3SigningCredentialType.NONE`;
           throw createHttpError[400](errorMessage);
         }
       }
       default: {
         const errorMessage =
-        `${fnTag} Unrecognized Web3SigningCredentialType: ` +
-        `Supported ones are: ` +
-        `${Object.values(Web3SigningCredentialType).join(";")}`;
-      throw createHttpError[400](errorMessage);
+          `${fnTag} Unrecognized Web3SigningCredentialType: ` +
+          `Supported ones are: ` +
+          `${Object.values(Web3SigningCredentialType).join(";")}`;
+        throw createHttpError[400](errorMessage);
       }
     }
   }
@@ -435,7 +431,7 @@ export class PluginLedgerConnectorPolkadot
     const { transactionConfig, web3SigningCredential } = req;
     const { mnemonic } =
       web3SigningCredential as Web3SigningCredentialMnemonicString;
-    if(!mnemonic){
+    if (!mnemonic) {
       throw createHttpError[400](
         `cannot perform transaction without mnemonic string`,
       );
@@ -520,9 +516,7 @@ export class PluginLedgerConnectorPolkadot
     const deserializedTransaction = this.api.tx(signedTx);
     const signature = deserializedTransaction.signature.toHex();
     if (!signature) {
-      throw createHttpError[400](
-        `${fnTag} Transaction is not signed.`,
-      );
+      throw createHttpError[400](`${fnTag} Transaction is not signed.`);
     }
 
     if (!isHex(signature)) {

packages/cactus-plugin-ledger-connector-polkadot/src/main/typescript/public-api.ts

@@ -4,13 +4,13 @@ export {
   PluginLedgerConnectorPolkadot,
   IPluginLedgerConnectorPolkadotOptions,
 } from "./plugin-ledger-connector-polkadot";
-export { PluginFactoryLedgerConnectorPolkadot } from "./plugin-factory-ledger-connector-polkadot";
+export { PluginFactoryLedgerConnector } from "./plugin-factory-ledger-connector-polkadot";
 
 import { IPluginFactoryOptions } from "@hyperledger/cactus-core-api";
-import { PluginFactoryLedgerConnectorPolkadot } from "./plugin-factory-ledger-connector-polkadot";
+import { PluginFactoryLedgerConnector } from "./plugin-factory-ledger-connector-polkadot";
 
 export async function createPluginFactory(
   pluginFactoryOptions: IPluginFactoryOptions,
-): Promise<PluginFactoryLedgerConnectorPolkadot> {
-  return new PluginFactoryLedgerConnectorPolkadot(pluginFactoryOptions);
+): Promise<PluginFactoryLedgerConnector> {
+  return new PluginFactoryLedgerConnector(pluginFactoryOptions);
 }

packages/cactus-plugin-ledger-connector-polkadot/src/test/typescript/integration/deploy-ink-contract.test.ts

@@ -15,11 +15,12 @@ import {
   IPluginLedgerConnectorPolkadotOptions,
   DefaultApi as PolkadotApi,
   Web3SigningCredentialType,
+  PluginFactoryLedgerConnector,
 } from "../../../main/typescript/public-api";
 import { PluginKeychainMemory } from "@hyperledger/cactus-plugin-keychain-memory";
 import { PluginRegistry } from "@hyperledger/cactus-core";
 import { AddressInfo } from "net";
-import { Configuration } from "@hyperledger/cactus-core-api";
+import { Configuration, PluginImportType } from "@hyperledger/cactus-core-api";
 import "jest-extended";
 
 const testCase = "deploy contract through all available methods";
@@ -83,8 +84,12 @@ describe(testCase, () => {
       wsProviderUrl: DEFAULT_WSPROVIDER,
       instanceId: instanceId,
     };
-    plugin = new PluginLedgerConnectorPolkadot(connectorOptions);
-    await plugin.createAPI();
+    const factory = new PluginFactoryLedgerConnector({
+      pluginImportType: PluginImportType.Local,
+    });
+
+    plugin = await factory.create(connectorOptions);
+    await plugin.onPluginInit();
 
     const listenOptions: IListenOptions = {
       hostname: "127.0.0.1",

packages/cactus-plugin-ledger-connector-polkadot/src/test/typescript/integration/invoke-ink-contract.test.ts

@@ -16,11 +16,12 @@ import {
   DefaultApi as PolkadotApi,
   Web3SigningCredentialType,
   PolkadotContractInvocationType,
+  PluginFactoryLedgerConnector,
 } from "../../../main/typescript/public-api";
 import { PluginKeychainMemory } from "@hyperledger/cactus-plugin-keychain-memory";
 import { PluginRegistry } from "@hyperledger/cactus-core";
 import { AddressInfo } from "net";
-import { Configuration } from "@hyperledger/cactus-core-api";
+import { Configuration, PluginImportType } from "@hyperledger/cactus-core-api";
 import "jest-extended";
 
 const testCase = "invoke contract with all invocation types";
@@ -90,8 +91,13 @@ describe(testCase, () => {
       wsProviderUrl: DEFAULT_WSPROVIDER,
       instanceId: instanceId,
     };
-    plugin = new PluginLedgerConnectorPolkadot(connectorOptions);
-    await plugin.createAPI();
+
+    const factory = new PluginFactoryLedgerConnector({
+      pluginImportType: PluginImportType.Local,
+    });
+
+    plugin = await factory.create(connectorOptions);
+    await plugin.onPluginInit();
 
     const listenOptions: IListenOptions = {
       hostname: "127.0.0.1",

packages/cactus-plugin-ledger-connector-polkadot/src/test/typescript/integration/run-transaction.test.ts

@@ -13,11 +13,12 @@ import {
   IPluginLedgerConnectorPolkadotOptions,
   DefaultApi as PolkadotApi,
   Web3SigningCredentialType,
+  PluginFactoryLedgerConnector,
 } from "../../../main/typescript/public-api";
 import { PluginKeychainMemory } from "@hyperledger/cactus-plugin-keychain-memory";
 import { PluginRegistry } from "@hyperledger/cactus-core";
 import { AddressInfo } from "net";
-import { Configuration } from "@hyperledger/cactus-core-api";
+import { Configuration, PluginImportType } from "@hyperledger/cactus-core-api";
 import { Keyring } from "@polkadot/api";
 import { K_CACTUS_POLKADOT_TOTAL_TX_COUNT } from "../../../main/typescript/prometheus-exporter/metrics";
 import "jest-extended";
@@ -82,8 +83,13 @@ describe(testCase, () => {
       wsProviderUrl: DEFAULT_WSPROVIDER,
       instanceId: instanceId,
     };
-    plugin = new PluginLedgerConnectorPolkadot(connectorOptions);
-    await plugin.createAPI();
+
+    const factory = new PluginFactoryLedgerConnector({
+      pluginImportType: PluginImportType.Local,
+    });
+
+    plugin = await factory.create(connectorOptions);
+    await plugin.onPluginInit();
 
     const listenOptions: IListenOptions = {
       hostname: "127.0.0.1",

packages/cactus-plugin-ledger-connector-polkadot/src/test/typescript/unit/constructor-instantiation.test.ts

@@ -5,9 +5,11 @@ import { pruneDockerAllIfGithubAction } from "@hyperledger/cactus-test-tooling";
 import {
   PluginLedgerConnectorPolkadot,
   IPluginLedgerConnectorPolkadotOptions,
+  PluginFactoryLedgerConnector,
 } from "../../../main/typescript";
 import { PluginRegistry } from "@hyperledger/cactus-core";
 import "jest-extended";
+import { PluginImportType } from "@hyperledger/cactus-core-api";
 
 const testCase = "Instantiate plugin";
 const logLevel: LogLevelDesc = "TRACE";
@@ -18,6 +20,7 @@ const prometheus: PrometheusExporter = new PrometheusExporter({
 });
 
 describe(testCase, () => {
+  let plugin: PluginLedgerConnectorPolkadot;
   const connectorOptions: IPluginLedgerConnectorPolkadotOptions = {
     logLevel: logLevel,
     prometheusExporter: prometheus,
@@ -31,7 +34,10 @@ describe(testCase, () => {
     emitContainerLogs: true,
   };
   const ledger = new SubstrateTestLedger(ledgerOptions);
-  const plugin = new PluginLedgerConnectorPolkadot(connectorOptions);
+  const factory = new PluginFactoryLedgerConnector({
+    pluginImportType: PluginImportType.Local,
+  });
+
   beforeAll(async () => {
     const pruning = pruneDockerAllIfGithubAction({ logLevel });
     await expect(pruning).toResolve();
@@ -44,7 +50,8 @@ describe(testCase, () => {
   test(testCase, async () => {
     await ledger.start();
     expect(ledger).toBeTruthy();
-    await plugin.createAPI();
+    plugin = await factory.create(connectorOptions);
+    await plugin.onPluginInit();
     await plugin.getOrCreateWebServices();
-  })
-})
+  });
+});