aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-02-01 07:40:13 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-02-01 07:40:13 +0800
commitc7db837214056be5b3661cd5d082e9dc94e4e136 (patch)
tree86798ba7695c7e2b33d52ddb3cfffb724af7d445 /packages
parent03cb7233dc5b8556952b4481f87a292e0fca1acf (diff)
downloaddexon-0x-contracts-c7db837214056be5b3661cd5d082e9dc94e4e136.tar.gz
dexon-0x-contracts-c7db837214056be5b3661cd5d082e9dc94e4e136.tar.zst
dexon-0x-contracts-c7db837214056be5b3661cd5d082e9dc94e4e136.zip
Update testnet-faucets README
Diffstat (limited to 'packages')
-rw-r--r--packages/testnet-faucets/README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/packages/testnet-faucets/README.md b/packages/testnet-faucets/README.md
index a52d16a00..72532bbb2 100644
--- a/packages/testnet-faucets/README.md
+++ b/packages/testnet-faucets/README.md
@@ -88,15 +88,23 @@ Returns a JSON payload describing the state of the queues for each network. For
`GET /ether/:recipient`
-Where recipient is a hex encoded Ethereum address prefixed with `0x`.
+Schedules a transaction that sends 0.1 ETH to the `recipient` where `recipient` is a hex encoded Ethereum address prefixed with `0x`.
`GET /zrx/:recipient`
-Where recipient is a hex encoded Ethereum address prefixed with `0x`.
+Schedules a transaction that sends 0.1 ZRX to the `recipient` where `recipient` is a hex encoded Ethereum address prefixed with `0x`.
+
+`GET /order/weth/:recipient`
+
+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/zrx/:recipient`
+
+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`.
#### Parameters
-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:
+The endpoints `/ether`, `/zrx`, `/order/weth/`, and `/order/zrx/` take a query parameter named `networkId` to specify the desired ethereum network
```bash
curl -i http://localhost:3000/ether/0x14e2F1F157E7DD4057D02817436D628A37120FD1\?networkId=3