Skip to content

Commit aa211f6

Browse files
mr-ubikmr-ubik
committed
Update NatSpec
1 parent 46c0dea commit aa211f6

11 files changed

+725
-281
lines changed

‎.prettierrc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"overrides": [
3+
{
4+
"files": "*.sol",
5+
"options": {
6+
"printWidth": 100,
7+
"tabWidth": 4,
8+
"useTabs": false,
9+
"singleQuote": false,
10+
"bracketSpacing": false,
11+
"explicitTypes": "always"
12+
}
13+
}
14+
]
15+
}

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 2-Clause License
22

3-
Copyright (c) 2019, BUIDL
3+
Copyright (c) 2020, BUIDL
44
All rights reserved.
55

66
Redistribution and use in source and binary forms, with or without

‎contracts/DeployDFO.sol

+281-85
Large diffs are not rendered by default.

‎contracts/DeployGovernanceRules.sol

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ contract DeployGovernanceRules {
6363
/**
6464
* @dev Deploy the Governance Rules cloning the original core one and modify it according to
6565
* the desired functionalities/configurations
66-
* @param sender
66+
* @param sender Address of the caller
6767
* @param
6868
* @param minimumBlockNumber Amount of blocks for the duration of a proposal
6969
* @param emergencyBlockNumber Amount of blocks for the duration of an EmergencyProposal
7070
* @param emergencyStaking
7171
* @param quorum Required quorum for a proposal to be accepted
72-
* @param surveyMaxCap
72+
* @param surveyMaxCap Amount of voting tokens needed to reach the max-cap on a proposal
7373
* @param surveyMinStake
7474
* @param surveySingleReward
7575
* @return mvdFunctionalitiesManager The newly created Functionalities Manager

‎contracts/DeployVotingToken.sol

+125-47
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,113 @@
1-
/* Update:
2-
* Move Amounts to decimals
3-
*/
4-
/* Discussion:
5-
* https://gitcoin.co/grants/154/decentralized-flexible-organization
6-
*/
7-
/* Description:
8-
* DFOHub - Voting Token Creation.
9-
* This specific DFOHub functionality is called during the new DFO creation.
10-
* It initialized 3 DFO delegates cloning them from the original DFOHub ones: Voting Token, State Holder, Well-Known Functionalities Manager.
11-
* Complessive Voting Token amount is split between DFOHub (calculating the correct amount through the proper functionality) and the survey proposer.
12-
* After its initialization, StateHolder is filled with a standard index page and an additional voting token amount (if any).
13-
*/
1+
// SPDX-License-Identifier: BSD
142
pragma solidity ^0.6.0;
153

4+
/**
5+
* @title Voting Token Creation.
6+
* @dev This specific DFOHub functionality is called during the new DFO creation.
7+
* It initialized 3 DFO delegates cloning them from the original DFOHub ones: Voting Token, State Holder,
8+
* Well-Known Functionalities Manager.
9+
* Voting Token amount is split between DFOHub (calculating the correct amount through
10+
* the proper functionality) and the survey proposer.
11+
* After its initialization, StateHolder is filled with a standard index page and an additional voting
12+
* token amount (if any).
13+
*/
1614
contract DeployVotingToken {
17-
1815
string private _metadataLink;
1916

2017
constructor(string memory metadataLink) public {
2118
_metadataLink = metadataLink;
2219
}
2320

24-
function getMetadataLink() public view returns(string memory) {
21+
function getMetadataLink() public view returns (string memory) {
2522
return _metadataLink;
2623
}
2724

28-
function onStart(address, address) public {
29-
}
30-
31-
function onStop(address) public {
32-
}
33-
25+
function onStart(address, address) public {}
26+
27+
function onStop(address) public {}
28+
29+
/**
30+
* @dev Deploy the voting token
31+
* @param sender Address of the Caller
32+
* @param
33+
* @param name Name of the voting token
34+
* @param symbol Ticker Symbol for the voting token
35+
* @param totalSupply Total Supply of the voting token
36+
* @param additionalAmount Amount of token to pay as generation fee
37+
* @return votingToken Address of the newly deployed voting token
38+
* @return stateHolderAddress Address of the StateHolder
39+
* @return mvdFunctionalityModelsManagerAddress Address of the FunctionalityModelsManager
40+
*/
3441
function deployVotingToken(
35-
address sender, uint256,
36-
string memory name, string memory symbol, uint256 totalSupply, uint256 additionalAmount)
37-
public returns(address votingToken, address stateHolderAddress, address mvdFunctionalityModelsManagerAddress) {
38-
42+
address sender,
43+
uint256,
44+
string memory name,
45+
string memory symbol,
46+
uint256 totalSupply,
47+
uint256 additionalAmount
48+
)
49+
public
50+
returns (
51+
address votingToken,
52+
address stateHolderAddress,
53+
address mvdFunctionalityModelsManagerAddress
54+
)
55+
{
3956
IMVDProxy proxy = IMVDProxy(msg.sender);
4057

41-
IVotingToken token = IVotingToken(votingToken = clone(proxy.getToken()));
58+
IVotingToken token = IVotingToken(
59+
votingToken = clone(proxy.getToken())
60+
);
4261
token.init(name, symbol, 18, totalSupply);
43-
token.transfer(proxy.getMVDWalletAddress(), additionalAmount + toUint256(proxy.read("getVotingTokenAmountForHub", abi.encode(token.totalSupply()))));
62+
token.transfer(
63+
proxy.getMVDWalletAddress(),
64+
additionalAmount +
65+
toUint256(
66+
proxy.read(
67+
"getVotingTokenAmountForHub",
68+
abi.encode(token.totalSupply())
69+
)
70+
)
71+
);
4472
token.transfer(sender, token.balanceOf(address(this)));
4573

46-
IStateHolder(stateHolderAddress = clone(proxy.getStateHolderAddress())).init();
47-
48-
mvdFunctionalityModelsManagerAddress = proxy.getMVDFunctionalityModelsManagerAddress();
49-
50-
proxy.emitEvent("DFOCollateralContractsCloned(address_indexed,address,address,address)", abi.encodePacked(sender), bytes(""), abi.encode(votingToken, stateHolderAddress, mvdFunctionalityModelsManagerAddress));
74+
IStateHolder(stateHolderAddress = clone(proxy.getStateHolderAddress()))
75+
.init();
76+
77+
mvdFunctionalityModelsManagerAddress = proxy
78+
.getMVDFunctionalityModelsManagerAddress();
79+
80+
proxy.emitEvent(
81+
"DFOCollateralContractsCloned(address_indexed,address,address,address)",
82+
abi.encodePacked(sender),
83+
bytes(""),
84+
abi.encode(
85+
votingToken,
86+
stateHolderAddress,
87+
mvdFunctionalityModelsManagerAddress
88+
)
89+
);
5190
}
5291

53-
function clone(address original) private returns(address copy) {
92+
function clone(address original) private returns (address copy) {
5493
assembly {
55-
mstore(0, or(0x5880730000000000000000000000000000000000000000803b80938091923cF3, mul(original, 0x1000000000000000000)))
94+
mstore(
95+
0,
96+
or(
97+
0x5880730000000000000000000000000000000000000000803b80938091923cF3,
98+
mul(original, 0x1000000000000000000)
99+
)
100+
)
56101
copy := create(0, 0, 32)
57-
switch extcodesize(copy) case 0 { invalid() }
102+
switch extcodesize(copy)
103+
case 0 {
104+
invalid()
105+
}
58106
}
59107
}
60108

61-
function toUint256(bytes memory bs) private pure returns(uint256 x) {
62-
if(bs.length >= 32) {
109+
function toUint256(bytes memory bs) private pure returns (uint256 x) {
110+
if (bs.length >= 32) {
63111
assembly {
64112
x := mload(add(bs, add(0x20, 0)))
65113
}
@@ -68,22 +116,52 @@ contract DeployVotingToken {
68116
}
69117

70118
interface IVotingToken {
71-
function init(string calldata name, string calldata symbol, uint256 decimals, uint256 totalSupply) external;
119+
function init(
120+
string calldata name,
121+
string calldata symbol,
122+
uint256 decimals,
123+
uint256 totalSupply
124+
) external;
125+
72126
function totalSupply() external view returns (uint256);
127+
73128
function balanceOf(address account) external view returns (uint256);
74-
function transfer(address recipient, uint256 amount) external returns (bool);
129+
130+
function transfer(address recipient, uint256 amount)
131+
external
132+
returns (bool);
75133
}
76134

77135
interface IStateHolder {
78136
function init() external;
79137
}
80138

81139
interface IMVDProxy {
82-
function getMVDWalletAddress() external view returns(address);
83-
function getToken() external view returns(address);
84-
function getStateHolderAddress() external view returns(address);
85-
function getMVDFunctionalityModelsManagerAddress() external view returns(address);
86-
function getMVDFunctionalitiesManagerAddress() external view returns(address);
87-
function read(string calldata codeName, bytes calldata data) external view returns(bytes memory returnData);
88-
function emitEvent(string calldata eventSignature, bytes calldata firstIndex, bytes calldata secondIndex, bytes calldata data) external;
89-
}
140+
function getMVDWalletAddress() external view returns (address);
141+
142+
function getToken() external view returns (address);
143+
144+
function getStateHolderAddress() external view returns (address);
145+
146+
function getMVDFunctionalityModelsManagerAddress()
147+
external
148+
view
149+
returns (address);
150+
151+
function getMVDFunctionalitiesManagerAddress()
152+
external
153+
view
154+
returns (address);
155+
156+
function read(string calldata codeName, bytes calldata data)
157+
external
158+
view
159+
returns (bytes memory returnData);
160+
161+
function emitEvent(
162+
string calldata eventSignature,
163+
bytes calldata firstIndex,
164+
bytes calldata secondIndex,
165+
bytes calldata data
166+
) external;
167+
}

‎contracts/GetEmergencySurveyStakingFunctionality.sol

+26-17
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,44 @@
1-
/* Description:
2-
* DFO Protocol - Emergency Survey staking provider.
3-
* One of the 4 well-known read-only mandatory Functionalities every DFO needs.
4-
* The logic is for general purpose so that every DFO can use it as a Stateless Microservice.
5-
* It provides the amount of Voting Tokens every proposer must stake to start a new emergency Survey Proposal.
6-
*/
7-
/* Discussion:
8-
* https://gitcoin.co/grants/154/decentralized-flexible-organization
9-
*/
1+
// SPDX-License-Identifier: BSD
102
pragma solidity ^0.6.0;
113

4+
/**
5+
* @title Emergency Survey staking provider.
6+
* @dev One of the 4 well-known read-only mandatory Functionalities every DFO needs.
7+
* The logic is for general purpose so that every DFO can use it as a Stateless Microservice.
8+
* It provides the amount of Voting Tokens every proposer must stake to start a new emergency
9+
* Survey Proposal.
10+
*/
1211
contract GetEmergencySurveyStakingFunctionality {
13-
1412
string private _metadataLink;
1513
uint256 private _value;
1614

15+
/**
16+
* @dev Contract constructor
17+
* @param metadataLink Metadata for the EmergencySurvey
18+
* @param value Amount of token that must be be staked for the EmergencySurvey to start
19+
*/
1720
constructor(string memory metadataLink, uint256 value) public {
1821
_metadataLink = metadataLink;
1922
_value = value;
2023
}
2124

22-
function getMetadataLink() public view returns(string memory) {
25+
/**
26+
* @dev GETTER for the metadataLink
27+
* @return metadataLink Link to the metadata of the EmergencySurvey
28+
*/
29+
function getMetadataLink() public view returns (string memory) {
2330
return _metadataLink;
2431
}
2532

26-
function onStart(address, address) public {
27-
}
33+
function onStart(address, address) public {}
2834

29-
function onStop(address) public {
30-
}
35+
function onStop(address) public {}
3136

32-
function getEmergencySurveyStaking() public view returns(uint256) {
37+
/**
38+
* @dev GETTER for the EmergencySurvey staking
39+
* @return value Amount of token that must be be staked for the EmergencySurvey to start
40+
*/
41+
function getEmergencySurveyStaking() public view returns (uint256 value) {
3342
return _value;
3443
}
35-
}
44+
}

‎contracts/GetMinimumBlockNumberForEmergencySurveyFunctionality.sol

+24-16
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,43 @@
1-
/* Description:
2-
* DFO Protocol - Emergency Survey duration provider.
3-
* One of the 4 well-known read-only mandatory Functionalities every DFO needs.
1+
// SPDX-License-Identifier: BSD-2
2+
pragma solidity ^0.6.0;
3+
4+
/** Description:
5+
* @title Emergency Survey duration provider.
6+
* @dev One of the 4 well-known read-only mandatory Functionalities every DFO needs.
47
* The logic is for general purpose so that every DFO can use it as a Stateless Microservice.
58
* It provides the time duration (expected in blocks) of every emergency Survey Proposal.
69
*/
7-
/* Discussion:
8-
* https://gitcoin.co/grants/154/decentralized-flexible-organization
9-
*/
10-
pragma solidity ^0.6.0;
11-
1210
contract GetMinimumBlockNumberForEmergencySurveyFunctionality {
13-
1411
string private _metadataLink;
1512
uint256 private _value;
1613

14+
/**
15+
* @dev Contract constructor
16+
* @param metadataLink Metadata for the EmergencySurvey
17+
* @param value Amount of blocks for the duration of the EmergencySurvey proposal
18+
*/
1719
constructor(string memory metadataLink, uint256 value) public {
1820
_metadataLink = metadataLink;
1921
_value = value;
2022
}
2123

22-
function getMetadataLink() public view returns(string memory) {
24+
/**
25+
* @dev GETTER for the metadataLink
26+
* @return metadataLink Link to the metadata of the EmergencySurvey
27+
*/
28+
function getMetadataLink() public view returns (string memory) {
2329
return _metadataLink;
2430
}
2531

26-
function onStart(address, address) public {
27-
}
32+
function onStart(address, address) public {}
2833

29-
function onStop(address) public {
30-
}
34+
function onStop(address) public {}
3135

32-
function getMinimumBlockNumberForEmergencySurvey() public view returns(uint256) {
36+
/**
37+
* @dev GETTER for the block duration of emergency proposals
38+
* @return value Amount of block indicating the duration of emergency proposals
39+
*/
40+
function getMinimumBlockNumberForEmergencySurvey() public view returns (uint256) {
3341
return _value;
3442
}
35-
}
43+
}

0 commit comments

Comments
 (0)