From d1e49129bd6551d955e0d3b9c4898edfb97f75fa Mon Sep 17 00:00:00 2001 From: Eric Jiang Date: Tue, 26 Mar 2019 11:20:37 -0400 Subject: [PATCH] chore(release): 0.24.1 :tada: --- CHANGELOG.md | 141 ++++----- docs/CLI-README.md | 713 ++++++++++++++++++++++++++++++++++++++++++++- package.json | 2 +- 3 files changed, 785 insertions(+), 71 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c3b9f4..67a791c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,22 @@ -# [0.24.0](https://github.com/AraBlocks/ara-contracts/compare/0.20.0...0.24.0) (2019-03-13) +## [0.24.1](https://github.com/AraBlocks/ara-contracts/compare/0.20.0...0.24.1) (2019-03-26) ### Bug Fixes +* lint ([4c0feb4](https://github.com/AraBlocks/ara-contracts/commit/4c0feb4)) * undo something ([85f265e](https://github.com/AraBlocks/ara-contracts/commit/85f265e)) * use safemath ([c2bbaa4](https://github.com/AraBlocks/ara-contracts/commit/c2bbaa4)) -* **): lint; add(:** standard estimate proxy did ([93d5656](https://github.com/AraBlocks/ara-contracts/commit/93d5656)) +* wording ([f3b747c](https://github.com/AraBlocks/ara-contracts/commit/f3b747c)) +* **): lint; add(:** standard estimate proxy did ([8fc0f29](https://github.com/AraBlocks/ara-contracts/commit/8fc0f29)) ### Features +* allow token transfer and balance with Etheruem address ([ef954d3](https://github.com/AraBlocks/ara-contracts/commit/ef954d3)) * consolidate proxy usage to AraProxy ([f0da598](https://github.com/AraBlocks/ara-contracts/commit/f0da598)) -* dynamically determine standard compile label ([e3756eb](https://github.com/AraBlocks/ara-contracts/commit/e3756eb)) +* dynamically determine standard compile label ([1ca775c](https://github.com/AraBlocks/ara-contracts/commit/1ca775c)) * refactor out AraRegistry dependency in AraProxy ([4c3cdfa](https://github.com/AraBlocks/ara-contracts/commit/4c3cdfa)) -* support estimate standard ([a0bb2fd](https://github.com/AraBlocks/ara-contracts/commit/a0bb2fd)) +* support estimate standard ([e0e4ce4](https://github.com/AraBlocks/ara-contracts/commit/e0e4ce4)) * update Library contract to use uint32, redeploy to privatenet ([6321541](https://github.com/AraBlocks/ara-contracts/commit/6321541)) @@ -40,9 +43,9 @@ * forgot a conflicts ([304cfd2](https://github.com/AraBlocks/ara-contracts/commit/304cfd2)) * forgot pk in constants, added new fixture ([c2de479](https://github.com/AraBlocks/ara-contracts/commit/c2de479)) * lint ([3a60e5a](https://github.com/AraBlocks/ara-contracts/commit/3a60e5a)) -* lint ([877af7c](https://github.com/AraBlocks/ara-contracts/commit/877af7c)) * lint ([f679e80](https://github.com/AraBlocks/ara-contracts/commit/f679e80)) * lint ([d06602f](https://github.com/AraBlocks/ara-contracts/commit/d06602f)) +* lint ([877af7c](https://github.com/AraBlocks/ara-contracts/commit/877af7c)) * more password bug fixes ([cf1cbcc](https://github.com/AraBlocks/ara-contracts/commit/cf1cbcc)) * or not... ([a31a27a](https://github.com/AraBlocks/ara-contracts/commit/a31a27a)) * PR comments, cleanup tests ([c5aa884](https://github.com/AraBlocks/ara-contracts/commit/c5aa884)) @@ -76,6 +79,9 @@ ### Bug Fixes +* **build/*:** revert ABIs ([840cf83](https://github.com/AraBlocks/ara-contracts/commit/840cf83)) +* **scripts/test:** downgrade solc compiler for truffle ([fc762f0](https://github.com/AraBlocks/ara-contracts/commit/fc762f0)) +* **storage.js:** remove comment ([7302568](https://github.com/AraBlocks/ara-contracts/commit/7302568)) * 134 ([941d25e](https://github.com/AraBlocks/ara-contracts/commit/941d25e)) * add help(false) back ([2fa8a34](https://github.com/AraBlocks/ara-contracts/commit/2fa8a34)) * add jobID tohex ([f9ec4e2](https://github.com/AraBlocks/ara-contracts/commit/f9ec4e2)) @@ -84,70 +90,67 @@ * address PR comments ([5505832](https://github.com/AraBlocks/ara-contracts/commit/5505832)) * check the correct value ([c6a42d9](https://github.com/AraBlocks/ara-contracts/commit/c6a42d9)) * constants ([a26bed8](https://github.com/AraBlocks/ara-contracts/commit/a26bed8)) -* **.npmignore:** revert bin/ and lib/ in npmignore ([392288e](https://github.com/AraBlocks/ara-contracts/commit/392288e)) * deploy standard during migration ([acefd34](https://github.com/AraBlocks/ara-contracts/commit/acefd34)) * increase timeout ([b09e898](https://github.com/AraBlocks/ara-contracts/commit/b09e898)) * issue [#85](https://github.com/AraBlocks/ara-contracts/issues/85) ([614ec5d](https://github.com/AraBlocks/ara-contracts/commit/614ec5d)) -* **.npmignore:** revert migrations, installed_contracts in ignore ([d5aef2d](https://github.com/AraBlocks/ara-contracts/commit/d5aef2d)) -* **build/*:** revert ABIs ([840cf83](https://github.com/AraBlocks/ara-contracts/commit/840cf83)) -* **constants.js:** lint it up ([c061587](https://github.com/AraBlocks/ara-contracts/commit/c061587)) -* **constants.js:** remove chainIds from address switch ([1a44cc3](https://github.com/AraBlocks/ara-contracts/commit/1a44cc3)) -* **constants.js:** revert privatenet addresses ([8e9ff24](https://github.com/AraBlocks/ara-contracts/commit/8e9ff24)) -* **migrations/2_deploy_contracts.js:** allow local truffle deployments ([0835298](https://github.com/AraBlocks/ara-contracts/commit/0835298)) -* **migrations/2_deploy_contracts.js:** fix undefined ctx in deploy ([13378e1](https://github.com/AraBlocks/ara-contracts/commit/13378e1)) -* **purchase.js:** accounted for budget == 0 for estimate ([#159](https://github.com/AraBlocks/ara-contracts/issues/159)) ([69dcf12](https://github.com/AraBlocks/ara-contracts/commit/69dcf12)) -* **scripts/test:** downgrade solc compiler for truffle ([fc762f0](https://github.com/AraBlocks/ara-contracts/commit/fc762f0)) * library tests ([7e20d63](https://github.com/AraBlocks/ara-contracts/commit/7e20d63)) -* lint ([e4eceec](https://github.com/AraBlocks/ara-contracts/commit/e4eceec)) -* lint ([95e9c7d](https://github.com/AraBlocks/ara-contracts/commit/95e9c7d)) -* lint ([7d90f9e](https://github.com/AraBlocks/ara-contracts/commit/7d90f9e)) -* lint ([c52b6ba](https://github.com/AraBlocks/ara-contracts/commit/c52b6ba)) -* lint ([7f9396c](https://github.com/AraBlocks/ara-contracts/commit/7f9396c)) -* lint ([bff4ded](https://github.com/AraBlocks/ara-contracts/commit/bff4ded)) -* lint ([0a5ff7d](https://github.com/AraBlocks/ara-contracts/commit/0a5ff7d)) +* lint ([94c0977](https://github.com/AraBlocks/ara-contracts/commit/94c0977)) * lint ([08646ab](https://github.com/AraBlocks/ara-contracts/commit/08646ab)) +* lint ([7f9396c](https://github.com/AraBlocks/ara-contracts/commit/7f9396c)) +* lint ([c52b6ba](https://github.com/AraBlocks/ara-contracts/commit/c52b6ba)) * lint ([4cdc00e](https://github.com/AraBlocks/ara-contracts/commit/4cdc00e)) -* lint ([daf3f9d](https://github.com/AraBlocks/ara-contracts/commit/daf3f9d)) -* lint ([94c0977](https://github.com/AraBlocks/ara-contracts/commit/94c0977)) -* local network support in constants ([a4b8f19](https://github.com/AraBlocks/ara-contracts/commit/a4b8f19)) +* lint ([bff4ded](https://github.com/AraBlocks/ara-contracts/commit/bff4ded)) * missed a variable ([33e4dac](https://github.com/AraBlocks/ara-contracts/commit/33e4dac)) * missed a word ([f1bd021](https://github.com/AraBlocks/ara-contracts/commit/f1bd021)) -* pass in owner still for allowance, bump ara-identity to 0.30.x ([b152283](https://github.com/AraBlocks/ara-contracts/commit/b152283)) -* remove async in promise ([733d17f](https://github.com/AraBlocks/ara-contracts/commit/733d17f)) -* remove logs ([f23c4ed](https://github.com/AraBlocks/ara-contracts/commit/f23c4ed)) -* remove owner being passed into ara-util.validate ([7cd9aad](https://github.com/AraBlocks/ara-contracts/commit/7cd9aad)) * remove unused verbose option ([584261f](https://github.com/AraBlocks/ara-contracts/commit/584261f)) +* **migrations/2_deploy_contracts.js:** fix undefined ctx in deploy ([13378e1](https://github.com/AraBlocks/ara-contracts/commit/13378e1)) +* **purchase.js:** accounted for budget == 0 for estimate ([#159](https://github.com/AraBlocks/ara-contracts/issues/159)) ([69dcf12](https://github.com/AraBlocks/ara-contracts/commit/69dcf12)) +* lint ([e4eceec](https://github.com/AraBlocks/ara-contracts/commit/e4eceec)) +* lint ([daf3f9d](https://github.com/AraBlocks/ara-contracts/commit/daf3f9d)) +* lint ([95e9c7d](https://github.com/AraBlocks/ara-contracts/commit/95e9c7d)) +* lint ([7d90f9e](https://github.com/AraBlocks/ara-contracts/commit/7d90f9e)) +* lint ([0a5ff7d](https://github.com/AraBlocks/ara-contracts/commit/0a5ff7d)) * revert contracts/ ignore, ara-identity 0.34.x => 0.37.x ([73317cb](https://github.com/AraBlocks/ara-contracts/commit/73317cb)) * rewards test ([4edec35](https://github.com/AraBlocks/ara-contracts/commit/4edec35)) * should fix travis ([68b67fc](https://github.com/AraBlocks/ara-contracts/commit/68b67fc)) * test order ([19c5d78](https://github.com/AraBlocks/ara-contracts/commit/19c5d78)) -* test script ([7868e36](https://github.com/AraBlocks/ara-contracts/commit/7868e36)) * tests ([387ac8c](https://github.com/AraBlocks/ara-contracts/commit/387ac8c)) -* **storage.js:** remove comment ([7302568](https://github.com/AraBlocks/ara-contracts/commit/7302568)) -* **storage.js:** remove storage falsy checks ([8bd3ced](https://github.com/AraBlocks/ara-contracts/commit/8bd3ced)) +* uncomment non-storage tests ([88d7890](https://github.com/AraBlocks/ara-contracts/commit/88d7890)) +* **.npmignore:** revert bin/ and lib/ in npmignore ([392288e](https://github.com/AraBlocks/ara-contracts/commit/392288e)) +* **.npmignore:** revert migrations, installed_contracts in ignore ([d5aef2d](https://github.com/AraBlocks/ara-contracts/commit/d5aef2d)) +* **migrations/2_deploy_contracts.js:** allow local truffle deployments ([0835298](https://github.com/AraBlocks/ara-contracts/commit/0835298)) * **test/token.js:** remove duplicate test ([9b041da](https://github.com/AraBlocks/ara-contracts/commit/9b041da)) +* local network support in constants ([a4b8f19](https://github.com/AraBlocks/ara-contracts/commit/a4b8f19)) +* pass in owner still for allowance, bump ara-identity to 0.30.x ([b152283](https://github.com/AraBlocks/ara-contracts/commit/b152283)) +* remove async in promise ([733d17f](https://github.com/AraBlocks/ara-contracts/commit/733d17f)) +* remove logs ([f23c4ed](https://github.com/AraBlocks/ara-contracts/commit/f23c4ed)) +* remove owner being passed into ara-util.validate ([7cd9aad](https://github.com/AraBlocks/ara-contracts/commit/7cd9aad)) +* test script ([7868e36](https://github.com/AraBlocks/ara-contracts/commit/7868e36)) * travis ([3cfc45b](https://github.com/AraBlocks/ara-contracts/commit/3cfc45b)) * travis ([2e20dbb](https://github.com/AraBlocks/ara-contracts/commit/2e20dbb)) * travis ([79870a8](https://github.com/AraBlocks/ara-contracts/commit/79870a8)) * travis? ([db5a541](https://github.com/AraBlocks/ara-contracts/commit/db5a541)) -* uncomment non-storage tests ([88d7890](https://github.com/AraBlocks/ara-contracts/commit/88d7890)) +* **constants.js:** lint it up ([c061587](https://github.com/AraBlocks/ara-contracts/commit/c061587)) +* **constants.js:** remove chainIds from address switch ([1a44cc3](https://github.com/AraBlocks/ara-contracts/commit/1a44cc3)) +* **constants.js:** revert privatenet addresses ([8e9ff24](https://github.com/AraBlocks/ara-contracts/commit/8e9ff24)) * wrap bc events in promises ([510d235](https://github.com/AraBlocks/ara-contracts/commit/510d235)) +* **storage.js:** remove storage falsy checks ([8bd3ced](https://github.com/AraBlocks/ara-contracts/commit/8bd3ced)) ### Features +* **storage.js:** checking if an AFS has been committed to ([31f7d97](https://github.com/AraBlocks/ara-contracts/commit/31f7d97)) * contract event updates and fix [#152](https://github.com/AraBlocks/ara-contracts/issues/152) ([623aab6](https://github.com/AraBlocks/ara-contracts/commit/623aab6)) * contracts storage interface ([123a701](https://github.com/AraBlocks/ara-contracts/commit/123a701)) * fixes [#140](https://github.com/AraBlocks/ara-contracts/issues/140) ([e56b76d](https://github.com/AraBlocks/ara-contracts/commit/e56b76d)) * getJobOwner ([5b0f8bf](https://github.com/AraBlocks/ara-contracts/commit/5b0f8bf)) -* **package.json:** added shipright cmd to version hook ([ca12fd3](https://github.com/AraBlocks/ara-contracts/commit/ca12fd3)) -* index event parameters ([f5ceec8](https://github.com/AraBlocks/ara-contracts/commit/f5ceec8)) -* rename commerce to ownership ([b2a60aa](https://github.com/AraBlocks/ara-contracts/commit/b2a60aa)) * show help if command provided is not valid ([c9eea56](https://github.com/AraBlocks/ara-contracts/commit/c9eea56)) * storage isEmpty wip ([04e643a](https://github.com/AraBlocks/ara-contracts/commit/04e643a)) * **purchase.js:** Added estimate opt for purchasing ([#154](https://github.com/AraBlocks/ara-contracts/issues/154)) ([cdb511a](https://github.com/AraBlocks/ara-contracts/commit/cdb511a)) +* index event parameters ([f5ceec8](https://github.com/AraBlocks/ara-contracts/commit/f5ceec8)) +* rename commerce to ownership ([b2a60aa](https://github.com/AraBlocks/ara-contracts/commit/b2a60aa)) +* **package.json:** added shipright cmd to version hook ([ca12fd3](https://github.com/AraBlocks/ara-contracts/commit/ca12fd3)) * **rewards.js:** estimaate option for redeem rewards balance ([63ef04a](https://github.com/AraBlocks/ara-contracts/commit/63ef04a)) -* **storage.js:** checking if an AFS has been committed to ([31f7d97](https://github.com/AraBlocks/ara-contracts/commit/31f7d97)) @@ -214,16 +217,16 @@ ### Bug Fixes -* password arg bug, finish token tests ([e10ca34](https://github.com/AraBlocks/ara-contracts/commit/e10ca34)) -* purchase.js uses hasPurchased ([548c402](https://github.com/AraBlocks/ara-contracts/commit/548c402)) -* refactor commerce to remove need for owner DID ([b9cb26a](https://github.com/AraBlocks/ara-contracts/commit/b9cb26a)) -* wrong pk in constants ([a27a418](https://github.com/AraBlocks/ara-contracts/commit/a27a418)) * **commerce.js:** fix linter ([ac0c1c9](https://github.com/AraBlocks/ara-contracts/commit/ac0c1c9)) * **commerce.js:** not treat ddo as content for request/revoke ([9cf9e3e](https://github.com/AraBlocks/ara-contracts/commit/9cf9e3e)) +* refactor commerce to remove need for owner DID ([b9cb26a](https://github.com/AraBlocks/ara-contracts/commit/b9cb26a)) * **commerce.js:** update address error messages ([4b07e55](https://github.com/AraBlocks/ara-contracts/commit/4b07e55)) * **contracts/Ownable.sol:** remove internal functions ([46d3989](https://github.com/AraBlocks/ara-contracts/commit/46d3989)) * **library.js:** check proxyExists first, to be deprecated in future PR ([4df3558](https://github.com/AraBlocks/ara-contracts/commit/4df3558)) +* password arg bug, finish token tests ([e10ca34](https://github.com/AraBlocks/ara-contracts/commit/e10ca34)) +* purchase.js uses hasPurchased ([548c402](https://github.com/AraBlocks/ara-contracts/commit/548c402)) * **library.js:** deprecate checkLibrary ([767d487](https://github.com/AraBlocks/ara-contracts/commit/767d487)) +* wrong pk in constants ([a27a418](https://github.com/AraBlocks/ara-contracts/commit/a27a418)) ### Features @@ -243,9 +246,9 @@ ### Bug Fixes -* **rewards:** using sha3 of farmer address ([5ee0886](https://github.com/AraBlocks/ara-contracts/commit/5ee0886)) * cleanup rewards.js ([dc82b14](https://github.com/AraBlocks/ara-contracts/commit/dc82b14)) * revert commit refactor ([#55](https://github.com/AraBlocks/ara-contracts/issues/55)) ([96d19a6](https://github.com/AraBlocks/ara-contracts/commit/96d19a6)) +* **rewards:** using sha3 of farmer address ([5ee0886](https://github.com/AraBlocks/ara-contracts/commit/5ee0886)) @@ -301,6 +304,19 @@ ### Bug Fixes +* rename Library.json ([ac05e39](https://github.com/AraBlocks/ara-contracts/commit/ac05e39)) +* **purchase.js:** remove double tx send ([9d53ad3](https://github.com/AraBlocks/ara-contracts/commit/9d53ad3)) +* **README.md:** Add correct link to Travis CI ([5771cca](https://github.com/AraBlocks/ara-contracts/commit/5771cca)) +* **rewards.js:** add budget BN conversion ([96e3a0e](https://github.com/AraBlocks/ara-contracts/commit/96e3a0e)) +* **rewards.js:** convert budget to BN ([09559a6](https://github.com/AraBlocks/ara-contracts/commit/09559a6)) +* remove budget > 0 dependency for rewards, always convert to BN ([203674a](https://github.com/AraBlocks/ara-contracts/commit/203674a)) +* **rewards.js:** remove duplicate expand ([fc73bb3](https://github.com/AraBlocks/ara-contracts/commit/fc73bb3)) +* properly convert token values for purchasing, rewards ([673e9ed](https://github.com/AraBlocks/ara-contracts/commit/673e9ed)) +* **package.json:** revert package.json ([7d9d43b](https://github.com/AraBlocks/ara-contracts/commit/7d9d43b)) +* **registry.js:** remove AraToken.sol from compilation ([7d9e9a9](https://github.com/AraBlocks/ara-contracts/commit/7d9e9a9)) +* **token.js:** expand for funcs calling contract ([fc43770](https://github.com/AraBlocks/ara-contracts/commit/fc43770)) +* **token.js:** fix loss of precision for big numbers ([b70f60e](https://github.com/AraBlocks/ara-contracts/commit/b70f60e)) +* **token.js:** update type checking for val ([f5b4bf5](https://github.com/AraBlocks/ara-contracts/commit/f5b4bf5)) * add error check to getStandard ([9cef6a5](https://github.com/AraBlocks/ara-contracts/commit/9cef6a5)) * add index >=0 check and remove unnecessary lib array ([9d6c33f](https://github.com/AraBlocks/ara-contracts/commit/9d6c33f)) * cli logic ([f686367](https://github.com/AraBlocks/ara-contracts/commit/f686367)) @@ -311,45 +327,25 @@ * fix setting default address ([e2cf648](https://github.com/AraBlocks/ara-contracts/commit/e2cf648)) * library cli ([2e8a821](https://github.com/AraBlocks/ara-contracts/commit/2e8a821)) * lint fixes ([44f3b49](https://github.com/AraBlocks/ara-contracts/commit/44f3b49)) -* properly convert token values for purchasing, rewards ([673e9ed](https://github.com/AraBlocks/ara-contracts/commit/673e9ed)) -* remove budget > 0 dependency for rewards, always convert to BN ([203674a](https://github.com/AraBlocks/ara-contracts/commit/203674a)) * remove slashes ([4c97c96](https://github.com/AraBlocks/ara-contracts/commit/4c97c96)) * remove unecessary default ([188ee2f](https://github.com/AraBlocks/ara-contracts/commit/188ee2f)) -* rename Library.json ([ac05e39](https://github.com/AraBlocks/ara-contracts/commit/ac05e39)) * require fix ([090b4ee](https://github.com/AraBlocks/ara-contracts/commit/090b4ee)) -* **token.js:** update type checking for val ([f5b4bf5](https://github.com/AraBlocks/ara-contracts/commit/f5b4bf5)) * revert approve function ([42359ef](https://github.com/AraBlocks/ara-contracts/commit/42359ef)) * solidity compile error ([2b1ceb1](https://github.com/AraBlocks/ara-contracts/commit/2b1ceb1)) -* **rewards.js:** remove duplicate expand ([fc73bb3](https://github.com/AraBlocks/ara-contracts/commit/fc73bb3)) -* switch if to require in library contract ([80ebc4d](https://github.com/AraBlocks/ara-contracts/commit/80ebc4d)) +* update compiled contracts to respect new StandardToken ([5e409f7](https://github.com/AraBlocks/ara-contracts/commit/5e409f7)) +* use string interpolate ([0a98289](https://github.com/AraBlocks/ara-contracts/commit/0a98289)) * **contracts/*:** compile fixes ([a5fc8fc](https://github.com/AraBlocks/ara-contracts/commit/a5fc8fc)) * **contracts/*:** fix typos ([f0d514d](https://github.com/AraBlocks/ara-contracts/commit/f0d514d)) * **index.js:** add to exports ([d8f59cc](https://github.com/AraBlocks/ara-contracts/commit/d8f59cc)) -* **package.json:** revert package.json ([7d9d43b](https://github.com/AraBlocks/ara-contracts/commit/7d9d43b)) -* **purchase.js:** remove double tx send ([9d53ad3](https://github.com/AraBlocks/ara-contracts/commit/9d53ad3)) -* **README.md:** Add correct link to Travis CI ([5771cca](https://github.com/AraBlocks/ara-contracts/commit/5771cca)) -* **registry.js:** remove AraToken.sol from compilation ([7d9e9a9](https://github.com/AraBlocks/ara-contracts/commit/7d9e9a9)) * **Registry.sol:** fix modifier logic ([c8f8417](https://github.com/AraBlocks/ara-contracts/commit/c8f8417)) -* **rewards.js:** add budget BN conversion ([96e3a0e](https://github.com/AraBlocks/ara-contracts/commit/96e3a0e)) -* update compiled contracts to respect new StandardToken ([5e409f7](https://github.com/AraBlocks/ara-contracts/commit/5e409f7)) -* **rewards.js:** convert budget to BN ([09559a6](https://github.com/AraBlocks/ara-contracts/commit/09559a6)) -* use string interpolate ([0a98289](https://github.com/AraBlocks/ara-contracts/commit/0a98289)) -* **token.js:** expand for funcs calling contract ([fc43770](https://github.com/AraBlocks/ara-contracts/commit/fc43770)) -* **token.js:** fix loss of precision for big numbers ([b70f60e](https://github.com/AraBlocks/ara-contracts/commit/b70f60e)) * **util.js:** specify hex encoding ([5439189](https://github.com/AraBlocks/ara-contracts/commit/5439189)) +* switch if to require in library contract ([80ebc4d](https://github.com/AraBlocks/ara-contracts/commit/80ebc4d)) ### Features -* **contracts/*:** ensure caller of addProxy is owner of proxy ([b3f4b39](https://github.com/AraBlocks/ara-contracts/commit/b3f4b39)) -* **contracts/AFS.sol:** remove need to pass in sizes arr for initial writes ([adfee98](https://github.com/AraBlocks/ara-contracts/commit/adfee98)) -* start lib cli ([c9c4255](https://github.com/AraBlocks/ara-contracts/commit/c9c4255)) -* **Library, Purchase:** add library and purchase contracts and deploy script ([213ae89](https://github.com/AraBlocks/ara-contracts/commit/213ae89)) -* **migrations/*:** migrate all contracts ([7194584](https://github.com/AraBlocks/ara-contracts/commit/7194584)) -* **Proxy.sol:** make Proxy a concrete contract ([7c74a78](https://github.com/AraBlocks/ara-contracts/commit/7c74a78)) -* **purchase.js:** complete purchase flow .. deploy proxy and add to registry ([355d92d](https://github.com/AraBlocks/ara-contracts/commit/355d92d)) -* add upgradeProxy function ([3b1ea7d](https://github.com/AraBlocks/ara-contracts/commit/3b1ea7d)) * **purchase.js:** remove budget being mandatory ([cb6a07d](https://github.com/AraBlocks/ara-contracts/commit/cb6a07d)) +* **token.js:** add expandTokenValue to exports to be consumed by ara-filesystem ([d35740f](https://github.com/AraBlocks/ara-contracts/commit/d35740f)) * add addresses to constants ([f64fb62](https://github.com/AraBlocks/ara-contracts/commit/f64fb62)) * add library and purchase contracts ([be8c6a7](https://github.com/AraBlocks/ara-contracts/commit/be8c6a7)) * add library module ([da0c160](https://github.com/AraBlocks/ara-contracts/commit/da0c160)) @@ -357,6 +353,7 @@ * add rc and move stuff around ([8303169](https://github.com/AraBlocks/ara-contracts/commit/8303169)) * add require reason messages and better error handling in registry ([67f0c10](https://github.com/AraBlocks/ara-contracts/commit/67f0c10)) * add testnet provider ([34bb143](https://github.com/AraBlocks/ara-contracts/commit/34bb143)) +* add upgradeProxy function ([3b1ea7d](https://github.com/AraBlocks/ara-contracts/commit/3b1ea7d)) * added convenience setup cli cmd ([f741267](https://github.com/AraBlocks/ara-contracts/commit/f741267)) * allocate rewards working ([b9b5ee6](https://github.com/AraBlocks/ara-contracts/commit/b9b5ee6)) * ara token contract wrapper ([a89f92d](https://github.com/AraBlocks/ara-contracts/commit/a89f92d)) @@ -367,14 +364,12 @@ * deploy new standards and upgrade proxies working ([21691be](https://github.com/AraBlocks/ara-contracts/commit/21691be)) * deploy standard progress ([626b856](https://github.com/AraBlocks/ara-contracts/commit/626b856)) * deployments working!!! ready for tests and cleanup ([a925bd0](https://github.com/AraBlocks/ara-contracts/commit/a925bd0)) -* **registry.js:** move deployProxy from afs repo to here, lint fixes ([fee218d](https://github.com/AraBlocks/ara-contracts/commit/fee218d)) * forgot one ([863736a](https://github.com/AraBlocks/ara-contracts/commit/863736a)) * more rewards progress ([30fa711](https://github.com/AraBlocks/ara-contracts/commit/30fa711)) * optimize storage in AFS contract ([e98d5f8](https://github.com/AraBlocks/ara-contracts/commit/e98d5f8)) * proxy progress ([68a3c8c](https://github.com/AraBlocks/ara-contracts/commit/68a3c8c)) * proxy testable ([13258ba](https://github.com/AraBlocks/ara-contracts/commit/13258ba)) * proxyExists ([da3d456](https://github.com/AraBlocks/ara-contracts/commit/da3d456)) -* **registry.js:** add registry module ([b93aea4](https://github.com/AraBlocks/ara-contracts/commit/b93aea4)) * purchase updated with jobs and submit job working ([4d92308](https://github.com/AraBlocks/ara-contracts/commit/4d92308)) * purchase working! made all hashed dids unhashed ([28cb7f1](https://github.com/AraBlocks/ara-contracts/commit/28cb7f1)) * redeem balance ([cbfb7cd](https://github.com/AraBlocks/ara-contracts/commit/cbfb7cd)) @@ -383,11 +378,19 @@ * rewards progress ([f1c5eb7](https://github.com/AraBlocks/ara-contracts/commit/f1c5eb7)) * simplify act setup ([c40e655](https://github.com/AraBlocks/ara-contracts/commit/c40e655)) * start cli ([f109eba](https://github.com/AraBlocks/ara-contracts/commit/f109eba)) +* start lib cli ([c9c4255](https://github.com/AraBlocks/ara-contracts/commit/c9c4255)) * started registry and proxy work ([ce6993b](https://github.com/AraBlocks/ara-contracts/commit/ce6993b)) * update to latest StandardToken ERC20 implementation ([8e57ac5](https://github.com/AraBlocks/ara-contracts/commit/8e57ac5)) * use had-did-method module ([df9c7db](https://github.com/AraBlocks/ara-contracts/commit/df9c7db)) * working with privatenet, and rebase ([8cf5821](https://github.com/AraBlocks/ara-contracts/commit/8cf5821)) -* **token.js:** add expandTokenValue to exports to be consumed by ara-filesystem ([d35740f](https://github.com/AraBlocks/ara-contracts/commit/d35740f)) +* **contracts/*:** ensure caller of addProxy is owner of proxy ([b3f4b39](https://github.com/AraBlocks/ara-contracts/commit/b3f4b39)) +* **contracts/AFS.sol:** remove need to pass in sizes arr for initial writes ([adfee98](https://github.com/AraBlocks/ara-contracts/commit/adfee98)) +* **Library, Purchase:** add library and purchase contracts and deploy script ([213ae89](https://github.com/AraBlocks/ara-contracts/commit/213ae89)) +* **migrations/*:** migrate all contracts ([7194584](https://github.com/AraBlocks/ara-contracts/commit/7194584)) +* **Proxy.sol:** make Proxy a concrete contract ([7c74a78](https://github.com/AraBlocks/ara-contracts/commit/7c74a78)) +* **purchase.js:** complete purchase flow .. deploy proxy and add to registry ([355d92d](https://github.com/AraBlocks/ara-contracts/commit/355d92d)) +* **registry.js:** add registry module ([b93aea4](https://github.com/AraBlocks/ara-contracts/commit/b93aea4)) +* **registry.js:** move deployProxy from afs repo to here, lint fixes ([fee218d](https://github.com/AraBlocks/ara-contracts/commit/fee218d)) diff --git a/docs/CLI-README.md b/docs/CLI-README.md index 0660354..5a7897c 100644 --- a/docs/CLI-README.md +++ b/docs/CLI-README.md @@ -1,8 +1,208 @@ + ### act(1) + +#### Abstract + +All other commands prepended with `act-` execute as a child of this command + +#### Usage + +```sh +usage: act: [-hDV] [--help] [--version] +[--debug] [] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show this message|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + + +--- + ### act-deploy(1) + +#### Abstract + +Deploy an Ara proxy or standard contract + +#### Usage + +```sh +usage: act deploy: [-h] [--help] +[options] [--] ... +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The DID of the Ara master account|string| + + + +#### Subcommands +| Subcommand | Description | +|--|--| +|act-deploy proxy|Deploy a proxy contract for | +|act-deploy standard|Deploy a new AFS standard| + + + ### act-deploy proxy(1) + +#### Abstract + +Deploy a proxy contract for + +#### Usage + +```sh +act-deploy proxy [options] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring|| +|-v, --version, -V|Show version number|| +|-name, -u, --upgrade|[boolean]|>| +|-f, --force|Bypass password input, must also pass in password.|| +|-p, --password|Password for DID|| +|-a, -password, --afs|Password for AFS|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The content DID for this proxy|string| +|version-name|The version name of the AFS standard to use with this proxy|string required| + + + + + ### act-deploy standard(1) + +#### Abstract + +Deploy a new AFS standard + +#### Usage + +```sh +act-deploy standard [options] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| +|-f, --force|Bypass password input, must also pass in password.|| +|-p, --password|Password for DID|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The registry contract owner DID|string| +|version-name|The version name of the new AFS standard|string| +|pathspec|Paths to the solidity dependencies(s) of AFS.sol|array required default: | + + + + +--- + ### act-library(1) + +#### Abstract + +Interact with the ARA library + +#### Usage + +```sh +usage: act library: [-h] [--help] + [options] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The library owner's DID|string| + + + +#### Subcommands +| Subcommand | Description | +|--|--| +|act-library get|Gets the content DID at in 's| + + + ### act-library get(1) + +#### Abstract + +Gets the content DID at in 's + +#### Usage + +```sh +act-library get +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The library owner's DID|string| +|index|The position in the library|number| + + + + +--- ### act-purchase(1) #### Abstract -All other commands prepended with `act-purchase-` execute as a child of this command +Purchase an AFS in the ARA network #### Usage @@ -21,3 +221,514 @@ act-purchase [--budget] |-b, --budget|The amount of Ara to budget for downloading the AFS[number]|| +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|purchaser|The DID of the purchaser|string| +|did|The content DID to purchase|string| + + + + +--- + ### act-reward(1) + +#### Abstract + +Submit, allocate, and redeem rewards + +#### Usage + +```sh +usage: act reward: [-h] [--help] [options] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Subcommands +| Subcommand | Description | +|--|--| +|act-reward balance|Query 's reward balance for| +|act-reward redeem|Transfer balance from to| +|act-reward submit|Submit a budget for a DCDN download| +|act-reward budget|Query the budget for a | +|act-reward allocate|Allocate the budget for | + + + ### act-reward balance(1) + +#### Abstract + +Query 's reward balance for + +#### Usage + +```sh +act-reward balance +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The DID that owns the balance|string| +|content|The content DID where the balance is located|string| + + + + + ### act-reward redeem(1) + +#### Abstract + +Transfer balance from to + +#### Usage + +```sh +act-reward redeem +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The DID that owns the balance|string| +|content|The content DID where the balance is located|string| + + + + + ### act-reward submit(1) + +#### Abstract + +Submit a budget for a DCDN download + +#### Usage + +```sh +act-reward submit +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The DID providing the budget|string| +|content|The content DID where the budget will be submitted[string] [required]|| +|budget|The amount of Ara to budget for a DCDN download|string| + + + + + ### act-reward budget(1) + +#### Abstract + +Query the budget for a + +#### Usage + +```sh +act-reward budget +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|content|The content DID where the budget is located|string| +|jobId|The ID of the DCDN job the budget is for|string| + + + + + ### act-reward allocate(1) + +#### Abstract + +Allocate the budget for + +#### Usage + +```sh +act-reward allocate [--returnBudget] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring|| +|-v, --version, -V|Show version number|| +|-r, --returnBudget|Flag to indicate whether the remaining rewards budget|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The DID allocating the budget|string| +|content|The content DID where the budget is located|string| +|jobId|The ID of the DCDN job the budget is for|string| + + + + +--- + ### act-approve(1) + +#### Abstract + +Approve Ara transfers on a sender's behalf + +#### Usage + +```sh +act-approve [options] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| +|-i, --increase|Flag to increase approval by || +|-d, --decrease|Flag to decrease approval by || + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|owner|DID of the owner (the account that owns the tokens to be spent)|string| +|amount|Amount to modify the allowance for |string| + + + + +--- + ### act-transfer(1) + +#### Abstract + +Transfer Ara to a specified address; can specify from address + +#### Usage + +```sh +act-transfer [--sender] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| +|-s, --sender|DID of the sender of the transaction if it is not || + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|from|DID of the account to transfer Ara from|string| +|to|DID or address of the account to transfer Ara to|string| +|amount|Number of Ara to transfer|string| + + + + +--- + ### act-deposit(1) + +#### Abstract + +Deposit Ara for rewards eligibility + +#### Usage + +```sh +act-deposit +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|DID of the requester (the account that owns the tokens to be deposited)|string| + + + + +--- + ### act-withdraw(1) + +#### Abstract + +Withdraw Ara from prior deposit + +#### Usage + +```sh +act-withdraw +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|DID of the withdrawer|string| +|amount|The number of Ara tokens to withdraw|string| + + + + +--- + ### act-token(1) + +#### Abstract + +Query balances, total supply, allowances, and deposit amounts + +#### Usage + +```sh +usage: act token: [-h] [--help] [options] [--] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Subcommands +| Subcommand | Description | +|--|--| +|act-token deposited|Query number of Ara currently deposited| +|act-token balance|Query Ara balance of of an Ara identity| +|act-token allowance|Query number of Ara can spend| +|act-token supply|Query total supply of Ara| + + + ### act-token deposited(1) + +#### Abstract + +Query number of Ara currently deposited + +#### Usage + +```sh +act-token deposited +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|DID of the account to check|string| + + + + + ### act-token balance(1) + +#### Abstract + +Query Ara balance of of an Ara identity + +#### Usage + +```sh +act-token balance +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|account|DID/Ethereum address of the account to check|string| + + + + + ### act-token allowance(1) + +#### Abstract + +Query number of Ara can spend + +#### Usage + +```sh +act-token allowance +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|DID of the owner|string| +|spender|DID of the spender|string| + + + + + ### act-token supply(1) + +#### Abstract + +Query total supply of Ara + +#### Usage + +```sh +act-token supply +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| + + + +--- + ### act-upgrade(1) + +#### Abstract + +Upgrade an Ara core contract (Registry, Library, Token) + +#### Usage + +```sh +act-upgrade [options] +``` + +#### Options +| Flag(s) | Description | Type | +|--|--|--| +|-h, --help|Show help|| +|-contracts, -D, --debug||:*')| +|-s, --secret|Shared secret for the keyring|| +|-n, --network|Network name of the key for the DID resolver in the keyring [string]|| +|-v, --version, -V|Show version number|| +|-r, --registry|Upgrade Registry contract|| +|-l, --library|Upgrade Library contract|| +|-t, --token|Upgrade Ara Token contract|| + + +#### Positionals +| Flag(s) | Description | Type | +|--|--|--| +|did|The DID of the Ara master account|string| +|version-name|The version name of the new contract|string| + + + diff --git a/package.json b/package.json index 02bb026..cf75000 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ara-contracts", - "version": "0.24.0", + "version": "0.24.1", "description": "Ara Contract Module - DCDN and AFS blockchain integration.", "main": "index.js", "bin": {