Skip to main content

CSFeeDistributor

CSFeeDistributor.sol is the supplementary contract that stores non-claimed and non-distributed Node Operator rewards on balance and the latest root of a rewards distribution Merkle tree root. It accepts calls from CSAccounting.sol with reward claim requests and stores data about already claimed rewards by the Node Operator. It receives non-distributed rewards from the CSModule.sol each time the StakingRouter mints the new portion of the Node Operators' rewards.

Upgradability​

The contract uses OssifiableProxy for upgradability.

State Variables​

RECOVERER_ROLE​

bytes32 public constant RECOVERER_ROLE = keccak256("RECOVERER_ROLE");

STETH​

IStETH public immutable STETH;

ACCOUNTING​

address public immutable ACCOUNTING;

ORACLE​

address public immutable ORACLE;

treeRoot​

Merkle Tree root

bytes32 public treeRoot;

treeCid​

CID of the published Merkle tree

string public treeCid;

logCid​

CID of the file with log of the last frame reported

string public logCid;

distributedShares​

Amount of stETH shares sent to the Accounting in favor of the NO

mapping(uint256 => uint256) public distributedShares;

totalClaimableShares​

Total Amount of stETH shares available for claiming by NOs

uint256 public totalClaimableShares;

Functions​

distributeFees​

Distribute fees to the Accounting in favor of the Node Operator

function distributeFees(
  uint256 nodeOperatorId,
  uint256 shares,
  bytes32[] calldata proof
) external returns (uint256 sharesToDistribute);

Parameters

NameTypeDescription
nodeOperatorIduint256ID of the Node Operator
sharesuint256Total Amount of stETH shares earned as fees
proofbytes32[]Merkle proof of the leaf

Returns

NameTypeDescription
sharesToDistributeuint256Amount of stETH shares distributed

processOracleReport​

Receive the data of the Merkle tree from the Oracle contract and process it

function processOracleReport(
  bytes32 _treeRoot,
  string calldata _treeCid,
  string calldata _logCid,
  uint256 distributed
) external;

pendingSharesToDistribute​

Get the Amount of stETH shares that are pending to be distributed

function pendingSharesToDistribute() external view returns (uint256);

Returns

NameTypeDescription
<none>uint256pendingShares Amount shares that are pending to distribute

getFeesToDistribute​

Get the Amount of stETH shares that can be distributed in favor of the Node Operator

function getFeesToDistribute(
  uint256 nodeOperatorId,
  uint256 shares,
  bytes32[] calldata proof
) public view returns (uint256 sharesToDistribute);

Parameters

NameTypeDescription
nodeOperatorIduint256ID of the Node Operator
sharesuint256Total Amount of stETH shares earned as fees
proofbytes32[]Merkle proof of the leaf

Returns

NameTypeDescription
sharesToDistributeuint256Amount of stETH shares that can be distributed

hashLeaf​

Get a hash of a leaf

Double hash the leaf to prevent second preimage attacks

function hashLeaf(uint256 nodeOperatorId, uint256 shares) public pure returns (bytes32);

Parameters

NameTypeDescription
nodeOperatorIduint256ID of the Node Operator
sharesuint256Amount of stETH shares

Returns

NameTypeDescription
<none>bytes32Hash of the leaf

Events​

FeeDistributed​

Emitted when fees are distributed

event FeeDistributed(uint256 indexed nodeOperatorId, uint256 shares);

DistributionDataUpdated​

Emitted when distribution data is updated

event DistributionDataUpdated(uint256 totalClaimableShares, bytes32 treeRoot, string treeCid);

DistributionLogUpdated​

Emitted when distribution log is updated

event DistributionLogUpdated(string logCid);