Skip to content

Commit

Permalink
add natspec to claimWithdrawal
Browse files Browse the repository at this point in the history
  • Loading branch information
danoctavian committed Sep 8, 2024
1 parent a583d8b commit cfcfcfe
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/WithdrawalQueueManager.sol
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,15 @@ contract WithdrawalQueueManager is IWithdrawalQueueManager, ERC721EnumerableUpgr
//--------------------------------------------------------------------------------------


/**
* @notice Claims a withdrawal for a specific token ID and transfers the assets to the specified receiver.
* @dev This function burns the token representing the withdrawal request and transfers the net amount
after fees to the receiver.
* It also transfers the fee to the fee receiver.
* It automatically finds the finalization ID for the given token ID.
* @param tokenId The ID of the token representing the withdrawal request.
* @param receiver The address to which the withdrawn assets will be sent.
*/
function claimWithdrawal(uint256 tokenId, address receiver) public nonReentrant {
WithdrawalClaim memory claim = WithdrawalClaim({
tokenId: tokenId,
Expand Down

0 comments on commit cfcfcfe

Please sign in to comment.