Skip to content

Commit 6c28f88

Browse files
committed
docs: minor things
1 parent 56b7b34 commit 6c28f88

File tree

5 files changed

+4
-13
lines changed

5 files changed

+4
-13
lines changed

contracts/src/arbitration/KlerosCoreBase.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ import {SafeERC20, IERC20} from "../libraries/SafeERC20.sol";
1212
import "../libraries/Constants.sol";
1313

1414
/// @title KlerosCoreBase
15-
/// Core arbitrator contract for Kleros v2 with new StakeController architecture.
16-
/// Note that this contract trusts the PNK token, the dispute kit and the stake controller contracts.
15+
/// Core arbitrator contract for Kleros v2.
16+
/// Note that this contract trusts the dispute kit and the stake controller contracts.
1717
abstract contract KlerosCoreBase is IArbitratorV2, Initializable, UUPSProxiable {
1818
using SafeERC20 for IERC20;
1919

contracts/src/arbitration/SortitionSumTree.sol

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ contract SortitionSumTree is ISortitionSumTree, Initializable, UUPSProxiable {
121121
KlerosCoreBase core = stakeController.core();
122122

123123
while (!finished) {
124+
// Tokens are also implicitly staked in parent courts via _updateParents().
124125
_set(bytes32(uint256(currentCourtID)), _newStake, stakePathID);
125126
if (currentCourtID == GENERAL_COURT) {
126127
finished = true;

contracts/src/arbitration/Vault.sol

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ import {VaultBase, IERC20} from "./VaultBase.sol";
66

77
/// @title Vault
88
/// @notice PNK Vault for handling deposits, withdrawals, locks, and penalties
9-
/// @dev Follows the same pattern as KlerosCore for upgradeable contracts
109
contract Vault is VaultBase {
11-
string public constant override version = "0.1.0";
10+
string public constant override version = "0.10.0";
1211

1312
// ************************************* //
1413
// * Constructor * //

contracts/src/arbitration/VaultBase.sol

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import {SafeERC20, IERC20} from "../libraries/SafeERC20.sol";
99

1010
/// @title VaultBase
1111
/// @notice Abstract base contract for PNK vault that handles deposits, withdrawals, locks, and penalties
12-
/// @dev Follows the same pattern as KlerosCoreBase for upgradeable contracts
1312
abstract contract VaultBase is IVault, Initializable, UUPSProxiable {
1413
using SafeERC20 for IERC20;
1514

@@ -31,15 +30,8 @@ abstract contract VaultBase is IVault, Initializable, UUPSProxiable {
3130
IERC20 public pnk; // The PNK token contract.
3231
address public stakeController; // The stake controller authorized to lock/unlock/penalize.
3332
address public core; // The KlerosCore authorized to transfer rewards.
34-
3533
mapping(address => JurorBalance) public jurorBalances; // Juror balance tracking.
3634

37-
// ************************************* //
38-
// * Events * //
39-
// ************************************* //
40-
41-
// Events are defined in IVault interface
42-
4335
// ************************************* //
4436
// * Function Modifiers * //
4537
// ************************************* //

contracts/src/arbitration/VaultNeo.sol

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
88

99
/// @title VaultNeo
1010
/// @notice Enhanced PNK Vault with additional features like NFT-gated deposits
11-
/// @dev Follows the same pattern as KlerosCoreNeo for upgradeable contracts
1211
contract VaultNeo is VaultBase {
1312
using SafeERC20 for IERC20;
1413

0 commit comments

Comments
 (0)