Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
ethereum-emissions-calculator
Advanced tools
Readme
Made with ♥ by Offsetra.com for carbon.fyi. Questions, comments, forks and PRs all very much appreciated!
License: NON-COMMERCIAL USE ONLY. Creative Commons BY-NC-SA. To request a commercial-use license contact support@offsetra.com.
JavaScript utility to calculate the CO2 emissions of any Ethereum address or contract.
The tool is written in TypeScript and powered by the the Etherscan.io API & an open-source carbon accounting methodology under development by Offsetra. We hope this tool is useful for raising awareness and understanding with regards to the rapidly growing carbon emissions of cryptocurrency mining.
This calculator should work in any client or server-side JavaScript environment.
npm install ethereum-emissions-calculator
The calculator exports two methods:
calculateAddressEmissions
calculateContractEmissions
calculateAddressEmissions
will only allocate emissions for outgoing (sent) transactions.
Provide an address
, and the calculator will tell you how many emissions this represents in KG CO2e.
To calculate the sum total emissions for an address, you must combine the sum of eth
, erc20
, and erc721
emissions.
import { calculateAddressEmissions } from "ethereum-emissions-calculator";
import { address, etherscanAPIKey } from "data";
const emissions = await calculateAddressEmissions({
address, // 0x12345[...]
etherscanAPIKey,
});
// returns:
export interface AddressEmissionsResult {
/** The total carbon footprint for all transactions of the provided type, sent from the provided address. In Kilograms of CO2e */
kgCO2: number;
/** The total number of transactions included for this query. */
transactionsCount: number;
/** Total sum of Gas Used for all transactions */
gasUsed: number;
/** False means the 10k limit was hit, so only the most recent 10k transactions were analyzed. */
done: boolean;
/** The block number of the most recent transaction found in the query */
highestBlockNumber: number;
/** The block number of the oldest transaction found in the query */
lowestBlockNumber: number;
}
The only difference between this method and calculateAddressEmissions
, is that this method will also calculate and add emissions from incoming transactions.
We have included this method at the request of platforms who are interested in calculating the collective impact of their contract, however for most cases we think calculateAddressEmissions
makes more sense (to avoid double-counting the same emissions-- sender takes responsibility!)
As of version 2.0 and greater, each invocation of calculateAddressEmissions()
or calculateAddressEmissions()
will return a maximum of 10k transactions.
Before version 2.0, the calculator attempted to recursively fetch the remaining transactions until the entire history had been retrieved. This caused problems with huge addresses or lower-memory devices. It is now up to the developer to re-fetch the remaining transactions (the calculator now returns the highestBlockNumber
and lowestBlockNumber
to help you find the next chunk).
The total emissions are derived from the amount of gas
used for each transaction.
See https://carbon.fyi/learn for a brief intro and link to more in-depth explainers.
FAQs
TypeScript utils to calculate the CO2 emissions of an Ethereum wallet. Powered by the Etherscan.io API.
The npm package ethereum-emissions-calculator receives a total of 28 weekly downloads. As such, ethereum-emissions-calculator popularity was classified as not popular.
We found that ethereum-emissions-calculator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.