Merge pull request #139 from abhayks1/jlp_fixes

Implementation of TokenHolder.getSessionKeyData needed for JLP

Author: gulshanvasnani

lib/ContractInteract/GnosisSafe.js

@@ -272,7 +272,7 @@ class GnosisSafe {
    * @return {Promise<Object>} Promise that resolves to array of owners.
    */
   getOwners() {
-    return this.contract.methods.getOwners().call();
+    return Promise.resolve(this.contract.methods.getOwners().call());
   }
 
   /**
@@ -281,7 +281,7 @@ class GnosisSafe {
    * @return {Promise<Object>} Promise that resolves current GnosisSafe nonce.
    */
   getNonce() {
-    return this.contract.methods.nonce().call();
+    return Promise.resolve(this.contract.methods.nonce().call());
   }
 
   /**
@@ -373,7 +373,7 @@ class GnosisSafe {
    * @returns {string} domain separator value.
    */
   async getDomainSeparator() {
-    return this.contract.methods.domainSeparator().call();
+    return Promise.resolve(this.contract.methods.domainSeparator().call());
   }
 
   /**
@@ -382,7 +382,7 @@ class GnosisSafe {
    * @returns {Object} Map of all modules.
    */
   async getModules() {
-    return this.contract.methods.getModules().call();
+    return Promise.resolve(this.contract.methods.getModules().call());
   }
 }
 

lib/ContractInteract/TokenHolder.js

@@ -110,6 +110,10 @@ class TokenHolder {
    * @returns {string} Executable data to revoke a session.
    */
   getRevokeSessionExecutableData(sessionKey) {
+    if (!Web3.utils.isAddress(sessionKey)) {
+      const err = new TypeError(`Invalid sessionKey address: ${sessionKey}.`);
+      return Promise.reject(err);
+    }
     return this.contract.methods.revokeSession(sessionKey).encodeABI();
   }
 
@@ -188,6 +192,21 @@ class TokenHolder {
     }
     return Promise.resolve(this.contract.methods.executeRule(to, data, nonce, r, s, v));
   }
+
+  /**
+   * It returns the session key data object.
+   *
+   * @param {string} sessionKey Authorized session key address.
+   *
+   * @return {Promise<Object>} Promise that resolves session data for valid session key.
+   */
+  getSessionKeyData(sessionKey) {
+    if (!Web3.utils.isAddress(sessionKey)) {
+      const err = new TypeError(`Invalid sessionKey address: ${sessionKey}.`);
+      return Promise.reject(err);
+    }
+    return Promise.resolve(this.contract.methods.sessionKeys(sessionKey).call());
+  }
 }
 
 module.exports = TokenHolder;

test/unit/TokenHolder/getRevokeSessionExecutableData.js

@@ -5,6 +5,7 @@ const sinon = require('sinon');
 const { assert } = require('chai');
 
 const Spy = require('../../../utils/Spy');
+const AssertAsync = require('../../../utils/AssertAsync');
 const TokenHolder = require('../../../lib/ContractInteract/TokenHolder');
 
 describe('TokenHolder.getAuthorizeSessionWithExecutableData()', () => {
@@ -32,4 +33,9 @@ describe('TokenHolder.getAuthorizeSessionWithExecutableData()', () => {
     assert.strictEqual(response, mockRevokeSession);
     Spy.assert(revokeSessionSpy, 1, [[sessionKey]]);
   });
+
+  it('should throw an error when sessoinKey address is undefined', async () => {
+    const sessionKey = undefined;
+    await AssertAsync.reject(tokenHolder.getSessionKeyData(sessionKey), `Invalid sessionKey address: undefined.`);
+  });
 });

test/unit/TokenHolder/getSessionKeyData.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const Web3 = require('web3');
+const sinon = require('sinon');
+const { assert } = require('chai');
+
+const Spy = require('../../../utils/Spy');
+const AssertAsync = require('../../../utils/AssertAsync');
+const TokenHolder = require('../../../lib/ContractInteract/TokenHolder');
+
+describe('TokenHolder.getSessionKeyData()', () => {
+  let tokenHolder;
+
+  beforeEach(() => {
+    const web3 = new Web3();
+    const address = '0x0000000000000000000000000000000000000002';
+    tokenHolder = new TokenHolder(web3, address);
+  });
+
+  it('should construct with correct parameters', async () => {
+    const sessionKey = '0x0000000000000000000000000000000000000003';
+
+    const mockSessionKeyData = 'mockSessionKeyData';
+    const sessionKeyDataSpy = sinon.replace(
+      tokenHolder.contract.methods,
+      'sessionKeys',
+      sinon.fake.returns({
+        call: () => Promise.resolve(mockSessionKeyData)
+      })
+    );
+    const response = await tokenHolder.getSessionKeyData(sessionKey);
+
+    assert.strictEqual(response, mockSessionKeyData);
+    Spy.assert(sessionKeyDataSpy, 1, [[sessionKey]]);
+  });
+
+  it('should throw an error when sessoinKey address is undefined', async () => {
+    const sessionKey = undefined;
+    await AssertAsync.reject(tokenHolder.getSessionKeyData(sessionKey), `Invalid sessionKey address: undefined.`);
+  });
+});