feat: new demand creation view and asset types integration (#14)

- Redesign demand creation UI
- Use formik, formik-material-ui, yup for composing forms with validation
- Use react-select for autocomplete multi-select component
- Backend for storing and matching multiple asset types from IREC registry
- `build:ts` for fast compile for the whole project
- standardized `id` type as "numeric" string

Author: e00dan

package.json

@@ -30,6 +30,7 @@
         "clean": "lerna run clean --parallel",
         "build:user-asset-registry-origin": "lerna run build --scope @energyweb/user-registry build --scope @energyweb/asset-registry build --scope @energyweb/origin --parallel",
         "build:static": "lerna run build:static --parallel",
+        "build:ts": "lerna run build-ts --stream",
         "run:demo": "lerna run start --scope @energyweb/utils-demo --stream",
         "run:backend": "lerna run start --scope @energyweb/utils-testbackend --stream",
         "run:ui": "lerna run start --scope @energyweb/origin-ui --stream",

packages/asset-registry/package.json

@@ -25,7 +25,7 @@
   },
   "scripts": {
     "build": "yarn compile && yarn build-schemas && yarn build-ts",
-    "build-and-deploy": "npm run build && npm run deploy-contracts",
+    "build-and-deploy": "yarn build && yarn deploy-contracts",
     "build-schema:AssetPropertiesOffChain": "typescript-json-schema --ignoreErrors --required src/blockchain-facade/Asset.ts IOffChainProperties",
     "build-schema:ProducingAssetPropertiesOffChain": "typescript-json-schema --ignoreErrors --required src/blockchain-facade/ProducingAsset.ts IOffChainProperties",
     "build-schemas": "./scripts/buildSchemas.js",

packages/asset-registry/src/blockchain-facade/ProducingAsset.ts

@@ -13,37 +13,22 @@
 // GNU General Public License for more details, at <http://www.gnu.org/licenses/>.
 //
 // @authors: slock.it GmbH; Heiko Burkhardt, heiko.burkhardt@slock.it; Martin Kuechler, martin.kuchler@slock.it
+import { Compliance, Configuration } from '@energyweb/utils-general';
+import moment from 'moment';
+import { TransactionReceipt } from 'web3/types';
 
-import { Configuration } from '@energyweb/utils-general';
-import * as Asset from './Asset';
 import { ProducingAssetPropertiesOffchainSchema } from '..';
-import { TransactionReceipt } from 'web3/types';
-import moment from 'moment';
 import { AssetProducingRegistryLogic } from '../wrappedContracts/AssetProducingRegistryLogic';
+import * as Asset from './Asset';
 
-/**
- * TODO: in generalLib
- */
-export enum Type {
-    Wind,
-    Solar,
-    RunRiverHydro,
-    BiomassGas
-}
 
-export enum Compliance {
-    none,
-    IREC,
-    EEC,
-    TIGR
-}
 
 export interface IOnChainProperties extends Asset.IOnChainProperties {
     maxOwnerChanges?: number;
 }
 
 export interface IOffChainProperties extends Asset.IOffChainProperties {
-    assetType: Type;
+    assetType: string;
     complianceRegistry: Compliance;
     otherGreenAttributes: string;
     typeOfPublicSupport: string;

packages/asset-registry/src/test/AssetProducingFacade.ts

@@ -1,35 +1,20 @@
-// Copyright 2018 Energy Web Foundation
-// This file is part of the Origin Application brought to you by the Energy Web Foundation,
-// a global non-profit organization focused on accelerating blockchain technology across the energy sector,
-// incorporated in Zug, Switzerland.
-//
-// The Origin Application is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-// This is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY and without an implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details, at <http://www.gnu.org/licenses/>.
-//
-// @authors: slock.it GmbH; Heiko Burkhardt, heiko.burkhardt@slock.it; Martin Kuechler, martin.kuchler@slock.it
-
-import { assert } from 'chai';
-import * as fs from 'fs';
-import Web3 from 'web3';
 import 'mocha';
-import { Configuration } from '@energyweb/utils-general';
-import { logger } from '../Logger';
+
 import {
-    UserContractLookup,
-    UserLogic,
-    migrateUserRegistryContracts,
     buildRights,
-    Role
+    migrateUserRegistryContracts,
+    Role,
+    UserContractLookup,
+    UserLogic
 } from '@energyweb/user-registry';
-import { migrateAssetRegistryContracts, AssetProducingRegistryLogic } from '..';
-import { ProducingAsset } from '..';
+import { Configuration, Compliance } from '@energyweb/utils-general';
+import { assert } from 'chai';
+import * as fs from 'fs';
 import moment from 'moment';
+import Web3 from 'web3';
+
+import { AssetProducingRegistryLogic, migrateAssetRegistryContracts, ProducingAsset } from '..';
+import { logger } from '../Logger';
 
 describe('AssetProducing Facade', () => {
     const configFile = JSON.parse(
@@ -50,13 +35,6 @@ describe('AssetProducing Facade', () => {
     let assetProducingLogic: AssetProducingRegistryLogic;
     let userLogic: UserLogic;
 
-    /*
-    let assetContractLookup: AssetContractLookup;
-    let assetProducingLogic: AssetProducingRegistryLogic;
-    let assetProducingDB: AssetProducingDB;
-    let assetConsumingDB: AssetConsumingDB;
-    */
-
     const assetOwnerPK = '0xfaab95e72c3ac39f7c060125d9eca3558758bb248d1a4cdc9c1b7fd3f91a4485';
     const assetOwnerAddress = web3.eth.accounts.privateKeyToAccount(assetOwnerPK).address;
 
@@ -162,8 +140,8 @@ describe('AssetProducing Facade', () => {
             houseNumber: '42',
             gpsLatitude: '0.0123123',
             gpsLongitude: '31.1231',
-            assetType: ProducingAsset.Type.Wind,
-            complianceRegistry: ProducingAsset.Compliance.EEC,
+            assetType: 'Wind',
+            complianceRegistry: Compliance.EEC,
             otherGreenAttributes: '',
             typeOfPublicSupport: '',
             facilityName: FACILITY_NAME
@@ -219,8 +197,8 @@ describe('AssetProducing Facade', () => {
             houseNumber: '42',
             gpsLatitude: '0.0123123',
             gpsLongitude: '31.1231',
-            assetType: ProducingAsset.Type.Wind,
-            complianceRegistry: ProducingAsset.Compliance.EEC,
+            assetType: 'Wind',
+            complianceRegistry: Compliance.EEC,
             otherGreenAttributes: '',
             typeOfPublicSupport: '',
             facilityName: 'Wuthering Heights Windfarm'
@@ -229,14 +207,14 @@ describe('AssetProducing Facade', () => {
         assert.equal(await ProducingAsset.getAssetListLength(conf), 1);
 
         try {
-            const asset = await ProducingAsset.createAsset(assetProps, assetPropsOffChain, conf);
+            await ProducingAsset.createAsset(assetProps, assetPropsOffChain, conf);
         } catch (ex) {
             assert.include(ex.message, 'smartmeter does already exist');
         }
         assert.equal(await ProducingAsset.getAssetListLength(conf), 1);
     });
 
-    it('should log a new meterreading', async () => {
+    it('should log a new meter reading', async () => {
         conf.blockchainProperties.activeUser = {
             address: assetSmartmeter,
             privateKey: assetSmartmeterPK
@@ -274,8 +252,8 @@ describe('AssetProducing Facade', () => {
                 houseNumber: '42',
                 gpsLatitude: '0.0123123',
                 gpsLongitude: '31.1231',
-                assetType: 0,
-                complianceRegistry: 2,
+                assetType: 'Wind',
+                complianceRegistry: Compliance.EEC,
                 otherGreenAttributes: '',
                 typeOfPublicSupport: '',
                 facilityName: 'Wuthering Heights Windfarm'
@@ -285,8 +263,7 @@ describe('AssetProducing Facade', () => {
 
     describe('getSmartMeterReads', () => {
         it('should correctly return reads', async () => {
-            let asset = await new ProducingAsset.Entity('0', conf).sync();
-
+            const asset = await new ProducingAsset.Entity('0', conf).sync();
             const reads = await asset.getSmartMeterReads();
 
             assert.deepEqual(reads, [

packages/asset-registry/src/test/AssetProducingLogic.ts

@@ -13,32 +13,33 @@
 // GNU General Public License for more details, at <http://www.gnu.org/licenses/>.
 //
 // @authors: slock.it GmbH; Martin Kuechler, martin.kuchler@slock.it; Heiko Burkhardt, heiko.burkhardt@slock.it
-
-import { assert } from 'chai';
-import * as fs from 'fs';
 import 'mocha';
-import Web3 from 'web3';
+
 import {
-    UserContractLookup,
-    UserLogic,
-    migrateUserRegistryContracts,
     buildRights,
-    Role
+    migrateUserRegistryContracts,
+    Role,
+    UserContractLookup,
+    UserLogic
 } from '@energyweb/user-registry';
-import { migrateAssetRegistryContracts } from '../utils/migrateContracts';
-import { AssetContractLookup } from '../wrappedContracts/AssetContractLookup';
-import { AssetConsumingRegistryLogic } from '../wrappedContracts/AssetConsumingRegistryLogic';
-import { AssetProducingRegistryLogic } from '../wrappedContracts/AssetProducingRegistryLogic';
-import { AssetConsumingDB } from '../wrappedContracts/AssetConsumingDB';
-import { AssetProducingDB } from '../wrappedContracts/AssetProducingDB';
+import { assert } from 'chai';
+import * as fs from 'fs';
+import moment from 'moment';
+import Web3 from 'web3';
+
 import {
-    AssetContractLookupJSON,
     AssetConsumingDBJSON,
     AssetConsumingRegistryLogicJSON,
+    AssetContractLookupJSON,
     AssetProducingDBJSON,
     AssetProducingRegistryLogicJSON
 } from '..';
-import moment from 'moment';
+import { migrateAssetRegistryContracts } from '../utils/migrateContracts';
+import { AssetConsumingDB } from '../wrappedContracts/AssetConsumingDB';
+import { AssetConsumingRegistryLogic } from '../wrappedContracts/AssetConsumingRegistryLogic';
+import { AssetContractLookup } from '../wrappedContracts/AssetContractLookup';
+import { AssetProducingDB } from '../wrappedContracts/AssetProducingDB';
+import { AssetProducingRegistryLogic } from '../wrappedContracts/AssetProducingRegistryLogic';
 
 describe('AssetProducingLogic', () => {
     const configFile = JSON.parse(
@@ -139,8 +140,6 @@ describe('AssetProducingLogic', () => {
 
             const deployedBytecode = await web3.eth.getCode(deployedContracts[key]);
             assert.isTrue(deployedBytecode.length > 0);
-
-            // const tempBytecode = contractInfo.deployedBytecode;
             assert.equal(deployedBytecode, tempBytecode);
         });
     });
@@ -210,10 +209,6 @@ describe('AssetProducingLogic', () => {
     });
 
     it('should onboard tests-users', async () => {
-        const userLogicAddress = await userContractLookup.userRegistry();
-
-        //  userLogic = new UserLogic(web3, userLogicAddress);
-
         await userLogic.createUser(
             'propertiesDocumentHash',
             'documentDBURL',
@@ -230,34 +225,10 @@ describe('AssetProducingLogic', () => {
         );
     });
 
-    it('should not deploy an asset as user', async () => {
-        let failed = false;
-        try {
-            await assetProducingLogic.createAsset(
-                assetSmartmeter,
-                assetOwnerAddress,
-                true,
-                [matcher] as any,
-                'propertiesDocumentHash',
-                'url',
-                2,
-                {
-                    privateKey: '0x191c4b074672d9eda0ce576cfac79e44e320ffef5e3aadd55e000de57341d36c'
-                }
-            );
-        } catch (ex) {
-            failed = true;
-            assert.include(ex.message, 'user does not have the required role');
-        }
-        assert.isTrue(failed);
-    });
-
     it('should return empty asset when smart meter is not onboarded yet', async () => {
         const deployedAsset = await assetProducingLogic.getAssetBySmartMeter(assetSmartmeter);
 
-        // all the properties are in 1 struct
         assert.equal(deployedAsset.length, 2);
-        // checking the number of properties in assetGeneral
         assert.equal(deployedAsset.assetGeneral.length, 10);
 
         const ag = deployedAsset.assetGeneral;
@@ -274,7 +245,7 @@ describe('AssetProducingLogic', () => {
         assert.isFalse(ag.bundled);
     });
 
-    it('should throw when trying to access a non exsting AssetGeneral-Struct', async () => {
+    it('should throw when trying to access a non existing AssetGeneral-Struct', async () => {
         let failed = false;
         try {
             await assetProducingLogic.getAssetGeneral(0);
@@ -340,7 +311,7 @@ describe('AssetProducingLogic', () => {
         assert.isFalse(ag.bundled);
     });
 
-    it('should return asset by smartmeter correctly', async () => {
+    it('should return asset by smart meter correctly', async () => {
         const deployedAsset = await assetProducingLogic.getAssetBySmartMeter(assetSmartmeter);
 
         assert.equal(deployedAsset.length, 2);
@@ -377,7 +348,7 @@ describe('AssetProducingLogic', () => {
         assert.isFalse(ag.bundled);
     });
 
-    it('should fail when trying to log with saveSmartMeterRead using the wrong smartmeter', async () => {
+    it('should fail when trying to log with saveSmartMeterRead using the wrong smart meter', async () => {
         let failed = false;
 
         try {
@@ -421,7 +392,7 @@ describe('AssetProducingLogic', () => {
         });
     });
 
-    it('should fail when trying to log with saveSmartMeterRead and a too low meterreading', async () => {
+    it('should fail when trying to log with saveSmartMeterRead and a too low meter reading', async () => {
         let failed = false;
 
         try {
@@ -466,7 +437,7 @@ describe('AssetProducingLogic', () => {
         });
     });
 
-    it('should fail when trying to deactive an asset as non-manager', async () => {
+    it('should fail when trying to deactivate an asset as non-manager', async () => {
         let failed = false;
 
         try {
@@ -481,7 +452,7 @@ describe('AssetProducingLogic', () => {
         assert.isTrue(failed);
     });
 
-    it('should be able to deactive an asset', async () => {
+    it('should be able to deactivate an asset', async () => {
         const tx = await assetProducingLogic.setActive(0, false, {
             privateKey: privateKeyDeployment
         });
@@ -535,7 +506,7 @@ describe('AssetProducingLogic', () => {
         assert.isTrue(failed);
     });
 
-    it('should be able to deactive an asset', async () => {
+    it('should be able to deactivate an asset', async () => {
         const tx = await assetProducingLogic.setActive(0, true, {
             privateKey: privateKeyDeployment
         });
@@ -1183,7 +1154,7 @@ describe('AssetProducingLogic', () => {
         assert.isTrue(ag.bundled);
     });
 
-    it('should return the correct latest hashes + meterreadings', async () => {
+    it('should return the correct latest hashes + meter readings', async () => {
         assert.deepEqual(await assetProducingLogic.getLastMeterReadingAndHash(0), {
             0: '200',
             1: 'lastSmartMeterReadFileHash#2',
@@ -1198,7 +1169,7 @@ describe('AssetProducingLogic', () => {
             _lastSmartMeterReadFileHash: ''
         });
 
-        it('should fail when trying to return latest hash + meterreading of a non existing asset', async () => {
+        it('should fail when trying to return latest hash + meter reading of a non existing asset', async () => {
             let failed = false;
 
             try {

packages/event-listener/test/helpers/deployDemo.ts

@@ -6,7 +6,7 @@ import { AssetConsumingRegistryLogic, AssetProducingRegistryLogic, migrateAssetR
 import { MarketLogic, migrateMarketRegistryContracts } from '@energyweb/market';
 import { CertificateLogic, migrateCertificateRegistryContracts } from '@energyweb/origin';
 import { buildRights, migrateUserRegistryContracts, Role, User, UserLogic } from '@energyweb/user-registry';
-import { Configuration } from '@energyweb/utils-general';
+import { Configuration, Compliance } from '@energyweb/utils-general';
 
 export const deployDemo = async () => {
     const connectionConfig = {
@@ -166,8 +166,8 @@ export const deployDemo = async () => {
     };
 
     const assetProducingPropsOffChain: ProducingAsset.IOffChainProperties = {
-        assetType: ProducingAsset.Type.Wind,
-        complianceRegistry: ProducingAsset.Compliance.IREC,
+        assetType: 'Wind',
+        complianceRegistry: Compliance.IREC,
         facilityName: 'Wuthering Heights Windfarm',
         capacityWh: 0,
         city: 'Warsaw',

packages/market-matcher/README.md

@@ -7,9 +7,5 @@ A matcher automates buying and selling certificates on the Origin platform.
 Update the config file in [example-conf/production-conf.json](example-conf/production-conf.json)
 - Make sure that `marketContractLookupAddress` and `originContractLookupAddress` match your deployed Origin contracts
 
-### Install
-Install the dependencies for the Matcher.
-- `npm install`
-
 ### Run
 - `npm start example-conf/production-conf.json`