@superfluid-finance/ethereum-contracts 1.2.3-dev.f94fdbb.0 → 1.3.1-dev.b8455ea.0

package/build/contracts/UUPSUtils.json

@@ -1,33 +1,33 @@
 {
   "contractName": "UUPSUtils",
   "abi": [],
-  "metadata": "{\"compiler\":{\"version\":\"0.8.13+commit.abaa5c0e\"},\"language\":\"Solidity\",\"output\":{\"abi\":[],\"devdoc\":{\"kind\":\"dev\",\"methods\":{},\"stateVariables\":{\"_IMPLEMENTATION_SLOT\":{\"details\":\"Implementation slot constant. Using https://eips.ethereum.org/EIPS/eip-1967 standard Storage slot 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc (obtained as bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1)).\"}},\"title\":\"UUPS (Universal Upgradeable Proxy Standard) Shared Library\",\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{},\"version\":1}},\"settings\":{\"compilationTarget\":{\"project:/contracts/upgradability/UUPSUtils.sol\":\"UUPSUtils\"},\"evmVersion\":\"london\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"ipfs\"},\"optimizer\":{\"enabled\":true,\"runs\":200},\"remappings\":[]},\"sources\":{\"project:/contracts/upgradability/UUPSUtils.sol\":{\"keccak256\":\"0xffec084e77ce3c0b595f0612687242f3d8b7a84cab15e5650c17428ee48d0b5b\",\"license\":\"AGPLv3\",\"urls\":[\"bzz-raw://be0183816467872b053562d9a737042ac3a91ea67e3c74e03de5db7226f3e73b\",\"dweb:/ipfs/QmUyi4YXh1T7MExbrLwZ6rAdXTPChF8q27YpZxxniR6CHM\"]}},\"version\":1}",
-  "bytecode": "0x60566037600b82828239805160001a607314602a57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600080fdfea264697066735822122028eb4c83ad7c3a74c4ece681880b774213a444812f65a2d44a21b9039275381064736f6c634300080d0033",
-  "deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600080fdfea264697066735822122028eb4c83ad7c3a74c4ece681880b774213a444812f65a2d44a21b9039275381064736f6c634300080d0033",
+  "metadata": "{\"compiler\":{\"version\":\"0.8.14+commit.80d49f37\"},\"language\":\"Solidity\",\"output\":{\"abi\":[],\"devdoc\":{\"kind\":\"dev\",\"methods\":{},\"stateVariables\":{\"_IMPLEMENTATION_SLOT\":{\"details\":\"Implementation slot constant. Using https://eips.ethereum.org/EIPS/eip-1967 standard Storage slot 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc (obtained as bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1)).\"}},\"title\":\"UUPS (Universal Upgradeable Proxy Standard) Shared Library\",\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{},\"version\":1}},\"settings\":{\"compilationTarget\":{\"project:/contracts/upgradability/UUPSUtils.sol\":\"UUPSUtils\"},\"evmVersion\":\"london\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"ipfs\"},\"optimizer\":{\"enabled\":true,\"runs\":200},\"remappings\":[]},\"sources\":{\"project:/contracts/upgradability/UUPSUtils.sol\":{\"keccak256\":\"0xe624225773a60f62c7a0687afb0536ba19a17e4e5605ae71e8af77a0287aca59\",\"license\":\"AGPLv3\",\"urls\":[\"bzz-raw://4294e5eb5b194477bca3b8ca04ca92a6fe72dd6cf8da8f0d942a4a86c41c1c7f\",\"dweb:/ipfs/QmdfPXZxJPaBjKNfC8joTcvEhWammJHzRACB1S18sFYfd7\"]}},\"version\":1}",
+  "bytecode": "0x60566037600b82828239805160001a607314602a57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600080fdfea26469706673582212200c4219b5df63907a3e0e63b25f15781205d376f266df3a5b506950774983f4b864736f6c634300080e0033",
+  "deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600080fdfea26469706673582212200c4219b5df63907a3e0e63b25f15781205d376f266df3a5b506950774983f4b864736f6c634300080e0033",
   "immutableReferences": {},
   "generatedSources": [],
   "deployedGeneratedSources": [],
   "sourceMap": "137:933:95:-:0;;;;;;;;;;;;;;;-1:-1:-1;;;137:933:95;;;;;;;;;;;;;;;;;",
   "deployedSourceMap": "137:933:95:-:0;;;;;;;;",
-  "source": "// SPDX-License-Identifier: AGPLv3\npragma solidity 0.8.13;\n\n/**\n * @title UUPS (Universal Upgradeable Proxy Standard) Shared Library\n */\nlibrary UUPSUtils {\n\n    /**\n     * @dev Implementation slot constant.\n     * Using https://eips.ethereum.org/EIPS/eip-1967 standard\n     * Storage slot 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc\n     * (obtained as bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1)).\n     */\n    bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;\n\n    /// @dev Get implementation address.\n    function implementation() internal view returns (address impl) {\n        assembly { // solium-disable-line\n            impl := sload(_IMPLEMENTATION_SLOT)\n        }\n    }\n\n    /// @dev Set new implementation address.\n    function setImplementation(address codeAddress) internal {\n        assembly {\n            // solium-disable-line\n            sstore(\n                _IMPLEMENTATION_SLOT,\n                codeAddress\n            )\n        }\n    }\n\n}\n",
+  "source": "// SPDX-License-Identifier: AGPLv3\npragma solidity 0.8.14;\n\n/**\n * @title UUPS (Universal Upgradeable Proxy Standard) Shared Library\n */\nlibrary UUPSUtils {\n\n    /**\n     * @dev Implementation slot constant.\n     * Using https://eips.ethereum.org/EIPS/eip-1967 standard\n     * Storage slot 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc\n     * (obtained as bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1)).\n     */\n    bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;\n\n    /// @dev Get implementation address.\n    function implementation() internal view returns (address impl) {\n        assembly { // solium-disable-line\n            impl := sload(_IMPLEMENTATION_SLOT)\n        }\n    }\n\n    /// @dev Set new implementation address.\n    function setImplementation(address codeAddress) internal {\n        assembly {\n            // solium-disable-line\n            sstore(\n                _IMPLEMENTATION_SLOT,\n                codeAddress\n            )\n        }\n    }\n\n}\n",
   "sourcePath": "/home/runner/work/protocol-monorepo/protocol-monorepo/packages/ethereum-contracts/contracts/upgradability/UUPSUtils.sol",
   "ast": {
     "absolutePath": "project:/contracts/upgradability/UUPSUtils.sol",
     "exportedSymbols": {
       "UUPSUtils": [
-        34919
+        34938
       ]
     },
-    "id": 34920,
+    "id": 34939,
     "license": "AGPLv3",
     "nodeType": "SourceUnit",
     "nodes": [
       {
-        "id": 34897,
+        "id": 34916,
         "literals": [
           "solidity",
           "0.8",
-          ".13"
+          ".14"
         ],
         "nodeType": "PragmaDirective",
         "src": "35:23:95"
@@ -39,15 +39,15 @@
         "contractDependencies": [],
         "contractKind": "library",
         "documentation": {
-          "id": 34898,
+          "id": 34917,
           "nodeType": "StructuredDocumentation",
           "src": "60:76:95",
           "text": " @title UUPS (Universal Upgradeable Proxy Standard) Shared Library"
         },
         "fullyImplemented": true,
-        "id": 34919,
+        "id": 34938,
         "linearizedBaseContracts": [
-          34919
+          34938
         ],
         "name": "UUPSUtils",
         "nameLocation": "145:9:95",
@@ -56,17 +56,17 @@
           {
             "constant": true,
             "documentation": {
-              "id": 34899,
+              "id": 34918,
               "nodeType": "StructuredDocumentation",
               "src": "162:288:95",
               "text": " @dev Implementation slot constant.\n Using https://eips.ethereum.org/EIPS/eip-1967 standard\n Storage slot 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc\n (obtained as bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1))."
             },
-            "id": 34902,
+            "id": 34921,
             "mutability": "constant",
             "name": "_IMPLEMENTATION_SLOT",
             "nameLocation": "481:20:95",
             "nodeType": "VariableDeclaration",
-            "scope": 34919,
+            "scope": 34938,
             "src": "455:115:95",
             "stateVariable": true,
             "storageLocation": "default",
@@ -75,7 +75,7 @@
               "typeString": "bytes32"
             },
             "typeName": {
-              "id": 34900,
+              "id": 34919,
               "name": "bytes32",
               "nodeType": "ElementaryTypeName",
               "src": "455:7:95",
@@ -86,7 +86,7 @@
             },
             "value": {
               "hexValue": "307833363038393461313362613161333231303636376338323834393264623938646361336532303736636333373335613932306133636135303564333832626263",
-              "id": 34901,
+              "id": 34920,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
@@ -104,7 +104,7 @@
           },
           {
             "body": {
-              "id": 34909,
+              "id": 34928,
               "nodeType": "Block",
               "src": "681:107:95",
               "statements": [
@@ -145,33 +145,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 34902,
+                      "declaration": 34921,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "751:20:95",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 34906,
+                      "declaration": 34925,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "737:4:95",
                       "valueSize": 1
                     }
                   ],
-                  "id": 34908,
+                  "id": 34927,
                   "nodeType": "InlineAssembly",
                   "src": "691:91:95"
                 }
               ]
             },
             "documentation": {
-              "id": 34903,
+              "id": 34922,
               "nodeType": "StructuredDocumentation",
               "src": "577:36:95",
               "text": "@dev Get implementation address."
             },
-            "id": 34910,
+            "id": 34929,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -179,23 +179,23 @@
             "nameLocation": "627:14:95",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 34904,
+              "id": 34923,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "641:2:95"
             },
             "returnParameters": {
-              "id": 34907,
+              "id": 34926,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 34906,
+                  "id": 34925,
                   "mutability": "mutable",
                   "name": "impl",
                   "nameLocation": "675:4:95",
                   "nodeType": "VariableDeclaration",
-                  "scope": 34910,
+                  "scope": 34929,
                   "src": "667:12:95",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -204,7 +204,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 34905,
+                    "id": 34924,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "667:7:95",
@@ -219,7 +219,7 @@
               ],
               "src": "666:14:95"
             },
