Add req params to rpc result (#55)

* Add request object with params to send call

* Update version

* Change send to async func and add req object correctly

* Change request to args

* Run linter

* Add test for args obj in send call

* Use lodash method for undefined

* Import lodash

Author: dwalintukan

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "qweb3",
   "namespace": "bodhi",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "description": "Qtum JavaScript API comunicating to qtum node over RPC",
   "main": "./src/index.js",
   "repository": {

package.json

@@ -46,27 +46,39 @@ class Contract {
   * @param params Parameters of the contract method.
   * @return The transaction id of the sendtocontract.
   */
-  send(methodName, params) {
+  async send(methodName, params) {
     // Throw if methodArgs or senderAddress is not defined in params
     Utils.paramsCheck('send', params, ['methodArgs', 'senderAddress']);
 
     const {
       methodArgs, amount, gasLimit, gasPrice, senderAddress,
     } = params;
     const { method: methodObj, args } = this.validateMethodAndArgs(methodName, methodArgs);
+    const amt = amount || SEND_AMOUNT;
+    const limit = gasLimit || SEND_GASLIMIT;
+    const price = gasPrice || SEND_GASPRICE;
     const options = {
       method: 'sendtocontract',
       params: [
         this.address,
         this.constructDataHex(methodObj, args),
-        amount || SEND_AMOUNT,
-        gasLimit || SEND_GASLIMIT,
-        gasPrice || SEND_GASPRICE,
+        amt,
+        limit,
+        price,
         senderAddress,
       ],
     };
 
-    return this.provider.request(options);
+    // Add request object with params used for request
+    const result = await this.provider.request(options);
+    result.args = {
+      contractAddress: this.address,
+      amount: amt,
+      gasLimit: limit,
+      gasPrice: price,
+    };
+
+    return result;
   }
 
   /*

src/contract.js

@@ -153,13 +153,13 @@ class Utils {
    * @return {Boolean}
    */
   static isQtumAddress(address) {
-    if (_.isUndefined(address)){
+    if (_.isUndefined(address)) {
       return false;
     }
 
     if (_.size(address) !== 34) {
       return false;
-    };
+    }
 
     if (!address.startsWith('q') && !address.startsWith('Q')) {
       return false;

src/utils.js

@@ -1,3 +1,5 @@
+const _ = require('lodash');
+
 // Load environment variables
 require('dotenv').config();
 
@@ -8,33 +10,31 @@ const Config = {
   ENCRYPTED_WALLET_TESTS: false,
 };
 
-const qtumRPCAddress = "QTUM_RPC_ADDRESS" in process.env ? String(new Buffer(process.env["QTUM_RPC_ADDRESS"])) : undefined;
-const qtumAddress = "SENDER_ADDRESS" in process.env ? String(new Buffer(process.env["SENDER_ADDRESS"])) : undefined;
+const qtumRPCAddress = 'QTUM_RPC_ADDRESS' in process.env ? String(new Buffer(process.env.QTUM_RPC_ADDRESS)) : undefined;
+const qtumAddress = 'SENDER_ADDRESS' in process.env ? String(new Buffer(process.env.SENDER_ADDRESS)) : undefined;
 
-/* Returns the default Qtum address 
+/* Returns the default Qtum address
  * @return {String} default Qtum address.
  */
 function getDefaultQtumAddress() {
-  if (typeof qtumAddress === "undefined") {
+  if (_.isUndefined(qtumAddress)) {
     return Config.SENDER_ADDRESS;
-  } else {
-    return qtumAddress;
   }
-};
+  return qtumAddress;
+}
 
-/* Returns the Qtum network RPC url 
+/* Returns the Qtum network RPC url
  * @return {String} the Qtum network RPC url.
  */
 function getQtumRPCAddress() {
-  if (typeof qtumRPCAddress === "undefined") {
+  if (_.isUndefined(qtumRPCAddress)) {
     return Config.QTUM_RPC_ADDRESS;
-  } else {
-    return qtumRPCAddress;
   }
-};
+  return qtumRPCAddress;
+}
 
-module.exports = {  
+module.exports = {
   Config,
   getQtumRPCAddress,
   getDefaultQtumAddress,
-}
+};

test/config/config.js

@@ -75,6 +75,25 @@ describe('Contract', () => {
       assert.isDefined(res.sender);
       assert.isDefined(res.hash160);
     });
+
+    it('returns the args object with the sent params', async () => {
+      const res = {
+        "txid": "60c14ddc003a84a0947db1ac9cbfb01f1d3253b7948dc95343d7dd5a9d5900e9",
+        "sender": "qUNeKdqh269AwJWxDFnxUAqKSJ9deSUsgF",
+        "hash160": "76a177b79b8ef37437dce27a38fa2653eb6d8241",
+        "args": {
+          "contractAddress": "f6177bc9812eeb531907621af6641a41133dea9e",
+          "amount": 0,
+          "gasLimit": 250000,
+          "gasPrice": 4e-7
+        }
+      };
+
+      assert.isString(res.args.contractAddress);
+      assert.isNumber(res.args.amount);
+      assert.isNumber(res.args.gasLimit);
+      assert.isNumber(res.args.gasPrice);
+    });
   });
 
   describe('constructDataHex()', () => {

test/contract.js

@@ -4,7 +4,7 @@ const chai = require('chai');
 const assert = chai.assert;
 const expect = chai.expect;
 
-const bs58 = require('bs58')
+const bs58 = require('bs58');
 
 const Qweb3 = require('../src/qweb3');
 const Formatter = require('../src/formatter');
@@ -310,8 +310,8 @@ describe('Qweb3', () => {
   /** ******** RAW TRANSACTIONS ********* */
   describe('getHexAddress()', () => {
     it('returns the hex address', async () => {
-      const hexDecodedAddress = bs58.decode(QTUM_ADDRESS).toString('hex')
-      var hexadecimalAddress = await qweb3.getHexAddress(QTUM_ADDRESS)
+      const hexDecodedAddress = bs58.decode(QTUM_ADDRESS).toString('hex');
+      const hexadecimalAddress = await qweb3.getHexAddress(QTUM_ADDRESS);
       assert.isString(hexadecimalAddress);
       assert.lengthOf(hexadecimalAddress, 40);
       assert.include(hexDecodedAddress, hexadecimalAddress);
@@ -320,7 +320,7 @@ describe('Qweb3', () => {
 
   describe('fromHexAddress()', () => {
     it('returns the qtum address', async () => {
-      const qtumAddress = await qweb3.fromHexAddress('17e7888aa7412a735f336d2f6d784caefabb6fa3')
+      const qtumAddress = await qweb3.fromHexAddress('17e7888aa7412a735f336d2f6d784caefabb6fa3');
       assert.isString(qtumAddress);
       assert.lengthOf(qtumAddress, 34);
     });