@superfluid-finance/ethereum-contracts 1.7.2-dev.c99f6f9.0 → 1.7.2-dev.dae8ea5.0

package/build/contracts/ISuperApp.json

@@ -265,18 +265,18 @@
     "absolutePath": "project:/contracts/interfaces/superfluid/ISuperApp.sol",
     "exportedSymbols": {
       "ISuperApp": [
-        23920
+        23923
       ],
       "ISuperToken": [
-        24394
+        24397
       ]
     },
-    "id": 23921,
+    "id": 23924,
     "license": "MIT",
     "nodeType": "SourceUnit",
     "nodes": [
       {
-        "id": 23808,
+        "id": 23811,
         "literals": [
           "solidity",
           ">=",
@@ -289,20 +289,20 @@
       {
         "absolutePath": "project:/contracts/interfaces/superfluid/ISuperToken.sol",
         "file": "./ISuperToken.sol",
-        "id": 23810,
+        "id": 23813,
         "nameLocation": "-1:-1:-1",
         "nodeType": "ImportDirective",
-        "scope": 23921,
-        "sourceUnit": 24395,
+        "scope": 23924,
+        "sourceUnit": 24398,
         "src": "59:48:52",
         "symbolAliases": [
           {
             "foreign": {
-              "id": 23809,
+              "id": 23812,
               "name": "ISuperToken",
               "nodeType": "Identifier",
               "overloadedDeclarations": [],
-              "referencedDeclaration": 24394,
+              "referencedDeclaration": 24397,
               "src": "68:11:52",
               "typeDescriptions": {}
             },
@@ -318,15 +318,15 @@
         "contractDependencies": [],
         "contractKind": "interface",
         "documentation": {
-          "id": 23811,
+          "id": 23814,
           "nodeType": "StructuredDocumentation",
           "src": "109:133:52",
           "text": " @title SuperApp interface\n @author Superfluid\n @dev Be aware of the app being jailed, when the word permitted is used."
         },
         "fullyImplemented": false,
-        "id": 23920,
+        "id": 23923,
         "linearizedBaseContracts": [
-          23920
+          23923
         ],
         "name": "ISuperApp",
         "nameLocation": "253:9:52",
@@ -334,13 +334,13 @@
         "nodes": [
           {
             "documentation": {
-              "id": 23812,
+              "id": 23815,
               "nodeType": "StructuredDocumentation",
               "src": "270:630:52",
               "text": " @dev Callback before a new agreement is created.\n @param superToken The super token used for the agreement.\n @param agreementClass The agreement class address.\n @param agreementId The agreementId\n @param agreementData The agreement data (non-compressed)\n @param ctx The context data.\n @return cbdata A free format in memory data the app can use to pass\n          arbitary information to the after-hook callback.\n @custom:note \n - It will be invoked with `staticcall`, no state changes are permitted.\n - Only revert with a \"reason\" is permitted."
             },
             "functionSelector": "30d9c915",
-            "id": 23828,
+            "id": 23831,
             "implemented": false,
             "kind": "function",
             "modifiers": [],
@@ -348,41 +348,41 @@
             "nameLocation": "914:22:52",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 23824,
+              "id": 23827,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23815,
+                  "id": 23818,
                   "mutability": "mutable",
                   "name": "superToken",
                   "nameLocation": "958:10:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23828,
+                  "scope": 23831,
                   "src": "946:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
-                    "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                    "typeIdentifier": "t_contract$_ISuperToken_$24397",
                     "typeString": "contract ISuperToken"
                   },
                   "typeName": {
-                    "id": 23814,
+                    "id": 23817,
                     "nodeType": "UserDefinedTypeName",
                     "pathNode": {
-                      "id": 23813,
+                      "id": 23816,
                       "name": "ISuperToken",
                       "nameLocations": [
                         "946:11:52"
                       ],
                       "nodeType": "IdentifierPath",
-                      "referencedDeclaration": 24394,
+                      "referencedDeclaration": 24397,
                       "src": "946:11:52"
                     },
-                    "referencedDeclaration": 24394,
+                    "referencedDeclaration": 24397,
                     "src": "946:11:52",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                      "typeIdentifier": "t_contract$_ISuperToken_$24397",
                       "typeString": "contract ISuperToken"
                     }
                   },
@@ -390,12 +390,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23817,
+                  "id": 23820,
                   "mutability": "mutable",
                   "name": "agreementClass",
                   "nameLocation": "986:14:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23828,
+                  "scope": 23831,
                   "src": "978:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -404,7 +404,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 23816,
+                    "id": 23819,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "978:7:52",
@@ -418,12 +418,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23819,
+                  "id": 23822,
                   "mutability": "mutable",
                   "name": "agreementId",
                   "nameLocation": "1018:11:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23828,
+                  "scope": 23831,
                   "src": "1010:19:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -432,7 +432,7 @@
                     "typeString": "bytes32"
                   },
                   "typeName": {
-                    "id": 23818,
+                    "id": 23821,
                     "name": "bytes32",
                     "nodeType": "ElementaryTypeName",
                     "src": "1010:7:52",
@@ -445,12 +445,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23821,
+                  "id": 23824,
                   "mutability": "mutable",
                   "name": "agreementData",
                   "nameLocation": "1054:13:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23828,
+                  "scope": 23831,
                   "src": "1039:28:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -459,7 +459,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23820,
+                    "id": 23823,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "1039:5:52",
@@ -472,12 +472,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23823,
+                  "id": 23826,
                   "mutability": "mutable",
                   "name": "ctx",
                   "nameLocation": "1092:3:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23828,
+                  "scope": 23831,
                   "src": "1077:18:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -486,7 +486,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23822,
+                    "id": 23825,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "1077:5:52",
@@ -501,17 +501,17 @@
               "src": "936:165:52"
             },
             "returnParameters": {
-              "id": 23827,
+              "id": 23830,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23826,
+                  "id": 23829,
                   "mutability": "mutable",
                   "name": "cbdata",
                   "nameLocation": "1162:6:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23828,
+                  "scope": 23831,
                   "src": "1149:19:52",
                   "stateVariable": false,
                   "storageLocation": "memory",
@@ -520,7 +520,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23825,
+                    "id": 23828,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "1149:5:52",
@@ -534,7 +534,7 @@
               ],
               "src": "1148:21:52"
             },
-            "scope": 23920,
+            "scope": 23923,
             "src": "905:265:52",
             "stateMutability": "view",
             "virtual": false,
@@ -542,13 +542,13 @@
           },
           {
             "documentation": {
-              "id": 23829,
+              "id": 23832,
               "nodeType": "StructuredDocumentation",
               "src": "1176:579:52",
               "text": " @dev Callback after a new agreement is created.\n @param superToken The super token used for the agreement.\n @param agreementClass The agreement class address.\n @param agreementId The agreementId\n @param agreementData The agreement data (non-compressed)\n @param cbdata The data returned from the before-hook callback.\n @param ctx The context data.\n @return newCtx The current context of the transaction.\n @custom:note \n - State changes is permitted.\n - Only revert with a \"reason\" is permitted."
             },
             "functionSelector": "d86ed3e5",
-            "id": 23847,
+            "id": 23850,
             "implemented": false,
             "kind": "function",
             "modifiers": [],
@@ -556,41 +556,41 @@
             "nameLocation": "1769:21:52",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 23843,
+              "id": 23846,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23832,
+                  "id": 23835,
                   "mutability": "mutable",
                   "name": "superToken",
                   "nameLocation": "1812:10:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23847,
+                  "scope": 23850,
                   "src": "1800:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
-                    "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                    "typeIdentifier": "t_contract$_ISuperToken_$24397",
                     "typeString": "contract ISuperToken"
                   },
                   "typeName": {
-                    "id": 23831,
+                    "id": 23834,
                     "nodeType": "UserDefinedTypeName",
                     "pathNode": {
-                      "id": 23830,
+                      "id": 23833,
                       "name": "ISuperToken",
                       "nameLocations": [
                         "1800:11:52"
                       ],
                       "nodeType": "IdentifierPath",
-                      "referencedDeclaration": 24394,
+                      "referencedDeclaration": 24397,
                       "src": "1800:11:52"
                     },
-                    "referencedDeclaration": 24394,
+                    "referencedDeclaration": 24397,
                     "src": "1800:11:52",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                      "typeIdentifier": "t_contract$_ISuperToken_$24397",
                       "typeString": "contract ISuperToken"
                     }
                   },
@@ -598,12 +598,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23834,
+                  "id": 23837,
                   "mutability": "mutable",
                   "name": "agreementClass",
                   "nameLocation": "1840:14:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23847,
+                  "scope": 23850,
                   "src": "1832:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -612,7 +612,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 23833,
+                    "id": 23836,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "1832:7:52",
@@ -626,12 +626,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23836,
+                  "id": 23839,
                   "mutability": "mutable",
                   "name": "agreementId",
                   "nameLocation": "1872:11:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23847,
+                  "scope": 23850,
                   "src": "1864:19:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -640,7 +640,7 @@
                     "typeString": "bytes32"
                   },
                   "typeName": {
-                    "id": 23835,
+                    "id": 23838,
                     "name": "bytes32",
                     "nodeType": "ElementaryTypeName",
                     "src": "1864:7:52",
@@ -653,12 +653,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23838,
+                  "id": 23841,
                   "mutability": "mutable",
                   "name": "agreementData",
                   "nameLocation": "1908:13:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23847,
+                  "scope": 23850,
                   "src": "1893:28:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -667,7 +667,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23837,
+                    "id": 23840,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "1893:5:52",
@@ -680,12 +680,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23840,
+                  "id": 23843,
                   "mutability": "mutable",
                   "name": "cbdata",
                   "nameLocation": "1946:6:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23847,
+                  "scope": 23850,
                   "src": "1931:21:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -694,7 +694,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23839,
+                    "id": 23842,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "1931:5:52",
@@ -707,12 +707,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23842,
+                  "id": 23845,
                   "mutability": "mutable",
                   "name": "ctx",
                   "nameLocation": "1977:3:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23847,
+                  "scope": 23850,
                   "src": "1962:18:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -721,7 +721,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23841,
+                    "id": 23844,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "1962:5:52",
@@ -736,17 +736,17 @@
               "src": "1790:196:52"
             },
             "returnParameters": {
-              "id": 23846,
+              "id": 23849,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23845,
+                  "id": 23848,
                   "mutability": "mutable",
                   "name": "newCtx",
                   "nameLocation": "2034:6:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23847,
+                  "scope": 23850,
                   "src": "2021:19:52",
                   "stateVariable": false,
                   "storageLocation": "memory",
@@ -755,7 +755,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23844,
+                    "id": 23847,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "2021:5:52",
@@ -769,7 +769,7 @@
               ],
               "src": "2020:21:52"
             },
