{{ props.title }}
41 |{{ props.description }}
42 | 43 |
21 |
22 | - [ ] I have synced my fork so that it is up to date with the latest changes
23 |
24 | 
25 |
26 | Let us know your wallet address/ENS:
27 |
28 | ```
29 | 0xYourAddress
30 | ```
31 |
--------------------------------------------------------------------------------
/.github/workflows/validate.yml:
--------------------------------------------------------------------------------
1 | name: Validate CI
2 |
3 | on:
4 | pull_request:
5 |
6 | jobs:
7 | validate:
8 | runs-on: ubuntu-latest
9 |
10 | steps:
11 | - uses: actions/checkout@v4
12 |
13 | - name: Setup Node.js
14 | uses: actions/setup-node@v4
15 | with:
16 | node-version-file: '.nvmrc'
17 |
18 | - name: Setup pnpm
19 | uses: pnpm/action-setup@v2
20 |
21 | - name: Install dependencies
22 | run: pnpm install
23 |
24 | - name: Check Formatting
25 | run: |
26 | pnpm format:check
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | node_modules
5 | .pnp
6 | .pnp.js
7 |
8 | # testing
9 | coverage
10 |
11 | # next.js
12 | .next/
13 | out/
14 | build
15 |
16 | # misc
17 | .DS_Store
18 | *.pem
19 |
20 | # debug
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 |
25 | # local env files
26 | .env
27 | .env.local
28 | .env.development.local
29 | .env.test.local
30 | .env.production.local
31 |
32 | # turbo
33 | .turbo
34 |
35 | # vercel
36 | .vercel
37 |
38 | **/dist
39 |
40 | .vscode/
41 |
42 | **/.vitepress/cache/
43 | **/.vitepress/dist/
44 |
45 | .chatgpt-md-translator
46 | .prompt.md
47 | translate.sh
48 |
49 | # other package manager lock files
50 | package-lock.json
51 | yarn.lock
52 |
--------------------------------------------------------------------------------
/.npmrc:
--------------------------------------------------------------------------------
1 | auto-install-peers=true
2 | engine-strict=true
3 |
--------------------------------------------------------------------------------
/.nvmrc:
--------------------------------------------------------------------------------
1 | 20.11.0
--------------------------------------------------------------------------------
/.prettierignore:
--------------------------------------------------------------------------------
1 | dist
2 | cache
3 | .turbo
4 | public
5 | package.json
6 | node_modules
7 | CHANGELOG.md
8 | .changeset
9 | .changeset/*.json
10 | .changeset/*.md
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) Berachain Foundation and affiliates.
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # 🐻 Berachain Monorepo Docs
2 |
3 | This is a monolithic repository that contains all the documentation for [Berachain](https://www.berachain.com/) and BEX.
4 |
5 | ## Requirements
6 |
7 | - NVM or Node `v20.11.0` or greater
8 | - [pnpm](https://pnpm.io/) (recommended)
9 |
10 | ## Turborepo Folder Structure
11 |
12 | This Turborepo includes the following packages/apps:
13 |
14 | ### Docs
15 |
16 | All docs are built with [Vitepress](https://vitepress.dev) - Vite & Vue Powered Static Site Generator.
17 |
18 | - `apps/bex`- Main docs repository for [https://docs.bex.berachain.com](https://docs.bex.berachain.com)
19 | - `apps/core`- Main docs repository for [https://docs.berachain.com](https://docs.berachain.com)
20 |
21 | ### Packages
22 |
23 | A series of packages that are shared with various `apps` (doc sites).
24 |
25 | - `packages/ui`: All Vitepress vue components used by the different doc apps.
26 | - `packages/config`: All configurations and constants
27 |
28 | ## Quick Start
29 |
30 | Install dependencies for all apps and packages.
31 |
32 | ```bash
33 | # FROM: ./
34 |
35 | pnpm install;
36 | ```
37 |
38 | If you'd like to run all apps at the same time, run the following:
39 |
40 | ```bash
41 | # FROM: ./
42 |
43 | pnpm dev;
44 |
45 | # @berachain/bex:dev - http://localhost:5173
46 | # @berachain/core:dev - http://localhost:5176
47 | ```
48 |
49 | If you'd like to run an individual app, run the following:
50 |
51 | ```bash
52 | # FROM: ./
53 |
54 | pnpm dev --filter @berachain/core;
55 | ```
56 |
57 | ## Contributing
58 |
59 | ### Code Of Conduct
60 |
61 | Please see [Code of Conduct](CODE_OF_CONDUCT.md).
62 |
63 | ### Contributing Guide
64 |
65 | Please see [CONTRIBUTING.md](CONTRIBUTING.md) on how to contribute and also see the [development workflow](CONTRIBUTING.md#development-workflow).
66 |
67 | ## License
68 |
69 | Berachain Docs [License](LICENSE)
70 |
--------------------------------------------------------------------------------
/apps/bex/.prettierignore:
--------------------------------------------------------------------------------
1 | dist
2 | cache
3 | .turbo
4 | public
5 | package.json
6 | node_modules
7 | CHANGELOG.md
--------------------------------------------------------------------------------
/apps/bex/.vitepress/theme/index.ts:
--------------------------------------------------------------------------------
1 | // Imports
2 | // ========================================================
3 | import { h, onMounted } from "vue";
4 | import DefaultTheme from "vitepress/theme";
5 | import Fidget from "@berachain/ui/Fidget";
6 | import "@berachain/ui/style";
7 | import { mountVercelToolbar } from "@vercel/toolbar/vite";
8 |
9 | // Theme Configuration
10 | // ========================================================
11 | export default {
12 | extends: DefaultTheme,
13 | Layout: () => {
14 | // Mount the Vercel toolbar when the component is mounted
15 | onMounted(() => {
16 | mountVercelToolbar();
17 | });
18 |
19 | return h(DefaultTheme.Layout, null, {
20 | // https://vitepress.dev/guide/extending-default-theme#layout-slots
21 | "sidebar-nav-after": () => h(Fidget),
22 | });
23 | },
24 | enhanceApp({ app, router, siteData }) {
25 | // Extended here
26 | },
27 | };
28 |
--------------------------------------------------------------------------------
/apps/bex/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # @berachain/bex
2 |
3 | ## 1.1.5
4 |
5 | ### Patch Changes
6 |
7 | - Updated dependencies
8 | - @berachain/config@1.2.0
9 |
10 | ## 1.1.4
11 |
12 | ### Patch Changes
13 |
14 | - Revised homepages to remove sidebar and emphasize other docs
15 | - Updated dependencies
16 | - @berachain/ui@1.1.1
17 |
18 | ## 1.1.3
19 |
20 | ### Patch Changes
21 |
22 | - Updated dependencies
23 | - @berachain/ui@1.1.0
24 |
25 | ## 1.1.2
26 |
27 | ### Patch Changes
28 |
29 | - Updated dependencies
30 | - @berachain/config@1.1.1
31 |
32 | ## 1.1.1
33 |
34 | ### Patch Changes
35 |
36 | - Updated dependencies
37 | - @berachain/ui@1.0.1
38 |
39 | ## 1.1.0
40 |
41 | ### Minor Changes
42 |
43 | - Updated constants variables
44 |
45 | ## 1.0.1
46 |
47 | ### Patch Changes
48 |
49 | - Updated dependencies [c7a86e4]
50 | - @berachain/config@1.1.0
51 |
52 | ## 1.0.0
53 |
54 | ### Major Changes
55 |
56 | - Initial versions for bend, berps, bex, and core
57 |
58 | ## 0.0.1
59 |
60 | ### Patch Changes
61 |
62 | - Updated dependencies
63 | - @berachain/config@1.0.0
64 | - @berachain/ui@1.0.0
65 |
--------------------------------------------------------------------------------
/apps/bex/content/developers/contracts/factory/stable-pool-factory.md:
--------------------------------------------------------------------------------
1 |
4 |
5 | # ComposableStablePoolFactory
6 |
7 | > {{config.mainnet.contracts.bex.stablePoolFactory.address}} | ABI JSON
8 |
9 | ## Functions
10 |
11 | ### create
12 |
13 | _Deploys a new `ComposableStablePool`._
14 |
15 | ```solidity
16 | function create(
17 | string memory name,
18 | string memory symbol,
19 | IERC20[] memory tokens,
20 | uint256 amplificationParameter,
21 | IRateProvider[] memory rateProviders,
22 | uint256[] memory tokenRateCacheDurations,
23 | bool exemptFromYieldProtocolFeeFlag,
24 | uint256 swapFeePercentage,
25 | address owner,
26 | bytes32 salt
27 | ) external returns (ComposableStablePool)
28 | ```
29 |
30 | **Parameters**
31 |
32 | | Name | Type | Description |
33 | | ------------------------------ | --------------- | --------------------------------------------------------------------- |
34 | | name | string | The name of the pool token |
35 | | symbol | string | The symbol of the pool token |
36 | | tokens | IERC20[] | Array of token addresses in the pool |
37 | | amplificationParameter | uint256 | The amplification parameter (A factor) for the pool |
38 | | rateProviders | IRateProvider[] | Array of rate provider addresses for each token |
39 | | tokenRateCacheDurations | uint256[] | Array of cache durations for each token's rate |
40 | | exemptFromYieldProtocolFeeFlag | bool | Boolean flag indicating if tokens are exempt from yield protocol fees |
41 | | swapFeePercentage | uint256 | The swap fee percentage for the pool |
42 | | owner | address | The owner address of the pool |
43 | | salt | bytes32 | Unique salt for deterministic pool address creation |
44 |
45 | ### isPoolFromFactory
46 |
47 | _Returns true if `pool` was created by this factory._
48 |
49 | ```solidity
50 | function isPoolFromFactory(address pool) external view returns (bool);
51 | ```
52 |
53 | ### isDisabled
54 |
55 | _Check whether the derived factory has been disabled._
56 |
57 | ```solidity
58 | function isDisabled() external view returns (bool);
59 | ```
60 |
61 | ### disable
62 |
63 | _Disable the factory, preventing the creation of more pools. Already existing pools are unaffected.
64 | Once a factory is disabled, it cannot be re-enabled._
65 |
66 | ```solidity
67 | function disable() external;
68 | ```
69 |
--------------------------------------------------------------------------------
/apps/bex/content/developers/contracts/factory/weighted-pool-factory.md:
--------------------------------------------------------------------------------
1 |
4 |
5 | # WeightedPoolFactory
6 |
7 | > {{config.mainnet.contracts.bex.weightedPoolFactory.address}} | ABI JSON
8 |
9 | ## Functions
10 |
11 | ### create
12 |
13 | _Deploys a new `WeightedPool`._
14 |
15 | ```solidity
16 | function create(
17 | string memory name,
18 | string memory symbol,
19 | IERC20[] memory tokens,
20 | uint256[] memory normalizedWeights,
21 | IRateProvider[] memory rateProviders,
22 | uint256 swapFeePercentage,
23 | address owner,
24 | bytes32 salt
25 | ) external returns (address);
26 | ```
27 |
28 | **Parameters**
29 |
30 | | Name | Type | Description |
31 | | ----------------- | --------------- | --------------------------------------------------- |
32 | | name | string | The name of the pool token |
33 | | symbol | string | The symbol of the pool token |
34 | | tokens | IERC20[] | Array of token addresses in the pool |
35 | | normalizedWeights | uint256[] | Array of normalized weights for each token |
36 | | rateProviders | IRateProvider[] | Array of rate provider addresses for each token |
37 | | swapFeePercentage | uint256 | The swap fee percentage for the pool |
38 | | owner | address | The owner address of the pool |
39 | | salt | bytes32 | Unique salt for deterministic pool address creation |
40 |
41 | ### isPoolFromFactory
42 |
43 | _Returns true if `pool` was created by this factory._
44 |
45 | ```solidity
46 | function isPoolFromFactory(address pool) external view returns (bool);
47 | ```
48 |
49 | ### isDisabled
50 |
51 | _Check whether the derived factory has been disabled._
52 |
53 | ```solidity
54 | function isDisabled() external view returns (bool);
55 | ```
56 |
57 | ### disable
58 |
59 | _Disable the factory, preventing the creation of more pools. Already existing pools are unaffected.
60 | Once a factory is disabled, it cannot be re-enabled._
61 |
62 | ```solidity
63 | function disable() external;
64 | ```
65 |
--------------------------------------------------------------------------------
/apps/bex/content/developers/contracts/lp_tokens/underlying.md:
--------------------------------------------------------------------------------
1 | # Underlying Tokens in BEX
2 |
3 | ## Overview
4 |
5 | It's common to want to know what underlying tokens a BEX LP token represents. This documentation explains how to query this information directly from the BEX contract and LP tokens.
6 |
7 | ## Querying the BEX Contract and LP Tokens
8 |
9 | The BEX contract can provide the exact number of tokens in a pool. By querying this information and calculating your share of the pool, you can determine your underlying token balances.
10 |
11 | ### Step-by-Step Process
12 |
13 | 1. Query the BEX contract for pool tokens and balances
14 | 2. Calculate your pool share
15 | 3. Calculate your underlying token balances
16 |
17 | ### Pseudocode
18 |
19 | ```solidity
20 | (tokens, balances, lastChangeBlock) = vault.getPoolTokens(poolId);
21 | yourPoolShare = lpToken.balanceOf(yourAddress) / lpToken.totalSupply();
22 | uint256[] yourUnderlyingBalances = new uint256[](balances.length);
23 | for (i = 0; i < balances.length; i++) {
24 | yourUnderlyingBalances[i] = balances[i] * yourPoolShare;
25 | }
26 | return (tokens, yourUnderlyingBalances);
27 | ```
28 |
29 | ## Special Considerations
30 |
31 | ### Stable Pools
32 |
33 | For stable pools in BEX:
34 |
35 | 1. Use `getActualSupply()` instead of `totalSupply()` to get the correct pool supply
36 | 2. If you've staked your LP tokens, calculate your total LP token balance as:
37 | ```solidity
38 | myLpTokens = lpToken.balanceOf(yourAddress) + lpStakingContract.balanceOf(yourAddress);
39 | ```
40 |
41 | ## Example: Querying BERA/HONEY Pool
42 |
43 | Let's say you want to know your underlying BERA and HONEY balances for a BERA/HONEY pool:
44 |
45 | | Step | Action | Result |
46 | | ---- | -------------------- | ----------------------------------------------------------- |
47 | | 1 | Query BEX | tokens = [BERA, HONEY], balances = [1000 BERA, 10000 HONEY] |
48 | | 2 | Get LP token balance | yourLpTokens = 100 |
49 | | 3 | Get total LP supply | actualSupply = getActualSupply() = 1000 |
50 | | 4 | Calculate pool share | yourPoolShare = 100 / 1000 = 0.1 (10%) |
51 | | 5 | Calculate underlying | yourBera = 1000 \* 0.1 = 100 BERA |
52 | | 6 | Calculate underlying | yourHoney = 10000 \* 0.1 = 1000 HONEY |
53 |
54 | In this example, your 100 LP tokens represent 100 BERA and 1000 HONEY.
55 |
--------------------------------------------------------------------------------
/apps/bex/content/developers/contracts/lp_tokens/valuing.md:
--------------------------------------------------------------------------------
1 | # Valuing BEX LP Tokens
2 |
3 | ## Overview
4 |
5 | It's common to want to know the value of a BEX LP token. This generally comes down to its Net Asset Value (NAV), i.e., the value of the underlying tokens.
6 |
7 | ## NAV Calculation
8 |
9 | ### Equation
10 |
11 | The Net Asset Value (NAV) of an LP token is calculated as:
12 |
13 | $$Price_{LP\ token} = \frac{\sum_i(Balance_i \times Price_i)}{Supply_{LP\ Tokens}}$$
14 |
15 | Where:
16 |
17 | - Balance₍ᵢ₎ is the balance of token i in the pool
18 | - Price₍ᵢ₎ is the market price of token i (e.g., from an oracle or price feed)
19 | - Supply₍ₗₚ₎ is the total supply of LP tokens
20 |
21 | ### Pseudocode
22 |
23 | ```solidity
24 | (tokens, balances, lastChangeBlock) = vault.getPoolTokens(poolId);
25 | prices = fetchPricesFromPriceProvider(tokens); // e.g., from an oracle
26 | poolValueUsd = sum(balances[i] * price[i]);
27 | lpTokenPriceUsd = poolValueUsd / lpToken.totalSupply();
28 | ```
29 |
30 | ## Special Considerations
31 |
32 | ### Stable Pools
33 |
34 | For stable pools, they have pre-minted LP tokens. In such cases:
35 |
36 | - Use `getActualSupply()` instead of `totalSupply()` to get the correct pool supply
37 |
38 | ### Calculating Value for a Specific Address
39 |
40 | To calculate the value of LP tokens held by a specific address:
41 |
42 | ```solidity
43 | myLpTokenValueUsd = lpToken.balanceOf(myAddress) * lpTokenPriceUsd;
44 | ```
45 |
46 | If LP tokens are staked, include staked balance:
47 |
48 | ```solidity
49 | myLpTokens = lpToken.balanceOf(myAddress) + lpStakingContract.balanceOf(myAddress);
50 | myLpTokenValueUsd = myLpTokens * lpTokenPriceUsd;
51 | ```
52 |
53 | ## Example: Valuing `$BERA/$HONEY` LP Tokens
54 |
55 | Let's value LP tokens for a `$BERA/$HONEY` pool:
56 |
57 | | Step | Action | Result |
58 | | ---- | ------------------------ | ----------------------------------------------------------------- |
59 | | 1 | Query BEX | tokens = [`$BERA`, `$HONEY`], balances = [1000 BERA, 10000 HONEY] |
60 | | 2 | Fetch prices | prices = [$10 (BERA), $1 (HONEY)] |
61 | | 3 | Calculate pool value | poolValueUsd = (1000 _ $10) + (10000 _ $1) = $20,000 |
62 | | 4 | Get total LP supply | totalLpSupply = 1000 |
63 | | 5 | Calculate LP token price | lpTokenPriceUsd = $20,000 / 1000 = $20 |
64 |
65 | In this example, each LP token is worth $20.
66 |
--------------------------------------------------------------------------------
/apps/bex/content/developers/contracts/relayers.md:
--------------------------------------------------------------------------------
1 | # Relayers
2 |
3 | Relayers are opt-in, audited contracts that can make calls to the vault on behalf of users. They can use the sender's ERC20 vault allowance, internal balance, or BPTs after being approved.
4 |
5 | ## Types of Relayers
6 |
7 | ### BalancerRelayer
8 |
9 | The BalancerRelayer allows users to execute multiple vault actions in a single transaction by chaining them together. This improves UX by reducing the number of transactions needed for complex operations.
10 |
11 | Example of chaining multiple actions:
12 |
13 | ```js
14 | // Approve relayer
15 | const approval = buildApproval(signature);
16 |
17 | // Chain exit pool and swap
18 | const exitPoolCallData = buildExitPool(poolId, bptAmount);
19 | const swapCallData = buildSwap(params);
20 |
21 | // Execute all actions in one transaction
22 | const tx = await relayer.multicall([approval, exitPoolCallData, swapCallData]);
23 | ```
24 |
25 | ### PoolCreationHelper
26 |
27 | The PoolCreationHelper is a specialized relayer that simplifies pool creation and initial liquidity provision. See the [PoolCreationHelper](/developers/contracts/factory/pool-creation-helper) documentation for details.
28 |
29 | Key features:
30 |
31 | - Creates and joins pools in a single transaction
32 | - Supports joining WBERA pools with either WBERA or BERA
33 | - Handles both weighted and stable pool creation
34 |
35 | ## Approving a Relayer
36 |
37 | Before a relayer can act on your behalf, you must approve it using the Vault's `setRelayerApproval` function:
38 |
39 | ```solidity
40 | function setRelayerApproval(
41 | address sender,
42 | address relayer,
43 | bool approved
44 | ) external;
45 | ```
46 |
47 | For example, to approve the PoolCreationHelper:
48 |
49 | ```js
50 | const vault = new ethers.Contract(VAULT_ADDRESS, vaultAbi, wallet);
51 | await vault.setRelayerApproval(
52 | wallet.address, // sender
53 | RELAYER_ADDRESS, // relayer
54 | true // approved
55 | );
56 | ```
57 |
58 | > Note: Only approve relayers that have been audited and are part of the official BEX deployment.
59 |
--------------------------------------------------------------------------------
/apps/bex/content/developers/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | head:
3 | - - meta
4 | - property: og:title
5 | content: Deployed Contracts
6 | - - meta
7 | - name: description
8 | content: Registry of deployed BEX contract addresses.
9 | - - meta
10 | - property: og:description
11 | content: Registry of deployed BEX contract addresses.
12 | ---
13 |
14 |
17 |
18 | # BEX Deployed Contracts
19 |
20 | :::warning ⚠️ Security Notice
21 |
22 | On January 21st, 2025, Balancer disclosed a long-standing vulnerability in their V2 Vault implementation. BEX incorporates contract logic from Balancer V2 and shares the same vulnerability. We advise users creating new pools to assess the vulnerability and exercise additional caution, particularly when including **untrusted or newly-created tokens**.
23 |
24 | **Funds currently deposited in BEX are safe, and no action from LPs is needed.** The issue only (potentially) affects tokens that are not live on-chain today. Frontend warnings are displayed on BEX for potentially vulnerable tokens.
25 |
26 | Future plans include integrating the Balancer V3 codebase, which mitigates this vulnerability and is cross-compatible with current BEX pools.
27 |
28 | For more information, see the [Balancer disclosure](https://forum.balancer.fi/t/balancer-v2-token-frontrun-vulnerability-disclosure/6309).
29 | :::
30 |
31 | The following is a list of contract address in order to interact with Berachain BEX.
32 |
33 | > A full list of Contract ABIs can be found at https://github.com/berachain/doc-abis
34 |
35 | ## Mainnet Contracts
36 |
37 | | Name | Bepolia | ABI |
|---|---|---|
| {{ contract.name }}{{ contract.name }} | 44 |45 | {{contract['mainnet-address']}} 46 | | 47 |ABI | 48 |
| Name | Bepolia | ABI |
|---|---|---|
| {{ contract.name }}{{ contract.name }} | 63 |64 | {{contract['bepolia-address']}} 65 | | 66 |ABI | 67 |
{{ props.description }}
42 | 43 | 44 | 45 | 46 | 50 | -------------------------------------------------------------------------------- /packages/ui/Fidget.vue: -------------------------------------------------------------------------------- 1 | 5 | 29 | 30 | 34 | 35 |