Merge pull request #141 from abhayks1/deprecation

Deprecation of setup and helpers

Author: gulshanvasnani

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Version 0.10.0
 
+* Deprecation of setup and helper files ([141](https://github.com/openst/openst.js/pull/141))
 * ABIs and BINs are now accessed as a dependency on openst-contracts ([137](https://github.com/openst/openst.js/pull/137))
 * Update PricerRule ABI/BIN with PricerRule:convertPayCurrencyToToken fix ([126](https://github.com/openst/openst.js/pull/126))
 * Recovery contract interaction fixes ([#116](https://github.com/openst/openst.js/pull/116))

README.md

@@ -470,9 +470,9 @@ The abiBinProvider provides abi(s) and bin(s) for the following contracts:
 * [TokenHolder](https://github.com/openst/openst-contracts/blob/0.10.0-alpha.1/contracts/token/TokenHolder.sol) (TokenHolder contract deployed on UtilityChain)
 * [TokenRules](https://github.com/openst/openst-contracts/blob/0.10.0-alpha.1/contracts/token/TokenRules.sol) (TokenRules contract deployed on UtilityChain)
 * [PricerRule](https://github.com/openst/openst-contracts/blob/0.10.0-alpha.1/contracts/rules/PricerRule.sol) (PricerRule is a rule contract deployed on UtilityChain)
-* [GnosisSafe](https://github.com/gnosis/safe-contracts/blob/v0.1.0/contracts/GnosisSafe.sol) (MultiSignature wallet with support for confirmations using signed messages)
+* [GnosisSafe](https://github.com/gnosis/safe-contracts/blob/v0.10.0/contracts/GnosisSafe.sol) (MultiSignature wallet with support for confirmations using signed messages)
 * [DelayedRecoveryModule](https://github.com/openst/openst-contracts/blob/0.10.0-alpha.1/contracts/gnosis_safe_modules/DelayedRecoveryModule.sol) (Allows to replace an owner without Safe confirmations) 
-* [CreateAndAddModules](https://github.com/gnosis/safe-contracts/blob/v0.1.0/contracts/libraries/CreateAndAddModules.sol) (Allows to create and add multiple module in one transaction)
+* [CreateAndAddModules](https://github.com/gnosis/safe-contracts/blob/v0.10.0/contracts/libraries/CreateAndAddModules.sol) (Allows to create and add multiple module in one transaction)
 * [UserWalletFactory](https://github.com/openst/openst-contracts/blob/0.10.0-alpha.1/contracts/proxies/UserWalletFactory.sol) (Creates proxy for GnosisSafe, TokenHolder and DelayedRecoveryModule)
 
 ```js

index.js

@@ -4,7 +4,7 @@ const AbiBinProvider = require('./lib/AbiBinProvider');
 const Contracts = require('./lib/Contracts');
 const TokenRulesSetup = require('./lib/setup/TokenRules');
 const User = require('./lib/setup/User');
-const UserHelper = require('./lib/User');
+const UserHelper = require('./lib/helper/User');
 const TokenRulesHelper = require('./lib/helper/TokenRules');
 const TokenHolderHelper = require('./lib/helper/TokenHolder');
 const Rules = require('./lib/setup/Rules');

lib/helper/GnosisSafe.js

@@ -19,6 +19,7 @@ class GnosisSafe {
    * @param auxiliaryWeb3 Auxiliary chain web3 object.
    */
   constructor(gnosisSafeProxy, auxiliaryWeb3) {
+    Utils.deprecationNotice('helper.GnosisSafe', 'Please use GnosisSafe ContractInteract!!!');
     const oThis = this;
 
     oThis.gnosisSafeProxy = gnosisSafeProxy;

lib/helper/TokenHolder.js

@@ -17,6 +17,7 @@ class TokenHolder {
    * @param tokenHolderProxy TokenHolder proxy address of a user.
    */
   constructor(auxiliaryWeb3, tokenHolderProxy) {
+    Utils.deprecationNotice('helper.TokenHolder', 'Please use TokenHolder ContractInteract!!!');
     const oThis = this;
 
     oThis.auxiliaryWeb3 = auxiliaryWeb3;

lib/helper/TokenRules.js

@@ -16,6 +16,7 @@ class TokenRules {
    * @param auxiliaryWeb3 Auxiliary chain web3.
    */
   constructor(tokenRules, auxiliaryWeb3) {
+    Utils.deprecationNotice('helper.TokenRules', 'Please use TokenRules ContractInteract!!!');
     const oThis = this;
     oThis.tokenRules = tokenRules;
     oThis.auxiliaryWeb3 = auxiliaryWeb3;

lib/User.js lib/helper/User.jslib/User.js renamed to lib/helper/User.js

@@ -1,8 +1,8 @@
 'use strict';
 
-const AbiBinProvider = require('./AbiBinProvider');
-const Contracts = require('./Contracts');
-const Utils = require('../utils/Utils');
+const AbiBinProvider = require('../AbiBinProvider');
+const Contracts = require('../Contracts');
+const Utils = require('../../utils/Utils');
 
 /**
  * Class is used to create a wallet of an user and configure it.

lib/helper/rules/PricerRule.js

@@ -18,6 +18,7 @@ class PricerRule {
    * @param contractAddress PricerRule contract address.
    */
   constructor(auxiliaryWeb3, contractAddress) {
+    Utils.deprecationNotice('helper.PricerRule', 'Please use PricerRule ContractInteract!!!');
     const oThis = this;
     oThis.auxiliaryWeb3 = auxiliaryWeb3;
     oThis.pricerRuleAddress = contractAddress;

lib/setup/Rules.js

@@ -4,6 +4,8 @@ const AbiBinProvider = require('../AbiBinProvider'),
   Deployer = require('../../utils/DeployContract'),
   PricerRuleContractName = 'PricerRule';
 
+const Utils = require('../../utils/Utils');
+
 /**
  * Helper class which performs setup/deployment of multiple Rules contract.
  */
@@ -17,6 +19,7 @@ class Rules {
    * @param tokenRules The economy token rules address.
    */
   constructor(auxiliaryWeb3, organization, eip20Token, tokenRules) {
+    Utils.deprecationNotice('setup.Rules', 'Please use PricerRule ContractInteract!!!');
     const oThis = this;
     oThis.auxiliaryWeb3 = auxiliaryWeb3;
     oThis.organization = organization;

lib/setup/TokenRules.js

@@ -1,8 +1,10 @@
 'use strict';
 
-const AbiBinProvider = require('../AbiBinProvider'),
-  Deployer = require('../../utils/DeployContract'),
-  ContractName = 'TokenRules';
+const AbiBinProvider = require('../AbiBinProvider');
+const Deployer = require('../../utils/DeployContract');
+const ContractName = 'TokenRules';
+
+const Utils = require('../../utils/Utils');
 
 /**
  * Helper method which performs deployment of Token Rules contract.
@@ -14,6 +16,7 @@ class TokenRules {
    * @param auxiliaryWeb3 Auxiliary chain web3 object.
    */
   constructor(auxiliaryWeb3) {
+    Utils.deprecationNotice('setup.TokenRules', 'Please use TokenRules ContractInteract!!!');
     const oThis = this;
     oThis.auxiliaryWeb3 = auxiliaryWeb3;
     oThis.abiBinProvider = new AbiBinProvider();