-            "scope": 23920,
+            "scope": 23923,
             "src": "1760:282:52",
             "stateMutability": "nonpayable",
             "virtual": false,
@@ -777,13 +777,13 @@
           },
           {
             "documentation": {
-              "id": 23848,
+              "id": 23851,
               "nodeType": "StructuredDocumentation",
               "src": "2048:630:52",
               "text": " @dev Callback before a new agreement is updated.\n @param superToken The super token used for the agreement.\n @param agreementClass The agreement class address.\n @param agreementId The agreementId\n @param agreementData The agreement data (non-compressed)\n @param ctx The context data.\n @return cbdata A free format in memory data the app can use to pass\n          arbitary information to the after-hook callback.\n @custom:note \n - It will be invoked with `staticcall`, no state changes are permitted.\n - Only revert with a \"reason\" is permitted."
             },
             "functionSelector": "884d1f40",
-            "id": 23864,
+            "id": 23867,
             "implemented": false,
             "kind": "function",
             "modifiers": [],
@@ -791,41 +791,41 @@
             "nameLocation": "2692:22:52",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 23860,
+              "id": 23863,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23851,
+                  "id": 23854,
                   "mutability": "mutable",
                   "name": "superToken",
                   "nameLocation": "2736:10:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23864,
+                  "scope": 23867,
                   "src": "2724:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
-                    "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                    "typeIdentifier": "t_contract$_ISuperToken_$24397",
                     "typeString": "contract ISuperToken"
                   },
                   "typeName": {
-                    "id": 23850,
+                    "id": 23853,
                     "nodeType": "UserDefinedTypeName",
                     "pathNode": {
-                      "id": 23849,
+                      "id": 23852,
                       "name": "ISuperToken",
                       "nameLocations": [
                         "2724:11:52"
                       ],
                       "nodeType": "IdentifierPath",
-                      "referencedDeclaration": 24394,
+                      "referencedDeclaration": 24397,
                       "src": "2724:11:52"
                     },
-                    "referencedDeclaration": 24394,
+                    "referencedDeclaration": 24397,
                     "src": "2724:11:52",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                      "typeIdentifier": "t_contract$_ISuperToken_$24397",
                       "typeString": "contract ISuperToken"
                     }
                   },
