Using DEBUG for ls-sdk debug logging

Author: ggarri

.env.sample

@@ -1,3 +1,5 @@
+DEBUG='ls-sdk:*'
+
 ACCOUNT="0xc916cfe5c83dd4fc3c3b0bf2ec2d4e401782875e"
 PASSPHRASE=""
 RELAY_HUB=""

build/src/web3/latest.js

@@ -321,7 +321,7 @@ module.exports.contractSendTx = function (web3, _ref9) {
                 useGSN: useGSN || false,
                 gas: estimatedGas
               }).on('transactionHash', function (txHash) {
-                console.log("Tx executed: ", txHash);
+                // console.log("Tx executed: ", txHash);
               }).on('receipt', function (txReceipt) {
                 if (!txReceipt.status) {
                   reject(new Error("Failed tx ".concat(txReceipt.hash)));

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "lightstreams-js-sdk",
-  "version": "0.16.3",
+  "version": "0.17.0",
   "description": "Lightstreams JS SDK for building mainstream DApps with support for Programmable Decentralized Private Storage.",
   "author": "Gabriel Garrido",
   "contributors": [
@@ -49,6 +49,7 @@
     "@openzeppelin/network": "0.2.9",
     "@openzeppelin/upgrades": "2.5.3",
     "cids": "^0.7.1",
+    "debug": "^4.1.1",
     "entropy-string": "^4.2.0",
     "eth-ens-namehash": "^2.0.8",
     "ethereum-ens": "^0.7.7",

package.json

@@ -5,10 +5,12 @@
  */
 
 const Web3Wrapper = require('../web3');
+const Debug = require('debug');
 
 const artistTokenSc = require('../../build/contracts/ArtistToken.json');
 const fundingPoolSc = require('../../build/contracts/FundingPool.json');
 const wphtSc = require('../../build/contracts/WPHT.json');
+const logger = Debug('ls-sdk:contract:artistToken');
 
 module.exports.deployFundingPool = async (web3, { from }) => {
   Web3Wrapper.validator.validateAddress("from", from);
@@ -24,7 +26,7 @@ module.exports.deployFundingPool = async (web3, { from }) => {
     }
   );
 
-  console.log(`FundingPool deployed at: ${receipt.contractAddress}`);
+  logger(`FundingPool deployed at: ${receipt.contractAddress}`);
 
   return receipt;
 };
@@ -119,7 +121,7 @@ module.exports.deployArtistToken = async (
     }
   );
 
-  console.log(`ArtistToken deployed at: ${receipt.contractAddress}`);
+  logger(`ArtistToken deployed at: ${receipt.contractAddress}`);
   return receipt;
 };
 
@@ -137,7 +139,7 @@ module.exports.isArtistTokenHatched = async (web3, { artistTokenAddr }) => {
     }
   );
 
-  console.log(`ArtistToken ${artistTokenAddr} is hatched: ${isHatched}`);
+  logger(`ArtistToken ${artistTokenAddr} is hatched: ${isHatched}`);
 
   return isHatched;
 };
@@ -149,7 +151,7 @@ module.exports.hatchArtistToken = async (web3, { from, artistTokenAddr, wphtAddr
   Web3Wrapper.validator.validateWeiBn("amountWeiBn", amountWeiBn);
 
   const hatchingAmountInPHT = Web3Wrapper.utils.toPht(amountWeiBn);
-  console.log(`Hatcher ${from} sent a hatch worth of ${hatchingAmountInPHT} PHT to artist token ${artistTokenAddr}`);
+  logger(`Hatcher ${from} sent a hatch worth of ${hatchingAmountInPHT} PHT to artist token ${artistTokenAddr}`);
   if (runDepositFirst) {
     await Web3Wrapper.contractSendTx(
       web3,
@@ -195,7 +197,7 @@ module.exports.hatchArtistToken = async (web3, { from, artistTokenAddr, wphtAddr
     contributionInWPHT: hatchingAmountInPHT
   });
 
-  console.log(`Hatched completed, expected ${expectedArtistTokens} ArtistTokens`);
+  logger(`Hatched completed, expected ${expectedArtistTokens} ArtistTokens`);
   return receipt;
 };
 
@@ -213,7 +215,7 @@ module.exports.getArtistTokenTotalSupply = async (web3, { artistTokenAddr }) =>
     }
   );
 
-  console.log(`ArtistToken ${artistTokenAddr} total supply is: ${Web3Wrapper.utils.wei2pht(totalSupply)} PHT`);
+  logger(`ArtistToken ${artistTokenAddr} total supply is: ${Web3Wrapper.utils.wei2pht(totalSupply)} PHT`);
 
   return totalSupply;
 };
