Skip to main content

Vault Interface

If you want stakers to deposit through your own site instead of app.stakewise.io, you can use the open-source stakewise/vault-interface — a Next.js frontend you connect to your Vault and deploy in a few minutes under your own domain.

The UI supports Ethereum, Gnosis Chain, and Hoodi Testnet, and offers the same style and set of actions stakers can take on app.stakewise.io: deposit, withdraw, mint, burn, boost, and unboost1. They can also see stats, unstake/unboost progress, and claim assets.

Building a staking interface from scratch takes time and engineering resources. The template gives you a production-ready UI. StakeWise keeps the template in sync with the latest released features and constantly improves it.

There are two ways to set it up:

  • CLI (recommended) — run npx @stakewise/create-vault-interface, which walks you through configuration and generates a ready-to-run project.
  • Manual setup — clone the repository, update the .env file with your configuration, install dependencies, and deploy.
IconLive demo

Try the live demo at vault-interface-lemon.vercel.app ↗ before deploying your own. For a real-world example, Serenita ↗ runs this template in production — a good reference for what a customized deployment looks like.

Requirements

  • Node.js ↗ 24.12.0 or higher (see .nvmrc).
  • pnpm ↗ — run corepack enable && corepack prepare pnpm@latest --activate2.
  • Git — recommended (the CLI initializes a fresh repository).

Setup

Run the CLI to scaffold a configured project in a few minutes:

npx @stakewise/create-vault-interface

The CLI will:

  1. Ask for the values listed in the configuration reference.
  2. Clone stakewise/vault-interface into your chosen folder (without git history).
  3. Apply the brand color you chose (or change it later — see Theming).
  4. Generate a populated .env file.
  5. Initialize a fresh git repository with an initial commit.
  6. Optionally run pnpm install, then npx vercel to deploy.

Configuration reference

Each row maps a CLI prompt to its .env variable. The CLI writes these for you; for manual setup, set them in .env yourself. The canonical list lives in .env.example.

CLI prompt.env variableDescription
Project name— (CLI only)Defaults to vault-interface.
Site titleNEXT_PUBLIC_TITLEUsed in site metadata.
Theme— (CLI only)Optional. If enabled, prompts for #rrggbb values for the light and dark themes.
NetworksSet by the per-network variables belowMulti-select: Mainnet / Gnosis / Hoodi.
Vault addressNEXT_PUBLIC_MAINNET_VAULT_ADDRESS, NEXT_PUBLIC_GNOSIS_VAULT_ADDRESS, NEXT_PUBLIC_HOODI_VAULT_ADDRESSRequired for each selected network. Validated as 0x followed by 40 hex characters.
RPC URLNEXT_PUBLIC_MAINNET_NETWORK_URL, NEXT_PUBLIC_GNOSIS_NETWORK_URL, NEXT_PUBLIC_HOODI_NETWORK_URLRequired for each selected network. Hoodi testnet only appears when VERCEL_ENV is not set to production; in production, users can switch to the testnet only through their wallet interface.
Fallback RPCNEXT_PUBLIC_MAINNET_FALLBACK_URL, NEXT_PUBLIC_GNOSIS_FALLBACK_URL, NEXT_PUBLIC_HOODI_FALLBACK_URLOptional backup RPC for each selected network.
Site domainNEXT_PUBLIC_OWNER_DOMAINRequired. Used in site metadata, e.g. app.example.io.
X accountNEXT_PUBLIC_OWNER_X_ACCOUNTOptional. Handle for site metadata.
WalletNEXT_PUBLIC_WALLET_CONNECT_IDOptional. WalletConnect Project ID.
ReferrerNEXT_PUBLIC_REFERREROptional. Validated as 0x address.
LanguagesNEXT_PUBLIC_LOCALESDefaults to en, ru, fr, es, pt, de, zh. Restrict with a comma-separated list, e.g. NEXT_PUBLIC_LOCALES=en, zh.
CurrenciesNEXT_PUBLIC_CURRENCIESDefaults to usd, eur, gbp, cny, jpy, krw, aud. Restrict with a comma-separated list.
SecurityNEXT_PUBLIC_CONTENT_SECURITY_POLICYOptional. Content-Security-Policy. Whitespace-separated origins allowed to embed the site in a frame, e.g. https://app.safe.global https://*.blockscout.com.
IconHiding specific actions

If your Vault doesn't support some actions (e.g. no osToken minting), you can hide their tabs from the UI by setting the matching NEXT_PUBLIC_DISABLE_* variable to any truthy value. See .env.example for the full list.

Theming

The UI ships with light and dark themes. The initial theme matches the user's system preference and can be changed from the settings menu.

Brand colors live in src/styles/settings.scss. After editing them, run:

pnpm colors

This script generates RGB versions from your hex codes and updates:

  • src/styles/tailwind/layers/base.css
  • src/styles/tailwind/theme.css
  • src/styles/variables.scss

The favicon is a 16x16 image in the public/ folder. By default, the osETH logo is used — replace the file to use your own.

IconStill have questions?

If you need any help with the template, reach out to the StakeWise team via info@stakewise.io, Telegram ↗, or Discord ↗.

1. Mint and Burn are available only if your Vault has osToken enabled. Boost and Unboost also require Ethereum Vault version 2+.

2. The pnpm install command (alias: pnpm i) is used to install all dependencies for a Node.js project listed in the package.json file, generating a pnpm-lock.yaml file to ensure consistent installations. It is faster and more disk-space efficient than npm install because it uses a centralized content-addressable store to create hard links for packages. For more details, see pnpm.io/motivation ↗.