@@ -833,12 +833,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23853,
+                  "id": 23856,
                   "mutability": "mutable",
                   "name": "agreementClass",
                   "nameLocation": "2764:14:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23864,
+                  "scope": 23867,
                   "src": "2756:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -847,7 +847,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 23852,
+                    "id": 23855,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "2756:7:52",
@@ -861,12 +861,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23855,
+                  "id": 23858,
                   "mutability": "mutable",
                   "name": "agreementId",
                   "nameLocation": "2796:11:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23864,
+                  "scope": 23867,
                   "src": "2788:19:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -875,7 +875,7 @@
                     "typeString": "bytes32"
                   },
                   "typeName": {
-                    "id": 23854,
+                    "id": 23857,
                     "name": "bytes32",
                     "nodeType": "ElementaryTypeName",
                     "src": "2788:7:52",
@@ -888,12 +888,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23857,
+                  "id": 23860,
                   "mutability": "mutable",
                   "name": "agreementData",
                   "nameLocation": "2832:13:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23864,
+                  "scope": 23867,
                   "src": "2817:28:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -902,7 +902,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23856,
+                    "id": 23859,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "2817:5:52",
@@ -915,12 +915,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23859,
+                  "id": 23862,
                   "mutability": "mutable",
                   "name": "ctx",
                   "nameLocation": "2870:3:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23864,
+                  "scope": 23867,
                   "src": "2855:18:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -929,7 +929,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23858,
+                    "id": 23861,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "2855:5:52",
@@ -944,17 +944,17 @@
               "src": "2714:165:52"
             },
             "returnParameters": {
-              "id": 23863,
+              "id": 23866,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23862,
+                  "id": 23865,
                   "mutability": "mutable",
                   "name": "cbdata",
                   "nameLocation": "2940:6:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23864,
+                  "scope": 23867,
                   "src": "2927:19:52",
                   "stateVariable": false,
                   "storageLocation": "memory",
@@ -963,7 +963,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23861,
+                    "id": 23864,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "2927:5:52",
@@ -977,7 +977,7 @@
               ],
               "src": "2926:21:52"
             },
