From 8709cc0bee842e0f728721d6e145d018251c630e Mon Sep 17 00:00:00 2001 From: Eric Jiang Date: Wed, 16 Jan 2019 10:38:13 -0500 Subject: [PATCH] chore(release): 0.20.0 :tada: --- CHANGELOG.md | 31 ++- docs/CLI-README.md | 678 +-------------------------------------------- package.json | 2 +- 3 files changed, 30 insertions(+), 681 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3eb9ddc..5eae9a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,27 +1,52 @@ -# [0.19.0](https://github.com/AraBlocks/ara-contracts/compare/0.16.0...0.19.0) (2019-01-09) +# [0.20.0](https://github.com/AraBlocks/ara-contracts/compare/0.16.0...0.20.0) (2019-01-16) ### Bug Fixes * 0x prefix ([cba1437](https://github.com/AraBlocks/ara-contracts/commit/cba1437)) +* actually silence ganache... ([948ede5](https://github.com/AraBlocks/ara-contracts/commit/948ede5)) +* add mods to AraRegistry ([338e479](https://github.com/AraBlocks/ara-contracts/commit/338e479)) * added quiet mode ganache ([525b781](https://github.com/AraBlocks/ara-contracts/commit/525b781)) +* AraProxy (i think?) ([c876f71](https://github.com/AraBlocks/ara-contracts/commit/c876f71)) * attempting disabling quiet mode ([e1106df](https://github.com/AraBlocks/ara-contracts/commit/e1106df)) +* bytesdir ([782ebb3](https://github.com/AraBlocks/ara-contracts/commit/782ebb3)) +* can upgrade all contracts at once ([f95b8d1](https://github.com/AraBlocks/ara-contracts/commit/f95b8d1)) +* cant silence ganache... ([b3d4c2f](https://github.com/AraBlocks/ara-contracts/commit/b3d4c2f)) +* cli arg description ([ad494c6](https://github.com/AraBlocks/ara-contracts/commit/ad494c6)) +* cli updates ([7f35312](https://github.com/AraBlocks/ara-contracts/commit/7f35312)) * convert test AFS owner to new privatenet account ([a1513a3](https://github.com/AraBlocks/ara-contracts/commit/a1513a3)) -* deploy proxy password bug ([928250d](https://github.com/AraBlocks/ara-contracts/commit/928250d)) +* deploy proxy password bug ([8a89340](https://github.com/AraBlocks/ara-contracts/commit/8a89340)) * ethify ([d9b22fe](https://github.com/AraBlocks/ara-contracts/commit/d9b22fe)) +* forgot a conflicts ([bbd139d](https://github.com/AraBlocks/ara-contracts/commit/bbd139d)) * forgot pk in constants, added new fixture ([c2de479](https://github.com/AraBlocks/ara-contracts/commit/c2de479)) +* lint ([1acb3fa](https://github.com/AraBlocks/ara-contracts/commit/1acb3fa)) * lint ([877af7c](https://github.com/AraBlocks/ara-contracts/commit/877af7c)) -* more password bug fixes ([baf4283](https://github.com/AraBlocks/ara-contracts/commit/baf4283)) +* lint ([ce85b70](https://github.com/AraBlocks/ara-contracts/commit/ce85b70)) +* lint ([81789ad](https://github.com/AraBlocks/ara-contracts/commit/81789ad)) +* more password bug fixes ([cf1cbcc](https://github.com/AraBlocks/ara-contracts/commit/cf1cbcc)) +* or not... ([8f5dded](https://github.com/AraBlocks/ara-contracts/commit/8f5dded)) * PR comments, cleanup tests ([c5aa884](https://github.com/AraBlocks/ara-contracts/commit/c5aa884)) +* remove spaces ([7eccba3](https://github.com/AraBlocks/ara-contracts/commit/7eccba3)) * revert ([94348aa](https://github.com/AraBlocks/ara-contracts/commit/94348aa)) * revert abis ([db0b9aa](https://github.com/AraBlocks/ara-contracts/commit/db0b9aa)) * update privatenet deploy account to accomodate mnemonic seed change ([70f055f](https://github.com/AraBlocks/ara-contracts/commit/70f055f)) * updated test constants ([a6955c3](https://github.com/AraBlocks/ara-contracts/commit/a6955c3)) +* upgrades should be working, more testing needed ([98ac217](https://github.com/AraBlocks/ara-contracts/commit/98ac217)) +* use AraProxy instead of Proxy ([5a42628](https://github.com/AraBlocks/ara-contracts/commit/5a42628)) * without toHexString ([c76a4fe](https://github.com/AraBlocks/ara-contracts/commit/c76a4fe)) +* woops ([1a2572e](https://github.com/AraBlocks/ara-contracts/commit/1a2572e)) ### Features +* add calls to factory and more tests ([fbe8c08](https://github.com/AraBlocks/ara-contracts/commit/fbe8c08)) +* add events ([bc895cb](https://github.com/AraBlocks/ara-contracts/commit/bc895cb)) +* API WIP ([e7beb19](https://github.com/AraBlocks/ara-contracts/commit/e7beb19)) +* just a start ([21d30f3](https://github.com/AraBlocks/ara-contracts/commit/21d30f3)) +* progress, need to fix AraProxy ([60339c8](https://github.com/AraBlocks/ara-contracts/commit/60339c8)) +* update deploy cli to replace version ([4abc53e](https://github.com/AraBlocks/ara-contracts/commit/4abc53e)) +* upgrade api update ([1b704a4](https://github.com/AraBlocks/ara-contracts/commit/1b704a4)) +* upgrade progress ([e7cb9fc](https://github.com/AraBlocks/ara-contracts/commit/e7cb9fc)) * use compiled bytecode when deploying AFS standard if available ([90a18a5](https://github.com/AraBlocks/ara-contracts/commit/90a18a5)) diff --git a/docs/CLI-README.md b/docs/CLI-README.md index a516797..0660354 100644 --- a/docs/CLI-README.md +++ b/docs/CLI-README.md @@ -1,208 +1,8 @@ - ### 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 AFS 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 -Purchase an AFS in the ARA network +All other commands prepended with `act-purchase-` execute as a child of this command #### Usage @@ -221,479 +21,3 @@ 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 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 | -|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 - -#### 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 | -|--|--|--| -|did|DID 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|| - - diff --git a/package.json b/package.json index df4fffb..13f4298 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ara-contracts", - "version": "0.19.0", + "version": "0.20.0", "description": "Ara Contract Module - DCDN and AFS blockchain integration.", "main": "index.js", "bin": {