Skip to content

Commit 20f5bb9

Browse files
committed
refactor: minor tweaks
1 parent a703fdd commit 20f5bb9

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

contracts/src/snapshot-proxy/KlerosCoreSnapshotProxy.sol contracts/src/arbitration/view/KlerosCoreSnapshotProxy.sol

+25-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
pragma solidity 0.8.24;
1010

11-
import {ISortitionModule} from "../arbitration/interfaces/ISortitionModule.sol";
11+
import {ISortitionModule} from "../interfaces/ISortitionModule.sol";
1212

1313
interface IKlerosCore {
1414
function sortitionModule() external view returns (ISortitionModule);
@@ -17,25 +17,41 @@ interface IKlerosCore {
1717
/// @title KlerosCoreSnapshotProxy
1818
/// Proxy contract for V2 that exposes staked PNK with balanceOf() function for Snapshot voting.
1919
contract KlerosCoreSnapshotProxy {
20+
// ************************************* //
21+
// * State Modifiers * //
22+
// ************************************* //
23+
2024
IKlerosCore public core;
2125
address public governor;
22-
string public name = "Staked Pinakion";
23-
string public symbol = "stPNK";
24-
uint8 public immutable decimals = 18;
26+
string public constant name = "Staked Pinakion";
27+
string public constant symbol = "stPNK";
28+
uint8 public constant decimals = 18;
29+
30+
// ************************************* //
31+
// * Modifiers * //
32+
// ************************************* //
2533

2634
modifier onlyByGovernor() {
2735
require(governor == msg.sender, "Access not allowed: Governor only.");
2836
_;
2937
}
3038

39+
// ************************************* //
40+
// * Constructor * //
41+
// ************************************* //
42+
3143
/// @dev Constructor
32-
/// @param _governor The govenor of the contract.
44+
/// @param _governor The governor of the contract.
3345
/// @param _core KlerosCore to read the balance from.
3446
constructor(address _governor, IKlerosCore _core) {
3547
governor = _governor;
3648
core = _core;
3749
}
3850

51+
// ************************************* //
52+
// * Governance * //
53+
// ************************************* //
54+
3955
/// @dev Changes the `governor` storage variable.
4056
/// @param _governor The new value for the `governor` storage variable.
4157
function changeGovernor(address _governor) external onlyByGovernor {
@@ -48,6 +64,10 @@ contract KlerosCoreSnapshotProxy {
4864
core = _core;
4965
}
5066

67+
// ************************************* //
68+
// * Public Views * //
69+
// ************************************* //
70+
5171
/// @dev Returns the amount of PNK staked in KlerosV2 for a particular address.
5272
/// Note: Proxy doesn't need to differentiate between courts so we pass 0 as courtID.
5373
/// @param _account The address to query.

0 commit comments

Comments
 (0)