Skip to content

Commit fe6ea09

Browse files
committed
Add extra docstrings to the AllocationExchange
1 parent 99f3ace commit fe6ea09

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

contracts/statechannels/AllocationExchange.sol

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ contract AllocationExchange is Governed {
3939
IStaking private immutable staking;
4040
IGraphToken private immutable graphToken;
4141
address public authority;
42+
43+
// Tracks redeemed allocationIDs. An allocation can only be redeemed once.
4244
mapping(address => bool) public allocationsRedeemed;
4345

4446
// -- Events
@@ -49,6 +51,13 @@ contract AllocationExchange is Governed {
4951

5052
// -- Functions
5153

54+
/**
55+
* @notice Contract constructor.
56+
* @param _graphToken Address of the GRT token
57+
* @param _staking Address of the protocol Staking contract
58+
* @param _governor Account capable of withdrawing funds and setting the authority
59+
* @param _authority Account that can sign the vouchers that this contract will redeem
60+
*/
5261
constructor(
5362
IGraphToken _graphToken,
5463
IStaking _staking,

0 commit comments

Comments
 (0)