Add dictionary deployment types: immutable, beacon

Author: kaihiroi

devkit/core/Dictionary.sol

@@ -12,8 +12,10 @@ import {Validator} from "devkit/system/Validator.sol";
 import {ForgeHelper} from "devkit/utils/ForgeHelper.sol";
 
 // External Libs
-import {IDictionary} from "@ucs.mc/dictionary/IDictionary.sol";
+import {IDictionary} from "@ucs.mc/dictionary/interfaces/IDictionary.sol";
 import {Dictionary as UCSDictionary} from "@ucs.mc/dictionary/Dictionary.sol";
+import {ImmutableDictionary, Function as Func} from "@ucs.mc/dictionary/ImmutableDictionary.sol";
+import {BeaconDictionary} from "@ucs.mc/dictionary/BeaconDictionary.sol";
 // Mock
 import {MockDictionary} from "devkit/test/mocks/MockDictionary.sol";
 
@@ -60,6 +62,9 @@ library DictionaryLib {
 
     /**-------------------------
         🚀 Deploy Dictionary
+            - Verifiable
+            - Immutable
+            - Beacon
     ---------------------------*/
     function deploy(address owner) internal returns(Dictionary memory dictionary) {
         uint pid = dictionary.startProcess("deploy", param(owner));
@@ -71,6 +76,31 @@ library DictionaryLib {
         return dictionary.finishProcess(pid);
     }
 
+    function deployImmutable(Function[] storage functions, address facade) internal returns(Dictionary memory dictionary) {
+        uint pid = dictionary.startProcess("deployImmutable", param(functions, facade));
+        Validator.SHOULD_FacadeIsContract(facade);
+        dictionary.startBuilding();
+        Func[] memory funcs;
+        for (uint i; i < functions.length; ++i) {
+            funcs[i] = Func(functions[i].selector, functions[i].implementation);
+        }
+        dictionary.addr = address(new ImmutableDictionary(funcs, facade));
+        dictionary.kind = DictionaryKind.Immutable;
+        dictionary.finishBuilding();
+        return dictionary.finishProcess(pid);
+    }
+
+    function deployBeacon(address implementation, address owner) internal returns(Dictionary memory dictionary) {
+        uint pid = dictionary.startProcess("deployBeacon", param(implementation, owner));
+        Validator.MUST_AddressIsContract(implementation);
+        Validator.SHOULD_OwnerIsNotZeroAddress(owner);
+        dictionary.startBuilding();
+        dictionary.addr = address(new BeaconDictionary(implementation, owner));
+        dictionary.kind = DictionaryKind.Beacon;
+        dictionary.finishBuilding();
+        return dictionary.finishProcess(pid);
+}
+
     /**-----------------------
         📩 Load Dictionary
     -------------------------*/
@@ -177,6 +207,8 @@ library DictionaryLib {
 enum DictionaryKind {
     undefined,
     Verifiable,
+    Immutable,
+    Beacon,
     Mock
 }
 using Inspector for DictionaryKind global;

devkit/system/Tracer.sol

@@ -347,6 +347,9 @@ function param(Function[] memory functions) pure returns(string memory res) {
         res = res.comma(functions[i].name);
     }
 }
+function param(Function[] memory functions, address facade) pure returns(string memory res) {
+    return param(functions).comma(facade);
+}
 
 function param(Bundle memory bundle) pure returns(string memory) {
     return bundle.name;

devkit/system/Validator.sol

@@ -79,6 +79,9 @@ library Validator {
     function MUST_AddressIsContract(address addr) internal view {
         validate(MUST, addr.isContract(), HEAD.ADDRESS_NOT_CONTRACT, BODY.ADDRESS_NOT_CONTRACT);
     }
+    function SHOULD_FacadeIsContract(address facade) internal view {
+        validate(SHOULD, facade.isContract(), HEAD.FACADE_NOT_CONTRACT, BODY.FACADE_NOT_CONTRACT);
+    }
     function SHOULD_OwnerIsNotZeroAddress(address owner) internal view {
         validate(MUST, owner.isNotZero(), HEAD.OWNER_ZERO_ADDRESS_RECOMMENDED, BODY.OWNER_ZERO_ADDRESS_RECOMMENDED);
     }

devkit/system/message/MessageBody.sol

@@ -11,6 +11,7 @@ library MessageBody {
     string constant ENV_KEY_REQUIRED = "The provided environment key cannot be an empty string. Please enter a non-empty value for the key and try again.";
     string constant SELECTOR_RECOMMENDED = "The provided function selector is empty (0x00000000). It is recommended to use a non-empty selector.";
     string constant ADDRESS_NOT_CONTRACT = "The provided address is not a contract address. Please provide the address of a deployed contract and try again.";
+    string constant FACADE_NOT_CONTRACT = "The provided facade address is not a contract address. It is recommended to use the address of a deployed facade contract and try again.";
     string constant OWNER_ZERO_ADDRESS_RECOMMENDED = "The provided owner address is the zero address (0x0). It is recommended to use a non-zero address for the owner to ensure proper access control and security.";
     // Current Context
     string constant CURRENT_NAME_NOT_FOUND = "Current Name Not Found";

devkit/system/message/MessageHead.sol

@@ -11,6 +11,7 @@ library MessageHead {
     string constant ENV_KEY_REQUIRED = "EnvKey Required";
     string constant SELECTOR_RECOMMENDED = "Empty Selector";
     string constant ADDRESS_NOT_CONTRACT = "Address Not Contract";
+    string constant FACADE_NOT_CONTRACT = "Facade Not Contract";
     string constant OWNER_ZERO_ADDRESS_RECOMMENDED = "Owner Zero Address";
     // Current Context
     string constant CURRENT_NAME_NOT_FOUND = "Current Name Not Found";

devkit/utils/global/MCDeployLib.sol

@@ -26,6 +26,10 @@ import {NameGenerator} from "devkit/utils/mapping/NameGenerator.sol";
 /************************************
  *  🚀 Deployment
  *      🌞 Deploy Meta Contract
+ *          - Deploy
+ *          - DeployImmutable
+ *          - DeployRestrictedUpgradeable
+ *          - DeployContractUpgradeable
  *      🏠 Deploy Proxy
  *      📚 Deploy Dictionary
  *      🔂 Duplicate Dictionary