Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/makerdao/petrometer
Tool which summarizes daily and total gas consumption of all transactions sent from a specified Ethereum address.
https://github.com/makerdao/petrometer
Last synced: 2 months ago
JSON representation
Tool which summarizes daily and total gas consumption of all transactions sent from a specified Ethereum address.
- Host: GitHub
- URL: https://github.com/makerdao/petrometer
- Owner: makerdao
- License: agpl-3.0
- Created: 2019-05-21T08:31:12.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-28T21:26:50.000Z (over 1 year ago)
- Last Synced: 2023-10-20T21:30:43.552Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 253 KB
- Stars: 16
- Watchers: 11
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# petrometer
`petrometer` is a tool which summarizes daily and total gas consumption of all transactions sent
from or received by one or more specified Ethereum addresses.
It uses the etherscan.io API () to download the transaction data as it's
much more effective than querying an Ethereum node directly. What even more, it caches the downloaded
data between invocations and only downloads new transactions when run again. Thanks to `appdirs`
(), standard OS locations are used for storing cached data.
You do need an etherscan.io API key () in order to use this tool,
it needs to be passed as the `--etherscan-api-key` parameter. You need to create an etherscan.io
account () in order to be able to generate an API key.
## Installation
This project uses _Python 3.6.6_.
In order to clone the project and install required third-party packages please execute:
```
git clone https://github.com/makerdao/petrometer.git
cd petrometer
pip3 install -r requirements.txt
```
## Usage
```
usage: petrometer [-h] --etherscan-api-key ETHERSCAN_API_KEY [--graphite-key GRAPHITE_KEY] [--graphite-endpoint GRAPHITE_ENDPOINT] [--alias SOME_ALIAS] [-j] [-o OUTPUT] [-i] ADDRESSES [ADDRESSES ...]
positional arguments:
ADDRESSES Ethereum addresses to get the gas usage of
optional arguments:
-h, --help show this help message and exit
--etherscan-api-key ETHERSCAN_API_KEY Etherscan API key
--graphite-endpoint GRAPHITE_ENDPOINT Endpoint of GraphiteDB to publish metrics to Grafana
--graphite-key GRAPHITE_KEY GraphiteDB key to publish metrics to Grafana
-j, --json Generate result as JSON
-o OUTPUT, --output OUTPUT File to save the output to
-i, --incoming Show incoming transaction gas usage, defaut outgoing
```
Sample invocation:
```
bin/petrometer --etherscan-api-key ABCDFDBCBAFDBCFBDFCBFDBAFB --graphite-key "0123:abcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabc=" --graphite-endpoint "https://graphite-us-central1.grafana.net/metrics" 0x1212121212343434343456565656565454545454 --alias SOME_ALIAS
```
Sample output:
```
Gas usage summary for: 0x00......................................
Day # transactions Average gas price Average gas cost Total gas cost
===========================================================================================================================
2018-01-06 12 39.7 GWei 0.005078854742238021 ETH 0.060946256906856247 ETH
2018-01-07 22 22.0 GWei 0.003037521765674030 ETH 0.066825478844828673 ETH
2018-01-08 76 27.7 GWei 0.003806332034057282 ETH 0.289281234588353420 ETH
Number of transactions: 351
Total gas cost: 1.526090324569235879 ETH
```
## License
See [COPYING](https://github.com/makerdao/petrometer/blob/master/COPYING) file.