-            "scope": 23920,
+            "scope": 23923,
             "src": "2683:265:52",
             "stateMutability": "view",
             "virtual": false,
@@ -985,13 +985,13 @@
           },
           {
             "documentation": {
-              "id": 23865,
+              "id": 23868,
               "nodeType": "StructuredDocumentation",
               "src": "2955:566:52",
               "text": " @dev Callback after a new agreement is updated.\n @param superToken The super token used for the agreement.\n @param agreementClass The agreement class address.\n @param agreementId The agreementId\n @param agreementData The agreement data (non-compressed)\n @param cbdata The data returned from the before-hook callback.\n @param ctx The context data.\n @return newCtx The current context of the transaction.\n @custom:note \n - State changes is permitted.\n - Only revert with a \"reason\" is permitted."
             },
             "functionSelector": "230dbd29",
-            "id": 23883,
+            "id": 23886,
             "implemented": false,
             "kind": "function",
             "modifiers": [],
@@ -999,41 +999,41 @@
             "nameLocation": "3535:21:52",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 23879,
+              "id": 23882,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23868,
+                  "id": 23871,
                   "mutability": "mutable",
                   "name": "superToken",
                   "nameLocation": "3578:10:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23883,
+                  "scope": 23886,
                   "src": "3566:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
-                    "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                    "typeIdentifier": "t_contract$_ISuperToken_$24397",
                     "typeString": "contract ISuperToken"
                   },
                   "typeName": {
-                    "id": 23867,
+                    "id": 23870,
                     "nodeType": "UserDefinedTypeName",
                     "pathNode": {
-                      "id": 23866,
+                      "id": 23869,
                       "name": "ISuperToken",
                       "nameLocations": [
                         "3566:11:52"
                       ],
                       "nodeType": "IdentifierPath",
-                      "referencedDeclaration": 24394,
+                      "referencedDeclaration": 24397,
                       "src": "3566:11:52"
                     },
-                    "referencedDeclaration": 24394,
+                    "referencedDeclaration": 24397,
                     "src": "3566:11:52",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                      "typeIdentifier": "t_contract$_ISuperToken_$24397",
                       "typeString": "contract ISuperToken"
                     }
                   },
