aboutsummaryrefslogtreecommitdiffstats
path: root/packages/testnet-faucets/README.md
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-02-06 08:28:03 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-02-06 10:11:26 +0800
commit83d0bad3a1e6635dedb46fbd99ee1bec5246d4bf (patch)
tree626fd908627a4b6b7e48c3b7326c12a1f30c2f5f /packages/testnet-faucets/README.md
parent99b1f81e89e3ac929c7829552ea7ae19998524e9 (diff)
downloaddexon-sol-tools-83d0bad3a1e6635dedb46fbd99ee1bec5246d4bf.tar
dexon-sol-tools-83d0bad3a1e6635dedb46fbd99ee1bec5246d4bf.tar.gz
dexon-sol-tools-83d0bad3a1e6635dedb46fbd99ee1bec5246d4bf.tar.bz2
dexon-sol-tools-83d0bad3a1e6635dedb46fbd99ee1bec5246d4bf.tar.lz
dexon-sol-tools-83d0bad3a1e6635dedb46fbd99ee1bec5246d4bf.tar.xz
dexon-sol-tools-83d0bad3a1e6635dedb46fbd99ee1bec5246d4bf.tar.zst
dexon-sol-tools-83d0bad3a1e6635dedb46fbd99ee1bec5246d4bf.zip
Addressed comments and update 0xProject/types-ethereumjs-util deps
Diffstat (limited to 'packages/testnet-faucets/README.md')
-rw-r--r--packages/testnet-faucets/README.md21
1 files changed, 9 insertions, 12 deletions
diff --git a/packages/testnet-faucets/README.md b/packages/testnet-faucets/README.md
index d0b9858a1..6cd842ea6 100644
--- a/packages/testnet-faucets/README.md
+++ b/packages/testnet-faucets/README.md
@@ -86,25 +86,24 @@ Returns a JSON payload describing the state of the queues for each network. For
}
```
-`GET /ether/:recipient`
+`GET /ether/:recipient?networkId=:networkId`
-Schedules a transaction that sends 0.1 ETH to the `recipient` where `recipient` is a hex encoded Ethereum address prefixed with `0x`.
+Schedules a transaction that sends 0.1 ETH to the `recipient` on the network specified by `networkId` where `recipient` is a hex encoded Ethereum address prefixed with `0x`. If no `networkId` is provided via query parameters the faucet will default to network 42 (Kovan).
-`GET /zrx/:recipient`
-Schedules a transaction that sends 0.1 ZRX to the `recipient` where `recipient` is a hex encoded Ethereum address prefixed with `0x`.
+`GET /zrx/:recipient?networkId=:networkId`
-`GET /order/weth/:recipient`
+Schedules a transaction that sends 0.1 ZRX to the `recipient` on the network specified by `networkId` where `recipient` is a hex encoded Ethereum address prefixed with `0x`. If no `networkId` is provided via query parameters the faucet will default to network 42 (Kovan).
-Returns a JSON payload describing an order for 0.1 WETH in exchange for 0.1 ZRX signed by the dispenser address. The taker is specified by `recipient` where `recipient` is a hex encoded Ethereum address prefixed with `0x`.
+`GET /order/weth/:recipient?networkId=:networkId`
-`GET /order/zrx/:recipient`
+Returns a JSON payload describing an order for 0.1 WETH in exchange for 0.1 ZRX signed by the dispenser address on the network specified by `networkId`. The taker is specified by `recipient` where `recipient` is a hex encoded Ethereum address prefixed with `0x`. If no `networkId` is provided via query parameters the faucet will default to network 42 (Kovan).
-Returns a JSON payload describing an order for 0.1 ZRX in exchange for 0.1 WETH signed by the dispenser address. The taker is specified by `recipient` where `recipient` is a hex encoded Ethereum address prefixed with `0x`.
+`GET /order/zrx/:recipient?networkId=:networkId`
-#### Parameters
+Returns a JSON payload describing an order for 0.1 ZRX in exchange for 0.1 WETH signed by the dispenser address on the network specified by `networkId`. The taker is specified by `recipient` where `recipient` is a hex encoded Ethereum address prefixed with `0x`. If no `networkId` is provided via query parameters the faucet will default to network 42 (Kovan).
-The endpoints `/ether`, `/zrx`, `/order/weth/`, and `/order/zrx/` take a query parameter named `networkId` to specify the desired ethereum network
+#### Example request
```bash
curl -i http://localhost:3000/ether/0x14e2F1F157E7DD4057D02817436D628A37120FD1\?networkId=3
@@ -112,8 +111,6 @@ curl -i http://localhost:3000/ether/0x14e2F1F157E7DD4057D02817436D628A37120FD1\?
This command will request the local server to initiate a transfer of 0.1 ETH from the dispensing address to `0x14e2F1F157E7DD4057D02817436D628A37120FD1` on the Ropsten testnet.
-If no `networkId` is provided via query parameters the faucet will default to network 42 (Kovan)
-
### Docker configs
```