Skip to content

Commit 9945280

Browse files
authored
Feat: wallet integration guide (yearn#499)
* feat: wallet and portfolio tracker integration doc * fix: grammar * fix: update kong APY types. * fix: missing vaults and incorrect links * fix: add ens * fix: add info on APY/APR
1 parent d2cd23b commit 9945280

File tree

8 files changed

+342
-182
lines changed

8 files changed

+342
-182
lines changed

docs/contributing/contribute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ You can see our progress on the [Github Project Board](https://github.com/orgs/y
3838

3939
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).
4040

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

4343
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.
4444

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

4949
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/).
5050

51-
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).
51+
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).
5252

5353
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).
5454

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

6161
#### Designers
6262

63-
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).
63+
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).
6464

6565
#### Creating Strategies
6666

docs/developers/addresses/v3-contracts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,5 +75,5 @@ To find individual vaults, use the V3 Registry below or refer to https://yearn.f
7575
| ---------------------- | ---------------------- |
7676
| **Role Manager** <br/> role-manager.v3.ychad.eth | <ContractAddress contractName = {['yearnV3RoleManager', 'roleManager']} /> |
7777
| **Current V3 Registry** <br/> registry.v3.ychad.eth | <ContractAddress contractName = {['yearnV3Contracts', 'registry']} /> |
78-
| **Legacy V3 Registry** <br/> | [0xff31A1B020c868F6eA3f61Eb953344920EeCA3af](https://etherscan.io/address/0xff31A1B020c868F6eA3f61Eb953344920EeCA3af) |
78+
| **Legacy V3 Registry** <br/> | <ContractAddress contractName = {['yearnV3Contracts', 'legacyRegistry1']} /> |
7979
| **Accountant** <br/> accountant.v3.ychad.eth | <ContractAddress contractName = {['yearnV3Contracts', 'accountant']} /> |

docs/developers/data-services/yearn-data.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,30 @@ yDaemon is a RESTful API that hydrates subgraph responses with more data, like A
1111
- **Docs:** https://ydaemon.yearn.farm/docs/intro
1212
- **Guide:** https://medium.com/iearn/ydaemon-one-api-to-unify-all-yearn-data-4fc74dc9a33b
1313

14+
## Kong
15+
16+
[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.
17+
18+
Kong's Yearn index covers the v3 and v2 vault ecosystems:
19+
20+
- Regular contract snapshots of each registry, vault, strategy, trade handler, accountant, and debt allocator.
21+
- Full event history for each of the above (*with limited history on transfers, deposits, withdraws, and approves).
22+
- Snapshot hooks for computing vault-strategies relationships, debts, fees, and rewards.
23+
- Snapshot hooks for integrating off-chain risk and meta data.
24+
- Event hooks for tracking new vaults and strategies, computing spot harvest APRs, and pricing transfers.
25+
- Timeseries hooks for computing APY and TVL.
26+
27+
Kong can be run locally or a hosted version run by Yearn can be queried with the public endpoint.
28+
29+
- **Live API:** https://kong.yearn.farm/api/gql
30+
- **Source:** https://github.com/yearn/kong
31+
- **Docs:** Under Construction 🚧
32+
1433
## Subgraph
1534

1635
:::info
1736

18-
Currently only subgraphs for V2 vaults are available and some subgraphs have not been migrated to the new service.
37+
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.
1938

2039
:::
2140

0 commit comments

Comments
 (0)