@@ -1041,12 +1041,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23870,
+                  "id": 23873,
                   "mutability": "mutable",
                   "name": "agreementClass",
                   "nameLocation": "3606:14:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23883,
+                  "scope": 23886,
                   "src": "3598:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -1055,7 +1055,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 23869,
+                    "id": 23872,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "3598:7:52",
@@ -1069,12 +1069,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23872,
+                  "id": 23875,
                   "mutability": "mutable",
                   "name": "agreementId",
                   "nameLocation": "3638:11:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23883,
+                  "scope": 23886,
                   "src": "3630:19:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -1083,7 +1083,7 @@
                     "typeString": "bytes32"
                   },
                   "typeName": {
-                    "id": 23871,
+                    "id": 23874,
                     "name": "bytes32",
                     "nodeType": "ElementaryTypeName",
                     "src": "3630:7:52",
@@ -1096,12 +1096,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23874,
+                  "id": 23877,
                   "mutability": "mutable",
                   "name": "agreementData",
                   "nameLocation": "3674:13:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23883,
+                  "scope": 23886,
                   "src": "3659:28:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -1110,7 +1110,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23873,
+                    "id": 23876,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "3659:5:52",
@@ -1123,12 +1123,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23876,
+                  "id": 23879,
                   "mutability": "mutable",
                   "name": "cbdata",
                   "nameLocation": "3712:6:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23883,
+                  "scope": 23886,
                   "src": "3697:21:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -1137,7 +1137,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23875,
+                    "id": 23878,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "3697:5:52",
@@ -1150,12 +1150,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23878,
+                  "id": 23881,
                   "mutability": "mutable",
                   "name": "ctx",
                   "nameLocation": "3743:3:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23883,
+                  "scope": 23886,
                   "src": "3728:18:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -1164,7 +1164,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23877,
+                    "id": 23880,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "3728:5:52",
@@ -1179,17 +1179,17 @@
               "src": "3556:196:52"
             },
             "returnParameters": {
-              "id": 23882,
+              "id": 23885,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23881,
+                  "id": 23884,
                   "mutability": "mutable",
                   "name": "newCtx",
                   "nameLocation": "3800:6:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23883,
+                  "scope": 23886,
                   "src": "3787:19:52",
                   "stateVariable": false,
                   "storageLocation": "memory",
@@ -1198,7 +1198,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23880,
+                    "id": 23883,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "3787:5:52",
@@ -1212,7 +1212,7 @@
               ],
               "src": "3786:21:52"
             },
-            "scope": 23920,
+            "scope": 23923,
             "src": "3526:282:52",
             "stateMutability": "nonpayable",
             "virtual": false,
@@ -1220,13 +1220,13 @@
           },
           {
             "documentation": {
-              "id": 23884,
+              "id": 23887,
               "nodeType": "StructuredDocumentation",
               "src": "3814:602:52",
               "text": " @dev Callback before a new agreement is terminated.\n @param superToken The super token used for the agreement.\n @param agreementClass The agreement class address.\n @param agreementId The agreementId\n @param agreementData The agreement data (non-compressed)\n @param ctx The context data.\n @return cbdata A free format in memory data the app can use to pass arbitary information to\n         the after-hook callback.\n @custom:note \n - It will be invoked with `staticcall`, no state changes are permitted.\n - Revert is not permitted."
             },
             "functionSelector": "5f9e7d77",
-            "id": 23900,
+            "id": 23903,
             "implemented": false,
             "kind": "function",
             "modifiers": [],
@@ -1234,41 +1234,41 @@
             "nameLocation": "4430:25:52",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 23896,
+              "id": 23899,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23887,
+                  "id": 23890,
                   "mutability": "mutable",
                   "name": "superToken",
                   "nameLocation": "4477:10:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23900,
+                  "scope": 23903,
                   "src": "4465:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
-                    "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                    "typeIdentifier": "t_contract$_ISuperToken_$24397",
                     "typeString": "contract ISuperToken"
                   },
                   "typeName": {
-                    "id": 23886,
+                    "id": 23889,
                     "nodeType": "UserDefinedTypeName",
                     "pathNode": {
-                      "id": 23885,
+                      "id": 23888,
                       "name": "ISuperToken",
                       "nameLocations": [
                         "4465:11:52"
                       ],
                       "nodeType": "IdentifierPath",
-                      "referencedDeclaration": 24394,
+                      "referencedDeclaration": 24397,
                       "src": "4465:11:52"
                     },
-                    "referencedDeclaration": 24394,
+                    "referencedDeclaration": 24397,
                     "src": "4465:11:52",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                      "typeIdentifier": "t_contract$_ISuperToken_$24397",
                       "typeString": "contract ISuperToken"
                     }
                   },
