aboutsummaryrefslogtreecommitdiffstats
path: root/packages/testnet-faucets/README.md
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-01-25 09:11:14 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-01-25 09:11:14 +0800
commitd3aa4f2bc7f2341a98c4aa6018c0d2ede221a3ed (patch)
tree8871a646678749dbe21d21ef724ac83b778d5257 /packages/testnet-faucets/README.md
parentb08bd0f9ab8d5e556c0be3867eafa264b08e8e0e (diff)
downloaddexon-sol-tools-d3aa4f2bc7f2341a98c4aa6018c0d2ede221a3ed.tar
dexon-sol-tools-d3aa4f2bc7f2341a98c4aa6018c0d2ede221a3ed.tar.gz
dexon-sol-tools-d3aa4f2bc7f2341a98c4aa6018c0d2ede221a3ed.tar.bz2
dexon-sol-tools-d3aa4f2bc7f2341a98c4aa6018c0d2ede221a3ed.tar.lz
dexon-sol-tools-d3aa4f2bc7f2341a98c4aa6018c0d2ede221a3ed.tar.xz
dexon-sol-tools-d3aa4f2bc7f2341a98c4aa6018c0d2ede221a3ed.tar.zst
dexon-sol-tools-d3aa4f2bc7f2341a98c4aa6018c0d2ede221a3ed.zip
Respond to GH comments and add /info endpoint
Diffstat (limited to 'packages/testnet-faucets/README.md')
-rw-r--r--packages/testnet-faucets/README.md35
1 files changed, 34 insertions, 1 deletions
diff --git a/packages/testnet-faucets/README.md b/packages/testnet-faucets/README.md
index cd98b4a64..00352cc2a 100644
--- a/packages/testnet-faucets/README.md
+++ b/packages/testnet-faucets/README.md
@@ -53,6 +53,39 @@ yarn dev
### Endpoints
+`GET /ping`
+
+Returns `pong`
+
+`GET /info`
+
+Returns a JSON payload describing the state of the queues for each network. For example:
+
+```json
+{
+ "3":{
+ "ether":{
+ "full":false,
+ "size":4
+ },
+ "zrx":{
+ "full":false,
+ "size":6
+ }
+ },
+ "42":{
+ "ether":{
+ "full":false,
+ "size":8
+ },
+ "zrx":{
+ "full":false,
+ "size":20
+ }
+ }
+}
+```
+
`GET /ether/:recipient`
Where recipient is a hex encoded Ethereum address prefixed with `0x`.
@@ -63,7 +96,7 @@ Where recipient is a hex encoded Ethereum address prefixed with `0x`.
#### Parameters
-Both endpoints take a query parameter named `networkId` to specify the desired network where you would like to receive the ETH or ZRX. For example:
+The endpoints `/ether` and `/zrx` take a query parameter named `networkId` to specify the desired network where you would like to receive the ETH or ZRX. For example:
```bash
curl -i http://localhost:3000/ether/0x14e2F1F157E7DD4057D02817436D628A37120FD1\?networkId=3