Skip to content

Commit d574493

Browse files
kronosapienskronosapiens
committed
Introduce a multiExtension approach
1 parent 73cedb6 commit d574493

12 files changed

+164
-99
lines changed

‎contracts/colony/Colony.sol

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -373,27 +373,28 @@ contract Colony is ColonyStorage, PatriciaTreeProofs, MultiChain {
373373
}
374374

375375
function installExtension(bytes32 _extensionId, uint256 _version)
376-
public stoppable auth
376+
public stoppable auth returns (address)
377377
{
378-
IColonyNetwork(colonyNetworkAddress).installExtension(_extensionId, _version);
378+
address extension = IColonyNetwork(colonyNetworkAddress).installExtension(_extensionId, _version);
379+
return extension;
379380
}
380381

381-
function upgradeExtension(bytes32 _extensionId, uint256 _newVersion)
382+
function upgradeExtension(address payable _extension, uint256 _newVersion)
382383
public stoppable auth
383384
{
384-
IColonyNetwork(colonyNetworkAddress).upgradeExtension(_extensionId, _newVersion);
385+
IColonyNetwork(colonyNetworkAddress).upgradeExtension(_extension, _newVersion);
385386
}
386387

387-
function deprecateExtension(bytes32 _extensionId, bool _deprecated)
388+
function deprecateExtension(address payable _extension, bool _deprecated)
388389
public stoppable auth
389390
{
390-
IColonyNetwork(colonyNetworkAddress).deprecateExtension(_extensionId, _deprecated);
391+
IColonyNetwork(colonyNetworkAddress).deprecateExtension(_extension, _deprecated);
391392
}
392393

393-
function uninstallExtension(bytes32 _extensionId)
394+
function uninstallExtension(address payable _extension)
394395
public stoppable auth
395396
{
396-
IColonyNetwork(colonyNetworkAddress).uninstallExtension(_extensionId);
397+
IColonyNetwork(colonyNetworkAddress).uninstallExtension(_extension);
397398
}
398399

399400
function addDomain(uint256 _permissionDomainId, uint256 _childSkillIndex, uint256 _parentDomainId) public
@@ -501,6 +502,15 @@ contract Colony is ColonyStorage, PatriciaTreeProofs, MultiChain {
501502
sig = bytes4(keccak256("setDefaultGlobalClaimDelay(uint256)"));
502503
colonyAuthority.setRoleCapability(uint8(ColonyRole.Root), address(this), sig, true);
503504

505+
sig = bytes4(keccak256("upgradeExtension(address,uint256)"));
506+
colonyAuthority.setRoleCapability(uint8(ColonyRole.Root), address(this), sig, true);
507+
508+
sig = bytes4(keccak256("deprecateExtension(address,bool)"));
509+
colonyAuthority.setRoleCapability(uint8(ColonyRole.Root), address(this), sig, true);
510+
511+
sig = bytes4(keccak256("uninstallExtension(address)"));
512+
colonyAuthority.setRoleCapability(uint8(ColonyRole.Root), address(this), sig, true);
513+
504514
sig = bytes4(keccak256("setExpenditureMetadata(uint256,uint256,uint256,string)"));
505515
colonyAuthority.setRoleCapability(uint8(ColonyRole.Arbitration), address(this), sig, true);
506516
}

‎contracts/colony/ColonyAuthority.sol

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,9 @@ contract ColonyAuthority is CommonAuthority {
117117
// Added in colony v8 (ebony-lwss)
118118
addRoleCapability(ROOT_ROLE, "makeArbitraryTransactions(address[],bytes[],bool)");
119119
addRoleCapability(ROOT_ROLE, "setDefaultGlobalClaimDelay(uint256)");
120+
addRoleCapability(ROOT_ROLE, "upgradeExtension(address,uint256)");
121+
addRoleCapability(ROOT_ROLE, "deprecateExtension(address,bool)");
122+
addRoleCapability(ROOT_ROLE, "uninstallExtension(address)");
120123
addRoleCapability(ARBITRATION_ROLE, "setExpenditureMetadata(uint256,uint256,uint256,string)");
121124
}
122125

‎contracts/colony/ColonyStorage.sol

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,11 +242,12 @@ contract ColonyStorage is CommonStorage, ColonyDataTypes, ColonyNetworkDataTypes
242242
// Ensure msg.sender is a contract
243243
require(isContract(msg.sender), "colony-sender-must-be-contract");
244244

