add improvements for privacy enhancement support (#38)

* add improvements for privacy enhancement support and update an example * fix linting * fix besu version for fixing INT tests * update besu version for fixing INT tests * add an example for GoQuorum multi-tenant * add an example for GoQuorum multi-tenant Co-authored-by: Antony Denyer <[email protected]>
Consensys · Jan 13, 2022 · d965a12 · d965a12
1 parent 0ed71ef
commit d965a12
Show file tree

Hide file tree

Showing 7 changed files with 209 additions and 31 deletions.
diff --git a/7nodes-test/deployContractViaHttp-pe.js b/7nodes-test/deployContractViaHttp-pe.js
@@ -89,9 +89,13 @@ const bytecodeWithInitParam = simpleContract
       from: signAcct,
       isPrivate: true,
       privateFrom: "BULeR8JyUWhiuuCMU/HLA0Q5pzkYT+cHII3ZKBey3Bo=",
-      privateFor: ["QfeDAys9MPDs2XHExtc84jKGHxZg/aj52DTh0vtA3Xc="],
+      privateFor: [
+        "QfeDAys9MPDs2XHExtc84jKGHxZg/aj52DTh0vtA3Xc=",
+        "BULeR8JyUWhiuuCMU/HLA0Q5pzkYT+cHII3ZKBey3Bo=",
+      ],
       nonce: txCount,
-      privacyFlag: 1,
+      privacyFlag: 2,
+      mandatoryFor: ["QfeDAys9MPDs2XHExtc84jKGHxZg/aj52DTh0vtA3Xc="],
     });
 
     console.log("Contract address: ", tx.contractAddress);

diff --git a/7nodes-test/multi-tenant.js b/7nodes-test/multi-tenant.js
@@ -0,0 +1,83 @@
+const Web3 = require("web3");
+const https = require("https");
+const axios = require("axios");
+const FormData = require("form-data");
+const Web3HttpProvider = require("web3-providers-http");
+
+const Web3Quorum = require("../src");
+
+const PSI = "PS1"; // To change based on the private state identifier
+const url = `https://localhost:22000?PSI=${PSI}`;
+const oauthURL = "https://localhost:4445/clients";
+
+const getAccessToken = async () => {
+  try {
+    const instance = axios.create({
+      httpsAgent: new https.Agent({
+        rejectUnauthorized: false,
+      }),
+    });
+    await instance.delete(`${oauthURL}/${PSI}`);
+    const args = {
+      client_id: PSI,
+      client_secret: "foofoo",
+      scope: `rpc://eth_* rpc://quorumExtension_* rpc://rpc_modules psi://${PSI}?self.eoa=0x0&node.eoa=0x0`,
+    };
+    await instance.post(oauthURL, {
+      grant_types: ["client_credentials"],
+      token_endpoint_auth_method: "client_secret_post",
+      audience: ["Node1"],
+      ...args,
+    });
+
+    const body = new FormData();
+    body.append("grant_type", "client_credentials");
+    body.append("audience", "Node1");
+    Object.keys(args).forEach((key) => {
+      body.append(key, args[key]);
+    });
+
+    const { data } = await instance.post(
+      `https://localhost:4444/oauth2/token`,
+      body,
+      {
+        headers: {
+          ...body.getHeaders(),
+        },
+      }
+    );
+    return data.access_token;
+  } catch (e) {
+    console.error(e.response.data);
+  }
+  return null;
+};
+(async () => {
+  try {
+    const accessToken = await getAccessToken();
+    const options = {
+      keepAlive: true,
+      headers: [{ name: "Authorization", value: `bearer ${accessToken}` }],
+      agent: {
+        https: https.Agent({
+          rejectUnauthorized: false,
+        }),
+        baseUrl: url,
+      },
+    };
+
+    const provider = new Web3HttpProvider(url, options);
+    const web3 = new Web3Quorum(
+      new Web3(provider),
+      {
+        privateUrl: "http://localhost:9081",
+      },
+      true
+    );
+    // Example of calling PSI specific API
+    const psi = await web3.eth.getPSI();
+    console.log(`You are connected to ${psi}`);
+  } catch (e) {
+    console.error(e);
+  }
+})();
diff --git a/docker/.env b/docker/.env
@@ -1,5 +1,5 @@
 
-BESU_VERSION=latest
+BESU_VERSION=21.10.6
 QUORUM_TESSERA_VERSION=latest
 QUORUM_ETHSIGNER_VERSION=latest
 QUICKSTART_VERSION=$BESU_VERSION

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -104,6 +104,7 @@
     "eslint-plugin-jest": "^24.3.5",
     "eslint-plugin-prettier": "^3.3.1",
     "eslint-plugin-promise": "^4.3.1",
+    "form-data": "^4.0.0",
     "husky": "^6.0.0",
     "jest": "^26.6.3",
     "jsdoc": "^3.6.7",
@@ -113,7 +114,8 @@
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
     "wait-for-expect": "^3.0.2",
-    "web3": "^1.5.2"
+    "web3": "^1.5.2",
+    "web3-providers-http": "^1.6.1"
   },
   "peerDependencies": {
     "web3": "^1.x"

diff --git a/src/eth.js b/src/eth.js
@@ -127,6 +127,15 @@ function Eth(web3) {
         call: "eth_getPrivateTransactionReceipt",
         params: 1,
       },
+      /**
+       * @function getPSI
+       * @return {String} the private state identifier (PSI)
+       */
+      {
+        name: "getPSI",
+        call: "eth_getPSI",
+        params: 0,
+      },
     ],
   });
 

diff --git a/src/priv.js b/src/priv.js
@@ -299,17 +299,7 @@ function Priv(web3) {
     return `0x${serializedTx.toString("hex")}`;
   };
 
-  const sendRawRequest = async (
-    payload,
-    privateFor,
-    privacyFlag = undefined
-  ) => {
-    const privacyParams = {
-      privateFor,
-    };
-    if (typeof privacyFlag !== "undefined") {
-      privacyParams.privacyFlag = privacyFlag;
-    }
+  const sendRawRequest = async (payload, privacyParams) => {
     const txHash = await web3.eth.sendRawPrivateTransaction(
       payload,
       privacyParams
@@ -326,11 +316,11 @@ function Priv(web3) {
       );
 
       const privateTx = web3.utils.setPrivate(serializedTx);
-      return sendRawRequest(
-        `0x${privateTx.toString("hex")}`,
-        options.privateFor,
-        options.privacyFlag
-      );
+      return sendRawRequest(`0x${privateTx.toString("hex")}`, {
+        privateFor: options.privateFor,
+        privacyFlag: options.privacyFlag,
+        mandatoryFor: options.mandatoryFor,
+      });
     }
     if (options.privacyGroupId && options.privateFor) {
       throw Error("privacyGroupId and privateFor are mutually exclusive");