Skip to content

chore: update honey clarifications #777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
okjintao wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −1
Open

chore: update honey clarifications #777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/core/content/developers/contracts/honey-factory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ function redeem(

### liquidate

Liquidates a bad collateral asset for a good one.
Liquidates a bad collateral asset for a good one. Uses a filtered weight calculation for the bad collateral in its global cap check, distinct from mint/redeem.

**Parameters:**

Expand Down
4 changes: 4 additions & 0 deletions apps/core/content/learn/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Berachain Improvement Proposals (BRIPs) are welcome from anyone, by [contributin

Below are important changes shipped to Berachain.

## February 2025

**Honey basket mode clarifications** – Added [proportional redemption rationale](/learn/pol/tokens/honey#why-proportional-redemptions) and [collateral caps behaviour](/learn/pol/tokens/honey#collateral-caps) to HONEY documentation. Documented paused vault treatment in cap calculations, weight changes via minting with other collaterals, and liquidate's filtered weight check. Updated [HoneyFactory](/developers/contracts/honey-factory#liquidate) liquidate reference.

## December 2025

**Reward allocation documentation updates** – Updated [BeraChef reward allocation documentation](/learn/pol/blockrewards#berachef-reward-allocation-management) to clarify the automated cutting board mechanism.
Expand Down
12 changes: 12 additions & 0 deletions apps/core/content/learn/pol/tokens/honey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,18 @@ Basket Mode is a safety mechanism that activates when collateral assets become u
- In this situation, to mint `$HONEY`, users must provide proportional amounts of all collateral assets in the basket, rather than choosing a single asset
- If one asset is depegged, you can mint only with the other asset

### Why Proportional Redemptions

Basket mode prevents selective exits when collateral becomes unstable. Redemptions are always proportional across all assets in the basket, so users cannot redeem only healthy collateral and leave depegged exposure to others. The protocol distributes depeg risk across the full collateral set.

### Collateral Caps

The HoneyFactory enforces global and relative caps on collateral weights. These limits apply to mint, redeem, recapitalize, and liquidate operations and keep the basket composition within configured bounds.

Paused vaults remain included in cap calculations (except when marked as bad collateral). Users cannot mint or redeem paused collateral directly, but its weight can decrease when users mint with other collaterals outside basket mode. The `liquidate` function uses a separate weight calculation that filters bad collateral, so liquidation remains available even when paused collateral affects mint and redeem cap checks.

On mainnet, caps are currently disabled by foundation configuration.

## Fees

Fees collected from minting and redeeming `$HONEY` are distributed to `$BGT` holders. The current fee structure is the following:
Expand Down