contracts_footprint.py

import argparse
import datetime
from collections import defaultdict

from etherscan import Etherscan, filter_transactions, sum_fees, wei_to_eth
from ethereum_footprint import EthereumFootprint
from utils import load_contracts, load_etherscan_api_key, write_results_tsv, write_results_json, split_name_kind

parser = argparse.ArgumentParser(description='Estimate emissions footprint for Ethereum platforms.')
parser.add_argument('contracts', nargs='+', help='List of contract JSON filenames')
parser.add_argument('--separate', action='store_true', help='Split results by contract.')
parser.add_argument('--noupdate', action='store_false', help='Do not update cache.')
parser.add_argument('--startdate', default='', help='YYYY-MM-DD start date for transactions.')
parser.add_argument('--enddate', default='', help='YYYY-MM-DD end date for transactions.')
parser.add_argument('--tsv', action='store_true', help='Output to TSV instead of JSON')
parser.add_argument('--verbose', action='store_true', help='Verbose mode.')
args = parser.parse_args()

start_date = None
end_date = None
if args.startdate != '':
    start_date = datetime.date.fromisoformat(args.startdate)
if args.enddate != '':
    end_date = datetime.date.fromisoformat(args.enddate)

api_key = load_etherscan_api_key()
contracts = load_contracts(args.contracts)
etherscan = Etherscan(api_key, read_only=not args.noupdate)
ethereum_footprint = EthereumFootprint()

summary = defaultdict(lambda: defaultdict(int))

output_json = {}
output_json['data'] = []

for name_kind, address in contracts.items():
    
    if args.verbose:
        print(name_kind)

    transactions = list(etherscan.load_transactions(address,
        update=args.noupdate,
        verbose=args.verbose))

    transactions = filter_transactions(transactions, start_date, end_date)
    fees = wei_to_eth(sum_fees(transactions))
    kgco2 = int(ethereum_footprint.sum_kgco2(transactions))
    name, kind = split_name_kind(name_kind)
    summary[name]['transactions'] += len(transactions)
    summary[name]['fees'] += fees
    summary[name]['kgco2'] += kgco2

    if args.separate:
        row = {
            'name': name,
            'kind': kind,
            'address': address,
            'fees': fees,
            'transactions': len(transactions),
            'kgco2': kgco2
        }
        output_json['data'].append(row)

if not args.separate:
    for name in sorted(summary.keys()):
        transactions = summary[name]['transactions']
        fees = summary[name]['fees']
        kgco2 = summary[name]['kgco2']
        row = {
            'name': name,
            'fees': fees,
            'transactions': transactions,
            'kgco2': kgco2
        }
        output_json['data'].append(row)

if args.tsv:
    write_results_tsv(output_json)
else:
    write_results_json(output_json)