From c486da9a6ebf875482086ebc80a05123f225e0c6 Mon Sep 17 00:00:00 2001 From: Drew Stone Date: Fri, 22 Mar 2019 08:07:36 -0700 Subject: [PATCH] Readme updates --- README.md | 10 +++++++++- scripts/lockdrop.js | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d55d89e..5876b9e 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,11 @@ To test, use `ganache-cli` and `truffle` ``` truffle test ``` -To use the script `/scripts/lockdrop.js`: +To deploy locally against `ganache-cli`: +``` +truffle deploy +``` +To use the script `/scripts/lockdrop.js`, ensure you've deployed to the respective network: ``` truffle compile node ./scripts/lockdrop.js --help @@ -23,7 +27,10 @@ Options: -V, --version output the version number -b, --balance Get the total balance across all locks -l, --lock Lock ETH with the lockdrop + -s, --signal Signal a contract balance in the lockdrop + -n, --nonce Transaction nonce that created a specific contract address -u, --unlock Unlock ETH from a specific lock contract + -r, --remoteUrl The remote URL of an Ethereum node (defaults to localhost:8545) --lockContractAddress The Ethereum address for a lock contract --lockdropContractAddress lockers --lockers Get the allocation for the current set of lockers @@ -33,6 +40,7 @@ Options: --pubKey Edgeware ED25519 pubKey in hex --isValidator A boolean flag indicating intent to be a validator -h, --help output usage information + ``` diff --git a/scripts/lockdrop.js b/scripts/lockdrop.js index 368a8e1..e757e5d 100755 --- a/scripts/lockdrop.js +++ b/scripts/lockdrop.js @@ -17,7 +17,7 @@ program .option('-s, --signal ', 'Signal a contract balance in the lockdrop') .option('-n, --nonce ', 'Transaction nonce that created a specific contract address') .option('-u, --unlock', 'Unlock ETH from a specific lock contract') - .option('-r, --remoteUrl ', 'The remote URL of an Ethereum node (defaults to localhost:8545') + .option('-r, --remoteUrl ', 'The remote URL of an Ethereum node (defaults to localhost:8545)') .option('--lockContractAddress ', 'The Ethereum address for a lock contract') .option('--lockdropContractAddress ', 'lockers') .option('--lockers', 'Get the allocation for the current set of lockers')