Merge pull request #143 from OpenST/develop

Merging develop to release-0.10.0

Author: abhayks1

CHANGELOG.md

@@ -2,28 +2,31 @@
 
 ## Version 0.10.0
 
-* Update PricerRule ABI/BIN with PricerRule:convertPayCurrencyToToken fix ([126](https://github.com/OpenSTFoundation/openst.js/pull/126))
-* PricerRule integration test and cleanup ([#114](https://github.com/OpenSTFoundation/openst.js/pull/114))
-* ProxyFactory address refactoring from createCompanyWallet method ([#113](https://github.com/OpenSTFoundation/openst.js/pull/113)
-* Integration with mosaic.js npm ([#109](https://github.com/OpenSTFoundation/openst.js/pull/109))
-* Docker Geth Integration: Using docker geth ([#108](https://github.com/OpenSTFoundation/openst.js/pull/108))
-* Delayed Recovery Module Setup ([#107](https://github.com/OpenSTFoundation/openst.js/pull/107))
-* Remove license from top of JS files ([#106](https://github.com/OpenSTFoundation/openst.js/pull/106))
-* MultiSig Operation: Logout all sessions ([104](https://github.com/OpenSTFoundation/openst.js/pull/104))
-* WalletOperations Test: Remove tokenRulesAddress while creating TokenHolder instance ([#91](https://github.com/OpenSTFoundation/openst.js/pull/91))
-* Remove pre commit hook from package.json which generates webpack ([#88](https://github.com/OpenSTFoundation/openst.js/pull/88))
-* Fix version to 0 in SignEIP1077Extension.js ([#87](https://github.com/OpenSTFoundation/openst.js/pull/87))
-* Wallet operations cleanup and refactoring ([#79](https://github.com/OpenSTFoundation/openst.js/pull/79))
-* Multisig operations : Change threshold ([#78](https://github.com/OpenSTFoundation/openst.js/pull/78))
-* Added multisig wallet operations ([#74](https://github.com/OpenSTFoundation/openst.js/pull/74))
-* Parse payCurrencyCode to bytes in PricerRule deployment ([#71](https://github.com/OpenSTFoundation/openst.js/pull/71))
-* User setup: Company to User Implementation ([#68](https://github.com/OpenSTFoundation/openst.js/pull/68))
-* Direct transfer of tokens using TokenRules contract ([#67](https://github.com/OpenSTFoundation/openst.js/pull/67))
-* Rule setup: Pricer rule setup and interaction ([#66](https://github.com/OpenSTFoundation/openst.js/pull/66))
-* Rename _createUserWallet to _createUserWalletRawTx ([#64](https://github.com/OpenSTFoundation/openst.js/pull/64))
-* Updated params _createUserWallet ([#61](https://github.com/OpenSTFoundation/openst.js/pull/61))
-* TokenRules : Rules registration framework for registration of rules getter to fetch registered rules ([#60](https://github.com/OpenSTFoundation/openst.js/pull/60))
-* Updated index.js to expose setup libraries ([#57](https://github.com/OpenSTFoundation/openst.js/pull/57))
-* User setup : Implement createUserWallet ([#55](https://github.com/OpenSTFoundation/openst.js/pull/55))
-* Interaction for MultiSig and TokenHolder master copy deployment ([#53](https://github.com/OpenSTFoundation/openst.js/pull/53))
-* Interaction for TokenRules deployment ([#51](https://github.com/OpenSTFoundation/openst.js/issues/51))
+* 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))
+* PricerRule integration test and cleanup ([#114](https://github.com/openst/openst.js/pull/114))
+* ProxyFactory address refactoring from createCompanyWallet method ([#113](https://github.com/openst/openst.js/pull/113)
+* Integration with mosaic.js npm ([#109](https://github.com/openst/openst.js/pull/109))
+* Docker Geth Integration: Using docker geth ([#108](https://github.com/openst/openst.js/pull/108))
+* Delayed Recovery Module Setup ([#107](https://github.com/openst/openst.js/pull/107))
+* Remove license from top of JS files ([#106](https://github.com/openst/openst.js/pull/106))
+* MultiSig Operation: Logout all sessions ([104](https://github.com/openst/openst.js/pull/104))
+* WalletOperations Test: Remove tokenRulesAddress while creating TokenHolder instance ([#91](https://github.com/openst/openst.js/pull/91))
+* Remove pre commit hook from package.json which generates webpack ([#88](https://github.com/openst/openst.js/pull/88))
+* Fix version to 0 in SignEIP1077Extension.js ([#87](https://github.com/openst/openst.js/pull/87))
+* Wallet operations cleanup and refactoring ([#79](https://github.com/openst/openst.js/pull/79))
+* Multisig operations : Change threshold ([#78](https://github.com/openst/openst.js/pull/78))
+* Added multisig wallet operations ([#74](https://github.com/openst/openst.js/pull/74))
+* Parse payCurrencyCode to bytes in PricerRule deployment ([#71](https://github.com/openst/openst.js/pull/71))
+* User setup: Company to User Implementation ([#68](https://github.com/openst/openst.js/pull/68))
+* Direct transfer of tokens using TokenRules contract ([#67](https://github.com/openst/openst.js/pull/67))
+* Rule setup: Pricer rule setup and interaction ([#66](https://github.com/openst/openst.js/pull/66))
+* Rename _createUserWallet to _createUserWalletRawTx ([#64](https://github.com/openst/openst.js/pull/64))
+* Updated params _createUserWallet ([#61](https://github.com/openst/openst.js/pull/61))
+* TokenRules : Rules registration framework for registration of rules getter to fetch registered rules ([#60](https://github.com/openst/openst.js/pull/60))
+* Updated index.js to expose setup libraries ([#57](https://github.com/openst/openst.js/pull/57))
+* User setup : Implement createUserWallet ([#55](https://github.com/openst/openst.js/pull/55))
+* Interaction for MultiSig and TokenHolder master copy deployment ([#53](https://github.com/openst/openst.js/pull/53))
+* Interaction for TokenRules deployment ([#51](https://github.com/openst/openst.js/issues/51))

README.md

@@ -2,18 +2,19 @@ OpenST.js
 ============
 
 OpenST is a framework for building token economies. OpenST supports interactions with openst-contracts.
+It requires [openst-contracts](https://github.com/openst/openst-contracts) for ABIs and BINs of contracts.
 
-![Build master](https://img.shields.io/travis/OpenSTFoundation/openst.js/master.svg?label=build%20master&style=flat)
-![Build develop](https://img.shields.io/travis/OpenSTFoundation/openst.js/develop.svg?label=build%20develop&style=flat)
-![npm version](https://img.shields.io/npm/v/@openstfoundation/openst.js.svg?style=flat)
+![Build master](https://img.shields.io/travis/openst/openst.js/master.svg?label=build%20master&style=flat)
+![Build develop](https://img.shields.io/travis/openst/openst.js/develop.svg?label=build%20develop&style=flat)
+![npm version](https://img.shields.io/npm/v/@openst/openst.js.svg?style=flat)
 ![Discuss on Discourse](https://img.shields.io/discourse/https/discuss.openst.org/topics.svg?style=flat)
-![Chat on Gitter](https://img.shields.io/gitter/room/OpenSTFoundation/SimpleToken.svg?style=flat)
+![Chat on Gitter](https://img.shields.io/gitter/room/openst/SimpleToken.svg?style=flat)
 
 ##  Setup
 This library assumes that nodejs and geth are installed and running. To install OpenST.js in your project using npm:
 
 ```bash
-$ npm install @openstfoundation/openst.js --save
+$ npm install @openst/openst.js --save
 ```
 
 The code works for Ethereum Byzantium and Petersburg.
@@ -22,16 +23,10 @@ The code works for Ethereum Byzantium and Petersburg.
 
 ```js
 // Creating OpenST.js object
-const OpenST = require('@openstfoundation/openst.js');
+const OpenST = require('@openst/openst.js');
 
 ```
 
-For deployment of Organization contract, Mosaic object is needed.
-```js
-// Create Mosaic object
-const Mosaic = require('@openstfoundation/mosaic.js');
-```
-
 ## Deploying contracts
 
 ## Constants
@@ -66,7 +61,7 @@ const gas = '7500000';
 An Organization contract serves as an on-chain access control mechanism by assigning roles to a set of addresses.
 
 ```js
-const { Organization } = Mosaic.ContractInteract;
+const { Organization } = OpenST.ContractInteract;
 const organizationOwner = '0xaabb1122....................';
 const admin = '0xaabb1122....................';
 const orgConfig = {
@@ -76,9 +71,14 @@ const orgConfig = {
   workers: [worker],
   workerExpirationHeight: '200000000' // This is the block height for when the the worker is set to expire.
 };
+const txOptions = {
+  gasPrice: '0x3B9ACA00',
+  from : deployerAddress,
+  gas: '7500000', // This is an optional parameter, if not passed gas will be estimated.
+};
 let organizationContractInstance;
 let organizationAddress;
-Organization.setup(web3Provider, orgConfig).then(function(instance){
+Organization.setup(web3Provider, orgConfig, txOptions).then(function(instance){
   organizationContractInstance = instance;
   organizationAddress = organizationContractInstance.address;
 });
@@ -359,7 +359,7 @@ tokenHolder.executeRule(tokenRulesAddress, directTransferCallData, nonce, vrs.r,
 
 ## Setup of PriceOracle 
 
-Make sure PriceOracle contract is already deployed. Refer [PriceOracle](https://github.com/OpenSTFoundation/ost-price-oracle) npm for setup of PriceOracle contract.
+Make sure PriceOracle contract is already deployed. Refer [PriceOracle](https://github.com/openst/ost-price-oracle) npm for setup of PriceOracle contract.
 
 ## Payment through PricerRule contract 
 
@@ -467,13 +467,13 @@ openst.js comes with an abi-bin provider for managing abi(s) and bin(s).
 
 The abiBinProvider provides abi(s) and bin(s) for the following contracts:
 
-* [TokenHolder](https://github.com/OpenSTFoundation/openst-contracts/blob/0.10.0-alpha.1/contracts/token/TokenHolder.sol) (TokenHolder contract deployed on UtilityChain)
-* [TokenRules](https://github.com/OpenSTFoundation/openst-contracts/blob/0.10.0-alpha.1/contracts/token/TokenRules.sol) (TokenRules contract deployed on UtilityChain)
-* [PricerRule](https://github.com/OpenSTFoundation/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)
-* [DelayedRecoveryModule](https://github.com/OpenSTFoundation/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)
-* [UserWalletFactory](https://github.com/OpenSTFoundation/openst-contracts/blob/0.10.0-alpha.1/contracts/proxies/UserWalletFactory.sol) (Creates proxy for GnosisSafe, TokenHolder and DelayedRecoveryModule)
+* [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.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.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