Skip to content

N-04 Incorrect or Misleading Documentation #2173

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

Merged
merged 1 commit into from
Aug 6, 2024
Merged

N-04 Incorrect or Misleading Documentation #2173

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
8 changes: 4 additions & 4 deletions contracts/contracts/vault/OETHVaultCore.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,12 +158,12 @@ contract OETHVaultCore is VaultCore {
* The OETH is burned on request and the WETH is transferred to the withdrawer on claim.
* This request can be claimed once the withdrawal queue's `claimable` amount
* is greater than or equal this request's `queued` amount.
* There is no minimum time or block number before a request can be claimed. It just needs
* There is a minimum of 10 minutes before a request can be claimed. After that, the request just needs
* enough WETH liquidity in the Vault to satisfy all the outstanding requests to that point in the queue.
* OETH is converted to WETH at 1:1.
* @param _amount Amount of OETH to burn.
* @param requestId Unique ID for the withdrawal request
* @param queued Cumulative total of all WETH queued including already claimed requests.
* @return requestId Unique ID for the withdrawal request
* @return queued Cumulative total of all WETH queued including already claimed requests.
*/
function requestWithdrawal(uint256 _amount)
external
Expand Down Expand Up @@ -383,7 +383,7 @@ contract OETHVaultCore is VaultCore {

/// @dev Get the balance of an asset held in Vault and all strategies
/// less any WETH that is reserved for the withdrawal queue.
/// This will only return a non-zero balance for WETH.
/// WETH is the only asset that can return a non-zero balance.
/// All other assets will return 0 even if there is some dust amounts left in the Vault.
/// For example, there is 1 wei left of stETH in the OETH Vault but will return 0 in this function.
///
Expand Down