Skip to content

Commit

Permalink
Merge branch 'master' into feat--add-veYFI-contract-checks
Browse files Browse the repository at this point in the history
  • Loading branch information
rossgalloway authored Jan 21, 2025
2 parents e5f5ed9 + 9945280 commit 0944af4
Show file tree
Hide file tree
Showing 8 changed files with 341 additions and 182 deletions.
6 changes: 3 additions & 3 deletions docs/contributing/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ You can see our progress on the [Github Project Board](https://github.com/orgs/y

We use a combination of HackMD, Docusaurus, and Github for our [Documentation](https://docs.yearn.fi/) and we use [DrawIO](https://draw.io) with Google Drive for our diagrams & schemas. If you are a grammar stickler, you can see our [Reviewer Guide](https://hackmd.io/juTKNn3xTpKJgFDo2AglLw).

Last but not least, join the #documentation channel in [Discord](https://discord.gg/freT6YRNSX) and introduce yourself.
Last but not least, join the #documentation channel in [Discord](https://discord.gg/yearn) and introduce yourself.

If this sounds confusing, please let us know what we can clear up. In the meantime: You can begin contributing to our HackMD docs immediately via the Github issues — we'll guide you through the rest.

Expand All @@ -48,7 +48,7 @@ If this sounds confusing, please let us know what we can clear up. In the meanti

If you're a developer, we need your help! Before you begin: Familiarize yourself with Yearn, its products, and its infrastructure by reading our [Documentation](https://docs.yearn.fi/).

You can see our progress on our [Github Project Board](https://contribute.yearn.farm/good-first-issue.html), and you can immediately begin contributing where you see fit. We recommend checking out issues tagged as `help wanted` and recommend sticking to the respective repository's coding guidelines (linting, formatting, PRs, etc). It's that simple 🙂. You can also join us on the #dev channel in [Discord](https://discord.gg/w89vVxeV9h).
You can see our progress on our [Github Project Board](https://contribute.yearn.farm/good-first-issue.html), and you can immediately begin contributing where you see fit. We recommend checking out issues tagged as `help wanted` and recommend sticking to the respective repository's coding guidelines (linting, formatting, PRs, etc). It's that simple 🙂. You can also join us on the #dev channel in [Discord](https://discord.gg/yearn).

If you are interested in working on a specific project, check out the list of Yearn products in the [General Resources](#general-resources) section below or check out our list of repos [here](https://github.com/orgs/yearn/repositories).

Expand All @@ -60,7 +60,7 @@ If you want to integrate with Yearn, please visit our [Integration Guide](https:

#### Designers

We invite designers, animators, artists, and more to share your skills with the Yearn ecosystem! If you're interested in creating graphics that describe Yearn's systems, creating video explainers, fixing Yearn's UI/UX, or any other combination of things — hop into the #ui-ux channel or #media-resources channels in [Discord](https://discord.gg/H8AVhpz63R).
We invite designers, animators, artists, and more to share your skills with the Yearn ecosystem! If you're interested in creating graphics that describe Yearn's systems, creating video explainers, fixing Yearn's UI/UX, or any other combination of things — hop into the #ui-ux channel or #media-resources channels in [Discord](https://discord.gg/yearn).

#### Creating Strategies

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/addresses/v3-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,5 @@ To find individual vaults, use the V3 Registry below or refer to https://yearn.f
| ---------------------- | ---------------------- |
| **Role Manager** <br/> role-manager.v3.ychad.eth | <ContractAddress contractName = {['yearnV3RoleManager', 'roleManager']} /> |
| **Current V3 Registry** <br/> registry.v3.ychad.eth | <ContractAddress contractName = {['yearnV3Contracts', 'registry']} /> |
| **Legacy V3 Registry** <br/> | [0xff31A1B020c868F6eA3f61Eb953344920EeCA3af](https://etherscan.io/address/0xff31A1B020c868F6eA3f61Eb953344920EeCA3af) |
| **Legacy V3 Registry** <br/> | <ContractAddress contractName = {['yearnV3Contracts', 'legacyRegistry1']} /> |
| **Accountant** <br/> accountant.v3.ychad.eth | <ContractAddress contractName = {['yearnV3Contracts', 'accountant']} /> |
21 changes: 20 additions & 1 deletion docs/developers/data-services/yearn-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,30 @@ yDaemon is a RESTful API that hydrates subgraph responses with more data, like A
- **Docs:** https://ydaemon.yearn.farm/docs/intro
- **Guide:** https://medium.com/iearn/ydaemon-one-api-to-unify-all-yearn-data-4fc74dc9a33b

## Kong

[Kong](https://kong.yearn.farm/) is an integrated set of services and tools that make it easy to index EVM logs and state, enrich your data with custom hooks, query your data over graphql. Kong is designed to be cheap, reliable, easy to maintain, and simplify the process of updating your index.

Kong's Yearn index covers the v3 and v2 vault ecosystems:

- Regular contract snapshots of each registry, vault, strategy, trade handler, accountant, and debt allocator.
- Full event history for each of the above (*with limited history on transfers, deposits, withdraws, and approves).
- Snapshot hooks for computing vault-strategies relationships, debts, fees, and rewards.
- Snapshot hooks for integrating off-chain risk and meta data.
- Event hooks for tracking new vaults and strategies, computing spot harvest APRs, and pricing transfers.
- Timeseries hooks for computing APY and TVL.

Kong can be run locally or a hosted version run by Yearn can be queried with the public endpoint.

- **Live API:** https://kong.yearn.farm/api/gql
- **Source:** https://github.com/yearn/kong
- **Docs:** Under Construction 🚧

## Subgraph

:::info

Currently only subgraphs for V2 vaults are available and some subgraphs have not been migrated to the new service.
Currently only subgraphs for V2 vaults are available and some subgraphs have not been migrated to the new service. We recommend using Kong or yDaemon for your data needs.

:::

Expand Down
Loading

0 comments on commit 0944af4

Please sign in to comment.