From bbb768c5cfa8bf713670608f859debae42b42898 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Mon, 20 Nov 2017 13:12:15 -0800 Subject: Add kovan faucet project into the mono repo --- packages/kovan-faucets/README.md | 64 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 packages/kovan-faucets/README.md (limited to 'packages/kovan-faucets/README.md') diff --git a/packages/kovan-faucets/README.md b/packages/kovan-faucets/README.md new file mode 100644 index 000000000..72c1368fb --- /dev/null +++ b/packages/kovan-faucets/README.md @@ -0,0 +1,64 @@ +Test Ether Faucet +---------------------- + +This faucet dispenses 0.1 test ether to one recipient per second. It has a max queue size of 1000. + + +## Install + +Install project dependencies: + +``` +npm install +``` + +## Start + +Set the following environment variables: + +``` +export FAUCET_ENVIRONMENT=development +export DISPENSER_ADDRESS=0x5409ed021d9299bf6814279a6a1411a7e866a631 +export DISPENSER_PRIVATE_KEY=f2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257d +export FAUCET_ROLLBAR_ACCESS_KEY={GET_THIS_FROM_ROLLBAR_ACCOUNT_SETTINGS} +``` + +Note: The above public/private keys exist when running `testrpc` with the following option `--mnemonic concert load couple harbor equip island argue ramp clarify fence smart topic`. + +The real production key with kovan ETH exist in 1password + +``` +npm run dev +``` + +## Endpoints + +```GET /rain/:recipient_address``` + +Where recipient_address is a hex encoded Ethereum address prefixed with `0x`. + +```GET /queue``` + +Returns the status of the queue + +```javascript +{ + "full": false, + "size": 0 +} +``` + +## Docker configs + +``` +docker run -d \ +-p 80:3000 \ +--name kovan-faucets \ +--log-opt max-size=100m \ +--log-opt max-file=20 \ +-e DISPENSER_ADDRESS=$DISPENSER_ADDRESS \ +-e DISPENSER_PRIVATE_KEY=$DISPENSER_PRIVATE_KEY \ +-e FAUCET_ROLLBAR_ACCESS_KEY=$FAUCET_ROLLBAR_ACCESS_KEY \ +-e FAUCET_ENVIRONMENT=production \ +kovan-faucets +``` -- cgit v1.2.3 From 1e9f23ebba5e0729b64e757d6901205278871e9f Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Tue, 12 Dec 2017 13:06:02 -0800 Subject: Fix build errors --- packages/kovan-faucets/README.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'packages/kovan-faucets/README.md') diff --git a/packages/kovan-faucets/README.md b/packages/kovan-faucets/README.md index 72c1368fb..b372c8b15 100644 --- a/packages/kovan-faucets/README.md +++ b/packages/kovan-faucets/README.md @@ -25,8 +25,6 @@ export FAUCET_ROLLBAR_ACCESS_KEY={GET_THIS_FROM_ROLLBAR_ACCOUNT_SETTINGS} Note: The above public/private keys exist when running `testrpc` with the following option `--mnemonic concert load couple harbor equip island argue ramp clarify fence smart topic`. -The real production key with kovan ETH exist in 1password - ``` npm run dev ``` -- cgit v1.2.3 From 91f276d9254bba3d93fc821c4fadab2eb6fc1d65 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Tue, 12 Dec 2017 17:18:15 -0800 Subject: Cleanup kovan-faucet package --- packages/kovan-faucets/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'packages/kovan-faucets/README.md') diff --git a/packages/kovan-faucets/README.md b/packages/kovan-faucets/README.md index b372c8b15..8903440e3 100644 --- a/packages/kovan-faucets/README.md +++ b/packages/kovan-faucets/README.md @@ -21,8 +21,11 @@ export FAUCET_ENVIRONMENT=development export DISPENSER_ADDRESS=0x5409ed021d9299bf6814279a6a1411a7e866a631 export DISPENSER_PRIVATE_KEY=f2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257d export FAUCET_ROLLBAR_ACCESS_KEY={GET_THIS_FROM_ROLLBAR_ACCOUNT_SETTINGS} +export INFURA_API_KEY={GET_THIS_FROM_INFURA} ``` +Infura API Key can be requested here: https://infura.io/register.html + Note: The above public/private keys exist when running `testrpc` with the following option `--mnemonic concert load couple harbor equip island argue ramp clarify fence smart topic`. ``` @@ -31,13 +34,14 @@ npm run dev ## Endpoints -```GET /rain/:recipient_address``` +```GET /ether/:recipient``` Where recipient_address is a hex encoded Ethereum address prefixed with `0x`. -```GET /queue``` +```GET /zrx/:recipient``` + +Where recipient_address is a hex encoded Ethereum address prefixed with `0x`. -Returns the status of the queue ```javascript { -- cgit v1.2.3