Skip to content
This repository was archived by the owner on May 22, 2023. It is now read-only.

Commit b271730

Browse files
committed
Added docs for ETH staking stake
1 parent b683a36 commit b271730

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

solidity/contracts/ETHStaking.sol

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import "@keep-network/keep-core/contracts/KeepRegistry.sol";
2020

2121
import "openzeppelin-solidity/contracts/math/SafeMath.sol";
2222

23-
2423
/// @title ETH Staking
2524
/// @notice A staking contract for ETH staking. An owner of the ETH can delegate
2625
/// ETH as a stake to an operator. The value of ETH the owner is willing to stake
@@ -38,11 +37,18 @@ contract ETHStaking is Authorizations, StakeDelegatable {
3837
address indexed authorizer
3938
);
4039

40+
/// @notice Registers stake details. The function is used to register
41+
/// addresses of operator, beneficiary and authorizer for a stake from the
42+
/// caller.
43+
/// @param operator Address of the operator.
44+
/// @param beneficiary Address of the beneficiary.
45+
/// @param authorizer Address of the authorizer.
4146
function stake(
4247
address operator,
4348
address payable beneficiary,
4449
address authorizer
4550
) external payable {
51+
// TODO: Do we need to verify the caller in any way?
4652
address _from = msg.sender;
4753

4854
require(

0 commit comments

Comments
 (0)