You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/_Interface_IColony.md
+51Lines changed: 51 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -206,6 +206,19 @@ Deobligate the user some amount of tokens, releasing the stake.
206
206
|_amount|uint256|Amount of internal token we are deobligating.
207
207
208
208
209
+
### `deprecateExtension`
210
+
211
+
Upgrade an extension in a colony. Secured function to authorised members.
212
+
213
+
214
+
**Parameters**
215
+
216
+
|Name|Type|Description|
217
+
|---|---|---|
218
+
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
219
+
|deprecated|bool|Whether to deprecate the extension or not
220
+
221
+
209
222
### `emitDomainReputationPenalty`
210
223
211
224
Emit a negative domain reputation update. Available only to Arbitration role holders
@@ -881,6 +894,19 @@ Called once when the colony is created to initialise certain storage slot values
881
894
|_token|address|Address of the colony ERC20 Token
882
895
883
896
897
+
### `installExtension`
898
+
899
+
Install an extension to the colony. Secured function to authorised members.
900
+
901
+
902
+
**Parameters**
903
+
904
+
|Name|Type|Description|
905
+
|---|---|---|
906
+
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
907
+
|version|uint256|The new extension version to install
908
+
909
+
884
910
### `makeExpenditure`
885
911
886
912
Add a new expenditure in the colony. Secured function to authorised members.
@@ -1536,6 +1562,18 @@ Transfer some amount of obligated tokens. Can be called by the arbitration role.
1536
1562
|_recipient|address|Recipient of the transferred tokens.
1537
1563
1538
1564
1565
+
### `uninstallExtension`
1566
+
1567
+
Uninstall an extension from a colony. Secured function to authorised members.
1568
+
1569
+
1570
+
**Parameters**
1571
+
1572
+
|Name|Type|Description|
1573
+
|---|---|---|
1574
+
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
1575
+
1576
+
1539
1577
### `updateColonyOrbitDB`
1540
1578
1541
1579
Update a colony's orbitdb address. Can only be called by a colony with a registered subdomain
@@ -1561,6 +1599,19 @@ Upgrades a colony to a new Colony contract version `_newVersion`.
1561
1599
|_newVersion|uint|The target version for the upgrade
1562
1600
1563
1601
1602
+
### `upgradeExtension`
1603
+
1604
+
Upgrade an extension in a colony. Secured function to authorised members.
1605
+
1606
+
1607
+
**Parameters**
1608
+
1609
+
|Name|Type|Description|
1610
+
|---|---|---|
1611
+
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
1612
+
|newVersion|uint256|The version to upgrade to (must be one larger than the current version)
1613
+
1614
+
1564
1615
### `userCanSetRoles`
1565
1616
1566
1617
Check whether a given user can modify roles in the target domain `_childDomainId`. Mostly a convenience function to provide a uniform interface for extension contracts validating permissions
Install an extension in a colony. Can only be called by a Colony.
637
631
638
632
639
633
**Parameters**
640
634
641
635
|Name|Type|Description|
642
636
|---|---|---|
643
-
|extensionId|bytes32|
644
-
|version|uint256|
645
-
|colony|address|
637
+
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
638
+
|version|uint256|Version of the extension to install
646
639
647
640
648
641
### `isColony`
@@ -812,7 +805,7 @@ Called to set the total per-cycle reputation reward, which will be split between
812
805
813
806
### `setReputationRootHash`
814
807
815
-
Set a new Reputation root hash and starts a new mining cycle. Can only be called by the ReputationMiningCycle contract.
808
+
This version of setReputationRootHash is deprecated and will be removed in a future release. It transparently calls the new version if it is called (essentially, removing the `reward` parameter.
816
809
817
810
818
811
**Parameters**
@@ -822,11 +815,12 @@ Set a new Reputation root hash and starts a new mining cycle. Can only be called
822
815
|newHash|bytes32|The reputation root hash
823
816
|newNLeaves|uint256|The updated leaves count value
824
817
|stakers|address[]|Array of users who submitted or backed the hash, being accepted here as the new reputation root hash
818
+
|reward|uint256|Amount of CLNY to be distributed as reward to miners (not used)
825
819
826
820
827
821
### `setReputationRootHash`
828
822
829
-
This version of setReputationRootHash is deprecated and will be removed in a future release. It transparently calls the new version if it is called (essentially, removing the `reward` parameter.
823
+
Set a new Reputation root hash and starts a new mining cycle. Can only be called by the ReputationMiningCycle contract.
830
824
831
825
832
826
**Parameters**
@@ -836,7 +830,6 @@ This version of setReputationRootHash is deprecated and will be removed in a fut
836
830
|newHash|bytes32|The reputation root hash
837
831
|newNLeaves|uint256|The updated leaves count value
838
832
|stakers|address[]|Array of users who submitted or backed the hash, being accepted here as the new reputation root hash
839
-
|reward|uint256|Amount of CLNY to be distributed as reward to miners (not used)
840
833
841
834
842
835
### `setTokenLocking`
@@ -915,15 +908,14 @@ Query if a contract implements an interface
915
908
916
909
### `uninstallExtension`
917
910
918
-
911
+
Uninstall an extension in a colony. Can only be called by a Colony.
919
912
920
913
921
914
**Parameters**
922
915
923
916
|Name|Type|Description|
924
917
|---|---|---|
925
-
|extensionId|bytes32|
926
-
|colony|address|
918
+
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
927
919
928
920
929
921
### `unstakeForMining`
@@ -964,13 +956,12 @@ Update a user's orbitdb address. Can only be called by a user with a registered
964
956
965
957
### `upgradeExtension`
966
958
967
-
959
+
Upgrade an extension in a colony. Can only be called by a Colony.
968
960
969
961
970
962
**Parameters**
971
963
972
964
|Name|Type|Description|
973
965
|---|---|---|
974
-
|extensionId|bytes32|
975
-
|colony|address|
976
-
|newVersion|uint256|
966
+
|extensionId|bytes32|keccak256 hash of the extension name, used as an indentifier
967
+
|newVersion|uint256|Version of the extension to upgrade to (must be one greater than current)
0 commit comments