@@ -246,6 +248,19 @@ module.exports.transfer = async (web3, { artistTokenAddr, from, to, amountInBn }
   );
 };
 
+module.exports.transferOwnership = async (web3, {artistTokenAddr, from, newOwnerAddr}) => {
+  return await Web3Wrapper.contractSendTx(
+      web3,
+      {
+        to: artistTokenAddr,
+        from: from,
+        method: 'transferOwnership',
+        abi: artistTokenSc.abi,
+        params: [newOwnerAddr]
+      }
+  );
+};
+
 module.exports.approve = async (web3, { artistTokenAddr, from, to, amountInBn }) => {
   return await Web3Wrapper.contractSendTx(
     web3,
@@ -386,7 +401,7 @@ module.exports.getArtistTokenBalanceOf = async (web3, { artistTokenAddr, account
     }
   );
 
-  console.log(`Account ${accountAddr} has ${Web3Wrapper.utils.wei2pht(balance.toString())} ${symbol} of ArtistToken ${artistTokenAddr}`);
+  logger(`Account ${accountAddr} has ${Web3Wrapper.utils.wei2pht(balance.toString())} ${symbol} of ArtistToken ${artistTokenAddr}`);
 
   return Web3Wrapper.utils.toBN(balance);
 };
@@ -438,7 +453,7 @@ module.exports.buyArtistTokens = async (web3, { from, artistTokenAddr, wphtAddr,
 
   const tokens = receipt.events['CurvedMint'].returnValues['amount'];
 
-  console.log(`Buyer ${from} purchased ${tokens.toString()} ${symbol} of ArtistToken ${artistTokenAddr}`);
+  logger(`Buyer ${from} purchased ${tokens.toString()} ${symbol} of ArtistToken ${artistTokenAddr}`);
 
   return Web3Wrapper.utils.toBN(tokens);
 };
@@ -465,7 +480,7 @@ module.exports.sellArtistTokens = async (web3, { from, artistTokenAddr, amountBn
 
   const wphtReimbursement = receipt.events['CurvedBurn'].returnValues['reimbursement'];
 
-  console.log(`Account ${from} sold ${Web3Wrapper.utils.wei2pht(amountBn.toString())} ${symbol} of ArtistToken ${artistTokenAddr} for ${Web3Wrapper.utils.wei2pht(wphtReimbursement.toString())} WPHT`);
+  logger(`Account ${from} sold ${Web3Wrapper.utils.wei2pht(amountBn.toString())} ${symbol} of ArtistToken ${artistTokenAddr} for ${Web3Wrapper.utils.wei2pht(wphtReimbursement.toString())} WPHT`);
 
   return wphtReimbursement;
 };

src/contracts/artist_token.js

@@ -3,22 +3,19 @@
  * Date: 14/08/19 15:44
  * Copyright 2019 (c) Lightstreams, Granada
  */
+const Debug = require('debug');
 const Web3Wrapper = require('../web3');
+
 const CID = require('cids');
 const {
   fundRecipient,
   isRelayHubDeployed,
   getRecipientFunds
 } = require('../gsn');
 
-const {
-  buyArtistTokens,
-  transfer: transferIERC20Token,
-  getBalanceOf
-} = require('./artist_token');
-
 const factoryScJSON = require('../../build/contracts/GSNProfileFactory.json');
 const profileScJSON = require('../../build/contracts/GSNProfile.json');
+const logger = Debug('ls-sdk:contract:profile');
 
 const cidPrefix = 'Qm';
 const cidLength = 46;
@@ -70,7 +67,7 @@ module.exports.initializeProfileFactory = async (web3, { contractAddr, relayHub,
   if (!txReceipt.status) {
     throw new Error(`ProfileFactory initialization failed`);
   } else {
-    console.log(`Activated GSN for ProfileFactory instance for RelayHub ${relayHub}...`);
+    logger(`Activated GSN for ProfileFactory instance for RelayHub ${relayHub}...`);
   }
 
   // Step 3: Profile factory is funded via RelayHub
@@ -81,26 +78,26 @@ module.exports.initializeProfileFactory = async (web3, { contractAddr, relayHub,
     amountInPht: factoryFundingInPht
   });
 
-  console.log(`Recipient ${contractAddr} is sponsored by relayHub with ${factoryFundingInPht} PHTs...`);
+  logger(`Recipient ${contractAddr} is sponsored by relayHub with ${factoryFundingInPht} PHTs...`);
 
   // Step 4: Top up factory contract to fund new profile deployments
   await Web3Wrapper.sendTransaction(web3, { from, to: contractAddr, valueInPht: faucetFundingInPht });
-  console.log(`Topped up ProfileFactory with ${faucetFundingInPht} PHTs to fund new profile creations...`);
+  logger(`Topped up ProfileFactory with ${faucetFundingInPht} PHTs to fund new profile creations...`);
 
   return contractAddr;
 };
 
 module.exports.validateHasEnoughFundToDeployProfile = async(web3, { contractAddr }) => {
   const recipientFundsInWei = await getRecipientFunds(web3, { recipient: contractAddr });
   const recipientFundsInPht = Web3Wrapper.utils.toPht(`${recipientFundsInWei}`);
-  console.log(`GSNProfileFactory recipient has ${recipientFundsInPht} PHT for GSN`);
+  logger(`GSNProfileFactory recipient has ${recipientFundsInPht} PHT for GSN`);
   if (parseFloat(recipientFundsInPht) < 1.0) {
     throw new Error(`Not enough recipient funds: ${recipientFundsInPht} PHT`);
   }
 
   const balanceInWei = await Web3Wrapper.getBalance(web3, { address: contractAddr });
   const balanceInPht = Web3Wrapper.utils.toPht(balanceInWei);
-  console.log(`GSNProfileFactory contract has ${balanceInPht} PHT in balance`);
+  logger(`GSNProfileFactory contract has ${balanceInPht} PHT in balance`);
   const newProfileFundingInWei = await Web3Wrapper.contractCall(web3, {
     to: contractAddr,
     abi: factoryScJSON.abi,
@@ -260,7 +257,7 @@ module.exports.hatchArtistToken = async (web3, {from, contractAddr, artistTokenA
   }
 
   const tokens = receipt.events['HatchedArtistTokens'].returnValues['amount'];
-  console.log(`Hatcher ${from} obtained an estimated amount of ${Web3Wrapper.utils.toPht(tokens).toString()} ArtistTokens ${artistTokenAddr}`);
+  logger(`Hatcher ${from} obtained an estimated amount of ${Web3Wrapper.utils.toPht(tokens).toString()} ArtistTokens ${artistTokenAddr}`);
   return Web3Wrapper.utils.toBN(tokens);
 };
 
@@ -284,7 +281,7 @@ module.exports.claimArtistToken = async (web3, {from, contractAddr, artistTokenA
   }
 
   const tokens = receipt.events['ClaimedArtistTokens'].returnValues['amount'];
-  console.log(`Hatcher ${from} claimed an amount of ${Web3Wrapper.utils.toPht(tokens).toString()} ArtistTokens ${artistTokenAddr}`);
+  logger(`Hatcher ${from} claimed an amount of ${Web3Wrapper.utils.toPht(tokens).toString()} ArtistTokens ${artistTokenAddr}`);
   return Web3Wrapper.utils.toBN(tokens);
 };
 
@@ -309,7 +306,7 @@ module.exports.refundArtistToken = async (web3, {from, contractAddr, artistToken
   }
 
   const tokens = receipt.events['RefundedTokens'].returnValues['amount'];
-  console.log(`Hatcher ${from} get a refund of ${Web3Wrapper.utils.toPht(tokens).toString()} WPHT tokens`);
+  logger(`Hatcher ${from} get a refund of ${Web3Wrapper.utils.toPht(tokens).toString()} WPHT tokens`);
   return Web3Wrapper.utils.toBN(tokens);
 };
 
@@ -333,6 +330,6 @@ module.exports.buyArtistToken = async(web3, {from, contractAddr, artistTokenAddr
   }
 
   const tokens = receipt.events['BoughtArtistTokens'].returnValues['amount'];
-  console.log(`Buyer ${from} purchased ${Web3Wrapper.utils.toPht(tokens).toString()} of ArtistTokens ${artistTokenAddr}`);
+  logger(`Buyer ${from} purchased ${Web3Wrapper.utils.toPht(tokens).toString()} of ArtistTokens ${artistTokenAddr}`);
   return Web3Wrapper.utils.toBN(tokens);
 };