ADA Rewards Reporter

About

A console application for reporting on total ADA staking rewards earned to date, broken down by epoch. Output is printed on the console in the form of a table, or it can be optionally written to a CSV file.

The Blockfrost API is used to query the Cardano blockchain.

Configuration

An appsettings.json or appsettings.Local.json file, with the following values, is necessary for the app to run. appsettings.Local.json is used to avoid commiting the Blockfrost API Key to source control. Alternatively, these configuration values can also be set as environment variables.

{
    "AuthenticationHeaderKey": "project_id",
    "ApiKey": "<redacted>",
    "MainnetBaseUrl": "https://cardano-mainnet.blockfrost.io/api/v0"
}

To get an API key, you can create a free developer account at blockfrost.io.

Parameters

stakeAddress (required)

The stake address of the wallet from which ADA is being staked. AFAIK, Daedalus and Yoroi give you access to your stake address, but Exodus doesn't.

regularAddress (optional | required if provided instead of stakeAddress)

A regular Cardano address used to send and receive ADA. If provided instead of the stake address, it will be used to resolve the stake address associated with the account. If provided in tandem with the stake address, it will be ignored. Using regularAddress instead of stakeAddress can be useful when staking in a wallet like Exodus where you don't have direct access to your stake address.

orderBy (optional)

The order, by epoch, in which to show rewards history in the report. The default value is desc. Possible values are desc or asc.

exportToCsv (optional)

Setting this flag will output a CSV file to the project's root directory with the contents of the report.

How to run

dotnet run -- --stakeAddress=<your_stake_address>

dotnet run -- --stakeAddress=<your_stake_address> --exportToCsv