Skip to content

Commit

Permalink
Be consistent with putting variable block at top of interface
Browse files Browse the repository at this point in the history
  • Loading branch information
Doy-lee committed Oct 3, 2024
1 parent 52f9829 commit 71b1fc5
Showing 1 changed file with 38 additions and 28 deletions.
66 changes: 38 additions & 28 deletions contracts/interfaces/IServiceNodeContribution.sol
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,51 @@ interface IServiceNodeContribution {
address beneficiary;
}

// Events
//////////////////////////////////////////////////////////////
// //
// Events //
// //
//////////////////////////////////////////////////////////////

event Finalized (uint256 indexed serviceNodePubkey);
event NewContribution (address indexed contributor, uint256 amount);
event OpenForPublicContribution(uint256 indexed serviceNodePubkey, address indexed operator, uint16 fee);
event Filled (uint256 indexed serviceNodePubkey, address indexed operator);
event WithdrawContribution (address indexed contributor, uint256 amount);
event UpdateStakerBeneficiary (address indexed staker, address beneficiary);

// Errors
//////////////////////////////////////////////////////////////
// //
// Variables //
// //
//////////////////////////////////////////////////////////////

function SENT() external view returns (IERC20);
function stakingRewardsContract() external view returns (IServiceNodeRewards);
function stakingRequirement() external view returns (uint256);

function blsPubkey() external view returns (uint256, uint256);
function serviceNodeParams() external view returns (IServiceNodeRewards.ServiceNodeParams memory);
function blsSignature() external view returns (IServiceNodeRewards.BLSSignatureParams memory);

function operator() external view returns (address);
function contributions(address) external view returns (uint256);
function contributionTimestamp(address) external view returns (uint256);
function contributorAddresses(uint256) external view returns (IServiceNodeRewards.Staker memory);
function maxContributors() external view returns (uint256);

function reservedContributions(address) external view returns (uint256);
function reservedContributionsAddresses(uint256) external view returns (address);

function status() external view returns (Status);
function manualFinalize() external view returns (bool);

//////////////////////////////////////////////////////////////
// //
// Errors //
// //
//////////////////////////////////////////////////////////////

error CalcMinContributionGivenBadContribArgs (uint256 numContributors, uint256 maxNumContributors);
/// @notice Contract is not in a state where it can accept contributions
error ContributeFundsNotPossible (Status status);
Expand Down Expand Up @@ -304,30 +340,4 @@ interface IServiceNodeContribution {

/// @notice Sum up all the reserved contributions recorded in the reserved list
function totalReservedContribution() external view returns (uint256 result);

//////////////////////////////////////////////////////////////
// //
// Variables //
// //
//////////////////////////////////////////////////////////////

function SENT() external view returns (IERC20);
function stakingRewardsContract() external view returns (IServiceNodeRewards);
function stakingRequirement() external view returns (uint256);

function blsPubkey() external view returns (uint256, uint256);
function serviceNodeParams() external view returns (IServiceNodeRewards.ServiceNodeParams memory);
function blsSignature() external view returns (IServiceNodeRewards.BLSSignatureParams memory);

function operator() external view returns (address);
function contributions(address) external view returns (uint256);
function contributionTimestamp(address) external view returns (uint256);
function contributorAddresses(uint256) external view returns (IServiceNodeRewards.Staker memory);
function maxContributors() external view returns (uint256);

function reservedContributions(address) external view returns (uint256);
function reservedContributionsAddresses(uint256) external view returns (address);

function status() external view returns (Status);
function manualFinalize() external view returns (bool);
}

0 comments on commit 71b1fc5

Please sign in to comment.