release version 0.11.4

.openzeppelin/project.json

@@ -7,7 +7,7 @@
   },
   "dependencies": {},
   "name": "org.id",
-  "version": "0.11.3",
+  "version": "0.11.4",
   "publish": true,
   "compiler": {
     "manager": "openzeppelin",

.openzeppelin/rinkeby-OrgId.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.11.4",
+  "contract": {
+    "name": "OrgId",
+    "implementation": "0xec4C42b2f8aF0d180D44E5Db0c2566041a57e4B5",
+    "proxy": "0x78E9C04D751F0a6baeDE7302099b73AB902e1af9"
+  },
+  "owner": "0xA0B74BFE28223c9e08d6DBFa74B5bf4Da763f959",
+  "proxyAdmin": null,
+  "blockNumber": 6080775
+}

.openzeppelin/ropsten-OrgId.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.11.4",
+  "contract": {
+    "name": "OrgId",
+    "implementation": "0xd863861E680B4C881A91fC92C36bAB1d09F8cd3A",
+    "proxy": "0xc8fD300bE7e4613bCa573ad820a6F1f0b915CfcA"
+  },
+  "owner": "0xA0B74BFE28223c9e08d6DBFa74B5bf4Da763f959",
+  "proxyAdmin": null,
+  "blockNumber": 7455603
+}

README.md

@@ -9,6 +9,7 @@ Smart contract of the Winding Tree ORG.ID protocol
 
 ```bash
 npm i
+npm link
 ```
 
 ## Tests
@@ -34,47 +35,96 @@ npm run lint
 ## Generated docs
 [OrgId](./docs/OrgId.md)
 