-            "scope": 34919,
+            "scope": 34938,
             "src": "618:170:95",
             "stateMutability": "view",
             "virtual": false,
@@ -227,7 +227,7 @@
           },
           {
             "body": {
-              "id": 34917,
+              "id": 34936,
               "nodeType": "Block",
               "src": "896:171:95",
               "statements": [
@@ -266,33 +266,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 34902,
+                      "declaration": 34921,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "988:20:95",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 34913,
+                      "declaration": 34932,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "1026:11:95",
                       "valueSize": 1
                     }
                   ],
-                  "id": 34916,
+                  "id": 34935,
                   "nodeType": "InlineAssembly",
                   "src": "906:155:95"
                 }
               ]
             },
             "documentation": {
-              "id": 34911,
+              "id": 34930,
               "nodeType": "StructuredDocumentation",
               "src": "794:40:95",
               "text": "@dev Set new implementation address."
             },
-            "id": 34918,
+            "id": 34937,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -300,17 +300,17 @@
             "nameLocation": "848:17:95",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 34914,
+              "id": 34933,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 34913,
+                  "id": 34932,
                   "mutability": "mutable",
                   "name": "codeAddress",
                   "nameLocation": "874:11:95",
                   "nodeType": "VariableDeclaration",
-                  "scope": 34918,
+                  "scope": 34937,
                   "src": "866:19:95",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -319,7 +319,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 34912,
