{"id":18263723,"url":"https://github.com/yearn/yearn-exporter","last_synced_at":"2025-04-12T15:32:35.111Z","repository":{"id":38177838,"uuid":"297351705","full_name":"yearn/yearn-exporter","owner":"yearn","description":"Realtime and historical Yearn metrics","archived":false,"fork":false,"pushed_at":"2024-11-09T06:38:33.000Z","size":2872,"stargazers_count":97,"open_issues_count":23,"forks_count":142,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-03T14:11:41.661Z","etag":null,"topics":["defi","grafana","grafana-dashboard","yearn"],"latest_commit_sha":null,"homepage":"https://yearn.vision","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yearn.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-21T13:41:49.000Z","updated_at":"2025-02-11T04:12:31.000Z","dependencies_parsed_at":"2024-12-13T19:11:52.705Z","dependency_job_id":"f9ee32f9-58f6-43c5-90a7-13cb11c3716a","html_url":"https://github.com/yearn/yearn-exporter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fyearn-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fyearn-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fyearn-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fyearn-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yearn","download_url":"https://codeload.github.com/yearn/yearn-exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248589838,"owners_count":21129689,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["defi","grafana","grafana-dashboard","yearn"],"created_at":"2024-11-05T11:12:25.168Z","updated_at":"2025-04-12T15:32:35.072Z","avatar_url":"https://github.com/yearn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yearn Exporter\n\nCollects real-time on-chain numeric data about all Yearn products and exposes it in multiple formats. Currently, it's able to export data from the following networks:\nEthereum, Fantom, Arbitrum, Gnosis, and Optimism.\n\nThe hosted version is available at https://yearn.vision.\n\n# Installation\n\nYou will need:\n\n- Etherscan API key (and API keys for other networks block explorer that you want to use)\n- [Docker](https://www.docker.com/) and [Docker Compose](https://github.com/docker/compose)\n\n## Usage\n\nRun `make up` to start all of the exporters.\n\n### Grafana Dashboard \u0026 Exporters\n\nExport the environment variables required in [.env.example](./.env.example) into .env to run the dashboards and exporters:\n\n```bash\n# Make sure all .env variables loaded (`source .env`), check with `echo $variable_name_here`\nmake build \u0026\u0026 make dashboards\n```\n\nAfter a successful startup, you can go directly to Grafana at `http://localhost:3000`. If you want to change your dashboards you can sign in at the lower left with `admin:admin`.\n\n### Historical TVL\n\n```bash\n# Make sure all .env variables loaded (`source .env`), check with `echo $variable_name_here`\nmake build \u0026\u0026 make tvl\n```\n\nAfter a successful start up you can access the tvl rest endpoint at `http://localhost:4000`.\n\n### Run All\n```bash\n# Make sure all .env variables loaded (`source .env`), check with `echo $variable_name_here`\nmake build \u0026\u0026 make up\n# Optionally you can filter `make up` by `make up network=eth` or network=ftm ect for networks supported in the make file\n```\n\n### Setting up GitHub Actions\n\nCreate Access Keys for `apy-exporter-service-user` user.\n\nCreate a new [environment](https://github.com/numan/yearn-exporter/settings/environments) named `production` and add the newly created `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.\n\n## Docker setup\n\nThe dockerized exporter is controlled via `make up` command which is invoked via multiple Makefile recipes.\nIt is possible to specify multiple Makefile args that control which exporters are started on which network.\nThe available args to control the startup sequence of containers are the following:\n\n- `network`: one of `ethereum`, `fantom`, `arbitrum`, `optimism`, see `make list-networks`\n- `commands`: a list of strings delimited with comma pointing to brownie scripts in `./scripts/` e.g. `exporters/partners,exporters/vaults`, see `make list-commands`\n- `filter`: used for `make logs` and `make down` to match the container name substring.\n\nThis is a flexible approach to start multiple containers on multiple networks which can be used for a given network or given exporters of a certain type and a combination of both.\n\n### Usage examples:\n\n- list supported networks:  \n  `make list-networks`\n\n- list supported exporter commands:  \n  `make list-commands`\n\n- build the docker image:  \n  `make build`\n\n- start _all_ exporters on _all_ supported networks (requires at least *num_exporters x num_networks* available cpu cores):  \n  `make up`\n\n- stop all exporters:  \n  `make down`\n\n- stop all docker infrastructure:   \n  `make down filter=infra`\n\n- start only the vaults exporter for ethereum:  \n  `make up network=ethereum commands=\"exporters/vaults\"`\n\n- start only the vaults exporter for all supported networks:  \n  `make up commands=\"exporters/vaults\"`\n\n- start only the treasury exporters for all supported networks:  \n  `make treasury`\n\n- start all available exporters on arbitrum:  \n  `make up network=arbitrum`\n\n- show the logs of all exporters on arbitrum:  \n  `make logs network=arbitrum`\n\n- stop all containers matching a string in their name, e.g. treasury:  \n  `make down filter=treasury`\n\n- start veYFI exporter on ethereum:  \n  `make veYFI`\n\n- start APY exporter on ethereum:  \n  `make apy network=eth`\n\n- start APY Debug on ethereum for a specific vault:  \n  `export DEBUG_ADDRESS=vault_address_here \u0026\u0026 make debug-apy network=eth`\n\n- start APY preview for curve pools:  \n   `make curve-apy-previews`\n\n- debug ypm prices:\n   `make debug-price network=optimism`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyearn%2Fyearn-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyearn%2Fyearn-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyearn%2Fyearn-exporter/lists"}