yearn.fi

Initial Setup

• Fork the original repo into your GitHub account

• Clone the forked repo from your GitHub account to your local machine

  git clone https://github.com/<your-gh>/yearn.fi.git
  

• Set origin to your fork. This is where you push your changes to. This is done automatically by the step above.

  git remote add origin https://github.com/<your-gh>/yearn.fi
  

• Set upstream to original repo.

  git remote add upstream https://github.com/yearn/yearn.fi.git
  

• Optional: Create a .env file in the repo root, copy .env.example, and replace values with your own keys. Client-readable values must use the NEXT_PUBLIC_ prefix; server-only secrets must stay unprefixed.

  cp apps/yearn/.env.example .env
  

• Optional: Install Husky for pre-commit scripts.

  bun add --dev husky
  

Install and run

Use Node.js 22.22.1+ (22.x), as required by lint-staged 17, and Bun 1.4.2 or newer.

The type-check and watch scripts invoke TypeScript 7 directly because the TypeScript 6 compatibility package used by boundary checks can also provide the tsc command.

1. Run bun install from the repository root.
2. Run bun run dev (or bun run dev:yearn) for Yearn at http://localhost:3000.
3. Run bun run dev:ybold for yBOLD at http://localhost:3002.

Both apps consume the private @yearn/vault-widget source package from this workspace. No registry publish is required.

Per-vault Enso denylist (disable zaps)

To disable Enso routing for specific vaults, edit:

apps/yearn/src/components/pages/vaults/constants/ensoDisabledVaults.ts

Add vault addresses under their chain ID:

const ENSO_DISABLED_VAULTS_BY_CHAIN: Partial<Record<number, readonly Address[]>> = {
  1: [
    '0x1111111111111111111111111111111111111111'
  ],
  42161: [
    '0x2222222222222222222222222222222222222222',
    '0x3333333333333333333333333333333333333333'
  ]
}

Notes:

• Keys are EVM chain IDs (1, 10, 137, 42161, etc.).
• Values are vault addresses for that chain.
• Address casing does not matter (addresses are normalized internally).
• Denylisted vaults disable Enso for both deposit and withdraw flows and hide zap UI on vault pages.

Making Changes

• Create a new local branch from upstream/main for each PR that you will submit

  git fetch
  git checkout -b <your branch name> upstream/main
  

• Commit your changes as you work

  git add .
  git commit -S -m "message"
  

  • info about verified commits

Pushing Changes to your Repo

• Commits are squashed when PR is merged so rebasing is optional

• When ready to push

  git fetch
  git merge upstream/main
  git push origin <branch-name>
  

Submitting Pull Request

• Go to your GitHub and navigate to your forked repo
• Click on Pull requests and then click on New pull request
• Click on compare across forks
• Click on compare: and select branch that you want to create a pull request for then click on create pull request