@@ -1276,12 +1276,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23889,
+                  "id": 23892,
                   "mutability": "mutable",
                   "name": "agreementClass",
                   "nameLocation": "4505:14:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23900,
+                  "scope": 23903,
                   "src": "4497:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -1290,7 +1290,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 23888,
+                    "id": 23891,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "4497:7:52",
@@ -1304,12 +1304,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23891,
+                  "id": 23894,
                   "mutability": "mutable",
                   "name": "agreementId",
                   "nameLocation": "4537:11:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23900,
+                  "scope": 23903,
                   "src": "4529:19:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -1318,7 +1318,7 @@
                     "typeString": "bytes32"
                   },
                   "typeName": {
-                    "id": 23890,
+                    "id": 23893,
                     "name": "bytes32",
                     "nodeType": "ElementaryTypeName",
                     "src": "4529:7:52",
@@ -1331,12 +1331,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23893,
+                  "id": 23896,
                   "mutability": "mutable",
                   "name": "agreementData",
                   "nameLocation": "4573:13:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23900,
+                  "scope": 23903,
                   "src": "4558:28:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -1345,7 +1345,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23892,
+                    "id": 23895,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "4558:5:52",
@@ -1358,12 +1358,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23895,
+                  "id": 23898,
                   "mutability": "mutable",
                   "name": "ctx",
                   "nameLocation": "4611:3:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23900,
+                  "scope": 23903,
                   "src": "4596:18:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -1372,7 +1372,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23894,
+                    "id": 23897,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "4596:5:52",
@@ -1387,17 +1387,17 @@
               "src": "4455:165:52"
             },
             "returnParameters": {
-              "id": 23899,
+              "id": 23902,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23898,
+                  "id": 23901,
                   "mutability": "mutable",
                   "name": "cbdata",
                   "nameLocation": "4681:6:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23900,
+                  "scope": 23903,
                   "src": "4668:19:52",
                   "stateVariable": false,
                   "storageLocation": "memory",
@@ -1406,7 +1406,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23897,
+                    "id": 23900,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "4668:5:52",
@@ -1420,7 +1420,7 @@
               ],
               "src": "4667:21:52"
             },
-            "scope": 23920,
+            "scope": 23923,
             "src": "4421:268:52",
             "stateMutability": "view",
             "virtual": false,
@@ -1428,13 +1428,13 @@
           },
           {
             "documentation": {
-              "id": 23901,
+              "id": 23904,
               "nodeType": "StructuredDocumentation",
               "src": "4695:552:52",
               "text": " @dev Callback after a new agreement is terminated.\n @param superToken The super token used for the agreement.\n @param agreementClass The agreement class address.\n @param agreementId The agreementId\n @param agreementData The agreement data (non-compressed)\n @param cbdata The data returned from the before-hook callback.\n @param ctx The context data.\n @return newCtx The current context of the transaction.\n @custom:note \n - State changes is permitted.\n - Revert is not permitted."
             },
             "functionSelector": "53c11f99",
-            "id": 23919,
+            "id": 23922,
             "implemented": false,
             "kind": "function",
             "modifiers": [],
@@ -1442,41 +1442,41 @@
             "nameLocation": "5261:24:52",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 23915,
+              "id": 23918,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23904,
+                  "id": 23907,
                   "mutability": "mutable",
                   "name": "superToken",
                   "nameLocation": "5307:10:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23919,
+                  "scope": 23922,
                   "src": "5295:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
-                    "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                    "typeIdentifier": "t_contract$_ISuperToken_$24397",
                     "typeString": "contract ISuperToken"
                   },
                   "typeName": {
-                    "id": 23903,
+                    "id": 23906,
                     "nodeType": "UserDefinedTypeName",
                     "pathNode": {
-                      "id": 23902,
+                      "id": 23905,
                       "name": "ISuperToken",
                       "nameLocations": [
                         "5295:11:52"
                       ],
                       "nodeType": "IdentifierPath",
-                      "referencedDeclaration": 24394,
+                      "referencedDeclaration": 24397,
                       "src": "5295:11:52"
                     },
-                    "referencedDeclaration": 24394,
+                    "referencedDeclaration": 24397,
                     "src": "5295:11:52",
                     "typeDescriptions": {
-                      "typeIdentifier": "t_contract$_ISuperToken_$24394",
+                      "typeIdentifier": "t_contract$_ISuperToken_$24397",
                       "typeString": "contract ISuperToken"
                     }
                   },
