HackMD
  • New!
    New!  “Bookmark” and save your note
    Find a note that's worth keeping or want reading it later? “Bookmark” it to your personal reading list.
    Got it
      • Create new note
      • Create a note from template
    • New!  “Bookmark” and save your note
      New!  “Bookmark” and save your note
      Find a note that's worth keeping or want reading it later? “Bookmark” it to your personal reading list.
      Got it
      • Options
      • Versions and GitHub Sync
      • Transfer ownership
      • Delete this note
      • Template
      • Save as template
      • Insert from template
      • Export
      • Dropbox
      • Google Drive
      • Gist
      • Import
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
      • Download
      • Markdown
      • HTML
      • Raw HTML
      • ODF (Beta)
      • Sharing Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Note Permission
      • Read
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Write
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • More (Comment, Invitee)
      • Publishing
        Everyone on the web can find and read all notes of this public team.
        After the note is published, everyone on the web can find and read this note.
        See all published notes on profile page.
      • Commenting Enable
        Disabled Forbidden Owners Signed-in users Everyone
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Invitee
      • No invitee
    Menu Sharing Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Versions and GitHub Sync Transfer ownership Delete this note
    Export
    Dropbox Google Drive Gist
    Import
    Dropbox Google Drive Gist Clipboard
    Download
    Markdown HTML Raw HTML ODF (Beta)
    Back
    Sharing
    Sharing Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Note Permission
    Read
    Owners
    • Owners
    • Signed-in users
    • Everyone
    Owners Signed-in users Everyone
    Write
    Owners
    • Owners
    • Signed-in users
    • Everyone
    Owners Signed-in users Everyone
    More (Comment, Invitee)
    Publishing
    Everyone on the web can find and read all notes of this public team.
    After the note is published, everyone on the web can find and read this note.
    See all published notes on profile page.
    More (Comment, Invitee)
    Commenting Enable
    Disabled Forbidden Owners Signed-in users Everyone
    Permission
    Owners
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Invitee
    No invitee
       owned this note    owned this note      
    Published Linked with
    Like1 BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    # Integration Guide ## Integration Points - [Vault Registry](#Vault-Registry) - [Subgraph](#Subgraph) - [API](#API) ### Vault Registry <a id="Vault-Registry"/> The Yearn Vault Registry (aka yRegistry) is a smart contract deployed on the ethereum mainnet. The Vault Registry is the single source of truth for active Yearn vaults. The registry allows users to query for active Yearn vaults and vault metadata (see "[available data](#Vault-Registry-Available-Data)" below). #### Details - Currently vaults are added manually by Yearn governance - In the future the vault registry may be integrated into the vault lifecycle (meaning new vaults would get added into the registry during their deployment process) #### Interact - ENS: [registry.ychad.eth](https://etherscan.io/enslookup-search?search=registry.ychad.eth) - Address: [0x3ee41c098f9666ed2ea246f4d2558010e59d63a0](https://etherscan.io/address/0x3ee41c098f9666ed2ea246f4d2558010e59d63a0#readContract) #### Code - https://github.com/iearn-finance/yearn-protocol/blob/develop/contracts/registries/YRegistry.sol #### Available data <a id="Vault-Registry-Available-Data"/> - Vault addresses (methods: getVaults) - Active controller address per vault (methods: getVaultInfo, getVaultsInfo) - Active strategy address per vault (methods: getVaultInfo, getVaultsInfo) - Vault type (normal, wrapped, delegated) (methods: isDelegated, isWrapped) - Governance address (methods: governance) #### Integrations - Yearn API - Utilizes vault registry as the single source of truth in many API calls #### Future Integrations - Yearn Subgraph - In the future we would like the Yearn subgraph to index new vaults automatically using the Vault registry. In order to accomplish this the vault registry must first be incorporated into the vault lifecycle. ### Subgraph <a id="Subgraph"/> The Yearn Subgraph is a GraphQL-based public API running on The Graph (thegraph.com) that can be utilized to extract current and historical data from the Yearn ecosystem. #### Details - See [README](https://github.com/juanmardefago/subgraph-y/blob/master/README.md) for detailed integration details #### Interact - Graph Explorer: https://thegraph.com/explorer/subgraph/juanmardefago/yearn-dev?version=current #### Code - https://github.com/juanmardefago/subgraph-y #### Available data - Vault snapshot (current contract values) - Vault metrics per vault (net deposits, withdrawals, transfers, earnings, etc.) - Vault metrics per user (net deposits, withdrawals, transfers, earnings, etc.) - Active controller address per vault - Active strategy address per vault - Historical harvest events and earnings #### Integrations ##### Examples of projects using the Yearn Subgraph | Link | Code | By | | ------------------------------ | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | https://yearn.tools | https://github.com/yearn-integrations/api | Collaboration: [x48](https://twitter.com/x48_crypto), [Lucinao](https://twitter.com/lbertenasco), [Graham](https://twitter.com/grahamu) | | https://yvault-roi.netlify.app | https://github.com/rrridges/yvault-roi | [Matt Ridges](https://twitter.com/rrridges) | | https://www.yfistats.com | | [Bob_The_Builder](https://twitter.com/Bob_The_Buidler) | ### API <a id="API"/> Yearn API is a collection of Serverless API endpoints focused on Yearn integrations. #### Details ##### Goals - Provide free API endpoints to simplify 3rd party integration with Yearn - Provide an "API playground" (Swagger UI) anyone can use to quickly browse and test available APIs - Document all existing APIs - Allow the entire API stack to be forked to enable community involvement in API development ##### Data Sources - Vault Registry - Yearn API utilizes the vault registry in a number of endpoints to maintain a list of active vaults - Subgraph - Yearn API utilizes the Yearn Subgraph for various metrics endpoints #### Interact - Yearn API Playground (Swagger UI): https://yearn.tools #### Code - https://github.com/yearn-integrations/api #### Available data - Current vault snapshots - Vault listings from vault registry (with injected strategy/controller/token metadata) - Vault metrics per user (net deposits, withdrawals, transfers, earnings, etc.) - Vault transactions per user - Vault APY data #### Integrations ##### Examples of projects using the API | Link | Code | By | | -------------------------- | ---------------------------------------------- | ----------------------------------------- | | https://yearn.finance | https://github.com/iearn-finance/iearn-finance | [Yearn](https://twitter.com/iearnfinance) | | https://yearn.party | https://github.com/x48-crypto/yearn-party | [x48](https://twitter.com/x48_crypto) | | https://feel-the-yearn.app | | [Graham](https://twitter.com/grahamu) |

    Import from clipboard

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lost their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template is not available.
    All
    • All
    • Team
    No template found.

    Create a template

    Delete template

    Do you really want to delete this template?

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in via Google

    New to HackMD? Sign up

    Help

    Documents

    Tutorials
    YAML Metadata
    Slide Example
    Book Example

    Contacts

    Talk to us
    Report an issue
    Send us email

    Cheatsheet

    Example Syntax
    Header # Header
    • Unordered List
    - Unordered List
    1. Ordered List
    1. Ordered List
    • Todo List
    - [ ] Todo List
    Blockquote
    > Blockquote
    Bold font **Bold font**
    Italics font *Italics font*
    Strikethrough ~~Strikethrough~~
    19th 19^th^
    H2O H~2~O
    Inserted text ++Inserted text++
    Marked text ==Marked text==
    Link [link text](https:// "title")
    Image ![image alt](https:// "title")
    Code `Code`
    var i = 0;
    ```javascript
    var i = 0;
    ```
    :smile: :smile:
    Externals {%youtube youtube_id %}
    LaTeX $L^aT_eX$

    This is a alert area.

    :::info
    This is a alert area.
    :::

    Versions

    Versions and GitHub Sync

    Sign in to link this note to GitHub Learn more
    This note is not linked with GitHub Learn more
     
    Add badge Pull Push GitHub Link Settings

    Version named by    

    More Less
    • Edit
    • Delete

    Note content is identical to the latest version.
    Compare with
      Choose a version
      No search result
      Version not found

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub

        Please sign in to GitHub and install the HackMD app on your GitHub repo. Learn more

         Sign in to GitHub

        HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully