fix: sodium-native (#432)

Author: Noel

packages/zilliqa-js-crypto/package.json

@@ -26,7 +26,6 @@
   },
   "dependencies": {
     "@types/uuid": "8.3.1",
-    "@types/sodium-native": "2.3.5",
     "@types/elliptic": "^6.4.13",
     "@zilliqa-js/util": "^3.3.2",
     "aes-js": "^3.1.1",

packages/zilliqa-js-crypto/src/random.ts

@@ -15,8 +15,6 @@
 //  You should have received a copy of the GNU General Public License
 //  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-import sodium from 'sodium-native';
-
 /**
  * randomBytes
  *
@@ -69,6 +67,15 @@ export const randomBytes = (bytes: number) => {
     // References:
     // - https://paragonie.com/blog/2016/05/how-generate-secure-random-numbers-in-various-programming-languages#nodejs-csprng
     // - https://github.com/nodejs/node/issues/5798
+    //
+    // This logic should run only in node env. Otherwise, it will throw an error 'require is not defined'.
+    //
+    // Consider using createRequire when typescipt 4.5 is available.
+    // https://devblogs.microsoft.com/typescript/announcing-typescript-4-5-beta
+    // https://nodejs.org/api/module.html#modulecreaterequirefilename
+    //
+    // eslint-disable-next-line
+    const sodium = require('sodium-native');
     sodium.randombytes_buf(b);
   } else {
     throw new Error('No secure random number generator available');

packages/zilliqa-js-crypto/test/random.node.spec.ts

@@ -21,18 +21,6 @@
 
 import { randomBytes } from '../src/random';
 
-const mockFn = jest.fn();
-
-jest.mock('sodium-native');
-
-// eslint-disable-next-line
-const sodium = require('sodium-native');
-
-sodium.randombytes_buf.mockImplementation(() => {
-  mockFn();
-  return global.Buffer.allocUnsafe(16).fill(0);
-});
-
 beforeEach(() => {
   jest.resetModules();
 });
@@ -47,6 +35,11 @@ describe('random', () => {
       },
     });
 
+    const mockFn = jest.fn();
+    jest.doMock('sodium-native', () => {
+      return { randombytes_buf: mockFn };
+    });
+
     const want = '00000000000000000000000000000000';
     const result = randomBytes(16);
     expect(result).toEqual(want);

yarn.lock

@@ -1840,13 +1840,6 @@
   resolved "https://registry.npmjs.org/@types/prettier/-/prettier-2.3.2.tgz#fc8c2825e4ed2142473b4a81064e6e081463d1b3"
   integrity sha512-eI5Yrz3Qv4KPUa/nSIAi0h+qX0XyewOliug5F2QAtuRg6Kjg6jfmxe1GIwoIRhZspD1A0RP8ANrPwvEXXtRFog==
 
-"@types/[email protected]":
-  version "2.3.5"
-  resolved "https://registry.npmjs.org/@types/sodium-native/-/sodium-native-2.3.5.tgz#5d2681e7b6b67bcbdc63cfb133e303ec9e942e43"
-  integrity sha512-a3DAIpW8+36XAY8aIR36JBQQsfOabxHuJwx11DL/PTvnbwEWPAXW66b8QbMi0r2vUnkOfREsketxdvjBmQxqDQ==
-  dependencies:
-    "@types/node" "*"
-
 "@types/source-list-map@*":
   version "0.1.2"
   resolved "https://registry.npmjs.org/@types/source-list-map/-/source-list-map-0.1.2.tgz#0078836063ffaf17412349bba364087e0ac02ec9"