Merge pull request #73 from Augmint/staging

v0.3.0

Author: rszaloki

README.md

@@ -9,6 +9,29 @@
 
 Decentralised stable cryptocurrency on Ethereum
 
+## Concept
+
+Decentralized stablecoins targeted to fiat currencies built on Ethereum.
+
+The first Augmint token is AEUR.
+
+**1 AEUR ≈ 1 EUR.**
+
+-   Buy and sell AEUR for ETH or EUR.
+-   Get a loan in AEUR by depositing ETH.
+-   Lock AEUR to earn a premium.
+
+Try it: **[https://www.augmint.org](http://www.augmint.org)**
+
+**[Manifesto](https://www.augmint.org/manifesto)**
+
+**[White Paper](http://bit.ly/augmint-wp)**
+
+### Related repos
+
+-   [Web frontend](https://github.com/Augmint/augmint-web)
+-   [augmint-contracts](https://github.com/Augmint/augmint-contracts)
+
 ## augmint-js lib
 
 This lib is heavily under construction. Anything can happen.
@@ -146,53 +169,31 @@ augmint-cli : start / stop augmint contracts. Docker image: augmint/contracts:vx
 
 Also recreates the container if it exists but image is not as expected (ie. there was a version upgrade)
 
-## Concept
-
-Augmint provides digital tokens, value of each token pegged to a fiat currency.
-
-The first Augmint token is A-EUR (Augmint Euro), pegged to EUR.
-
-The value of 1 A-EUR is always closely around 1 EUR.
-
-**[White paper](http://bit.ly/augmint-wp)**
-
-Try it: **[www.augmint.org](http://www.augmint.org)**
-
-**[Our Trello board](https://trello.com/b/RYGAt2so/augmint-documents)** with a collection of documents about the project.
-
-## Other components
-
-[Web frontend](https://github.com/Augmint/augmint-web)
-
-[Solidity contracts](https://github.com/Augmint/augmint-contracts)
-
 ## Contributions
 
 Augmint is an open and transparent project.
 
-We are seeking for great minds to extend our core team. Contribution in any area is much appreciated: development, testing, UX&UI design, legal, marketing spreading the word etc.
-
-## Get in touch
+We are looking for great minds to extend our core team. Contributions in any area is much appreciated: development, testing, UX&UI design, legal, marketing, spreading the word etc.
 
-Drop us an email: [email protected]
+[Code of Conduct](CODE_OF_CONDUCT.md)
 
-Say hi on our [Discord server](https://discord.gg/PwDmsnu): [![Discord](https://img.shields.io/discord/407574313810788364.svg)](https://discord.gg/PwDmsnu)
+## Get in touch
 
-Talk to us on [Telegram](https://t.me/augmint)
+-   [[email protected]](mailto:[email protected])
+-   [Discord server](https://discord.gg/PwDmsnu) [![Discord](https://img.shields.io/discord/407574313810788364.svg)](https://discord.gg/PwDmsnu)
+-   [Telegram](https://t.me/augmint)
 
 ## Authors
 
-Check the team at [www.augmint.org](https://www.augmint.org)
+See team on [www.augmint.org](https://www.augmint.org)
 
-The project was born at [DECENT Labs](http://www.decent.org)
+<img src="https://github.com/Augmint/augmint-web/raw/staging/src/assets/images/decentlabs.png" alt="Decentlabs" width="60" height="60"> The project was born at [DECENT Labs](http://www.decent.org)
 
 ### Concept, initial version
 
 -   [szerintedmi](https://github.com/szerintedmi)
 -   [Charlie](https://github.com/krosza)
 
-Check the whole team on [augmint.org](http://www.augmint.org)
-
 ## Licence
 
 This project is licensed under the GNU Affero General Public License v3.0 license - see the [LICENSE](LICENSE) file for details.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@augmint/js",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Augmint Javascript Library",
   "keywords": [
     "augmint javascript library A-EUR stablecoin web3 dapp"
@@ -26,24 +26,25 @@
     "yarn": "1.15.2"
   },
   "dependencies": {
-    "@augmint/contracts": "1.0.9",
-    "bignumber.js": "5.0.0",
+    "@augmint/contracts": "1.0.12",
     "bn.js": "4.11.8",
     "dotenv": "8.0.0",
     "ulog": "2.0.0-beta.6",
     "web3": "1.0.0-beta.36"
   },
   "devDependencies": {
+    "@types/bn.js": "4.11.5",
     "@types/node": "^10.14.5",
     "chai": "4.2.0",
     "chai-as-promised": "7.1.1",
+    "chai-exclude": "2.0.1",
     "cross-env": "5.2",
     "eslint": "5.16.0",
     "mocha": "6.1.4",
-    "rollup": "1.11.3",
+    "rollup": "1.12.3",
     "rollup-plugin-node-builtins": "2.1.2",
     "rollup-plugin-node-globals": "1.4.0",
-    "rollup-plugin-typescript2": "0.21.0",
+    "rollup-plugin-typescript2": "0.21.1",
     "sinon": "7.3.2",
     "tslint": "5.16.0",
     "tslint-config-prettier": "1.18.0",
@@ -61,14 +62,12 @@
     "ganache:run": "scripts/augmint-cli.sh ganache run --blockTime 1"
   },
   "greenkeeper": {
-    "ignore": [
-      "bignumber.js"
-    ]
+    "ignore": ["@types/node"]
   },
   "main": "dist/index.js",
   "module": "dist/index.es.js",
   "files": [
     "dist"
   ],
-  "types": "dist/index.d.ts"
-}
+  "types": "dist/src/index.d.ts"
+}

scripts/augmint-cli.sh

@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
-DOCKER_IMAGE=augmint/contracts:v1.0.9
+CONTRACTS_VERSION=`yarn list --pattern @augmint/contracts --depth=0 -s` # output: └─ @augmint/[email protected]
+DOCKER_IMAGE="augmint/contracts:v${CONTRACTS_VERSION##*@}"
 CONTAINER_NAME=ganache
 
 echo ""
@@ -34,7 +35,7 @@ function remove_container_if_image_mismatched {
         echo "  It's likely because of an augmint-js upgrade since last local run of container. Removing existing $CONTAINER_NAME container."
 
         stop_container_if_running
-        
+
         docker rm $CONTAINER_NAME
     fi
 }
@@ -50,7 +51,7 @@ function print_instructions {
 case "$1" in
     ganache )
 
-        ADDITIONAL_GANACHE_LAUNCH_FLAGS=${@:3} 
+        ADDITIONAL_GANACHE_LAUNCH_FLAGS=${@:3}
 
         case "$2" in
             run )
@@ -66,7 +67,7 @@ case "$1" in
                 run_ganache
             ;;
 
-            start )     
+            start )
                 remove_container_if_image_mismatched
 
                 if [ "$(docker ps --quiet -all --filter name=^/$CONTAINER_NAME$)" ]; then
@@ -91,4 +92,4 @@ case "$1" in
     *)
         print_instructions
         ;;
-esac
+esac

src/Augmint.ts

@@ -1,13 +1,20 @@
 import deployments from "../generated/deployments";
-import { AugmintContracts, Exchange as ExchangeInstance, Rates as RatesInstance, TokenAEur } from "../generated/index";
+import {
+    AugmintContracts,
+    Exchange as ExchangeInstance,
+    LoanManager as LoanManagerInstance,
+    Rates as RatesInstance,
+    TokenAEur
+} from "../generated/index";
 import { AugmintToken } from "./AugmintToken";
 import * as constants from "./constants";
 import { DeployedContract, IDeploymentItem } from "./DeployedContract";
 import { DeployedEnvironment, ILatestContracts } from "./DeployedEnvironment";
 import * as Errors from "./Errors";
 import { EthereumConnection, IOptions } from "./EthereumConnection";
-import { Exchange } from "./Exchange";
+import { Exchange, IExchangeOptions } from "./Exchange";
 import * as gas from "./gas";
+import { ILoanManagerOptions, LoanManager } from "./LoanManager";
 import { Rates } from "./Rates";
 import { Transaction } from "./Transaction";
 
@@ -43,6 +50,7 @@ export class Augmint {
     private _token: AugmintToken;
     private _rates: Rates;
     private _exchange: Exchange;
+    private _loanManager: LoanManager;
 
     private constructor(ethereumConnection: EthereumConnection, environment?: DeployedEnvironment) {
         this.ethereumConnection = ethereumConnection;
@@ -88,6 +96,14 @@ export class Augmint {
         return Transaction;
     }
 
+    static get Exchange(): typeof Exchange {
+        return Exchange;
+    }
+  
+    static get LoanManager(): typeof LoanManager {
+        return LoanManager;
+    }
+
     get token(): AugmintToken {
         if (!this._token) {
             const tokenContract: DeployedContract<TokenAEur> = this.deployedEnvironment.getLatestContract(
@@ -103,12 +119,7 @@ export class Augmint {
             const ratesContract: DeployedContract<RatesInstance> = this.deployedEnvironment.getLatestContract(
                 AugmintContracts.Rates
             );
-            this._rates = new Rates(ratesContract.connect(this.web3), {
-                decimals: this.token.decimals,
-                decimalsDiv: this.token.decimalsDiv,
-                constants,
-                ethereumConnection: this.ethereumConnection
-            });
+            this._rates = new Rates(ratesContract.connect(this.web3), this.ethereumConnection);
         }
         return this._rates;
     }
@@ -121,19 +132,41 @@ export class Augmint {
             this._exchange = new Exchange(exchangeContract.connect(this.web3), {
                 token: this.token,
                 rates: this.rates,
-                ONE_ETH_IN_WEI: constants.ONE_ETH_IN_WEI,
                 ethereumConnection: this.ethereumConnection
             });
         }
         return this._exchange;
     }
 
-    public getLegacyTokens(): AugmintToken[] {
-        const legacyTokens: Array<DeployedContract<TokenAEur>> = this.deployedEnvironment.getLegacyContracts(
-            AugmintContracts.TokenAEur
-        );
+    get loanManager(): LoanManager {
+        if (!this._loanManager) {
+            const loanManagerContract: DeployedContract<
+                LoanManagerInstance
+            > = this.deployedEnvironment.getLatestContract(AugmintContracts.LoanManager);
+            this._loanManager = new LoanManager(loanManagerContract.connect(this.web3), {
+                token: this.token,
+                rates: this.rates,
+                ethereumConnection: this.ethereumConnection
+            });
+        }
+        return this._loanManager;
+    }
+
+    public getLegacyTokens(addresses: string[] = []): AugmintToken[] {
+        let legacyTokens: Array<DeployedContract<TokenAEur>> = [];
+
+        if (addresses.length === 0) {
+            legacyTokens = this.deployedEnvironment.getLegacyContracts(AugmintContracts.TokenAEur);
+        } else {
+            legacyTokens = this.deployedEnvironment.getContractFromAddresses(AugmintContracts.TokenAEur, addresses);
+            if (legacyTokens.length !== addresses.length) {
+                throw new Error("legacy contracts length mismatch!");
+            }
+        }
+
         return legacyTokens.map(
-            tokenContract => new AugmintToken(tokenContract.connect(this.web3), { web3: this.web3 })
+            (tokenContract: DeployedContract<TokenAEur>) =>
+                new AugmintToken(tokenContract.connect(this.web3), { web3: this.web3 })
         );
     }
 
@@ -148,15 +181,37 @@ export class Augmint {
                 throw new Error("legacy contracts length mismatch!");
             }
         }
-        const options = {
-            decimalsDiv: this.token.decimalsDiv,
+        const options: IExchangeOptions = {
             token: this.token, // FIXME: This should come from the exchange contract's augmintToken property
             rates: this.rates,
-            ONE_ETH_IN_WEI: constants.ONE_ETH_IN_WEI,
             ethereumConnection: this.ethereumConnection
         };
         return legacyContracts.map(
             (contract: DeployedContract<ExchangeInstance>) => new Exchange(contract.connect(this.web3), options)
         );
     }
+
+    //  augmint.getLegacyLoanManagers(Augmint.constants.SUPPORTED_LEGACY_LOANMANAGERS)
+    public getLegacyLoanManagers(addresses: string[] = []): LoanManager[] {
+        let legacyContracts: Array<DeployedContract<LoanManagerInstance>> = [];
+        if (addresses.length === 0) {
+            legacyContracts = this.deployedEnvironment.getLegacyContracts(AugmintContracts.LoanManager);
+        } else {
+            legacyContracts = this.deployedEnvironment.getContractFromAddresses(
+                AugmintContracts.LoanManager,
+                addresses
+            );
+            if (legacyContracts.length !== addresses.length) {
+                throw new Error("legacy contracts length mismatch!");
+            }
+        }
+        const options: ILoanManagerOptions = {
+            token: this.token, // FIXME: This should come from LoanManager contract's augmintToken property
+            rates: this.rates, // FIXME: This should come from LoanManager contract's rates property
+            ethereumConnection: this.ethereumConnection
+        };
+        return legacyContracts.map(
+            (contract: DeployedContract<LoanManagerInstance>) => new LoanManager(contract.connect(this.web3), options)
+        );
+    }
 }

src/Errors.ts

@@ -17,15 +17,6 @@ export class ZeroRateError extends AugmintJsError {
     }
 }
 
-// tslint:disable-next-line:max-classes-per-file
-export class InvalidPriceError extends AugmintJsError {
-    constructor(message: string) {
-        super(message);
-        this.name = InvalidPriceError.name;
-        Object.setPrototypeOf(this, InvalidPriceError.prototype);
-    }
-}
-
 // tslint:disable-next-line:max-classes-per-file
 export class TransactionError extends AugmintJsError {
     constructor(message: string) {