yearn
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Write
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights New
    • Engagement control
    • Make a copy
    • Transfer ownership
    • Delete this note
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Help
Menu
Options
Engagement control Make a copy Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
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
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    --- tags: brand, docs-v2 --- # Yearn Naming Standard ## yVaults * Acceptable alternative names include Yearn Vaults, or informally referring to the product as vaults. * When referring to a specific yVault, the preferred name is generally `token name + yVault`; this matches the `name` field on the token contract. However, it is also acceptable to use `yvToken + Vault`, `Yearn + Token + Vault` or `yvToken`; the latter matches `symbol` in the contract. * **Examples:** `DAI yVault`, `yvDAI Vault`, or simply `yvDAI` * For each yVault, name and symbol conventions are as follows: * Name: `${token.symbol()} or override yVault ` * Symbol: `yv${token.symbol()} or override` * A `version` field is included in the token contract to correspond to the major yVault release version. * The predominant use case for name and symbol override is for LP tokens. * Curve * Name: `Curve + pool + Pool yVault` * **Examples:** `Curve sBTC Pool yVault`, `Curve 3pool yVault`, `Curve Y Pool yVault` * In this case, `pool` is taken directly from Curve.fi's UI, and we can adjust for capitalization as needed. In the case of the `3pool`, the redundant "Pool" is removed. * Symbol: `yvCurve-pool` * **Examples:** `yvCurve-sBTC`, `yvCurve-3pool`, `yvCurve-Y` * Note: In this methodology, `yvCurve-Y` replaces the previously used `yUSD`. In the future, `yUSD` will be used to refer to the Meta Vault token. * Uniswap * Name: `Uniswap + v${self.version()} + TOKEN-TOKEN + Pool yVault` * **Examples:** `Uniswap v2 USDT-WETH Pool yVault`, `Uniswap v2 WBTC-WETH Pool yVault` * Symbol: `yvUni-TOKEN-TOKEN` * **Examples:** `yvUni-USDT-WETH`, `yvUni-WBTC-WETH` * Note: Version was included for Uniswap LP tokens to help limit confusion between UNI-v2 LP tokens and upcoming UNI-v3 LP tokens. * Balancer * Name: `Balancer + TOKEN-TOKEN + Pool yVault` * **Examples:** `Balancer USDT-WETH Pool yVault`, `Balancer WBTC-WETH Pool yVault` * Symbol: `yvBal-TOKEN-TOKEN` * **Examples:** `yvBal-USDT-WETH`, `yvBal-WBTC-WETH` * Note: Since Balancer allows more than two tokens per pool, append as many `TOKEN` as needed for the pool in question. ## yEarn * These are Yearn's original yield-aware tokens, whose v2 and v3 contracts can be found [here](https://docs.yearn.finance/developers/deployed-contracts-registry#v2-yield-tokens). * These products should be referred to as yEarn Tokens, `underlying token name + Earn`, or `y{token.symbol()}v${self.version()}` * **Examples:** `yDAIv2`, `yDAI Earn`, `yBUSDv3`, `yBUSD Earn` ## Test Products * For deployed contracts that have not reached their final production version, a simple modification is included to designate these on the contract level as being test products. * Name: `${token.symbol()} or override + Test + Product` * Symbol: `yt${token.symbol()} or override` * **Examples:** `DAI Test yVault`, `ytDAI` * Additionally, the v2 yVault contracts have upgradeable `name` and `symbol` fields. This means that should a test contract perform well, these fields can be updated to reflect that it is no longer a test contract, removing the need to deploy new contracts. ## Future Products * Future products can follow a simple naming convention: `y + product`, where the product and any potential token names follow similar guidelines as above with yVaults. These can then be further modified as needed based on the product(s). * **Examples:** `ySwap`, `yBorrow`, `yTrade` ## Current yVaults and v2 Names | Current Name | Current Symbol | v2 Name | v2 Symbol | Current Vault Token Contract | | ------------------- | -------------- | ------------ | -------------- | ------------------------------------------ | | yearn Wrapped Ether | yWETH | WETH yVault | yvWETH | 0xe1237aa7f535b0cc33fd973d66cbf830354d16c7 | | yearn yearn.finance | yYFI | YFI yVault | yvYFI | 0xba2e7fed597fd0e3e70f5130bcdbbfe06bb94fe1 | | yearn Curve.fi DAI/USDC/USDT | y3Crv | Curve 3pool yVault | yvCurve-3pool | 0x9cA85572E6A3EbF24dEDd195623F188735A5179f | | yearn Curve.fi yDAI/yUSDC/yUSDT/yTUSD | yyDAI+yUSDC+yUSDT+yTUSD | Curve Y Pool yVault | yvCurve-Y | 0x5dbcF33D8c2E976c6b560249878e6F1491Bca25c | | yearn Curve.fi yDAI/yUSDC/yUSDT/yBUSD | yyDAI+yUSDC+yUSDT+yBUSD | Curve BUSD Pool yVault | yvCurve-BUSD | 0x2994529C0652D127b7842094103715ec5299bBed | | yearn Curve.fi renBTC/wBTC/sBTC | ycrvRenWSBTC | Curve sBTC Pool yVault | yvCurve-sBTC | 0x7Ff566E1d69DEfF32a7b244aE7276b9f90e9D0f6 | | yearn Dai Stablecoin | yDAI | DAI yVault | yvDAI | 0xACd43E627e64355f1861cEC6d3a6688B31a6F952 | | yearn TrueUSD | yTUSD | TUSD yVault | yvTUSD | 0x37d19d1c4E1fa9DC47bD1eA12f742a0887eDa74a | | yearn USD//C | yUSDC | USDC yVault | yvUSDC | 0x597aD1e0c13Bfe8025993D9e79C69E1c0233522e | | yearn Tether USD | yUSDT | USDT yVault | yvUSDT | 0x2f08119C6f07c006695E079AAFc638b8789FAf18 | | yearn Gemini Dollar | yGUSD | GUSD yVault | yvGUSD | 0xec0d8D3ED5477106c6D4ea27D90a60e594693C90 | | yearn Aave Interest bearing LINK | yaLINK | aLINK yVault | yvaLINK | 0x29E240CFD7946BA20895a7a02eDb25C210f9f324 |

    Import from clipboard

    Paste your markdown or webpage here...

    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 lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    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 with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # 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
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    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.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        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
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

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

        Syncing

        Push failed

        Push successfully