update readme files

Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
Jakub Sokołowski 2019-03-20 09:59:59 +01:00
parent bf6c9b76f0
commit aa98b2ef8b
No known key found for this signature in database
GPG Key ID: 4EF064D0E6D63020
2 changed files with 60 additions and 0 deletions

View File

@ -6,7 +6,38 @@ This role configures the [faucet](https://github.com/status-im/faucet) service w
The only required settings are:
```yaml
faucet_account_addr: 0x12312312312312321
faucet_account_json: '{"wallet":"json"}'
faucet_account_pass: 'very-secret-password'
faucet_network: 'rinkeby-faucet.example.org'
faucet_domain: 'rinkeby'
```
# API
```bash
admin@master-01.gc-us-central1-a.faucet.ropsten:~ % curl -s http://localhost:3001/ | jq .
{
"message": "Status.im Ropsten Faucet",
"methods": [
"GET /",
"POST /queue",
"GET /donate/{address}",
"GET /faucet-info"
]
}
```
# Usage
To check sync state you can use the `ageth` wrapper for attaching to `geth` RPC port:
```bash
admin@master-01.gc-us-central1-a.faucet.ropsten:~ % ageth eth.syncing
{
currentBlock: 202432,
highestBlock: 5120931,
knownStates: 0,
pulledStates: 0,
startingBlock: 149504
}
```

View File

@ -0,0 +1,29 @@
# Description
This role configures the [geth](https://github.com/ethereum/go-ethereum) service which mines Ethereum in Ropsten and Rinkeby networks for use with the [faucet](https://github.com/status-im/faucet) hosted on the `master` hosts.
# Configuration
The only required settings are:
```yaml
miner_network: rinkeby
miner_base_account_pass: 123qwe
miner_base_account_addr: 0x12312312312312321
miner_base_account_json: '{"wallet":"json"}'
```
# API
# Usage
To check sync state you can use the `ageth` wrapper for attaching to `geth` RPC port:
```bash
admin@master-01.gc-us-central1-a.faucet.ropsten:~ % ageth eth.syncing
{
currentBlock: 202432,
highestBlock: 5120931,
knownStates: 0,
pulledStates: 0,
startingBlock: 149504
}
```