+                    "id": 34931,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "866:7:95",
@@ -335,19 +335,19 @@
               "src": "865:21:95"
             },
             "returnParameters": {
-              "id": 34915,
+              "id": 34934,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "896:0:95"
             },
-            "scope": 34919,
+            "scope": 34938,
             "src": "839:228:95",
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "internal"
           }
         ],
-        "scope": 34920,
+        "scope": 34939,
         "src": "137:933:95",
         "usedErrors": []
       }
@@ -356,11 +356,11 @@
   },
   "compiler": {
     "name": "solc",
-    "version": "0.8.13+commit.abaa5c0e.Emscripten.clang"
+    "version": "0.8.14+commit.80d49f37.Emscripten.clang"
   },
   "networks": {},
   "schemaVersion": "3.4.7",
-  "updatedAt": "2022-06-03T09:45:14.338Z",
+  "updatedAt": "2022-06-15T22:03:58.997Z",
   "devdoc": {
     "kind": "dev",
     "methods": {},

package/build/contracts-sizes.txt

@@ -1,8 +1,8 @@
-FullUpgradableSuperTokenProxy.sol : 635 (23941)
+FullUpgradableSuperTokenProxy.sol : 606 (23970)
 SuperfluidToken.sol : 2 (24574)
 SuperToken.sol : 18856 (5720)
-SuperTokenFactory.sol : 4997 (19579)
-Superfluid.sol : 22090 (2486)
+SuperTokenFactory.sol : 4968 (19608)
+Superfluid.sol : 22092 (2484)
 AgreementBase.sol : 2 (24574)
 InstantDistributionAgreementV1.sol : 21566 (3010)
 AgreementLibrary.sol : 143 (24433)

package/contracts/agreements/AgreementBase.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { UUPSProxiable } from "../upgradability/UUPSProxiable.sol";
 import { ISuperAgreement } from "../interfaces/superfluid/ISuperAgreement.sol";

package/contracts/agreements/AgreementLibrary.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperfluidGovernance,

package/contracts/agreements/ConstantFlowAgreementV1.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     IConstantFlowAgreementV1,

package/contracts/agreements/InstantDistributionAgreementV1.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 

package/contracts/gov/SuperfluidGovernanceBase.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import {
     ISuperfluid,

package/contracts/gov/SuperfluidGovernanceII.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPLv3
-pragma solidity 0.8.13;
+pragma solidity 0.8.14;
 
 import { UUPSProxy } from "../upgradability/UUPSProxy.sol";
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";

package/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol

@@ -33,7 +33,7 @@ abstract contract IConstantFlowAgreementV1 is ISuperAgreement {
      * @dev Calculates the deposit based on the liquidationPeriod and flowRate
      * @param flowRate Flow rate to be tested
      * @return deposit The deposit amount based on flowRate and liquidationPeriod
-     * NOTE:
+     * @custom:note 
      * - if calculated deposit (flowRate * liquidationPeriod) is less
      *   than the minimum deposit, we use the minimum deposit otherwise
      *   we use the calculated deposit
@@ -163,13 +163,12 @@ abstract contract IConstantFlowAgreementV1 is ISuperAgreement {
      * @param flowRate New flow rate in amount per second
      * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
      *
-     * # App callbacks
-     *
+     * @custom:callbacks 
      * - AgreementCreated
      *   - agreementId - can be used in getFlowByID
      *   - agreementData - abi.encode(address flowSender, address flowReceiver)
      *
-     * NOTE:
+     * @custom:note 
      * - A deposit is taken as safety margin for the solvency agents
      * - A extra gas fee may be taken to pay for solvency agent liquidations
      */
@@ -209,13 +208,12 @@ abstract contract IConstantFlowAgreementV1 is ISuperAgreement {
      * @param flowRate New flow rate in amount per second
      * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
      *
-     * # App callbacks
-     *
+     * @custom:callbacks 
      * - AgreementUpdated
      *   - agreementId - can be used in getFlowByID
      *   - agreementData - abi.encode(address flowSender, address flowReceiver)
      *
-     * NOTE:
+     * @custom:note 
      * - Only the flow sender may update the flow rate
      * - Even if the flow rate is zero, the flow is not deleted
      * from the system
@@ -335,13 +333,12 @@ abstract contract IConstantFlowAgreementV1 is ISuperAgreement {
      * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
      * @param receiver Flow receiver address
      *
-     * # App callbacks
-     *
+     * @custom:callbacks 
      * - AgreementTerminated
      *   - agreementId - can be used in getFlowByID
      *   - agreementData - abi.encode(address flowSender, address flowReceiver)
      *
-     * NOTE:
+     * @custom:note 
      * - Both flow sender and receiver may delete the flow
      * - If Sender account is insolvent or in critical state, a solvency agent may
      *   also terminate the agreement

package/contracts/interfaces/agreements/IInstantDistributionAgreementV1.sol

@@ -9,7 +9,7 @@ import { ISuperfluidToken } from "../superfluid/ISuperfluidToken.sol";
  * @title Instant Distribution Agreement interface
  * @author Superfluid
  *
- * Notes:
+ * @notice 
  *   - A publisher can create as many as indices as possibly identifiable with `indexId`.
  *     - `indexId` is deliberately limited to 32 bits, to avoid the chance for sha-3 collision.
  *       Despite knowing sha-3 collision is only theoretical.
@@ -50,8 +50,7 @@ abstract contract IInstantDistributionAgreementV1 is ISuperAgreement {
      * @param indexId Id of the index
      * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
      *
-     * # App callbacks
-     *
+     * @custom:callbacks 
      * None
      */
     function createIndex(
@@ -124,8 +123,7 @@ abstract contract IInstantDistributionAgreementV1 is ISuperAgreement {
      * @param indexValue Value of the index
      * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
      *
-     * # App callbacks
-     *
+     * @custom:callbacks 
      * None
      */
     function updateIndex(
@@ -164,15 +162,14 @@ abstract contract IInstantDistributionAgreementV1 is ISuperAgreement {
      * @param amount The amount of tokens desired to be distributed
      * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
      *
-     * NOTE:
+     * @custom:note 
      * - This is a convenient version of updateIndex. It adds to the index
      *   a delta that equals to `amount / totalUnits`
      * - The actual amount distributed could be obtained via
      *   `calculateDistribution`. This is due to precision error with index
      *   value and units data range
      *
-     * # App callbacks
-     *
+     * @custom:callbacks 
      * None
      */
     function distribute(
@@ -196,8 +193,7 @@ abstract contract IInstantDistributionAgreementV1 is ISuperAgreement {
      * @param indexId Id of the index
      * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
      *
-     * # App callbacks
-     *
+     * @custom:callbacks 
      * - if subscription exist
      *   - AgreementCreated callback to the publisher:
      *      - agreementId is for the subscription
@@ -251,7 +247,7 @@ abstract contract IInstantDistributionAgreementV1 is ISuperAgreement {
     * @param indexId Id of the index
     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
     *
-    * # App callbacks
+    * @custom:callbacks 
     * - AgreementUpdated callback to the publisher:
     *    - agreementId is for the subscription
     */
@@ -301,8 +297,7 @@ abstract contract IInstantDistributionAgreementV1 is ISuperAgreement {
      * @param units Number of units of the subscription
      * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
      *
-     * # App callbacks
-     *
+     * @custom:callbacks 
      * - if subscription exist
      *   - AgreementCreated callback to the subscriber:
      *      - agreementId is for the subscription
@@ -432,8 +427,7 @@ abstract contract IInstantDistributionAgreementV1 is ISuperAgreement {
      * @param subscriber The subscriber's address
      * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
      *
-     * # App callbacks
-     *
+     * @custom:callbacks 
      * - if the subscriber called it
      *   - AgreementTerminated callback to the publsiher:
      *      - agreementId is for the subscription
@@ -459,10 +453,9 @@ abstract contract IInstantDistributionAgreementV1 is ISuperAgreement {
     * @param subscriber The subscriber's address
     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)
     *
-    * The subscription should not be approved yet
-    *
-    * # App callbacks
+    * @custom:note The subscription should not be approved yet
     *
+    * @custom:callbacks 
     * - AgreementUpdated callback to the publisher:
     *    - agreementId is for the subscription
     */

package/contracts/interfaces/superfluid/ISuperApp.sol

@@ -7,7 +7,6 @@ import { ISuperToken } from "./ISuperToken.sol";
  * @title SuperApp interface
  * @author Superfluid
  * @dev Be aware of the app being jailed, when the word permitted is used.
- *
  */
 interface ISuperApp {
 
@@ -21,7 +20,7 @@ interface ISuperApp {
      * @return cbdata A free format in memory data the app can use to pass
      *          arbitary information to the after-hook callback.
      *
-     * NOTE:
+     * @custom:note 
      * - It will be invoked with `staticcall`, no state changes are permitted.
      * - Only revert with a "reason" is permitted.
      */
@@ -46,7 +45,7 @@ interface ISuperApp {
      * @param ctx The context data.
      * @return newCtx The current context of the transaction.
      *
-     * NOTE:
+     * @custom:note 
      * - State changes is permitted.
      * - Only revert with a "reason" is permitted.
      */
@@ -71,7 +70,7 @@ interface ISuperApp {
      * @return cbdata A free format in memory data the app can use to pass
      *          arbitary information to the after-hook callback.
      *
-     * NOTE:
+     * @custom:note 
      * - It will be invoked with `staticcall`, no state changes are permitted.
      * - Only revert with a "reason" is permitted.
      */
@@ -97,7 +96,7 @@ interface ISuperApp {
     * @param ctx The context data.
     * @return newCtx The current context of the transaction.
     *
-    * NOTE:
+    * @custom:note 
     * - State changes is permitted.
     * - Only revert with a "reason" is permitted.
     */
@@ -119,10 +118,9 @@ interface ISuperApp {
     * @param agreementId The agreementId
     * @param agreementData The agreement data (non-compressed)
     * @param ctx The context data.
-    * @return cbdata A free format in memory data the app can use to pass
-    *          arbitary information to the after-hook callback.
+    * @return cbdata A free format in memory data the app can use to pass arbitary information to the after-hook callback.
     *
-    * NOTE:
+    * @custom:note 
     * - It will be invoked with `staticcall`, no state changes are permitted.
     * - Revert is not permitted.
     */
@@ -147,7 +145,7 @@ interface ISuperApp {
     * @param ctx The context data.
     * @return newCtx The current context of the transaction.
     *
-    * NOTE:
+    * @custom:note 
     * - State changes is permitted.
     * - Revert is not permitted.
     */