@@ -1484,12 +1484,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23906,
+                  "id": 23909,
                   "mutability": "mutable",
                   "name": "agreementClass",
                   "nameLocation": "5335:14:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23919,
+                  "scope": 23922,
                   "src": "5327:22:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -1498,7 +1498,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 23905,
+                    "id": 23908,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "5327:7:52",
@@ -1512,12 +1512,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23908,
+                  "id": 23911,
                   "mutability": "mutable",
                   "name": "agreementId",
                   "nameLocation": "5367:11:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23919,
+                  "scope": 23922,
                   "src": "5359:19:52",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -1526,7 +1526,7 @@
                     "typeString": "bytes32"
                   },
                   "typeName": {
-                    "id": 23907,
+                    "id": 23910,
                     "name": "bytes32",
                     "nodeType": "ElementaryTypeName",
                     "src": "5359:7:52",
@@ -1539,12 +1539,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23910,
+                  "id": 23913,
                   "mutability": "mutable",
                   "name": "agreementData",
                   "nameLocation": "5403:13:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23919,
+                  "scope": 23922,
                   "src": "5388:28:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -1553,7 +1553,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23909,
+                    "id": 23912,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "5388:5:52",
@@ -1566,12 +1566,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23912,
+                  "id": 23915,
                   "mutability": "mutable",
                   "name": "cbdata",
                   "nameLocation": "5441:6:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23919,
+                  "scope": 23922,
                   "src": "5426:21:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -1580,7 +1580,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23911,
+                    "id": 23914,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "5426:5:52",
@@ -1593,12 +1593,12 @@
                 },
                 {
                   "constant": false,
-                  "id": 23914,
+                  "id": 23917,
                   "mutability": "mutable",
                   "name": "ctx",
                   "nameLocation": "5472:3:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23919,
+                  "scope": 23922,
                   "src": "5457:18:52",
                   "stateVariable": false,
                   "storageLocation": "calldata",
@@ -1607,7 +1607,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23913,
+                    "id": 23916,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "5457:5:52",
@@ -1622,17 +1622,17 @@
               "src": "5285:196:52"
             },
             "returnParameters": {
-              "id": 23918,
+              "id": 23921,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 23917,
+                  "id": 23920,
                   "mutability": "mutable",
                   "name": "newCtx",
                   "nameLocation": "5529:6:52",
                   "nodeType": "VariableDeclaration",
-                  "scope": 23919,
+                  "scope": 23922,
                   "src": "5516:19:52",
                   "stateVariable": false,
                   "storageLocation": "memory",
@@ -1641,7 +1641,7 @@
                     "typeString": "bytes"
                   },
                   "typeName": {
-                    "id": 23916,
+                    "id": 23919,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
                     "src": "5516:5:52",
@@ -1655,14 +1655,14 @@
               ],
               "src": "5515:21:52"
             },
-            "scope": 23920,
+            "scope": 23923,
             "src": "5252:285:52",
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "external"
           }
         ],
-        "scope": 23921,
+        "scope": 23924,
         "src": "243:5296:52",
         "usedErrors": []
       }
@@ -1675,7 +1675,7 @@
   },
   "networks": {},
   "schemaVersion": "3.4.13",
-  "updatedAt": "2023-07-12T09:52:15.897Z",
+  "updatedAt": "2023-08-06T18:11:20.924Z",
   "devdoc": {
     "author": "Superfluid",
     "details": "Be aware of the app being jailed, when the word permitted is used.",