crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update testnet-faucets README

Browse Source
This commit is contained in:
Brandon Millman
2018-01-31 15:40:13 -08:00
parent 03cb7233dc
commit c7db837214
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
packages/testnet-faucets/README.md
View File

@@ -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