Skip to content
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.

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

doc: comment to notice compatible LST token type #69

Merged
merged 7 commits into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
7 changes: 7 additions & 0 deletions src/core/ExocoreGateway.sol
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,13 @@ contract ExocoreGateway is
}

/// @inheritdoc IExocoreGateway
/// @notice Tokens can only be normal reward-bearong LST tokens like wstETH, rETH, jitoSol...
adu-web3 marked this conversation as resolved.
Show resolved Hide resolved
/// And they are not intended to be: 1) rebasing tokens like stETH, since we assume staker's
/// balance would not change if nothing is done after deposit, 2) fee-on-transfer tokens, since we
/// assume Vault would count for the amount that staker transfers to it.
adu-web3 marked this conversation as resolved.
Show resolved Hide resolved
/// @notice If we want to activate client chain's native restaking, we should add the corresponding virtual
/// token address to the whitelist, bytes32(bytes20(0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)) for Ethereum
/// native restaking for example.
function addOrUpdateWhitelistTokens(
uint32 clientChainId,
bytes32[] calldata tokens,
Expand Down
4 changes: 4 additions & 0 deletions src/core/Vault.sol
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ contract Vault is Initializable, VaultStorage, IVault {
/// @notice Initializes the Vault contract.
/// @param underlyingToken_ The address of the underlying token.
/// @param gateway_ The address of the gateway contract.
/// @dev Vault only works with normal ERC20 like reward-bearing LST tokens like wstETH, rETH.
/// And It is not intended to be used for: 1) rebasing token like stETH, since we assume staker's
/// balance would not change if nothing is done after deposit, 2) fee-on-transfer token, since we
/// assume Vault would count for the amount that staker transfers to it.
adu-web3 marked this conversation as resolved.
Show resolved Hide resolved
function initialize(address underlyingToken_, address gateway_) external initializer {
if (underlyingToken_ == address(0) || gateway_ == address(0)) {
revert Errors.ZeroAddress();
Expand Down
Loading