fix(auth): using private key in browser to login.

energywebfoundation · Oct 4, 2021 · cdb3d20 · cdb3d20
1 parent 30c74f4
commit cdb3d20
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 17 deletions.
diff --git a/docs/api/classes/GnosisIam.GnosisIam-1.md b/docs/api/classes/GnosisIam.GnosisIam-1.md
@@ -1041,13 +1041,13 @@ ___
 
 ### getProviderType
 
-▸ **getProviderType**(): `undefined` \| [`WalletProvider`](../enums/types_WalletProvider.WalletProvider.md)
+▸ **getProviderType**(): [`WalletProvider`](../enums/types_WalletProvider.WalletProvider.md)
 
 Get the current initialized provider type
 
 #### Returns
 
-`undefined` \| [`WalletProvider`](../enums/types_WalletProvider.WalletProvider.md)
+[`WalletProvider`](../enums/types_WalletProvider.WalletProvider.md)
 
 provider type if the session is active if not undefined
 

diff --git a/docs/api/classes/iam.IAM.md b/docs/api/classes/iam.IAM.md
@@ -893,13 +893,13 @@ ___
 
 ### getProviderType
 
-▸ **getProviderType**(): `undefined` \| [`WalletProvider`](../enums/types_WalletProvider.WalletProvider.md)
+▸ **getProviderType**(): [`WalletProvider`](../enums/types_WalletProvider.WalletProvider.md)
 
 Get the current initialized provider type
 
 #### Returns
 
-`undefined` \| [`WalletProvider`](../enums/types_WalletProvider.WalletProvider.md)
+[`WalletProvider`](../enums/types_WalletProvider.WalletProvider.md)
 
 provider type if the session is active if not undefined
 

diff --git a/docs/api/enums/types_WalletProvider.WalletProvider.md b/docs/api/enums/types_WalletProvider.WalletProvider.md
@@ -8,6 +8,7 @@
 
 - [EwKeyManager](types_WalletProvider.WalletProvider.md#ewkeymanager)
 - [MetaMask](types_WalletProvider.WalletProvider.md#metamask)
+- [PrivateKey](types_WalletProvider.WalletProvider.md#privatekey)
 - [WalletConnect](types_WalletProvider.WalletProvider.md#walletconnect)
 
 ## Enumeration members
@@ -24,6 +25,12 @@ ___
 
 ___
 
+### PrivateKey
+
+• **PrivateKey** = `"PrivateKey"`
+
+___
+
 ### WalletConnect
 
 • **WalletConnect** = `"WalletConnect"`
diff --git a/src/iam/iam-base.ts b/src/iam/iam-base.ts
@@ -82,7 +82,7 @@ export class IAMBase {
     protected _didSigner: EwSigner | undefined;
     protected _identityToken: string | undefined;
     protected _transactionOverrides: utils.Deferrable<providers.TransactionRequest> = {};
-    protected _providerType: WalletProvider | undefined;
+    protected _providerType: WalletProvider;
     protected _publicKey: string | undefined | null;
 
     protected _registrySetting: RegistrySettings;
@@ -144,6 +144,10 @@ export class IAMBase {
             this._publicKey = localStorage.getItem(PUBLIC_KEY);
         }
 
+        if (this._executionEnvironment === ExecutionEnvironment.NODE) {
+            this._providerType = WalletProvider.PrivateKey;
+        }
+
         this._walletConnectService = new WalletConnectService(bridgeUrl, infuraId, ewKeyManagerUrl);
     }
 
@@ -180,15 +184,10 @@ export class IAMBase {
         walletProvider?: WalletProvider;
     }): Promise<AccountInfo | undefined> {
         const { privateKey, rpcUrl } = this._connectionOptions;
-        if (this._executionEnvironment === ExecutionEnvironment.NODE) {
-            if (!privateKey) {
-                throw new Error(ERROR_MESSAGES.PRIVATE_KEY_NOT_PROVIDED);
-            }
-            if (!rpcUrl) {
-                throw new Error(ERROR_MESSAGES.RPC_URL_NOT_PROVIDED);
-            }
-            this._provider = new JsonRpcProvider({ url: rpcUrl });
-            this._signer = new Wallet(privateKey, this._provider);
+
+        if (walletProvider === WalletProvider.PrivateKey) {
+            this.initWithPrivateKey(privateKey, rpcUrl);
+            this._providerType = walletProvider;
             return;
         }
 
@@ -248,6 +247,17 @@ export class IAMBase {
         throw new Error(ERROR_MESSAGES.WALLET_TYPE_NOT_PROVIDED);
     }
 
+    private initWithPrivateKey(privateKey, rpcUrl) {
+        if (!privateKey) {
+            throw new Error(ERROR_MESSAGES.PRIVATE_KEY_NOT_PROVIDED);
+        }
+        if (!rpcUrl) {
+            throw new Error(ERROR_MESSAGES.RPC_URL_NOT_PROVIDED);
+        }
+        this._provider = new JsonRpcProvider({ url: rpcUrl });
+        this._signer = new Wallet(privateKey, this._provider);
+    }
+
     /**
      * @description Establishes connection to the cache serverand sets public key and identity token
      */
@@ -320,7 +330,14 @@ export class IAMBase {
      * @requires to be called after the connection to wallet was initialized
      */
     on(event: "accountChanged" | "networkChanged" | "disconnected", eventHandler: () => void) {
-        if (!this._providerType) return;
+        const providersThatHandleEvents = [
+            WalletProvider.WalletConnect,
+            WalletProvider.EwKeyManager,
+            WalletProvider.MetaMask,
+        ];
+        if (!providersThatHandleEvents.includes(this._providerType)) {
+            return;
+        }
         const isMetamask = this._providerType === WalletProvider.MetaMask;
         switch (event) {
             case "accountChanged": {

diff --git a/src/types/WalletProvider.ts b/src/types/WalletProvider.ts
@@ -2,4 +2,5 @@ export enum WalletProvider {
     WalletConnect = "WalletConnect",
     MetaMask = "MetaMask",
     EwKeyManager = "EwKeyManager",
+    PrivateKey = "PrivateKey",
 }
diff --git a/test/initializeConnection.testSuite.ts b/test/initializeConnection.testSuite.ts
@@ -6,8 +6,8 @@ import { WalletProvider } from "../src/types/WalletProvider";
 const iam_withoutKey = new IAM({ rpcUrl });
 
 export const initializeConnectionTests = () => {
-    test("initializeConnection requires privateKey or walletProvider enum", async () => {
-        await expect(iam_withoutKey.initializeConnection()).rejects.toThrow(ERROR_MESSAGES.WALLET_TYPE_NOT_PROVIDED);
+    test("initializeConnection requires privateKey", async () => {
+        await expect(iam_withoutKey.initializeConnection()).rejects.toThrow(ERROR_MESSAGES.PRIVATE_KEY_NOT_PROVIDED);
     });
 
     test("initializeConnection requires walletProvider to be known value", async () => {