245-
// Ensure msg.sender is an extension
245+
// Ensure msg.sender is an extension, must check old & new formats
246246
// slither-disable-next-line unused-return
247247
try ColonyExtension(msg.sender).identifier() returns (bytes32 extensionId) {
248248
require(
249-
IColonyNetwork(colonyNetworkAddress).getExtensionInstallation(extensionId, address(this)) == msg.sender,
249+
IColonyNetwork(colonyNetworkAddress).getExtensionInstallation(extensionId, address(this)) == msg.sender ||
250+
IColonyNetwork(colonyNetworkAddress).getExtensionMultiInstallation(msg.sender) == address(this),
250251
"colony-must-be-extension"
251252
);
252253
} catch {

‎contracts/colony/IColony.sol

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -263,23 +263,24 @@ interface IColony is ColonyDataTypes, IRecovery {
263263
/// @notice Install an extension to the colony. Secured function to authorised members.
264264
/// @param extensionId keccak256 hash of the extension name, used as an indentifier
265265
/// @param version The new extension version to install
266-
function installExtension(bytes32 extensionId, uint256 version) external;
266+
/// @return extension The address of the extension installation
267+
function installExtension(bytes32 extensionId, uint256 version) external returns (address extension);
267268

268269
/// @notice Upgrade an extension in a colony. Secured function to authorised members.
269-
/// @param extensionId keccak256 hash of the extension name, used as an indentifier
270+
/// @param extension The address of the extension installation
270271
/// @param newVersion The version to upgrade to (must be one larger than the current version)
271-
function upgradeExtension(bytes32 extensionId, uint256 newVersion) external;
272+
function upgradeExtension(address payable extension, uint256 newVersion) external;
272273

273274
/// @notice Set the deprecation of an extension in a colony. Secured function to authorised members.
274-
/// @param extensionId keccak256 hash of the extension name, used as an indentifier
275+
/// @param extension The address of the extension installation
275276
/// @param deprecated Whether to deprecate the extension or not
276-
function deprecateExtension(bytes32 extensionId, bool deprecated) external;
277+
function deprecateExtension(address payable extension, bool deprecated) external;
277278

278279
/// @notice Uninstall an extension from a colony. Secured function to authorised members.
279280
/// @dev This is a permanent action -- re-installing the extension will deploy a new contract
280281
/// @dev It is recommended to deprecate an extension before uninstalling to allow active objects to be resolved
281-
/// @param extensionId keccak256 hash of the extension name, used as an indentifier
282-
function uninstallExtension(bytes32 extensionId) external;
282+
/// @param extension The address of the extension installation
283+
function uninstallExtension(address payable extension) external;
283284

284285
/// @notice Add a colony domain, and its respective local skill under skill with id `_parentSkillId`.
285286
/// New funding pot is created and associated with the domain here.

‎contracts/colonyNetwork/ColonyNetworkDataTypes.sol

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,26 +116,27 @@ interface ColonyNetworkDataTypes {
116116

117117
/// @notice Event logged when an extension is installed in a colony
118118
/// @param extensionId The identifier for the extension
119+
/// @param extension Address of the extension installation
119120
/// @param colony The address of the colony
120121
/// @param version The version of the extension
121-
event ExtensionInstalled(bytes32 indexed extensionId, address indexed colony, uint256 version);
122+
event ExtensionInstalled(bytes32 indexed extensionId, address indexed extension, address indexed colony, uint256 version);
122123

123124
/// @notice Event logged when an extension is upgraded in a colony
124-
/// @param extensionId The identifier for the extension
125+
/// @param extension Address of the extension installation
125126
/// @param colony The address of the colony
126127
/// @param version The new version of the extension
127-
event ExtensionUpgraded(bytes32 indexed extensionId, address indexed colony, uint256 version);
128+
event ExtensionUpgraded(address indexed extension, address indexed colony, uint256 version);
128129

129130
/// @notice Event logged when an extension is (un)deprecated in a colony
130-
/// @param extensionId The identifier for the extension
131+
/// @param extension Address of the extension installation
131132
/// @param colony The address of the colony
132133
/// @param deprecated Whether the extension is deprecated or not
133-
event ExtensionDeprecated(bytes32 indexed extensionId, address indexed colony, bool deprecated);
134+
event ExtensionDeprecated(address indexed extension, address indexed colony, bool deprecated);
134135

135136
/// @notice Event logged when an extension is uninstalled from a colony
136-
/// @param extensionId The identifier for the extension
137+
/// @param extension Address of the extension installation
137138
/// @param colony The address of the colony
138-
event ExtensionUninstalled(bytes32 indexed extensionId, address indexed colony);
139+
event ExtensionUninstalled(address indexed extension, address indexed colony);
139140

140141
struct Skill {
141142
// total number of parent skills

‎contracts/colonyNetwork/ColonyNetworkExtensions.sol

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -50,59 +50,63 @@ contract ColonyNetworkExtensions is ColonyNetworkStorage {
5050
public
5151
stoppable
5252
calledByColony
53+
returns (address)
5354
{
5455
require(resolvers[_extensionId][_version] != address(0x0), "colony-network-extension-bad-version");
55-
require(installations[_extensionId][msg.sender] == address(0x0), "colony-network-extension-already-installed");
5656

5757
EtherRouter extension = new EtherRouter();
58-
installations[_extensionId][msg.sender] = address(extension);
58+
multiInstallations[address(extension)] = msg.sender;
5959

6060
extension.setResolver(resolvers[_extensionId][_version]);
6161
ColonyExtension(address(extension)).install(msg.sender);
6262

63-
emit ExtensionInstalled(_extensionId, msg.sender, _version);
63+
emit ExtensionInstalled(_extensionId, address(extension), msg.sender, _version);
64+
65+
return address(extension);
6466
}
6567

66-
function upgradeExtension(bytes32 _extensionId, uint256 _newVersion)
68+
function upgradeExtension(address payable _extension, uint256 _newVersion)
6769
public
6870
stoppable
6971
calledByColony
7072
{
71-
require(installations[_extensionId][msg.sender] != address(0x0), "colony-network-extension-not-installed");
73+
require(multiInstallations[_extension] == msg.sender, "colony-network-extension-not-installed");
74+
75+
bytes32 extensionId = ColonyExtension(_extension).identifier();
7276

73-
address payable extension = installations[_extensionId][msg.sender];
74-
require(_newVersion == ColonyExtension(extension).version() + 1, "colony-network-extension-bad-increment");
75-
require(resolvers[_extensionId][_newVersion] != address(0x0), "colony-network-extension-bad-version");
77+
require(_newVersion == ColonyExtension(_extension).version() + 1, "colony-network-extension-bad-increment");
78+
require(resolvers[extensionId][_newVersion] != address(0x0), "colony-network-extension-bad-version");
7679

77-
EtherRouter(extension).setResolver(resolvers[_extensionId][_newVersion]);
78-
ColonyExtension(extension).finishUpgrade();
79-
assert(ColonyExtension(extension).version() == _newVersion);
80+
EtherRouter(_extension).setResolver(resolvers[extensionId][_newVersion]);
81+
ColonyExtension(_extension).finishUpgrade();
8082

81-
emit ExtensionUpgraded(_extensionId, msg.sender, _newVersion);
83+
assert(ColonyExtension(_extension).version() == _newVersion);
84+
85+
emit ExtensionUpgraded(_extension, msg.sender, _newVersion);
8286
}
8387

84-
function deprecateExtension(bytes32 _extensionId, bool _deprecated)
88+
function deprecateExtension(address payable _extension, bool _deprecated)
8589
public
8690
stoppable
8791
calledByColony
8892
{
89-
ColonyExtension(installations[_extensionId][msg.sender]).deprecate(_deprecated);
93+
ColonyExtension(_extension).deprecate(_deprecated);
9094

91-
emit ExtensionDeprecated(_extensionId, msg.sender, _deprecated);
95+
emit ExtensionDeprecated(_extension, msg.sender, _deprecated);
9296
}
9397

94-
function uninstallExtension(bytes32 _extensionId)
98+
function uninstallExtension(address payable _extension)
9599
public
96100
stoppable
97101
calledByColony
98102
{
99-
require(installations[_extensionId][msg.sender] != address(0x0), "colony-network-extension-not-installed");
103+
require(multiInstallations[_extension] == msg.sender, "colony-network-extension-not-installed");
104+
105+
delete multiInstallations[_extension];
100106

101-
ColonyExtension extension = ColonyExtension(installations[_extensionId][msg.sender]);
102-
installations[_extensionId][msg.sender] = address(0x0);
103-
extension.uninstall();
107+
ColonyExtension(_extension).uninstall();
104108

105-
emit ExtensionUninstalled(_extensionId, msg.sender);
109+
emit ExtensionUninstalled(_extension, msg.sender);
106110
}
107111

108112
// Public view functions
@@ -115,6 +119,14 @@ contract ColonyNetworkExtensions is ColonyNetworkStorage {
115119
return resolvers[_extensionId][_version];
116120
}
117121

122+
function getExtensionMultiInstallation(address _extension)
123+
public
124+
view
125+
returns (address)
126+
{
127+
return multiInstallations[_extension];
128+
}
129+
118130
function getExtensionInstallation(bytes32 _extensionId, address _colony)
119131
public
120132
view

‎contracts/colonyNetwork/ColonyNetworkStorage.sol

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,16 @@ contract ColonyNetworkStorage is CommonStorage, ColonyNetworkDataTypes, DSMath {
9393
uint256 DEPRECATED_lastMetaColonyStipendIssued; // Storage slot 37
9494

9595
// [_extensionId][version] => resolver
96-
mapping(bytes32 => mapping(uint256 => address)) resolvers; // Storage slot 38
96+
mapping (bytes32 => mapping(uint256 => address)) resolvers; // Storage slot 38
9797
// [_extensionId][colony] => address
98-
mapping(bytes32 => mapping(address => address payable)) installations; // Storage slot 39
98+
mapping (bytes32 => mapping(address => address payable)) installations; // Storage slot 39
9999

100100
// Used for whitelisting payout tokens
101101
mapping (address => bool) payoutWhitelist; // Storage slot 40
102102

103+
// [_extension] => colony
104+
mapping (address => address payable) multiInstallations; // Storage slot 41
105+
103106
modifier calledByColony() {
104107
require(_isColony[msg.sender], "colony-caller-must-be-colony");
105108
_;

‎contracts/colonyNetwork/IColonyNetwork.sol

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -316,21 +316,22 @@ interface IColonyNetwork is ColonyNetworkDataTypes, IRecovery {
316316
/// @notice Install an extension in a colony. Can only be called by a Colony.
317317
/// @param extensionId keccak256 hash of the extension name, used as an indentifier
318318
/// @param version Version of the extension to install
319-
function installExtension(bytes32 extensionId, uint256 version) external;
319+
/// @return extension The address of the extension installation
320+
function installExtension(bytes32 extensionId, uint256 version) external returns (address extension);
320321

321322
/// @notice Upgrade an extension in a colony. Can only be called by a Colony.
322-
/// @param extensionId keccak256 hash of the extension name, used as an indentifier
323+
/// @param extension Address of the extension installation
323324
/// @param newVersion Version of the extension to upgrade to (must be one greater than current)
324-
function upgradeExtension(bytes32 extensionId, uint256 newVersion) external;
325+
function upgradeExtension(address payable extension, uint256 newVersion) external;
325326

326327
/// @notice Set the deprecation of an extension in a colony. Can only be called by a Colony.
327-
/// @param extensionId keccak256 hash of the extension name, used as an indentifier
328+
/// @param extension Address of the extension installation
328329
/// @param deprecated Whether to deprecate the extension or not
329-
function deprecateExtension(bytes32 extensionId, bool deprecated) external;
330+
function deprecateExtension(address payable extension, bool deprecated) external;
330331

331332
/// @notice Uninstall an extension in a colony. Can only be called by a Colony.
332-
/// @param extensionId keccak256 hash of the extension name, used as an indentifier
333-
function uninstallExtension(bytes32 extensionId) external;
333+
/// @param extension Address of the extension installation
334+
function uninstallExtension(address payable extension) external;
334335

335336
/// @notice Get an extension's resolver.
336337
/// @param extensionId keccak256 hash of the extension name, used as an indentifier
@@ -344,6 +345,11 @@ interface IColonyNetwork is ColonyNetworkDataTypes, IRecovery {
344345
/// @return installation The address of the installed extension
345346
function getExtensionInstallation(bytes32 extensionId, address colony) external view returns (address installation);
346347

348+
/// @notice Get an extension's installed colony.
349+
/// @param extension Address of the extension installation
350+
/// @return colony Address of the colony the extension is installed in
351+
function getExtensionMultiInstallation(address extension) external view returns (address colony);
352+
347353
/// @notice Return 1 / the fee to pay to the network. e.g. if the fee is 1% (or 0.01), return 100.
348354
/// @return _feeInverse The inverse of the network fee
349355
function getFeeInverse() external view returns (uint256 _feeInverse);

‎docs/_Interface_IColony.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ Set the deprecation of an extension in a colony. Secured function to authorised
257257

258258
|Name|Type|Description|
259259
|---|---|---|
260-
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
260+
|extension|address|The address of the extension installation
261261
|deprecated|bool|Whether to deprecate the extension or not
262262

263263

@@ -1038,6 +1038,11 @@ Install an extension to the colony. Secured function to authorised members.
10381038
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
10391039
|version|uint256|The new extension version to install
10401040

1041+
**Return Parameters**
1042+
1043+
|Name|Type|Description|
1044+
|---|---|---|
1045+
|extension|address|The address of the extension installation
10411046

10421047
### `lockExpenditure`
10431048

@@ -1894,7 +1899,7 @@ Uninstall an extension from a colony. Secured function to authorised members.
18941899

18951900
|Name|Type|Description|
18961901
|---|---|---|
1897-
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
1902+
|extension|address|The address of the extension installation
18981903

18991904

19001905
### `unlockToken`
@@ -1964,7 +1969,7 @@ Upgrade an extension in a colony. Secured function to authorised members.
19641969

19651970
|Name|Type|Description|
19661971
|---|---|---|
1967-
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
1972+
|extension|address|The address of the extension installation
19681973
|newVersion|uint256|The version to upgrade to (must be one larger than the current version)
19691974

19701975

0 commit comments

Comments
 (0)