From 4ab749201fd7fbd3478c7085fb0850d7573a05c4 Mon Sep 17 00:00:00 2001 From: Docs Syncer Date: Wed, 3 Jul 2024 11:44:02 +0000 Subject: [PATCH] CI: `a372599` --- .../contracts/access/MerkleWhitelisted.md | 52 ------------------- .../finance/staking/AbstractStaking.md | 10 +++- 2 files changed, 9 insertions(+), 53 deletions(-) diff --git a/docs/reference/contracts/access/MerkleWhitelisted.md b/docs/reference/contracts/access/MerkleWhitelisted.md index b4fe87e..fcc0563 100644 --- a/docs/reference/contracts/access/MerkleWhitelisted.md +++ b/docs/reference/contracts/access/MerkleWhitelisted.md @@ -38,58 +38,6 @@ modifier onlyWhitelistedUser(address user_, bytes32[] memory merkleProof_) ## Functions info -### isWhitelisted (0x7ea25896) - -```solidity -function isWhitelisted( - bytes32 leaf_, - bytes32[] memory merkleProof_ -) public view returns (bool) -``` - -The function to check if the leaf belongs to the Merkle tree - - -Parameters: - -| Name | Type | Description | -| :----------- | :-------- | :---------------------------------------------- | -| leaf_ | bytes32 | the leaf to be checked | -| merkleProof_ | bytes32[] | the path from the leaf to the Merkle tree root | - - -Return values: - -| Name | Type | Description | -| :--- | :--- | :----------------------------------------------------------- | -| [0] | bool | true if the leaf belongs to the Merkle tree, false otherwise | - -### isWhitelistedUser (0xa188491c) - -```solidity -function isWhitelistedUser( - address user_, - bytes32[] memory merkleProof_ -) public view returns (bool) -``` - -The function to check if the user belongs to the Merkle tree - - -Parameters: - -| Name | Type | Description | -| :----------- | :-------- | :---------------------------------------------- | -| user_ | address | the user to be checked | -| merkleProof_ | bytes32[] | the path from the user to the Merkle tree root | - - -Return values: - -| Name | Type | Description | -| :--- | :--- | :----------------------------------------------------------- | -| [0] | bool | true if the user belongs to the Merkle tree, false otherwise | - ### getMerkleRoot (0x49590657) ```solidity diff --git a/docs/reference/contracts/finance/staking/AbstractStaking.md b/docs/reference/contracts/finance/staking/AbstractStaking.md index 72d3efa..daa7122 100644 --- a/docs/reference/contracts/finance/staking/AbstractStaking.md +++ b/docs/reference/contracts/finance/staking/AbstractStaking.md @@ -70,10 +70,18 @@ Parameters: ### claimAll (0xd1058e59) ```solidity -function claimAll() public stakingStarted +function claimAll() public stakingStarted returns (uint256) ``` Claims all the available rewards. + + +Return values: + +| Name | Type | Description | +| :--- | :------ | :-------------------------------------- | +| [0] | uint256 | The total value of the rewards claimed. | + ### withdraw (0x3ccfd60b) ```solidity