hyperlane-monorepo

Commit Graph

Author	SHA1	Message	Date
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
Yorke Rhodes	1579ca221c	fix: disable initializers in xERC20 adapters (#3979 ) ### Description - Follow OZ best practice from https://docs.openzeppelin.com/upgrades-plugins/1.x/writing-upgradeable#initializing_the_implementation_contract ### Backward compatibility Yes ### Testing Unit tests	5 months ago
Yorke Rhodes	6620fe6367	fix: eliminate branching from `TokenRouter` (#3878 ) ### Description Fixes bug in `TokenRouter` which dispatches messages to token recipient rather than address in `Router` table when hook overrides are provided. ### Drive-by changes Simplifies inheritance tree of `TokenRouter` > `GasRouter` > `Router` > `MailboxClient` ### Backward compatibility Yes ### Testing Unit Tests	5 months ago
Yorke Rhodes	a8a68f6f61	test: XERC20 and XERC20 Lockbox integration tests (#3849 )	6 months ago
Yorke Rhodes	49f41d9759	chore: Merge branch 'main' into cli-2.0 (#3863 ) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Kunal Arora <55632507+aroralanuk@users.noreply.github.com> Co-authored-by: Connor McEwen <connor.mcewen@gmail.com> Co-authored-by: Trevor Porter <tkporter4@gmail.com> Co-authored-by: byeongsu-hong <hong@byeongsu.dev> Co-authored-by: Avi Atkin <103125634+avious00@users.noreply.github.com> Co-authored-by: Daniel Savu <23065004+daniel-savu@users.noreply.github.com> Co-authored-by: J M Rossy <jm.rossy@gmail.com> Co-authored-by: Ali Alaoui <aalaoui2001@gmail.com> Co-authored-by: Nam Chu Hoai <nambrot@googlemail.com> Co-authored-by: Paul Balaji <paul@hyperlane.xyz> Co-authored-by: omahs <73983677+omahs@users.noreply.github.com>	6 months ago
Yorke Rhodes	babe816f86	feat: support xerc20 and xerc20Lockbox in CLI (#3753 ) ### Description - Supports xERC20 and xERC20Lockbox in CLI and UI ### Drive-by changes - Rename XERC20Collateral to XERC20 ### Backward compatibility - Yes ### Testing - Manual	6 months ago
Noah Bayindirli 🥂	21b62faea4	address new license warnings on hypcoll contracts (#3727 ) ### Description Addresses sol compiler warnings on missing licenses	7 months ago
Yorke Rhodes	b6fdf2f7fe	Implement Connext xERC20 and Circle FiatToken collateral (#3618 ) ### Description - Implement XERC20 Collateral contract - Implement FiatToken Collateral contract ### Drive-by - Move vault collateral extension into token extensions folder ### Related issues - Fixes https://github.com/hyperlane-xyz/hyperlane-monorepo/issues/3486 ### Backward compatibility - Yes ### Testing - Unit tests	7 months ago
Lee	0090f19e78	Support self-relay with IGP enforced on warp routes (#3566 ) ### Description Adds transferRemote overload ### Drive-by changes <!-- Are there any minor or drive-by changes also included? --> ### Related issues - Fixes #3525 ### Backward compatibility Yes ### Testing Unit Tests	8 months ago
J M Rossy	adab1bec0c	Add code spellcheck CI job (#3467 ) ### Description Fix spelling mistakes and create codespell CI job. An extension of #3422 with the remaining mistakes fixed ### Backward compatibility Yes --------- Co-authored-by: miles <66052478+miles-six@users.noreply.github.com> Co-authored-by: Paul Balaji <paul@hyperlane.xyz>	8 months ago
Yorke Rhodes	b14f997810	Graduate to yarn 4 🧶 (#2899 ) Co-authored-by: J M Rossy <jm.rossy@gmail.com> Fixes https://github.com/hyperlane-xyz/issues/issues/687 Fixes #2228 Fixes https://github.com/hyperlane-xyz/issues/issues/704	1 year ago
Yorke Rhodes	1d18549755	Merge main to v3 (#2812 )	1 year ago
Yorke Rhodes	1ecfc46ce2	v3 Router SDK changes (#2752 ) ### Description - Reorganize solidity directory structure for clarity - Updates router apps (token and helloworld) with changes from https://github.com/hyperlane-xyz/hyperlane-monorepo/pull/2749 ### Drive-by changes - Merges the hyperlane-token package to solidity and sdk ### Backward compatibility No (removed token package) ### Testing - Unit Tests - Instrumented coverage	1 year ago

12 Commits (52c041862ec410c70384e60e7b96fef1a28c3d1a)