@latticexyz/world-modules 2.0.0-main-fd10cff6 → 2.0.0-main-85218618

package/out/IWorldContextConsumer.sol/IWorldContextConsumer.json

@@ -75,7 +75,7 @@
     "_world()": "e1af802c",
     "supportsInterface(bytes4)": "01ffc9a7"
   },
-  "rawMetadata": "{\"compiler\":{\"version\":\"0.8.21+commit.d9974bed\"},\"language\":\"Solidity\",\"output\":{\"abi\":[{\"inputs\":[],\"name\":\"_msgSender\",\"outputs\":[{\"internalType\":\"address\",\"name\":\"\",\"type\":\"address\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[],\"name\":\"_msgValue\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[],\"name\":\"_world\",\"outputs\":[{\"internalType\":\"address\",\"name\":\"\",\"type\":\"address\"}],\"stateMutability\":\"view\",\"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\":{\"supportsInterface(bytes4)\":{\"notice\":\"Query if a contract implements an interface.\"}},\"version\":1}},\"settings\":{\"compilationTarget\":{\"/home/runner/work/mud/mud/packages/world/src/IWorldContextConsumer.sol\":\"IWorldContextConsumer\"},\"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/IWorldContextConsumer.sol\":{\"keccak256\":\"0x0c0f9eba3a700d97a3b87678bbf12d4bbd8a80490e9b3a5841d049ebc1a89f93\",\"license\":\"MIT\",\"urls\":[\"bzz-raw://a56466e8ddcaf10b9109bfbc581563f5e9eefcaff1963a6954ccd093859ef6d2\",\"dweb:/ipfs/QmNk6FvWzmLT3vnsUuzqr9MYMfaQRa7yLuNM7DVvpkuytf\"]}},\"version\":1}",
+  "rawMetadata": "{\"compiler\":{\"version\":\"0.8.21+commit.d9974bed\"},\"language\":\"Solidity\",\"output\":{\"abi\":[{\"inputs\":[],\"name\":\"_msgSender\",\"outputs\":[{\"internalType\":\"address\",\"name\":\"\",\"type\":\"address\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[],\"name\":\"_msgValue\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[],\"name\":\"_world\",\"outputs\":[{\"internalType\":\"address\",\"name\":\"\",\"type\":\"address\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"bytes4\",\"name\":\"interfaceID\",\"type\":\"bytes4\"}],\"name\":\"supportsInterface\",\"outputs\":[{\"internalType\":\"bool\",\"name\":\"\",\"type\":\"bool\"}],\"stateMutability\":\"view\",\"type\":\"function\"}],\"devdoc\":{\"details\":\"This contract should only be used for contracts without their own storage, like Systems.\",\"kind\":\"dev\",\"methods\":{\"_msgSender()\":{\"returns\":{\"_0\":\"The address of the `msg.sender` that called the World contract before the World routed the call to the WorldContextConsumer contract.\"}},\"_msgValue()\":{\"returns\":{\"_0\":\"The `msg.value` in the call to the World contract before the World routed the call to the WorldContextConsumer contract.\"}},\"_world()\":{\"returns\":{\"_0\":\"The address of the World contract that routed the call to this WorldContextConsumer.\"}},\"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\":\"WorldContextConsumer - Extracting trusted context values from appended calldata.\",\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{\"_msgSender()\":{\"notice\":\"Extract the `msg.sender` from the context appended to the calldata.\"},\"_msgValue()\":{\"notice\":\"Extract the `msg.value` from the context appended to the calldata.\"},\"_world()\":{\"notice\":\"Get the address of the World contract that routed the call to this WorldContextConsumer.\"},\"supportsInterface(bytes4)\":{\"notice\":\"Query if a contract implements an interface.\"}},\"notice\":\"This contract is designed to extract trusted context values (like msg.sender and msg.value) from the appended calldata. It provides mechanisms similar to EIP-2771 (https://eips.ethereum.org/EIPS/eip-2771), but allowing any contract to be the trusted forwarder.\",\"version\":1}},\"settings\":{\"compilationTarget\":{\"/home/runner/work/mud/mud/packages/world/src/IWorldContextConsumer.sol\":\"IWorldContextConsumer\"},\"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/IWorldContextConsumer.sol\":{\"keccak256\":\"0x22b8cb3ffcc21cb1657d57fc8ac929d2d6fdd199328e6f43ad2cb54f53dcd500\",\"license\":\"MIT\",\"urls\":[\"bzz-raw://47c001f6b7c6d6e453c340618d23b1532078abb7d0fd7283405071e4e8ff8d2d\",\"dweb:/ipfs/QmRW3femBhqQCPwDEj4Jop2Dnd3EU21ufg7GDVwN4joCQu\"]}},\"version\":1}",
   "metadata": {
     "compiler": {
       "version": "0.8.21+commit.d9974bed"
@@ -145,6 +145,21 @@
       "devdoc": {
         "kind": "dev",
         "methods": {
+          "_msgSender()": {
+            "returns": {
+              "_0": "The address of the `msg.sender` that called the World contract before the World routed the call to the WorldContextConsumer contract."
+            }
+          },
+          "_msgValue()": {
+            "returns": {
+              "_0": "The `msg.value` in the call to the World contract before the World routed the call to the WorldContextConsumer contract."
+            }
+          },
+          "_world()": {
+            "returns": {
+              "_0": "The address of the World contract that routed the call to this WorldContextConsumer."
+            }
+          },
           "supportsInterface(bytes4)": {
             "details": "Interface identification is specified in ERC-165. This function uses less than 30,000 gas.",
             "params": {
@@ -160,6 +175,15 @@
       "userdoc": {
         "kind": "user",
         "methods": {
+          "_msgSender()": {
+            "notice": "Extract the `msg.sender` from the context appended to the calldata."
+          },
+          "_msgValue()": {
+            "notice": "Extract the `msg.value` from the context appended to the calldata."
+          },
+          "_world()": {
+            "notice": "Get the address of the World contract that routed the call to this WorldContextConsumer."
+          },
           "supportsInterface(bytes4)": {
             "notice": "Query if a contract implements an interface."
           }
@@ -195,10 +219,10 @@
         "license": "MIT"
       },
       "/home/runner/work/mud/mud/packages/world/src/IWorldContextConsumer.sol": {
-        "keccak256": "0x0c0f9eba3a700d97a3b87678bbf12d4bbd8a80490e9b3a5841d049ebc1a89f93",
+        "keccak256": "0x22b8cb3ffcc21cb1657d57fc8ac929d2d6fdd199328e6f43ad2cb54f53dcd500",
         "urls": [
-          "bzz-raw://a56466e8ddcaf10b9109bfbc581563f5e9eefcaff1963a6954ccd093859ef6d2",
-          "dweb:/ipfs/QmNk6FvWzmLT3vnsUuzqr9MYMfaQRa7yLuNM7DVvpkuytf"
+          "bzz-raw://47c001f6b7c6d6e453c340618d23b1532078abb7d0fd7283405071e4e8ff8d2d",
+          "dweb:/ipfs/QmRW3femBhqQCPwDEj4Jop2Dnd3EU21ufg7GDVwN4joCQu"
         ],
         "license": "MIT"
       }
@@ -207,7 +231,7 @@
   },
   "ast": {
     "absolutePath": "/home/runner/work/mud/mud/packages/world/src/IWorldContextConsumer.sol",
-    "id": 23065,
+    "id": 23074,
     "exportedSymbols": {
       "ERC165_INTERFACE_ID": [
         22927
@@ -216,17 +240,17 @@
         22937
       ],
       "IWorldContextConsumer": [
-        23064
+        23073
       ],
       "WORLD_CONTEXT_CONSUMER_INTERFACE_ID": [
-        23046
+        23051
       ]
     },
     "nodeType": "SourceUnit",
-    "src": "32:583:37",
+    "src": "32:1985:37",
     "nodes": [
       {
-        "id": 23028,
+        "id": 23032,
         "nodeType": "PragmaDirective",
         "src": "32:25:37",
         "nodes": [],
@@ -238,19 +262,19 @@
         ]
       },
       {
-        "id": 23031,
+        "id": 23035,
         "nodeType": "ImportDirective",
         "src": "59:61:37",
         "nodes": [],
         "absolutePath": "/home/runner/work/mud/mud/packages/world/src/IERC165.sol",
         "file": "./IERC165.sol",
         "nameLocation": "-1:-1:-1",
-        "scope": 23065,
+        "scope": 23074,
         "sourceUnit": 22938,
         "symbolAliases": [
           {
             "foreign": {
-              "id": 23029,
+              "id": 23033,
               "name": "IERC165",
               "nodeType": "Identifier",
               "overloadedDeclarations": [],
@@ -262,7 +286,7 @@
           },
           {
             "foreign": {
-              "id": 23030,
+              "id": 23034,
               "name": "ERC165_INTERFACE_ID",
               "nodeType": "Identifier",
               "overloadedDeclarations": [],
@@ -276,15 +300,15 @@
         "unitAlias": ""
       },
       {
-        "id": 23046,
+        "id": 23051,
         "nodeType": "VariableDeclaration",
-        "src": "191:206:37",
+        "src": "431:206:37",
         "nodes": [],
         "constant": true,
         "mutability": "constant",
         "name": "WORLD_CONTEXT_CONSUMER_INTERFACE_ID",
-        "nameLocation": "207:35:37",
-        "scope": 23065,
+        "nameLocation": "447:35:37",
+        "scope": 23074,
         "stateVariable": false,
         "storageLocation": "default",
         "typeDescriptions": {
@@ -292,10 +316,10 @@
           "typeString": "bytes4"
         },
         "typeName": {
-          "id": 23032,
+          "id": 23037,
           "name": "bytes4",
           "nodeType": "ElementaryTypeName",
-          "src": "191:6:37",
+          "src": "431:6:37",
           "typeDescriptions": {
             "typeIdentifier": "t_bytes4",
             "typeString": "bytes4"
@@ -306,7 +330,7 @@
             "typeIdentifier": "t_bytes4",
             "typeString": "bytes4"
           },
-          "id": 23045,
+          "id": 23050,
           "isConstant": false,
           "isLValue": false,
           "isPure": true,
@@ -316,7 +340,7 @@
               "typeIdentifier": "t_bytes4",
               "typeString": "bytes4"
             },
-            "id": 23043,
+            "id": 23048,
             "isConstant": false,
             "isLValue": false,
             "isPure": true,
@@ -326,7 +350,7 @@
                 "typeIdentifier": "t_bytes4",
                 "typeString": "bytes4"
               },
-              "id": 23039,
+              "id": 23044,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
@@ -334,41 +358,41 @@
               "leftExpression": {
                 "expression": {
                   "expression": {
-                    "id": 23033,
+                    "id": 23038,
                     "name": "IWorldContextConsumer",
                     "nodeType": "Identifier",
                     "overloadedDeclarations": [],
-                    "referencedDeclaration": 23064,
-                    "src": "245:21:37",
+                    "referencedDeclaration": 23073,
+                    "src": "485:21:37",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_type$_t_contract$_IWorldContextConsumer_$23064_$",
+                      "typeIdentifier": "t_type$_t_contract$_IWorldContextConsumer_$23073_$",
                       "typeString": "type(contract IWorldContextConsumer)"
                     }
                   },
-                  "id": 23034,
+                  "id": 23039,
                   "isConstant": false,
                   "isLValue": false,
                   "isPure": true,
                   "lValueRequested": false,
-                  "memberLocation": "267:10:37",
+                  "memberLocation": "507:10:37",
                   "memberName": "_msgSender",
                   "nodeType": "MemberAccess",
-                  "referencedDeclaration": 23053,
-                  "src": "245:32:37",
+                  "referencedDeclaration": 23060,
+                  "src": "485:32:37",
                   "typeDescriptions": {
                     "typeIdentifier": "t_function_declaration_view$__$returns$_t_address_$",
                     "typeString": "function IWorldContextConsumer._msgSender() view returns (address)"
                   }
                 },
-                "id": 23035,
+                "id": 23040,
                 "isConstant": false,
                 "isLValue": false,
                 "isPure": true,
                 "lValueRequested": false,
-                "memberLocation": "278:8:37",
+                "memberLocation": "518:8:37",
                 "memberName": "selector",
                 "nodeType": "MemberAccess",
-                "src": "245:41:37",
+                "src": "485:41:37",
                 "typeDescriptions": {
                   "typeIdentifier": "t_bytes4",
                   "typeString": "bytes4"
@@ -379,47 +403,47 @@
               "rightExpression": {
                 "expression": {
                   "expression": {
-                    "id": 23036,
+                    "id": 23041,
                     "name": "IWorldContextConsumer",
                     "nodeType": "Identifier",
                     "overloadedDeclarations": [],
-                    "referencedDeclaration": 23064,
-                    "src": "291:21:37",
+                    "referencedDeclaration": 23073,
+                    "src": "531:21:37",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_type$_t_contract$_IWorldContextConsumer_$23064_$",
+                      "typeIdentifier": "t_type$_t_contract$_IWorldContextConsumer_$23073_$",
                       "typeString": "type(contract IWorldContextConsumer)"
                     }
                   },
-                  "id": 23037,
+                  "id": 23042,
                   "isConstant": false,
                   "isLValue": false,
                   "isPure": true,
                   "lValueRequested": false,
-                  "memberLocation": "313:9:37",
+                  "memberLocation": "553:9:37",
                   "memberName": "_msgValue",
                   "nodeType": "MemberAccess",
-                  "referencedDeclaration": 23058,
-                  "src": "291:31:37",
+                  "referencedDeclaration": 23066,
+                  "src": "531:31:37",
                   "typeDescriptions": {
                     "typeIdentifier": "t_function_declaration_view$__$returns$_t_uint256_$",
                     "typeString": "function IWorldContextConsumer._msgValue() view returns (uint256)"
                   }
                 },
-                "id": 23038,
+                "id": 23043,
                 "isConstant": false,
                 "isLValue": false,
                 "isPure": true,
                 "lValueRequested": false,
-                "memberLocation": "323:8:37",
+                "memberLocation": "563:8:37",
                 "memberName": "selector",
                 "nodeType": "MemberAccess",
-                "src": "291:40:37",
+                "src": "531:40:37",
                 "typeDescriptions": {
                   "typeIdentifier": "t_bytes4",
                   "typeString": "bytes4"
                 }
               },
-              "src": "245:86:37",
+              "src": "485:86:37",
               "typeDescriptions": {
                 "typeIdentifier": "t_bytes4",
                 "typeString": "bytes4"
@@ -430,47 +454,47 @@
             "rightExpression": {
               "expression": {
                 "expression": {
-                  "id": 23040,
+                  "id": 23045,
                   "name": "IWorldContextConsumer",
                   "nodeType": "Identifier",
                   "overloadedDeclarations": [],
-                  "referencedDeclaration": 23064,
-                  "src": "336:21:37",
+                  "referencedDeclaration": 23073,
+                  "src": "576:21:37",
                   "typeDescriptions": {
-                    "typeIdentifier": "t_type$_t_contract$_IWorldContextConsumer_$23064_$",
+                    "typeIdentifier": "t_type$_t_contract$_IWorldContextConsumer_$23073_$",
                     "typeString": "type(contract IWorldContextConsumer)"
                   }
                 },
-                "id": 23041,
+                "id": 23046,
                 "isConstant": false,
                 "isLValue": false,
                 "isPure": true,
                 "lValueRequested": false,
-                "memberLocation": "358:6:37",
+                "memberLocation": "598:6:37",
                 "memberName": "_world",
                 "nodeType": "MemberAccess",
-                "referencedDeclaration": 23063,
-                "src": "336:28:37",
+                "referencedDeclaration": 23072,
+                "src": "576:28:37",
                 "typeDescriptions": {
                   "typeIdentifier": "t_function_declaration_view$__$returns$_t_address_$",
                   "typeString": "function IWorldContextConsumer._world() view returns (address)"
                 }
               },
-              "id": 23042,
+              "id": 23047,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
               "lValueRequested": false,
-              "memberLocation": "365:8:37",
+              "memberLocation": "605:8:37",
               "memberName": "selector",
               "nodeType": "MemberAccess",
-              "src": "336:37:37",
+              "src": "576:37:37",
               "typeDescriptions": {
                 "typeIdentifier": "t_bytes4",
                 "typeString": "bytes4"
               }
             },
-            "src": "245:128:37",
+            "src": "485:128:37",
             "typeDescriptions": {
               "typeIdentifier": "t_bytes4",
               "typeString": "bytes4"
@@ -479,18 +503,18 @@
           "nodeType": "BinaryOperation",
           "operator": "^",
           "rightExpression": {
-            "id": 23044,
+            "id": 23049,
             "name": "ERC165_INTERFACE_ID",
             "nodeType": "Identifier",
             "overloadedDeclarations": [],
             "referencedDeclaration": 22927,
-            "src": "378:19:37",
+            "src": "618:19:37",
             "typeDescriptions": {
               "typeIdentifier": "t_bytes4",
               "typeString": "bytes4"
             }
           },
-          "src": "245:152:37",
+          "src": "485:152:37",
           "typeDescriptions": {
             "typeIdentifier": "t_bytes4",
             "typeString": "bytes4"
@@ -499,40 +523,46 @@
         "visibility": "internal"
       },
       {
-        "id": 23064,
+        "id": 23073,
         "nodeType": "ContractDefinition",
-        "src": "400:214:37",
+        "src": "1114:902:37",
         "nodes": [
           {
-            "id": 23053,
+            "id": 23060,
             "nodeType": "FunctionDefinition",
-            "src": "447:54:37",
+            "src": "1406:54:37",
             "nodes": [],
+            "documentation": {
+              "id": 23055,
+              "nodeType": "StructuredDocumentation",
+              "src": "1161:242:37",
+              "text": " @notice Extract the `msg.sender` from the context appended to the calldata.\n @return The address of the `msg.sender` that called the World contract\n before the World routed the call to the WorldContextConsumer contract."
+            },
             "functionSelector": "119df25f",
             "implemented": false,
             "kind": "function",
             "modifiers": [],
             "name": "_msgSender",
-            "nameLocation": "456:10:37",
+            "nameLocation": "1415:10:37",
             "parameters": {
-              "id": 23049,
+              "id": 23056,
               "nodeType": "ParameterList",
               "parameters": [],
-              "src": "466:2:37"
+              "src": "1425:2:37"
             },
             "returnParameters": {
-              "id": 23052,
+              "id": 23059,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23051,
+                  "id": 23058,
                   "mutability": "mutable",
                   "name": "",
                   "nameLocation": "-1:-1:-1",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23053,
-                  "src": "492:7:37",
+                  "scope": 23060,
+                  "src": "1451:7:37",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -540,10 +570,10 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 23050,
+                    "id": 23057,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "492:7:37",
+                    "src": "1451:7:37",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -553,43 +583,49 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "491:9:37"
+              "src": "1450:9:37"
             },
-            "scope": 23064,
+            "scope": 23073,
             "stateMutability": "view",
             "virtual": false,
             "visibility": "external"
           },
           {
-            "id": 23058,
+            "id": 23066,
             "nodeType": "FunctionDefinition",
-            "src": "505:53:37",
+            "src": "1695:53:37",
             "nodes": [],
+            "documentation": {
+              "id": 23061,
+              "nodeType": "StructuredDocumentation",
+              "src": "1464:228:37",
+              "text": " @notice Extract the `msg.value` from the context appended to the calldata.\n @return The `msg.value` in the call to the World contract before the World routed the\n call to the WorldContextConsumer contract."
+            },
             "functionSelector": "45ec9354",
             "implemented": false,
             "kind": "function",
             "modifiers": [],
             "name": "_msgValue",
-            "nameLocation": "514:9:37",
+            "nameLocation": "1704:9:37",
             "parameters": {
-              "id": 23054,
+              "id": 23062,
               "nodeType": "ParameterList",
               "parameters": [],
-              "src": "523:2:37"
+              "src": "1713:2:37"
             },
             "returnParameters": {
-              "id": 23057,
+              "id": 23065,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23056,
+                  "id": 23064,
                   "mutability": "mutable",
                   "name": "",
                   "nameLocation": "-1:-1:-1",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23058,
-                  "src": "549:7:37",
+                  "scope": 23066,
+                  "src": "1739:7:37",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -597,10 +633,10 @@
                     "typeString": "uint256"
                   },
                   "typeName": {
-                    "id": 23055,
+                    "id": 23063,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "549:7:37",
+                    "src": "1739:7:37",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -609,43 +645,49 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "548:9:37"
+              "src": "1738:9:37"
             },
-            "scope": 23064,
+            "scope": 23073,
             "stateMutability": "view",
             "virtual": false,
             "visibility": "external"
           },
           {
-            "id": 23063,
+            "id": 23072,
             "nodeType": "FunctionDefinition",
-            "src": "562:50:37",
+            "src": "1964:50:37",
             "nodes": [],
+            "documentation": {
+              "id": 23067,
+              "nodeType": "StructuredDocumentation",
+              "src": "1752:209:37",
+              "text": " @notice Get the address of the World contract that routed the call to this WorldContextConsumer.\n @return The address of the World contract that routed the call to this WorldContextConsumer."
+            },
             "functionSelector": "e1af802c",
             "implemented": false,
             "kind": "function",
             "modifiers": [],
             "name": "_world",
-            "nameLocation": "571:6:37",
+            "nameLocation": "1973:6:37",
             "parameters": {
-              "id": 23059,
+              "id": 23068,
               "nodeType": "ParameterList",
               "parameters": [],
-              "src": "577:2:37"
+              "src": "1979:2:37"
             },
             "returnParameters": {
-              "id": 23062,
+              "id": 23071,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23061,
+                  "id": 23070,
                   "mutability": "mutable",
                   "name": "",
                   "nameLocation": "-1:-1:-1",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23063,
-                  "src": "603:7:37",
+                  "scope": 23072,
+                  "src": "2005:7:37",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -653,10 +695,10 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 23060,
+                    "id": 23069,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "603:7:37",
+                    "src": "2005:7:37",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -666,9 +708,9 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "602:9:37"
+              "src": "2004:9:37"
             },
-            "scope": 23064,
+            "scope": 23073,
             "stateMutability": "view",
             "virtual": false,
             "visibility": "external"
@@ -678,31 +720,37 @@
         "baseContracts": [
           {
             "baseName": {
-              "id": 23047,
+              "id": 23053,
               "name": "IERC165",
               "nameLocations": [
-                "435:7:37"
+                "1149:7:37"
               ],
               "nodeType": "IdentifierPath",
               "referencedDeclaration": 22937,
-              "src": "435:7:37"
+              "src": "1149:7:37"
             },
-            "id": 23048,
+            "id": 23054,
             "nodeType": "InheritanceSpecifier",
-            "src": "435:7:37"
+            "src": "1149:7:37"
           }
         ],
         "canonicalName": "IWorldContextConsumer",
         "contractDependencies": [],
         "contractKind": "interface",
+        "documentation": {
+          "id": 23052,
+          "nodeType": "StructuredDocumentation",
+          "src": "640:473:37",
+          "text": " @title WorldContextConsumer - Extracting trusted context values from appended calldata.\n @notice This contract is designed to extract trusted context values (like msg.sender and msg.value)\n from the appended calldata. It provides mechanisms similar to EIP-2771 (https://eips.ethereum.org/EIPS/eip-2771),\n but allowing any contract to be the trusted forwarder.\n @dev This contract should only be used for contracts without their own storage, like Systems."
+        },
         "fullyImplemented": false,
         "linearizedBaseContracts": [
-          23064,
+          23073,
           22937
         ],
         "name": "IWorldContextConsumer",
-        "nameLocation": "410:21:37",
-        "scope": 23065,
+        "nameLocation": "1124:21:37",
+        "scope": 23074,
         "usedErrors": [],
         "usedEvents": []
       }