The home for Hyperlane core contracts, sdk packages, and other infrastructure

blockchainhyperlaneinterchainmonorepo

You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Kunal Arora 63abe564d4 feat: implementation of yield rebasing warp route contracts (#4203) ... ### Description - To reflect the rebased underlying asset, `_transferRemote` is overridden because we need to pass in the ERC4626 vault shares which on the synthetic `HypERC4626VaultYield` which change in value as the underlying vault shares accrue yield or receive a drawdown. - The exchangeRate (i.e., assets/shares) is encoded as metadata and sent to the synthetic token to calculate the value of the synthetic token. - On synthetic transfers, the overridden `ERC20.transfer()` function calculates the needed shares for the amount and transfers them instead. Design decisions - Do we need to rebase frequently? Yes, otherwise the exchangeRate on the synthetic token will be stale compared to the the actual vault claimable yield, which means a user who deposits later and right before the infrequent rebase will get disproportionate share of the yield. You can rebase by calling `rebase()` on the collateral token which makes a transferRemote call with 0 amount. - Why exchangeRate and not underlyingDepositedAmount on the synthetic? If a user withdraws (ie calls transferRemote on the synthetic) while a rebase is inflight, the underlyingDepositedAmount will get an inaccurate update (will be overreported and hence will derive inaccurate balance amounts on the synthetic. The exchangeRate doesn't change if the user is depositing or withdrawing. - Why override the `transfer` on the synthetic? Otherwise if a user A sends 100 USDC worth of shares to user B which has a exchange rate of 1.05, user A would have unwittingly sent 105 #tokens (5 excess). - What happens in a drawdown of the value? Once the user calls withdraws the the withdrawal they get out is accordingly discounted. If a user transfers on the synthetic, it will still gets the stale exchangeRate until rebase. - What if the owner of the vault charges a fee on the yield? In that case, you need to override the totalAssets to reflect the assets - feesByOwner and the warp route implementation will stay the same. One example implementation is `MockERC4626YieldSharing` and we have adequate tests to cover the functionality. - Rounding error? We're rounding down the exchangeRate as per the general recommendation for ERC4626 vault math. - Why not make the synthetic token an ERC4626 itself, given that there's some overlapping functionality? Even though, the assetsToShares and assetsToShares functions are the same, the synthetic token itself doesn't have an underlying token so it doesn't confer to the 4626 interface. - What if there are multiple synthetic tokens for a single rebasing collateral contract and what happens is the exchange rate is not in sync between the synthetics? Things to keep in mind for - How do I keep the exchangeRate in sync with the underlying vault? Keep calling rebase as a cron job frequently, or make a hook call in deposit, redeem, and withdraw function to automatically resync the exchangeRate. - 4626 math pitfalls: https://www.zellic.io/blog/exploring-erc-4626/ ### Drive-by changes - Renaming `HypERC20CollateralVaultDeposit` -> `HypERC4626OwnerYieldCollateral` ### Related issues - fixes https://github.com/hyperlane-xyz/issues/issues/1334 ### Backward compatibility Yes ### Testing Unit tests		4 months ago
..
FastHypERC20.sol	Graduate to yarn 4 🧶 (#2899)	1 year ago
FastHypERC20Collateral.sol	Graduate to yarn 4 🧶 (#2899)	1 year ago
HypERC721URICollateral.sol	Graduate to yarn 4 🧶 (#2899)	1 year ago
HypERC721URIStorage.sol	Graduate to yarn 4 🧶 (#2899)	1 year ago
HypERC4626.sol	feat: implementation of yield rebasing warp route contracts (#4203)	4 months ago
HypERC4626Collateral.sol	feat: implementation of yield rebasing warp route contracts (#4203)	4 months ago
HypERC4626OwnerCollateral.sol	feat: implementation of yield rebasing warp route contracts (#4203)	4 months ago
HypFiatToken.sol	feat: support xerc20 and xerc20Lockbox in CLI (#3753)	6 months ago
HypNativeScaled.sol	fix: eliminate branching from `TokenRouter` (#3878)	5 months ago
HypXERC20.sol	fix: disable initializers in xERC20 adapters (#3979)	5 months ago
HypXERC20Lockbox.sol	fix: disable initializers in xERC20 adapters (#3979)	5 months ago