Skip to content

Commit d90fc0a

Browse files
committed
minor comments
1 parent 8b15be9 commit d90fc0a

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

contracts/base-chain/TokenVault.sol

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,9 @@ contract TokenVault is Ownable {
8383

8484
/**
8585
* @notice Transfers specified amount from the depositor's wallet and locks it in the gateway contract.
86+
* @param token address of the token to lock.
87+
* @param depositor address of wallet to transfer specified token from
88+
* @param amount amount of tokens to transfer
8689
*/
8790
function lock(
8891
address token,
@@ -95,6 +98,9 @@ contract TokenVault is Ownable {
9598

9699
/**
97100
* @notice Unlocks the specified amount from the gateway contract and transfers it to the recipient.
101+
* @param token address of the token to unlock.
102+
* @param recipient address of wallet to transfer specified token to
103+
* @param amount amount of tokens to transfer
98104
*/
99105
function unlock(
100106
address token,
@@ -106,7 +112,8 @@ contract TokenVault is Ownable {
106112
}
107113

108114
/**
109-
* @notice Total token balance secured by the gateway contract.
115+
* @notice Total balance of the specified token, held by this vault.
116+
* @param token address of the token to check.
110117
*/
111118
function totalLocked(address token) external view returns (uint256) {
112119
return IERC20(token).balanceOf(address(this));

0 commit comments

Comments
 (0)