+## Contracts ABI and addresses
+
+Install the package
+
+```bash
+$ npm i @windingtree/org.id
+```
+
+Import ABIs in the your JavaScript code
+
+```javascript
+const { OrgIdContract, OrgIdInterfaceContract, addresses } = require('@windingtree/org.id');
+```
+
+Addresses of the deployed ORG.ID contract
+
+```javascript
+const { mainnet, ropsten, rinkeby } = addresses;
+```
+
+## ORG.ID Structure
+
+![OrgId Structure](./assets/orgid-structure.png)
+
+OrgId smart contract manages information about organizations and their Lif token deposits. Each organization record inside the contract storage contains following information:
+
+- **orgId**: The organization unique Id. A hash that represents a hex value of the bytes32 string. This identifier can be generated by the organization owner by his own or automatically generated on the smart contract side at the moment of organization record creation. 
+- **orgJsonUri**: Offchain data. URI that points to the Organization JSON file available online. This file has to be created against the [ORG.ID JSON schema](https://github.com/windingtree/org.json-schema) rules.
+- **orgJsonHash**: keccak256 hash of the ORG.ID JSON contents
+- **parentEntity**: The parent organization Id
+- **owner**: The organization owner
+- **director**: The organization director. Only awailable for subsidiaries
+- **state**: State of the organization (enabled or disabled)
+- **directorConfirmed**: Flag is director ownership is confirmed. Director ownership confirmation os required for cases when director address is different from the parent organization owner address.
+- **deposit**: Lif deposit value
+
+Any organization registered at the OrgId smart contract can make a **deposit of Lif tokens**. Staking of this deposit is a part of a trust schema in the ORG.ID protocol. Deposits can be withdrawn but a certain delay is required between the withdraw request and real withdrawal. This delay is managed by the OrgId owner for now (community-managed in the future).
+
 ## Contract deployment
 
-All deployments, upgrades, transactions and calls can be hadled using our [command line tools](./management/tools/README.md): 
+All deployments, upgrades, transactions, calls and complex tasks can be hadled using our [command line tools](./management/tools/README.md): 
 
 ```bash
-$ ./management/tools/index.js --network development cmd=contract name=OrgId initMethod=initialize initArgs=0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1 from=0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1
+$ orgid-tools --network ropsten cmd=deploy name=OrgId from=0xA0B74BFE28223c9e08d6DBFa74B5bf4Da763f959 initMethod=initialize initArgs=0xA0B74BFE28223c9e08d6DBFa74B5bf4Da763f959,0xB6e225194a1C892770c43D4B529841C99b3DA1d7
 ```
 
 The result will look like:
 
 ```bash
-WindingTree Command Line Interface  
-Version:  0.10.0
-Contract name:  OrgId
-Actual version:  0.10.0
-Last known version:  0.10.0
-App address:  0xe78A0F7E598Cc8b0Bb87894B0F60dD2a88d6a8Ab
-Proxy admin:  0xD833215cBcc3f914bD1C9ece3EE7BF8B14f841bb
-Contract implementation:  0x9561C133DD8580860B6b7E504bC5Aa500f0f06a7
-New deployment  
-Contract proxy:  0x59d3631c86BbE35EF041872d502F218A39FBa150
+Deployment of the contract:  OrgId
+Version:  0.11.4
+Owner address:  0xA0B74BFE28223c9e08d6DBFa74B5bf4Da763f959
+Initializing method:  initialize
+Initializing arguments:  [ '0xA0B74BFE28223c9e08d6DBFa74B5bf4Da763f959',
+  '0xB6e225194a1C892770c43D4B529841C99b3DA1d7' ]
+Contract deployed at address:  0xc8fD300bE7e4613bCa573ad820a6F1f0b915CfcA
 ```
 
 Auto-generated deployment configuration will be saved on the `./openzeppelin` repository folder and will look like:
 
 ```json
 {
-  "version": "0.10.0",
+  "version": "0.11.4",
   "contract": {
     "name": "OrgId",
-    "implementation": "0x9561C133DD8580860B6b7E504bC5Aa500f0f06a7",
-    "proxy": "0x59d3631c86BbE35EF041872d502F218A39FBa150"
+    "implementation": "0xd863861E680B4C881A91fC92C36bAB1d09F8cd3A",
+    "proxy": "0xc8fD300bE7e4613bCa573ad820a6F1f0b915CfcA"
   },
-  "owner": "0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1",
-  "app": "0xe78A0F7E598Cc8b0Bb87894B0F60dD2a88d6a8Ab",
-  "proxyAdmin": "0xD833215cBcc3f914bD1C9ece3EE7BF8B14f841bb",
-  "implementationDirectory": "0xCfEB869F69431e42cdB54A4F4f105C19C080A601",
-  "package": "0x5b1869D9A4C187F2EAa108f3062412ecf0526b24",
-  "blockNumber": 9
+  "owner": "0xA0B74BFE28223c9e08d6DBFa74B5bf4Da763f959",
+  "proxyAdmin": null,
+  "blockNumber": 7455603
 }
 ```
 
 The filename of the configuration file is formed according to mask:   
-`./[NETWORK_NAME]-[CONTRACT_NAME].json`
+`./<NETWORK_NAME>-<CONTRACT_NAME>.json`
+
+## Contract upgrade
+
+Upgrading of the contract is pretty similar to the deployment procedure but with a little difference. To be able to make an upgrade a configuration file (that had been created on the previous step) must already exist. So do not remove file with deployment information. In opposite case, the error message will be thrown and you will not be able to upgrade the contract. The second thing is a repository version. This version should be different from the previously deployed.
+
+```bash
+$ orgid-tools --network ropsten cmd=deploy name=OrgId from=0xA0B74BFE28223c9e08d6DBFa74B5bf4Da763f959 initMethod=setInterfaces
+```
+
+The result will look like:
+
+```bash
+Upgrading of the contract:  OrgId
+Version:  0.11.5
+Owner address:  0xA0B74BFE28223c9e08d6DBFa74B5bf4Da763f959
+Initializing method:  setInterfaces
+COntract upgraded at address:  0xc8fD300bE7e4613bCa573ad820a6F1f0b915CfcA

assets/contracts-schema.drawio

@@ -1 +1 @@
-<mxfile modified="2020-02-07T02:50:27.898Z" host="" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/11.2.4 Chrome/76.0.3809.139 Electron/6.0.7 Safari/537.36" etag="ZdpcFA7NbEGprIDQfD22" version="11.2.4" type="device" pages="1"><diagram id="P1KJMvUTy4tlil_FxDQn" name="Page-1">7V3hc6I4FP9rnLn70A4QCPCxtt3du+tOd66729t+uYkSlVskboxt7V9/QYJAgoqKgNVOZ2oeIcJ7v/fLy8uDdsD1+PUjRZPRZ+LhoGNo3msH3HQMQzcNoxP9at48ljimFQuG1PdEp1Tw4L9hIdSEdOZ7eJrryAgJmD/JC/skDHGf5WSIUvKS7zYgQf5bJ2iIFcFDHwWq9NH32EhIdeimBz5hfzgSX+0YdnxgjJLO4k6mI+SRl4wI3HbANSWExZ/Gr9c4iJSX6CU+78OKo8sLozhkZU746+rX8Mn942I47t59u3q7Gd3+erzQTXFxbJ7cMfa4AkSTUDYiQxKi4DaVdimZhR6OhtV4K+1zR8iEC3Uu/A8zNhfWRDNGuGjExoE4il999k90+qUlWj/EYNHnm9dsY540QkbnmZOi5o9kvKiRnrZoJedNGaLsKkICF9z+PUahdx/i5MAHPwiWp3lptzdMyVfyGYXz+IjoF31ZrLBISysNIURTMqN90ct9ur9x7nw6x9+f+h9f5t7b8+AiATSiQ8zWWWkJF+5nmIwxv0F+HsUBYv5z/jqQAPxw2U+cym8OzTMdJsQP2TQz8pdIwDsI3wWmQLLwXNOV8CX1N3R3XX/+Ib6CpJW5lVS0wOwW+DXO+G0Xfgv7wWPAr2lpB8XvOg0+o2Am1HBPhyj037hiSKhgO0VuZMmXkc/wwwQtbPTC5988Sgfc5tckIHRxLvAQdgb9BXAo+YkzR2Dfwb3BEhoFSHjGlOHXjEg1ZsICDry0cnq0wFLykplBk2lxlJk8obYaAxk7bK9mQ1XzYHA9Qn4YhSaIIZVFgoCHGAs/G6FJJOwHZOZtrfXBYGD0C7XuwR60YEVaB7akdWi4ZbXuHErrQNG6quaUtPoBmk79vsS0KWuaWdbULjfx5qL1BVOf3wumQnh4qjMK6VU1XMYoVoFNEtl2FKnOyYo3Qn0pSYaJ712cuYYgAVBcGyqDxQpSBquKL00FUpH3fqN+x4AB1123R/mnIVvaOoM17kssjy6Kp5xpe4sOETzElMJ7W92OdcMlKPCHYQRODpgIRd3IJ32+PLgSB8a+5y2CigD1cNBF/Z/DBUnnKYD/FKJvrdvI3r9c5Igr7mTXEUWscKFdAkd3ciZLALonsC40CQqODAQyGEzxQTBgKRj4RBgObnzKdUMEb1U2a1rY8cwi/naMHoBV8beW16YO3IZnTKjOmAwds4qBq7VMxXbB9BiT2HSCwpx+4a9ZlCaIFXsxjTV7xbuEhI5RkHZIyO/Kp4Ef4ozB4pH5hcaDr+DI9tvRstvmKo7qKscdw5utjOFdVc3vKoa3zDxBtSGCT7KwFYXw0MilPrRLo94gXnjqxiBeQK0lQbzqjnsE8VYLgnhdzXq8vyh+6TrnMH6FghyVShpL3S5bK5K3vCHTUMpreU6zNnDa7vSlWyX5Sy/JX6XRs98koi7Y7l9CTEs4ezJvz8bBVRTHZlz3LvLUL2TqL4IscNMjjJFxOReW3Z8RKQAgMxaFz9fLTcW1httmnSfn6YojK1BrclRT9F6HIybuo2/nPtU58B6O6JZ0RKddjlgQQp+oI0JoNOqIbNTtPv1JtX+n2sOd/2r2Xed7MqfX64cH2l/c4FaF97/VdmITXlV41eBstVJWs1tltWbqBkoao7R1D281q1VWUxeOj37o+eGQC79SjPmf2yhamCyXrlVl3gZOHxfngHqOFZUOHCRJnaSE6ki6FVceuY34yenV16yu+yrrpHXX18j1XgZ0snBT+0NrXf8D1Yc1Mjuf8bsdfhupD9sWv3J9WC343VQfJi/cfpvOelPf8xGd/17p/Id1z8J20fznQhugdA+kIN+pQGfl/KdbeZsAvekJsKHkyJlAYu23mUCADdpPIMZpEQjQ8zZpAYHoihrPBFIbgYA2E4hl5CvUW0kgahHvuyYQE+Zt0gICaSQtfCaQWPtmSQKxmyAQ6OgSIax/xAUCeQlewyNaasn2uyYQaORt0jyBqNvvSVmoot4WbvPtt540zbwxbKgY41BbfIW2UMuqT8YWQNPaZQu1/vpkbGFC0C5bqDXUJ2MLqDntsoVaJaIGoJtqfg9QZXdpbBVUVhgDFpTdbfOYfj1Vwroh1bOYTn6IshXCuvSAhelKA1VXHVysRTXnfeL4gyXxZzSJPyCtLUxjR/wBJz8QsGvGn5oybQn+svDTLvmiZQME1zw9UQku7ZK4BE3i0tIqwqVlNYxLdR3XElw2xYsFj/OszkA0hT8owcYEO+LPloAMnJrxB1W41Vgm3nROcZeE6G5Y3+tVUStigH0fQZODS21HEPO7k0CslQLxoV/+I+/l1vLyKt1uxKNOL7Nf9mHQbaKXfcNlaZ/JsuwdPQpIHuUexqMs2aOc9ZuV8uam1P9AHtWmZwrPHrVdPLavR9mSR8FdPcqUXmSotcOj5N2+WjzKKHh4c/naBXnrrum3MAxIyISX6lXtIMlVoqYYIrN6cIpWD+Zq/O5XDlDwZp5TMoghpSebN4i6j3RSBrGkPdbmDVLwQp5TMoit6S0zSAU7SrKe0pjLtPO5LNc098hm5XOsRrmXOVRT63wk20z5XXxbXsCX32aSBgLloqzK6horeLXRGlDqIAdKx3GPE5RHsff0fkBZwd7nalA6eUjuDki9QUAexabT+wGkcQbkBkAexS7UEQCSN9N/hhJ3T/+lDLj9Hw==</diagram></mxfile>
+<mxfile modified="2020-03-04T21:26:49.089Z" host="" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/11.2.4 Chrome/76.0.3809.139 Electron/6.0.7 Safari/537.36" etag="q1pkCbJOq9vX_8VheS-6" pages="1" version="11.2.4" type="device"><diagram id="P1KJMvUTy4tlil_FxDQn" name="Page-1">7Vxbd9o4EP41OWf3IT3Y8o3H3NptT7rpbvbstn3ZI2wB2hqLyiJAfv3KWL5JIjhggwnkJdZIGluab0Yzw9gX4Gay+EDhdPyZBCi8MHvB4gLcXpimYfRM/i+hLFOKZ1opYURxIAYVhEf8jASxJ6gzHKC4MpAREjI8rRJ9EkXIZxUapJTMq8OGJKzedQpHSCE8+jBUqf/ggI2zdTn9ouM3hEdjlq3PTTsmMBssVhKPYUDmJRK4uwA3lBCWXk0WNyhMNi/bl3Te+zW9+YNRFLE6E/71v42x//OP/sffx79/moPHa/zp0hHPxpbZglHA1y+ahLIxGZEIhncF9ZqSWRSghGuPt4ox94RMOdHgxP8QY0shTDhjhJPGbBKKXrTA7Gsy/Z0tWt8qrduF4L1qLEuNL4jiCWKIZrSI0eXXcqPEKWkWrFatjFe66mSpazdTkGIyo74Y1f/+cOvdY7pEf3/3P8yXwfPT8NIQQGCQjhB7YavNXOZcWRDhy6BLPo+iEDL8VH0QKFA7yscVguUXQrZ6Ob/4lE8wnIlbPcwjvo+mE/KHvh4kVyOWb00JEBy30+RyNgmvfEb41l8/Icow15F7OEDhFxJjhknEhwwIY2TCB4RJxzX0f4xWYLkhYTKPcwPD1V+Jx1WIR8lcloCnjBIyYyGO0E2u2IXgNHJK2KFFiaTutOg1HaGhwiKBnlDQeaHfQJDGJc12ervLRgsMQxFNLpVCKClhSPiyy9Jxfs5I1nEZrxTuig8wnOmi6My4PNDRxyBjxR815Va9Aycrdy3AMZuOKAwQHPDbK53xBFKWmmJGIReZjKTCcCTynY8xQ49TuNKuOT89quIf4jAs48bzke8nd2GU/EClnoFnW3aBDQUIGrisxYYtYcNWoWGY+8SG1x37nPWssc65JS6M77eK7dVb4pjbTXaVHNSccPfnBEbBQ4Syjvc42S4xLSiGPSNK/iKfYbRMe8Q4Y2vTvt5i17DsYE+WXXvzfncQ0tsKIcbrEFIRfRkkhgySAksFQrY//HdCyBqrUxshq6l8ZXBZGjAlOGJxifOXhFAYM9CvGjPDkRxEabxjvjieX6RPUGA1X8r28DVVv4SOYISf4cqnaPIICSDyhtojxPE9NBg2c4QAsNm92O8ZAjZssXyO/xLPBjEOMKTLXxsVADICG7k6AfQdF0CnHQHYxqEF4HbIRHc+yNLuoH0MJ7Gt6NktpmgVMh1BTLWTzskxlU7n9htT9ZQ9P2Wd26hgRpZb2+jJgNrY2I/WGWr4fMSZjZ200Op3LbNhdkcLjzt83azAoK4CW11T4E3+6dGFAHIW6fAhQCb0U4kBlDzewWMAw+6OKTwKh8Q5WnvmnG4cIHsgh48DzrH369TOq6l2mfHsjtp55zhATHBrpCD3q4Ud+pHijccBmV5uVuD6sNqPAmdP/nbiAK/XtTjA1CRL3nIcIEvg8HGA2aGUyDE4JGbdvEb37Jma1ziZOED2QA4eB2RVp51Qu608kGMuk6ifnNxRYfWFDZZ0CuTFxRmLdAFiVoE0tUJCYpQfHRmjdIEKo8aKJbqURDo5FNd2rVtCsSGhWAZfbRRLjAxQD8WvrT/ynCOoPwKqP9agwngVb8t7WWVe4W2Zm9ytih5FZFMo6ocwjrFfNwrdSnvqJnTNgzptavL2YTi8GUOsCY4CyKBqkMMQT+PVfgunzg/JLHh1gMQ9OFNf8Bw4A8dOAqSkfluA0GiqkMMyq0Ym04+S4+ZpHDfbaksg7mkLxHK7JhBNnvWUBOIaXROI5tWeUxKIbLIszUsbexUI0CQyT0kgssk6vEA0Wc9TEohssg4vEKDs8NnpbsXpFt5TzbLOxmNWkBVDZIelZ78ze6U/u8qxbggLLOmXFVNi1HIiBqjpxDOAWwHw6+oRmgewKQG43xCAbQnAYM8AVjOJZwC3AuC6nwdoyQCDKn6B3RB+5RLX/p7xq3644ozfNvALaie9rXYAbEkAdhoCsFsFsCUzahvAamHiGcCtALjum007VwusO+klALsNAdiTAGzsGcBqHlBBdB4sL0PMoU03x8uDVAfuBzkhL3B4SGsVKgjZLSzOnjg3ARdyVOxoomKrrRoFoCbyjnxH+wfeUUvNxCk7WrJGwl5pLKpRsafmhrKpw78vXdfmpUqsyrMkMFuXGBK0HU2j48r1kduZQlf64fhyz2UZlu4LTrvDzH07MOt3CWaG1xDO6hZONIYzU8FZuXo3VkDHLTmrIq2adxZILCepBQmKisEQDRMOciHhBAfBqrhId/hU/dgmjpV+9VjRpa9tFT6yFWjuWFErO+/xkBMCNE0KNU9GEIamoL0hSfBm8WnMVIGKD4yCu/8B</diagram></mxfile>

management/build-index.js

@@ -2,24 +2,43 @@ const fs = require('fs');
 const path = require('path');
 
 const BASE_PATH = 'build/contracts';
+const DEPLOYMENTS_PATH = '.openzeppelin';
 const CONTRACTS_DIR = path.resolve(__dirname, `../${BASE_PATH}`);
+const DEPLOYMENTS_DIR = path.resolve(__dirname, `../${DEPLOYMENTS_PATH}`);
 const bundle = [
     'OrgId.json',
     'OrgIdInterface.json'
 ];
+const deploymentsInfo = [
+    'mainnet-OrgId.json',
+    'ropsten-OrgId.json',
+    'rinkeby-OrgId.json'
+];
 const files = fs.readdirSync(CONTRACTS_DIR);
+const deploymentsFiles = fs.readdirSync(DEPLOYMENTS_DIR);
 const bundleRegex = new RegExp(bundle.join('|'));
+const deploymentsRegex = new RegExp(deploymentsInfo.join('|'));
 const importStatements = [];
 const exportStatements = [];
 
 files
-    .filter((f) => f.match(bundleRegex))
-    .map((f) => {
+    .filter(f => f.match(bundleRegex))
+    .map(f => {
         const name = f.split('.')[0];
         importStatements.push(`const ${name}Contract = require('./${BASE_PATH}/${f}');`);
         exportStatements.push(`    ${name}Contract: ${name}Contract,`);
     });
 
+const addresses = [];
+deploymentsFiles
+    .filter(f => f.match(deploymentsRegex))
+    .map(f => {
+        const network = f.split('-')[0];
+        importStatements.push(`const ${network}Config = require('./${DEPLOYMENTS_PATH}/${f}');`);
+        addresses.push(`        ${network}: ${network}Config.contract.proxy,`);
+    });
+exportStatements.push(`    addresses: {\n${addresses.join('\n')}\n    }`);
+
 const result = `
 ${importStatements.join('\n')}
 

management/tools/commands/upgrade.js

@@ -128,7 +128,7 @@ module.exports = async (options) => {
             }
         ));
 
-    log('Proxy upgraded at address', proxy.address);
+    log('COntract upgraded at address', proxy.address);
 
     // Creation of the deployment configuration file
     deploymentConfig.version = packageJson.version;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@windingtree/org.id",
-  "version": "0.11.3",
+  "version": "0.11.4",
   "description": "ORG.ID smart contract",
   "directories": {
     "test": "test",