@latticexyz/world-modules 2.0.0-main-87235a21 → 2.0.0-main-fd10cff6

package/out/IModule.sol/IModule.json

@@ -85,7 +85,7 @@
     "installRoot(bytes)": "7c5b0335",
     "supportsInterface(bytes4)": "01ffc9a7"
   },
-  "rawMetadata": "{\"compiler\":{\"version\":\"0.8.21+commit.d9974bed\"},\"language\":\"Solidity\",\"output\":{\"abi\":[{\"inputs\":[],\"name\":\"Module_NonRootInstallNotSupported\",\"type\":\"error\"},{\"inputs\":[],\"name\":\"Module_RootInstallNotSupported\",\"type\":\"error\"},{\"inputs\":[],\"name\":\"getName\",\"outputs\":[{\"internalType\":\"bytes16\",\"name\":\"name\",\"type\":\"bytes16\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"bytes\",\"name\":\"args\",\"type\":\"bytes\"}],\"name\":\"install\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"bytes\",\"name\":\"args\",\"type\":\"bytes\"}],\"name\":\"installRoot\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"bytes4\",\"name\":\"interfaceID\",\"type\":\"bytes4\"}],\"name\":\"supportsInterface\",\"outputs\":[{\"internalType\":\"bool\",\"name\":\"\",\"type\":\"bool\"}],\"stateMutability\":\"view\",\"type\":\"function\"}],\"devdoc\":{\"kind\":\"dev\",\"methods\":{\"supportsInterface(bytes4)\":{\"details\":\"Interface identification is specified in ERC-165. This function  uses less than 30,000 gas.\",\"params\":{\"interfaceID\":\"The interface identifier, as specified in ERC-165\"},\"returns\":{\"_0\":\"`true` if the contract implements `interfaceID` and  `interfaceID` is not 0xffffffff, `false` otherwise\"}}},\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{\"getName()\":{\"notice\":\"Return the module name as a bytes16.\"},\"install(bytes)\":{\"notice\":\"This function is called by the World as part of `installModule`. The module expects to be called via the World contract, and therefore installs itself on the `msg.sender`. This function is separate from `installRoot` because the logic might be different (eg. accepting namespace parameters, or using `callFrom`)\"},\"installRoot(bytes)\":{\"notice\":\"This function is called by the World as part of `installRootModule`. The module expects to be called via the World contract, and therefore installs itself on the `msg.sender`.\"},\"supportsInterface(bytes4)\":{\"notice\":\"Query if a contract implements an interface\"}},\"version\":1}},\"settings\":{\"compilationTarget\":{\"/home/runner/work/mud/mud/packages/world/src/IModule.sol\":\"IModule\"},\"evmVersion\":\"paris\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"none\"},\"optimizer\":{\"enabled\":true,\"runs\":3000},\"remappings\":[\":@latticexyz/=node_modules/@latticexyz/\",\":ds-test/=node_modules/ds-test/src/\",\":forge-std/=node_modules/forge-std/src/\"]},\"sources\":{\"/home/runner/work/mud/mud/packages/world/src/IERC165.sol\":{\"keccak256\":\"0x1a113ae394de69ca1db7e9acb1886eaee3967dcfed46fc78497e77bc26dd778f\",\"license\":\"MIT\",\"urls\":[\"bzz-raw://091e04dc9e8d5b3a492d1d39a6d06fd5b4bad3c282bd4c06a38d92bec3422513\",\"dweb:/ipfs/QmbfMi1bH9RAs4JMDxKmhVqpAoyoVgN9nd7o11SakJC1zQ\"]},\"/home/runner/work/mud/mud/packages/world/src/IModule.sol\":{\"keccak256\":\"0x94ea093fda2be088097d66cc615b048a7a21d54a52b82cee9fdb76b31bedbb09\",\"license\":\"MIT\",\"urls\":[\"bzz-raw://ed989ab47a35f8ca01f5b9f6f42f075687ce41e2f26c647cc27031421f5179e8\",\"dweb:/ipfs/QmT6Xc4A2CGzGa7eL3NimPFXBW4Jy4jFBFFCw1QU6aGo61\"]}},\"version\":1}",
+  "rawMetadata": "{\"compiler\":{\"version\":\"0.8.21+commit.d9974bed\"},\"language\":\"Solidity\",\"output\":{\"abi\":[{\"inputs\":[],\"name\":\"Module_NonRootInstallNotSupported\",\"type\":\"error\"},{\"inputs\":[],\"name\":\"Module_RootInstallNotSupported\",\"type\":\"error\"},{\"inputs\":[],\"name\":\"getName\",\"outputs\":[{\"internalType\":\"bytes16\",\"name\":\"name\",\"type\":\"bytes16\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"bytes\",\"name\":\"args\",\"type\":\"bytes\"}],\"name\":\"install\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"bytes\",\"name\":\"args\",\"type\":\"bytes\"}],\"name\":\"installRoot\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"bytes4\",\"name\":\"interfaceID\",\"type\":\"bytes4\"}],\"name\":\"supportsInterface\",\"outputs\":[{\"internalType\":\"bool\",\"name\":\"\",\"type\":\"bool\"}],\"stateMutability\":\"view\",\"type\":\"function\"}],\"devdoc\":{\"details\":\"Interface for the Module system. A module can be installed within the context of a world, either as a root or non-root module. This interface adheres to the ERC-165 standard for determining interface support.\",\"errors\":{\"Module_RootInstallNotSupported()\":[{\"details\":\"Errors to represent non-support of specific installation types.\"}]},\"kind\":\"dev\",\"methods\":{\"getName()\":{\"details\":\"Provides a way to identify the module by a unique name.\",\"returns\":{\"name\":\"The name of the module as a bytes16.\"}},\"install(bytes)\":{\"details\":\"This function is invoked by the World contract during `installModule` process. The module expects to be called via the World contract and thus installs itself on the `msg.sender`. Logic might differ from `installRoot`, for example, this might accept namespace parameters.\",\"params\":{\"args\":\"Arguments that may be needed during the installation process.\"}},\"installRoot(bytes)\":{\"details\":\"This function is invoked by the World contract during `installRootModule` process. The module expects to be called via the World contract and thus installs itself on the `msg.sender`.\",\"params\":{\"args\":\"Arguments that may be needed during the installation process.\"}},\"supportsInterface(bytes4)\":{\"details\":\"Interface identification is specified in ERC-165. This function uses less than 30,000 gas.\",\"params\":{\"interfaceID\":\"The interface identifier, as specified in ERC-165.\"},\"returns\":{\"_0\":\"True if the contract implements `interfaceID` and `interfaceID` is not 0xffffffff, false otherwise.\"}}},\"title\":\"IModule\",\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{\"getName()\":{\"notice\":\"Return the name of the module.\"},\"install(bytes)\":{\"notice\":\"Installs the module.\"},\"installRoot(bytes)\":{\"notice\":\"Installs the module as a root module.\"},\"supportsInterface(bytes4)\":{\"notice\":\"Query if a contract implements an interface.\"}},\"version\":1}},\"settings\":{\"compilationTarget\":{\"/home/runner/work/mud/mud/packages/world/src/IModule.sol\":\"IModule\"},\"evmVersion\":\"paris\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"none\"},\"optimizer\":{\"enabled\":true,\"runs\":3000},\"remappings\":[\":@latticexyz/=node_modules/@latticexyz/\",\":ds-test/=node_modules/ds-test/src/\",\":forge-std/=node_modules/forge-std/src/\"]},\"sources\":{\"/home/runner/work/mud/mud/packages/world/src/IERC165.sol\":{\"keccak256\":\"0x7997ebbdee6a2493f28e7032c7a8b906ade40f807d95734e2653c8f1b023ff47\",\"license\":\"MIT\",\"urls\":[\"bzz-raw://c8ca41bb2619bf27e5bf886d1322f0e2dffd096c49f7ae6e716541dd1e1ddce5\",\"dweb:/ipfs/Qmb8zATUWWTtiWaSLjbAe6PGnJPes9ANvEyk7pYoWR3P3Y\"]},\"/home/runner/work/mud/mud/packages/world/src/IModule.sol\":{\"keccak256\":\"0xec02d49b84a882c9cf01e4e5c16f890ed7c52db945fd43a6f97ffe87730ba0d3\",\"license\":\"MIT\",\"urls\":[\"bzz-raw://8f8ee1a3aaac5789b36808bdae2e26e32d1664583a6b21680b5721f04d81bbc3\",\"dweb:/ipfs/Qmd4L3vGQiavSCe9g2k7riyA6cer3ruuxRFehAJCSxNRfw\"]}},\"version\":1}",
   "metadata": {
     "compiler": {
       "version": "0.8.21+commit.d9974bed"
@@ -163,13 +163,31 @@
       "devdoc": {
         "kind": "dev",
         "methods": {
+          "getName()": {
+            "details": "Provides a way to identify the module by a unique name.",
+            "returns": {
+              "name": "The name of the module as a bytes16."
+            }
+          },
+          "install(bytes)": {
+            "details": "This function is invoked by the World contract during `installModule` process. The module expects to be called via the World contract and thus installs itself on the `msg.sender`. Logic might differ from `installRoot`, for example, this might accept namespace parameters.",
+            "params": {
+              "args": "Arguments that may be needed during the installation process."
+            }
+          },
+          "installRoot(bytes)": {
+            "details": "This function is invoked by the World contract during `installRootModule` process. The module expects to be called via the World contract and thus installs itself on the `msg.sender`.",
+            "params": {
+              "args": "Arguments that may be needed during the installation process."
+            }
+          },
           "supportsInterface(bytes4)": {
-            "details": "Interface identification is specified in ERC-165. This function  uses less than 30,000 gas.",
+            "details": "Interface identification is specified in ERC-165. This function uses less than 30,000 gas.",
             "params": {
-              "interfaceID": "The interface identifier, as specified in ERC-165"
+              "interfaceID": "The interface identifier, as specified in ERC-165."
             },
             "returns": {
-              "_0": "`true` if the contract implements `interfaceID` and  `interfaceID` is not 0xffffffff, `false` otherwise"
+              "_0": "True if the contract implements `interfaceID` and `interfaceID` is not 0xffffffff, false otherwise."
             }
           }
         },
@@ -179,16 +197,16 @@
         "kind": "user",
         "methods": {
           "getName()": {
-            "notice": "Return the module name as a bytes16."
+            "notice": "Return the name of the module."
           },
           "install(bytes)": {
-            "notice": "This function is called by the World as part of `installModule`. The module expects to be called via the World contract, and therefore installs itself on the `msg.sender`. This function is separate from `installRoot` because the logic might be different (eg. accepting namespace parameters, or using `callFrom`)"
+            "notice": "Installs the module."
           },
           "installRoot(bytes)": {
-            "notice": "This function is called by the World as part of `installRootModule`. The module expects to be called via the World contract, and therefore installs itself on the `msg.sender`."
+            "notice": "Installs the module as a root module."
           },
           "supportsInterface(bytes4)": {
-            "notice": "Query if a contract implements an interface"
+            "notice": "Query if a contract implements an interface."
           }
         },
         "version": 1
@@ -214,18 +232,18 @@
     },
     "sources": {
       "/home/runner/work/mud/mud/packages/world/src/IERC165.sol": {
-        "keccak256": "0x1a113ae394de69ca1db7e9acb1886eaee3967dcfed46fc78497e77bc26dd778f",
+        "keccak256": "0x7997ebbdee6a2493f28e7032c7a8b906ade40f807d95734e2653c8f1b023ff47",
         "urls": [
-          "bzz-raw://091e04dc9e8d5b3a492d1d39a6d06fd5b4bad3c282bd4c06a38d92bec3422513",
-          "dweb:/ipfs/QmbfMi1bH9RAs4JMDxKmhVqpAoyoVgN9nd7o11SakJC1zQ"
+          "bzz-raw://c8ca41bb2619bf27e5bf886d1322f0e2dffd096c49f7ae6e716541dd1e1ddce5",
+          "dweb:/ipfs/Qmb8zATUWWTtiWaSLjbAe6PGnJPes9ANvEyk7pYoWR3P3Y"
         ],
         "license": "MIT"
       },
       "/home/runner/work/mud/mud/packages/world/src/IModule.sol": {
-        "keccak256": "0x94ea093fda2be088097d66cc615b048a7a21d54a52b82cee9fdb76b31bedbb09",
+        "keccak256": "0xec02d49b84a882c9cf01e4e5c16f890ed7c52db945fd43a6f97ffe87730ba0d3",
         "urls": [
-          "bzz-raw://ed989ab47a35f8ca01f5b9f6f42f075687ce41e2f26c647cc27031421f5179e8",
-          "dweb:/ipfs/QmT6Xc4A2CGzGa7eL3NimPFXBW4Jy4jFBFFCw1QU6aGo61"
+          "bzz-raw://8f8ee1a3aaac5789b36808bdae2e26e32d1664583a6b21680b5721f04d81bbc3",
+          "dweb:/ipfs/Qmd4L3vGQiavSCe9g2k7riyA6cer3ruuxRFehAJCSxNRfw"
         ],
         "license": "MIT"
       }
@@ -234,26 +252,26 @@
   },
   "ast": {
     "absolutePath": "/home/runner/work/mud/mud/packages/world/src/IModule.sol",
-    "id": 22979,
+    "id": 22986,
     "exportedSymbols": {
       "ERC165_INTERFACE_ID": [
-        22924
+        22927
       ],
       "IERC165": [
-        22933
+        22937
       ],
       "IModule": [
-        22978
+        22985
       ],
       "MODULE_INTERFACE_ID": [
-        22953
+        22958
       ]
     },
     "nodeType": "SourceUnit",
-    "src": "32:1188:35",
+    "src": "32:1982:35",
     "nodes": [
       {
-        "id": 22935,
+        "id": 22939,
         "nodeType": "PragmaDirective",
         "src": "32:25:35",
         "nodes": [],
@@ -265,23 +283,23 @@
         ]
       },
       {
-        "id": 22938,
+        "id": 22942,
         "nodeType": "ImportDirective",
         "src": "59:61:35",
         "nodes": [],
         "absolutePath": "/home/runner/work/mud/mud/packages/world/src/IERC165.sol",
         "file": "./IERC165.sol",
         "nameLocation": "-1:-1:-1",
-        "scope": 22979,
-        "sourceUnit": 22934,
+        "scope": 22986,
+        "sourceUnit": 22938,
         "symbolAliases": [
           {
             "foreign": {
-              "id": 22936,
+              "id": 22940,
               "name": "IERC165",
               "nodeType": "Identifier",
               "overloadedDeclarations": [],
-              "referencedDeclaration": 22933,
+              "referencedDeclaration": 22937,
               "src": "68:7:35",
               "typeDescriptions": {}
             },
@@ -289,11 +307,11 @@
           },
           {
             "foreign": {
-              "id": 22937,
+              "id": 22941,
               "name": "ERC165_INTERFACE_ID",
               "nodeType": "Identifier",
               "overloadedDeclarations": [],
-              "referencedDeclaration": 22924,
+              "referencedDeclaration": 22927,
               "src": "77:19:35",
               "typeDescriptions": {}
             },
@@ -303,15 +321,15 @@
         "unitAlias": ""
       },
       {
-        "id": 22953,
+        "id": 22958,
         "nodeType": "VariableDeclaration",
-        "src": "191:148:35",
+        "src": "322:148:35",
         "nodes": [],
         "constant": true,
         "mutability": "constant",
         "name": "MODULE_INTERFACE_ID",
-        "nameLocation": "207:19:35",
-        "scope": 22979,
+        "nameLocation": "338:19:35",
+        "scope": 22986,
         "stateVariable": false,
         "storageLocation": "default",
         "typeDescriptions": {
@@ -319,10 +337,10 @@
           "typeString": "bytes4"
         },
         "typeName": {
-          "id": 22939,
+          "id": 22944,
           "name": "bytes4",
           "nodeType": "ElementaryTypeName",
-          "src": "191:6:35",
+          "src": "322:6:35",
           "typeDescriptions": {
             "typeIdentifier": "t_bytes4",
             "typeString": "bytes4"
@@ -333,7 +351,7 @@
             "typeIdentifier": "t_bytes4",
             "typeString": "bytes4"
           },
-          "id": 22952,
+          "id": 22957,
           "isConstant": false,
           "isLValue": false,
           "isPure": true,
@@ -343,7 +361,7 @@
               "typeIdentifier": "t_bytes4",
               "typeString": "bytes4"
             },
-            "id": 22950,
+            "id": 22955,
             "isConstant": false,
             "isLValue": false,
             "isPure": true,
@@ -353,7 +371,7 @@
                 "typeIdentifier": "t_bytes4",
                 "typeString": "bytes4"
               },
-              "id": 22946,
+              "id": 22951,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
@@ -361,41 +379,41 @@
               "leftExpression": {
                 "expression": {
                   "expression": {
-                    "id": 22940,
+                    "id": 22945,
                     "name": "IModule",
                     "nodeType": "Identifier",
                     "overloadedDeclarations": [],
-                    "referencedDeclaration": 22978,
-                    "src": "229:7:35",
+                    "referencedDeclaration": 22985,
+                    "src": "360:7:35",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_type$_t_contract$_IModule_$22978_$",
+                      "typeIdentifier": "t_type$_t_contract$_IModule_$22985_$",
                       "typeString": "type(contract IModule)"
                     }
                   },
-                  "id": 22941,
+                  "id": 22946,
                   "isConstant": false,
                   "isLValue": false,
                   "isPure": true,
                   "lValueRequested": false,
-                  "memberLocation": "237:7:35",
+                  "memberLocation": "368:7:35",
                   "memberName": "getName",
                   "nodeType": "MemberAccess",
-                  "referencedDeclaration": 22965,
-                  "src": "229:15:35",
+                  "referencedDeclaration": 22972,
+                  "src": "360:15:35",
                   "typeDescriptions": {
                     "typeIdentifier": "t_function_declaration_view$__$returns$_t_bytes16_$",
                     "typeString": "function IModule.getName() view returns (bytes16)"
                   }
                 },
-                "id": 22942,
+                "id": 22947,
                 "isConstant": false,
                 "isLValue": false,
                 "isPure": true,
                 "lValueRequested": false,
-                "memberLocation": "245:8:35",
+                "memberLocation": "376:8:35",
                 "memberName": "selector",
                 "nodeType": "MemberAccess",
-                "src": "229:24:35",
+                "src": "360:24:35",
                 "typeDescriptions": {
                   "typeIdentifier": "t_bytes4",
                   "typeString": "bytes4"
@@ -406,47 +424,47 @@
               "rightExpression": {
                 "expression": {
                   "expression": {
-                    "id": 22943,
+                    "id": 22948,
                     "name": "IModule",
                     "nodeType": "Identifier",
                     "overloadedDeclarations": [],
-                    "referencedDeclaration": 22978,
-                    "src": "258:7:35",
+                    "referencedDeclaration": 22985,
+                    "src": "389:7:35",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_type$_t_contract$_IModule_$22978_$",
+                      "typeIdentifier": "t_type$_t_contract$_IModule_$22985_$",
                       "typeString": "type(contract IModule)"
                     }
                   },
-                  "id": 22944,
+                  "id": 22949,
                   "isConstant": false,
                   "isLValue": false,
                   "isPure": true,
                   "lValueRequested": false,
-                  "memberLocation": "266:11:35",
+                  "memberLocation": "397:11:35",
                   "memberName": "installRoot",
                   "nodeType": "MemberAccess",
-                  "referencedDeclaration": 22971,
-                  "src": "258:19:35",
+                  "referencedDeclaration": 22978,
+                  "src": "389:19:35",
                   "typeDescriptions": {
                     "typeIdentifier": "t_function_declaration_nonpayable$_t_bytes_memory_ptr_$returns$__$",
                     "typeString": "function IModule.installRoot(bytes memory)"
                   }
                 },
-                "id": 22945,
+                "id": 22950,
                 "isConstant": false,
                 "isLValue": false,
                 "isPure": true,
                 "lValueRequested": false,
-                "memberLocation": "278:8:35",
+                "memberLocation": "409:8:35",
                 "memberName": "selector",
                 "nodeType": "MemberAccess",
-                "src": "258:28:35",
+                "src": "389:28:35",
                 "typeDescriptions": {
                   "typeIdentifier": "t_bytes4",
                   "typeString": "bytes4"
                 }
               },
-              "src": "229:57:35",
+              "src": "360:57:35",
               "typeDescriptions": {
                 "typeIdentifier": "t_bytes4",
                 "typeString": "bytes4"
@@ -457,47 +475,47 @@
             "rightExpression": {
               "expression": {
                 "expression": {
-                  "id": 22947,
+                  "id": 22952,
                   "name": "IModule",
                   "nodeType": "Identifier",
                   "overloadedDeclarations": [],
-                  "referencedDeclaration": 22978,
-                  "src": "291:7:35",
+                  "referencedDeclaration": 22985,
+                  "src": "422:7:35",
                   "typeDescriptions": {
-                    "typeIdentifier": "t_type$_t_contract$_IModule_$22978_$",
+                    "typeIdentifier": "t_type$_t_contract$_IModule_$22985_$",
                     "typeString": "type(contract IModule)"
                   }
                 },
-                "id": 22948,
+                "id": 22953,
                 "isConstant": false,
                 "isLValue": false,
                 "isPure": true,
                 "lValueRequested": false,
-                "memberLocation": "299:7:35",
+                "memberLocation": "430:7:35",
                 "memberName": "install",
                 "nodeType": "MemberAccess",
-                "referencedDeclaration": 22977,
-                "src": "291:15:35",
+                "referencedDeclaration": 22984,
+                "src": "422:15:35",
                 "typeDescriptions": {
                   "typeIdentifier": "t_function_declaration_nonpayable$_t_bytes_memory_ptr_$returns$__$",
                   "typeString": "function IModule.install(bytes memory)"
                 }
               },
-              "id": 22949,
+              "id": 22954,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
               "lValueRequested": false,
-              "memberLocation": "307:8:35",
+              "memberLocation": "438:8:35",
               "memberName": "selector",
               "nodeType": "MemberAccess",
-              "src": "291:24:35",
+              "src": "422:24:35",
               "typeDescriptions": {
                 "typeIdentifier": "t_bytes4",
                 "typeString": "bytes4"
               }
             },
-            "src": "229:86:35",
+            "src": "360:86:35",
             "typeDescriptions": {
               "typeIdentifier": "t_bytes4",
               "typeString": "bytes4"
@@ -506,18 +524,18 @@
           "nodeType": "BinaryOperation",
           "operator": "^",
           "rightExpression": {
-            "id": 22951,
+            "id": 22956,
             "name": "ERC165_INTERFACE_ID",
             "nodeType": "Identifier",
             "overloadedDeclarations": [],
-            "referencedDeclaration": 22924,
-            "src": "320:19:35",
+            "referencedDeclaration": 22927,
+            "src": "451:19:35",
             "typeDescriptions": {
               "typeIdentifier": "t_bytes4",
               "typeString": "bytes4"
             }
           },
-          "src": "229:110:35",
+          "src": "360:110:35",
           "typeDescriptions": {
             "typeIdentifier": "t_bytes4",
             "typeString": "bytes4"
@@ -526,76 +544,82 @@
         "visibility": "internal"
       },
       {
-        "id": 22978,
+        "id": 22985,
         "nodeType": "ContractDefinition",
-        "src": "342:877:35",
+        "src": "722:1291:35",
         "nodes": [
           {
-            "id": 22957,
+            "id": 22964,
             "nodeType": "ErrorDefinition",
-            "src": "375:39:35",
+            "src": "830:39:35",
             "nodes": [],
+            "documentation": {
+              "id": 22962,
+              "nodeType": "StructuredDocumentation",
+              "src": "755:72:35",
+              "text": "@dev Errors to represent non-support of specific installation types."
+            },
             "errorSelector": "b6622fc0",
             "name": "Module_RootInstallNotSupported",
-            "nameLocation": "381:30:35",
+            "nameLocation": "836:30:35",
             "parameters": {
-              "id": 22956,
+              "id": 22963,
               "nodeType": "ParameterList",
               "parameters": [],
-              "src": "411:2:35"
+              "src": "866:2:35"
             }
           },
           {
-            "id": 22959,
+            "id": 22966,
             "nodeType": "ErrorDefinition",
-            "src": "417:42:35",
+            "src": "872:42:35",
             "nodes": [],
             "errorSelector": "ea8b184c",
             "name": "Module_NonRootInstallNotSupported",
-            "nameLocation": "423:33:35",
+            "nameLocation": "878:33:35",
             "parameters": {
-              "id": 22958,
+              "id": 22965,
               "nodeType": "ParameterList",
               "parameters": [],
-              "src": "456:2:35"
+              "src": "911:2:35"
             }
           },
           {
-            "id": 22965,
+            "id": 22972,
             "nodeType": "FunctionDefinition",
-            "src": "517:56:35",
+            "src": "1095:56:35",
             "nodes": [],
             "documentation": {
-              "id": 22960,
+              "id": 22967,
               "nodeType": "StructuredDocumentation",
-              "src": "463:51:35",
-              "text": " Return the module name as a bytes16."
+              "src": "918:174:35",
+              "text": " @notice Return the name of the module.\n @dev Provides a way to identify the module by a unique name.\n @return name The name of the module as a bytes16."
             },
             "functionSelector": "17d7de7c",
             "implemented": false,
             "kind": "function",
             "modifiers": [],
             "name": "getName",
-            "nameLocation": "526:7:35",
+            "nameLocation": "1104:7:35",
             "parameters": {
-              "id": 22961,
+              "id": 22968,
               "nodeType": "ParameterList",
               "parameters": [],
-              "src": "533:2:35"
+              "src": "1111:2:35"
             },
             "returnParameters": {
-              "id": 22964,
+              "id": 22971,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 22963,
+                  "id": 22970,
                   "mutability": "mutable",
                   "name": "name",
-                  "nameLocation": "567:4:35",
+                  "nameLocation": "1145:4:35",
                   "nodeType": "VariableDeclaration",
-                  "scope": 22965,
-                  "src": "559:12:35",
+                  "scope": 22972,
+                  "src": "1137:12:35",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -603,10 +627,10 @@
                     "typeString": "bytes16"
                   },
                   "typeName": {
-                    "id": 22962,
+                    "id": 22969,
                     "name": "bytes16",
                     "nodeType": "ElementaryTypeName",
-                    "src": "559:7:35",
+                    "src": "1137:7:35",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes16",
                       "typeString": "bytes16"
@@ -615,43 +639,43 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "558:14:35"
+              "src": "1136:14:35"
             },
-            "scope": 22978,
+            "scope": 22985,
             "stateMutability": "view",
             "virtual": false,
             "visibility": "external"
           },
           {
-            "id": 22971,
+            "id": 22978,
             "nodeType": "FunctionDefinition",
-            "src": "775:49:35",
+            "src": "1496:49:35",
             "nodes": [],
             "documentation": {
-              "id": 22966,
+              "id": 22973,
               "nodeType": "StructuredDocumentation",
-              "src": "577:195:35",
-              "text": " This function is called by the World as part of `installRootModule`.\n The module expects to be called via the World contract, and therefore installs itself on the `msg.sender`."
+              "src": "1155:338:35",
+              "text": " @notice Installs the module as a root module.\n @dev This function is invoked by the World contract during `installRootModule` process.\n The module expects to be called via the World contract and thus installs itself on the `msg.sender`.\n @param args Arguments that may be needed during the installation process."
             },
             "functionSelector": "7c5b0335",
             "implemented": false,
             "kind": "function",
             "modifiers": [],
             "name": "installRoot",
-            "nameLocation": "784:11:35",
+            "nameLocation": "1505:11:35",
             "parameters": {
-              "id": 22969,
+              "id": 22976,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 22968,
+                  "id": 22975,
                   "mutability": "mutable",
                   "name": "args",
-                  "nameLocation": "809:4:35",
+                  "nameLocation": "1530:4:35",
                   "nodeType": "VariableDeclaration",
-                  "scope": 22971,
-                  "src": "796:17:35",
+                  "scope": 22978,
+                  "src": "1517:17:35",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -659,10 +683,10 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 22967,
+                    "id": 22974,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "796:5:35",
+                    "src": "1517:5:35",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -671,49 +695,49 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "795:19:35"
+              "src": "1516:19:35"
             },
             "returnParameters": {
-              "id": 22970,
+              "id": 22977,
               "nodeType": "ParameterList",
               "parameters": [],
-              "src": "823:0:35"
+              "src": "1544:0:35"
             },
-            "scope": 22978,
+            "scope": 22985,
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "external"
           },
           {
-            "id": 22977,
+            "id": 22984,
             "nodeType": "FunctionDefinition",
-            "src": "1172:45:35",
+            "src": "1966:45:35",
             "nodes": [],
             "documentation": {
-              "id": 22972,
+              "id": 22979,
               "nodeType": "StructuredDocumentation",
-              "src": "828:341:35",
-              "text": " This function is called by the World as part of `installModule`.\n The module expects to be called via the World contract, and therefore installs itself on the `msg.sender`.\n This function is separate from `installRoot` because the logic might be different (eg. accepting namespace parameters,\n or using `callFrom`)"
+              "src": "1549:414:35",
+              "text": " @notice Installs the module.\n @dev This function is invoked by the World contract during `installModule` process.\n The module expects to be called via the World contract and thus installs itself on the `msg.sender`.\n Logic might differ from `installRoot`, for example, this might accept namespace parameters.\n @param args Arguments that may be needed during the installation process."
             },
             "functionSelector": "13861fb5",
             "implemented": false,
             "kind": "function",
             "modifiers": [],
             "name": "install",
-            "nameLocation": "1181:7:35",
+            "nameLocation": "1975:7:35",
             "parameters": {
-              "id": 22975,
+              "id": 22982,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 22974,
+                  "id": 22981,
                   "mutability": "mutable",
                   "name": "args",
-                  "nameLocation": "1202:4:35",
+                  "nameLocation": "1996:4:35",
                   "nodeType": "VariableDeclaration",
-                  "scope": 22977,
-                  "src": "1189:17:35",
+                  "scope": 22984,
+                  "src": "1983:17:35",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -721,10 +745,10 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 22973,
+                    "id": 22980,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "1189:5:35",
+                    "src": "1983:5:35",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -733,15 +757,15 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "1188:19:35"
+              "src": "1982:19:35"
             },
             "returnParameters": {
-              "id": 22976,
+              "id": 22983,
               "nodeType": "ParameterList",
               "parameters": [],
-              "src": "1216:0:35"
+              "src": "2010:0:35"
             },
-            "scope": 22978,
+            "scope": 22985,
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "external"
@@ -751,34 +775,40 @@
         "baseContracts": [
           {
             "baseName": {
-              "id": 22954,
+              "id": 22960,
               "name": "IERC165",
               "nameLocations": [
-                "363:7:35"
+                "743:7:35"
               ],
               "nodeType": "IdentifierPath",
-              "referencedDeclaration": 22933,
-              "src": "363:7:35"
+              "referencedDeclaration": 22937,
+              "src": "743:7:35"
             },
-            "id": 22955,
+            "id": 22961,
             "nodeType": "InheritanceSpecifier",
-            "src": "363:7:35"
+            "src": "743:7:35"
           }
         ],
         "canonicalName": "IModule",
         "contractDependencies": [],
         "contractKind": "interface",
+        "documentation": {
+          "id": 22959,
+          "nodeType": "StructuredDocumentation",
+          "src": "473:248:35",
+          "text": " @title IModule\n @dev Interface for the Module system.\n A module can be installed within the context of a world, either as a root or non-root module.\n This interface adheres to the ERC-165 standard for determining interface support."
+        },
         "fullyImplemented": false,
         "linearizedBaseContracts": [
-          22978,
-          22933
+          22985,
+          22937
         ],
         "name": "IModule",
-        "nameLocation": "352:7:35",
-        "scope": 22979,
+        "nameLocation": "732:7:35",
+        "scope": 22986,
         "usedErrors": [
-          22957,
-          22959
+          22964,
+          22966
         ],
         "usedEvents": []
       }