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

package/build/contracts/IConstantFlowAgreementV1.json

@@ -790,7 +790,7 @@
       "type": "function"
     }
   ],
-  "metadata": "{\"compiler\":{\"version\":\"0.8.13+commit.abaa5c0e\"},\"language\":\"Solidity\",\"output\":{\"abi\":[{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"indexed\":true,\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"indexed\":true,\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"uint8\",\"name\":\"permissions\",\"type\":\"uint8\"},{\"indexed\":false,\"internalType\":\"int96\",\"name\":\"flowRateAllowance\",\"type\":\"int96\"}],\"name\":\"FlowOperatorUpdated\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"indexed\":true,\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"indexed\":true,\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"indexed\":false,\"internalType\":\"int256\",\"name\":\"totalSenderFlowRate\",\"type\":\"int256\"},{\"indexed\":false,\"internalType\":\"int256\",\"name\":\"totalReceiverFlowRate\",\"type\":\"int256\"},{\"indexed\":false,\"internalType\":\"bytes\",\"name\":\"userData\",\"type\":\"bytes\"}],\"name\":\"FlowUpdated\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"}],\"name\":\"FlowUpdatedExtension\",\"type\":\"event\"},{\"inputs\":[],\"name\":\"agreementType\",\"outputs\":[{\"internalType\":\"bytes32\",\"name\":\"\",\"type\":\"bytes32\"}],\"stateMutability\":\"pure\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"authorizeFlowOperatorWithFullControl\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"createFlow\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"createFlowByOperator\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"deleteFlow\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"deleteFlowByOperator\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"}],\"name\":\"getAccountFlowInfo\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"owedDeposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"}],\"name\":\"getDepositRequiredForFlowRate\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"}],\"name\":\"getFlow\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"owedDeposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"bytes32\",\"name\":\"agreementId\",\"type\":\"bytes32\"}],\"name\":\"getFlowByID\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"owedDeposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"}],\"name\":\"getFlowOperatorData\",\"outputs\":[{\"internalType\":\"bytes32\",\"name\":\"flowOperatorId\",\"type\":\"bytes32\"},{\"internalType\":\"uint8\",\"name\":\"permissions\",\"type\":\"uint8\"},{\"internalType\":\"int96\",\"name\":\"flowRateAllowance\",\"type\":\"int96\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"bytes32\",\"name\":\"flowOperatorId\",\"type\":\"bytes32\"}],\"name\":\"getFlowOperatorDataByID\",\"outputs\":[{\"internalType\":\"uint8\",\"name\":\"permissions\",\"type\":\"uint8\"},{\"internalType\":\"int96\",\"name\":\"flowRateAllowance\",\"type\":\"int96\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"}],\"name\":\"getMaximumFlowRateFromDeposit\",\"outputs\":[{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"}],\"name\":\"getNetFlow\",\"outputs\":[{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"}],\"name\":\"isPatricianPeriod\",\"outputs\":[{\"internalType\":\"bool\",\"name\":\"\",\"type\":\"bool\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"}],\"name\":\"isPatricianPeriodNow\",\"outputs\":[{\"internalType\":\"bool\",\"name\":\"isCurrentlyPatricianPeriod\",\"type\":\"bool\"},{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"time\",\"type\":\"uint256\"}],\"name\":\"realtimeBalanceOf\",\"outputs\":[{\"internalType\":\"int256\",\"name\":\"dynamicBalance\",\"type\":\"int256\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"owedDeposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"revokeFlowOperatorWithFullControl\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"updateFlow\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"updateFlowByOperator\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"internalType\":\"uint8\",\"name\":\"permissions\",\"type\":\"uint8\"},{\"internalType\":\"int96\",\"name\":\"flowRateAllowance\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"updateFlowOperatorPermissions\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"}],\"devdoc\":{\"author\":\"Superfluid\",\"events\":{\"FlowOperatorUpdated(address,address,address,uint8,int96)\":{\"details\":\"Flow operator updated event\",\"params\":{\"flowOperator\":\"Flow operator address\",\"flowRateAllowance\":\"The flow rate allowance the `flowOperator` is granted (only goes down)\",\"permissions\":\"Octo bitmask representation of permissions\",\"sender\":\"Flow sender address\",\"token\":\"Super token address\"}},\"FlowUpdated(address,address,address,int96,int256,int256,bytes)\":{\"details\":\"Flow updated event\",\"params\":{\"flowRate\":\"Flow rate in amount per second for this flow\",\"receiver\":\"Flow recipient address\",\"sender\":\"Flow sender address\",\"token\":\"Super token address\",\"totalReceiverFlowRate\":\"Total flow rate in amount per second for the receiver\",\"totalSenderFlowRate\":\"Total flow rate in amount per second for the sender\",\"userData\":\"The user provided data\"}},\"FlowUpdatedExtension(address,uint256)\":{\"details\":\"Flow updated extension event\",\"params\":{\"deposit\":\"The deposit amount for the stream\",\"flowOperator\":\"Flow operator address - the Context.msgSender\"}}},\"kind\":\"dev\",\"methods\":{\"agreementType()\":{\"details\":\"ISuperAgreement.agreementType implementation\"},\"authorizeFlowOperatorWithFullControl(address,address,bytes)\":{\"details\":\"msgSender from `ctx` grants `flowOperator` all permissions with flowRateAllowance as type(int96).max\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowOperator\":\"The permission grantee address\",\"token\":\"Super token address\"}},\"createFlow(address,address,int96,bytes)\":{\"details\":\"flowId (agreementId) is the keccak256 hash of encoded sender and receiver\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct) # App callbacks - AgreementCreated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver) 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\",\"flowRate\":\"New flow rate in amount per second\",\"receiver\":\"Flow receiver address\",\"token\":\"Super token address\"}},\"createFlowByOperator(address,address,address,int96,bytes)\":{\"details\":\"A flow created by an approved flow operator (see above for details on callbacks)\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowRate\":\"New flow rate in amount per second\",\"receiver\":\"Flow receiver address\",\"sender\":\"Flow sender address (has granted permissions)\",\"token\":\"Super token address\"}},\"deleteFlow(address,address,address,bytes)\":{\"details\":\"flowId (agreementId) is the keccak256 hash of encoded sender and receiver\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"receiver\":\"Flow receiver address # App callbacks - AgreementTerminated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver) 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 - Gas fee may be returned to the sender\",\"token\":\"Super token address\"}},\"deleteFlowByOperator(address,address,address,bytes)\":{\"details\":\"A flow deleted by an approved flow operator (see above for details on callbacks)\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"receiver\":\"Flow receiver address\",\"token\":\"Super token address\"}},\"getAccountFlowInfo(address,address)\":{\"details\":\"Get the aggregated flow info of the account\",\"params\":{\"account\":\"Account for the query\",\"token\":\"Super token address\"},\"returns\":{\"deposit\":\"The sum of all deposits for account's flows\",\"flowRate\":\"The net flow rate of token for account\",\"owedDeposit\":\"The sum of all owed deposits for account's flows\",\"timestamp\":\"Timestamp of when a flow was last updated for account\"}},\"getDepositRequiredForFlowRate(address,int96)\":{\"details\":\"Calculates the deposit based on the liquidationPeriod and flowRate\",\"params\":{\"flowRate\":\"Flow rate to be tested\"},\"returns\":{\"deposit\":\"The deposit amount based on flowRate and liquidationPeriod NOTE: - if calculated deposit (flowRate * liquidationPeriod) is less   than the minimum deposit, we use the minimum deposit otherwise   we use the calculated deposit\"}},\"getFlow(address,address,address)\":{\"details\":\"Get the flow data between `sender` and `receiver` of `token`\",\"params\":{\"receiver\":\"Flow sender\",\"sender\":\"Flow receiver\",\"token\":\"Super token address\"},\"returns\":{\"deposit\":\"The amount of deposit the flow\",\"flowRate\":\"The flow rate\",\"owedDeposit\":\"The amount of owed deposit of the flow\",\"timestamp\":\"Timestamp of when the flow is updated\"}},\"getFlowByID(address,bytes32)\":{\"details\":\"flowId (agreementId) is the keccak256 hash of encoded sender and receiver\",\"params\":{\"agreementId\":\"The agreement ID\",\"token\":\"Super token address\"},\"returns\":{\"deposit\":\"The deposit amount of the flow\",\"flowRate\":\"The flow rate\",\"owedDeposit\":\"The owed deposit amount of the flow\",\"timestamp\":\"Timestamp of when the flow is updated\"}},\"getFlowOperatorData(address,address,address)\":{\"params\":{\"flowOperator\":\"The permission grantee address\",\"sender\":\"The permission granter address\",\"token\":\"Super token address\"},\"returns\":{\"flowOperatorId\":\"The keccak256 hash of encoded string \\\"flowOperator\\\", sender and flowOperator\",\"flowRateAllowance\":\"The flow rate allowance the `flowOperator` is granted (only goes down)\",\"permissions\":\"A bitmask representation of the granted permissions\"}},\"getFlowOperatorDataByID(address,bytes32)\":{\"params\":{\"flowOperatorId\":\"The keccak256 hash of encoded string \\\"flowOperator\\\", sender and flowOperator\",\"token\":\"Super token address\"},\"returns\":{\"flowRateAllowance\":\"The flow rate allowance the `flowOperator` is granted (only goes down)\",\"permissions\":\"A bitmask representation of the granted permissions\"}},\"getMaximumFlowRateFromDeposit(address,uint256)\":{\"details\":\"The deposit is clipped and rounded down\",\"params\":{\"deposit\":\"Deposit amount used for creating the flow\"},\"returns\":{\"flowRate\":\"The maximum flow rate\"}},\"getNetFlow(address,address)\":{\"details\":\"Get the net flow rate of the account\",\"params\":{\"account\":\"Account for the query\",\"token\":\"Super token address\"},\"returns\":{\"flowRate\":\"Net flow rate\"}},\"isPatricianPeriod(address,address,uint256)\":{\"details\":\"Returns whether it is the patrician period based on timestamp\",\"params\":{\"account\":\"The account we are interested in\",\"timestamp\":\"The timestamp we are interested in observing the result of isPatricianPeriod\"},\"returns\":{\"_0\":\"bool Whether it is currently the patrician period dictated by governance\"}},\"isPatricianPeriodNow(address,address)\":{\"details\":\"Returns whether it is the patrician period based on host.getNow()\",\"params\":{\"account\":\"The account we are interested in\"},\"returns\":{\"isCurrentlyPatricianPeriod\":\"Whether it is currently the patrician period dictated by governance\",\"timestamp\":\"The value of host.getNow()\"}},\"realtimeBalanceOf(address,address,uint256)\":{\"details\":\"Calculate the real-time balance for the account of this agreement class\",\"params\":{\"account\":\"Account the state belongs to\",\"time\":\"Time used for the calculation\"},\"returns\":{\"deposit\":\"Account deposit amount of this agreement\",\"dynamicBalance\":\"Dynamic balance portion of real-time balance of this agreement\",\"owedDeposit\":\"Account owed deposit amount of this agreement\"}},\"revokeFlowOperatorWithFullControl(address,address,bytes)\":{\"details\":\"`permissions` and `flowRateAllowance` will both be set to 0\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowOperator\":\"The permission grantee address\",\"token\":\"Super token address\"}},\"updateFlow(address,address,int96,bytes)\":{\"details\":\"flowId (agreementId) is the keccak256 hash of encoded sender and receiver\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct) # App callbacks - AgreementUpdated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver) 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 - Deposit amount will be adjusted accordingly - No new gas fee is charged\",\"flowRate\":\"New flow rate in amount per second\",\"receiver\":\"Flow receiver address\",\"token\":\"Super token address\"}},\"updateFlowByOperator(address,address,address,int96,bytes)\":{\"details\":\"A flow updated by an approved flow operator (see above for details on callbacks)\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowRate\":\"New flow rate in amount per second\",\"receiver\":\"Flow receiver address\",\"sender\":\"Flow sender address (has granted permissions)\",\"token\":\"Super token address\"}},\"updateFlowOperatorPermissions(address,address,uint8,int96,bytes)\":{\"details\":\"msgSender from `ctx` updates permissions for the `flowOperator` with `flowRateAllowance`\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowOperator\":\"The permission grantee address\",\"flowRateAllowance\":\"The flow rate allowance the `flowOperator` is granted (only goes down)\",\"permissions\":\"A bitmask representation of the granted permissions\",\"token\":\"Super token address\"}}},\"title\":\"Constant Flow Agreement interface\",\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{\"createFlow(address,address,int96,bytes)\":{\"notice\":\"Create a flow betwen ctx.msgSender and receiver\"},\"createFlowByOperator(address,address,address,int96,bytes)\":{\"notice\":\"Create a flow between sender and receiver\"},\"deleteFlow(address,address,address,bytes)\":{\"notice\":\"Delete the flow between sender and receiver\"},\"deleteFlowByOperator(address,address,address,bytes)\":{\"notice\":\"Delete the flow between sender and receiver\"},\"getDepositRequiredForFlowRate(address,int96)\":{\"notice\":\"Get the deposit required for creating the flow\"},\"getFlowByID(address,bytes32)\":{\"notice\":\"Get flow data using agreementId\"},\"getFlowOperatorData(address,address,address)\":{\"notice\":\"Get the permissions of a flow operator between `sender` and `flowOperator` for `token`\"},\"getFlowOperatorDataByID(address,bytes32)\":{\"notice\":\"Get flow operator using flowOperatorId\"},\"getMaximumFlowRateFromDeposit(address,uint256)\":{\"notice\":\"Get the maximum flow rate allowed with the deposit\"},\"revokeFlowOperatorWithFullControl(address,address,bytes)\":{\"notice\":\"msgSender from `ctx` revokes `flowOperator` create/update/delete permissions\"},\"updateFlow(address,address,int96,bytes)\":{\"notice\":\"Update the flow rate between ctx.msgSender and receiver\"},\"updateFlowByOperator(address,address,address,int96,bytes)\":{\"notice\":\"Update a flow between sender and receiver\"}},\"version\":1}},\"settings\":{\"compilationTarget\":{\"project:/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol\":\"IConstantFlowAgreementV1\"},\"evmVersion\":\"london\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"ipfs\"},\"optimizer\":{\"enabled\":true,\"runs\":200},\"remappings\":[]},\"sources\":{\"project:/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol\":{\"keccak256\":\"0xb96bb6cb0fe88ddf5b890b6826f7f7585cf6e94223c76d8e2fb269779afe4445\",\"license\":\"AGPLv3\",\"urls\":[\"bzz-raw://b864597ae952222f0f43c66943492966013021c4171d5ef4f7357c047dfd737c\",\"dweb:/ipfs/Qmcr7xicfmPDD343B34ETP3XrdU9Vi1z3zxJSgqLipfQmY\"]},\"project:/contracts/interfaces/superfluid/ISuperAgreement.sol\":{\"keccak256\":\"0xc3a6a907245116bcecc70fe4b207454012e8ce4fa190228fb8bbe39e0b1bc5cf\",\"license\":\"AGPLv3\",\"urls\":[\"bzz-raw://83c116bdae48685d20e5a27c942111e685ec1ef6334e7ff6f6d9af66edbd8025\",\"dweb:/ipfs/QmTnVuNTaRFiDmkAmDk7NFYdfQTW1kqgBZiY2exC6k8jDx\"]},\"project:/contracts/interfaces/superfluid/ISuperfluidToken.sol\":{\"keccak256\":\"0x518b869178aafffde40c654a1e24b3b1a2b5e42e5e8f17562556f404db8b9434\",\"license\":\"AGPLv3\",\"urls\":[\"bzz-raw://458ce84666b418fa3a7569c0e109db4d920fb6d1cb67ebc4c497c9c71107d93b\",\"dweb:/ipfs/QmV9nqhRF7MDGkV6UW3WWcqeXov2vmqHuRcvbqaaV8yP6u\"]}},\"version\":1}",
+  "metadata": "{\"compiler\":{\"version\":\"0.8.14+commit.80d49f37\"},\"language\":\"Solidity\",\"output\":{\"abi\":[{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"indexed\":true,\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"indexed\":true,\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"uint8\",\"name\":\"permissions\",\"type\":\"uint8\"},{\"indexed\":false,\"internalType\":\"int96\",\"name\":\"flowRateAllowance\",\"type\":\"int96\"}],\"name\":\"FlowOperatorUpdated\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"indexed\":true,\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"indexed\":true,\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"indexed\":false,\"internalType\":\"int256\",\"name\":\"totalSenderFlowRate\",\"type\":\"int256\"},{\"indexed\":false,\"internalType\":\"int256\",\"name\":\"totalReceiverFlowRate\",\"type\":\"int256\"},{\"indexed\":false,\"internalType\":\"bytes\",\"name\":\"userData\",\"type\":\"bytes\"}],\"name\":\"FlowUpdated\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"}],\"name\":\"FlowUpdatedExtension\",\"type\":\"event\"},{\"inputs\":[],\"name\":\"agreementType\",\"outputs\":[{\"internalType\":\"bytes32\",\"name\":\"\",\"type\":\"bytes32\"}],\"stateMutability\":\"pure\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"authorizeFlowOperatorWithFullControl\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"createFlow\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"createFlowByOperator\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"deleteFlow\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"deleteFlowByOperator\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"}],\"name\":\"getAccountFlowInfo\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"owedDeposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"}],\"name\":\"getDepositRequiredForFlowRate\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"}],\"name\":\"getFlow\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"owedDeposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"bytes32\",\"name\":\"agreementId\",\"type\":\"bytes32\"}],\"name\":\"getFlowByID\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"owedDeposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"}],\"name\":\"getFlowOperatorData\",\"outputs\":[{\"internalType\":\"bytes32\",\"name\":\"flowOperatorId\",\"type\":\"bytes32\"},{\"internalType\":\"uint8\",\"name\":\"permissions\",\"type\":\"uint8\"},{\"internalType\":\"int96\",\"name\":\"flowRateAllowance\",\"type\":\"int96\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"bytes32\",\"name\":\"flowOperatorId\",\"type\":\"bytes32\"}],\"name\":\"getFlowOperatorDataByID\",\"outputs\":[{\"internalType\":\"uint8\",\"name\":\"permissions\",\"type\":\"uint8\"},{\"internalType\":\"int96\",\"name\":\"flowRateAllowance\",\"type\":\"int96\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"}],\"name\":\"getMaximumFlowRateFromDeposit\",\"outputs\":[{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"}],\"name\":\"getNetFlow\",\"outputs\":[{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"}],\"name\":\"isPatricianPeriod\",\"outputs\":[{\"internalType\":\"bool\",\"name\":\"\",\"type\":\"bool\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"}],\"name\":\"isPatricianPeriodNow\",\"outputs\":[{\"internalType\":\"bool\",\"name\":\"isCurrentlyPatricianPeriod\",\"type\":\"bool\"},{\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"account\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"time\",\"type\":\"uint256\"}],\"name\":\"realtimeBalanceOf\",\"outputs\":[{\"internalType\":\"int256\",\"name\":\"dynamicBalance\",\"type\":\"int256\"},{\"internalType\":\"uint256\",\"name\":\"deposit\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"owedDeposit\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"revokeFlowOperatorWithFullControl\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"updateFlow\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"sender\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"receiver\",\"type\":\"address\"},{\"internalType\":\"int96\",\"name\":\"flowRate\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"updateFlowByOperator\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"contract ISuperfluidToken\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"flowOperator\",\"type\":\"address\"},{\"internalType\":\"uint8\",\"name\":\"permissions\",\"type\":\"uint8\"},{\"internalType\":\"int96\",\"name\":\"flowRateAllowance\",\"type\":\"int96\"},{\"internalType\":\"bytes\",\"name\":\"ctx\",\"type\":\"bytes\"}],\"name\":\"updateFlowOperatorPermissions\",\"outputs\":[{\"internalType\":\"bytes\",\"name\":\"newCtx\",\"type\":\"bytes\"}],\"stateMutability\":\"nonpayable\",\"type\":\"function\"}],\"devdoc\":{\"author\":\"Superfluid\",\"events\":{\"FlowOperatorUpdated(address,address,address,uint8,int96)\":{\"details\":\"Flow operator updated event\",\"params\":{\"flowOperator\":\"Flow operator address\",\"flowRateAllowance\":\"The flow rate allowance the `flowOperator` is granted (only goes down)\",\"permissions\":\"Octo bitmask representation of permissions\",\"sender\":\"Flow sender address\",\"token\":\"Super token address\"}},\"FlowUpdated(address,address,address,int96,int256,int256,bytes)\":{\"details\":\"Flow updated event\",\"params\":{\"flowRate\":\"Flow rate in amount per second for this flow\",\"receiver\":\"Flow recipient address\",\"sender\":\"Flow sender address\",\"token\":\"Super token address\",\"totalReceiverFlowRate\":\"Total flow rate in amount per second for the receiver\",\"totalSenderFlowRate\":\"Total flow rate in amount per second for the sender\",\"userData\":\"The user provided data\"}},\"FlowUpdatedExtension(address,uint256)\":{\"details\":\"Flow updated extension event\",\"params\":{\"deposit\":\"The deposit amount for the stream\",\"flowOperator\":\"Flow operator address - the Context.msgSender\"}}},\"kind\":\"dev\",\"methods\":{\"agreementType()\":{\"details\":\"ISuperAgreement.agreementType implementation\"},\"authorizeFlowOperatorWithFullControl(address,address,bytes)\":{\"details\":\"msgSender from `ctx` grants `flowOperator` all permissions with flowRateAllowance as type(int96).max\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowOperator\":\"The permission grantee address\",\"token\":\"Super token address\"}},\"createFlow(address,address,int96,bytes)\":{\"custom:callbacks\":\" - AgreementCreated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver)\",\"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\",\"details\":\"flowId (agreementId) is the keccak256 hash of encoded sender and receiver\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowRate\":\"New flow rate in amount per second\",\"receiver\":\"Flow receiver address\",\"token\":\"Super token address\"}},\"createFlowByOperator(address,address,address,int96,bytes)\":{\"details\":\"A flow created by an approved flow operator (see above for details on callbacks)\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowRate\":\"New flow rate in amount per second\",\"receiver\":\"Flow receiver address\",\"sender\":\"Flow sender address (has granted permissions)\",\"token\":\"Super token address\"}},\"deleteFlow(address,address,address,bytes)\":{\"custom:callbacks\":\" - AgreementTerminated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver)\",\"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 - Gas fee may be returned to the sender\",\"details\":\"flowId (agreementId) is the keccak256 hash of encoded sender and receiver\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"receiver\":\"Flow receiver address\",\"token\":\"Super token address\"}},\"deleteFlowByOperator(address,address,address,bytes)\":{\"details\":\"A flow deleted by an approved flow operator (see above for details on callbacks)\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"receiver\":\"Flow receiver address\",\"token\":\"Super token address\"}},\"getAccountFlowInfo(address,address)\":{\"details\":\"Get the aggregated flow info of the account\",\"params\":{\"account\":\"Account for the query\",\"token\":\"Super token address\"},\"returns\":{\"deposit\":\"The sum of all deposits for account's flows\",\"flowRate\":\"The net flow rate of token for account\",\"owedDeposit\":\"The sum of all owed deposits for account's flows\",\"timestamp\":\"Timestamp of when a flow was last updated for account\"}},\"getDepositRequiredForFlowRate(address,int96)\":{\"custom:note\":\" - if calculated deposit (flowRate * liquidationPeriod) is less   than the minimum deposit, we use the minimum deposit otherwise   we use the calculated deposit\",\"details\":\"Calculates the deposit based on the liquidationPeriod and flowRate\",\"params\":{\"flowRate\":\"Flow rate to be tested\"},\"returns\":{\"deposit\":\"The deposit amount based on flowRate and liquidationPeriod\"}},\"getFlow(address,address,address)\":{\"details\":\"Get the flow data between `sender` and `receiver` of `token`\",\"params\":{\"receiver\":\"Flow sender\",\"sender\":\"Flow receiver\",\"token\":\"Super token address\"},\"returns\":{\"deposit\":\"The amount of deposit the flow\",\"flowRate\":\"The flow rate\",\"owedDeposit\":\"The amount of owed deposit of the flow\",\"timestamp\":\"Timestamp of when the flow is updated\"}},\"getFlowByID(address,bytes32)\":{\"details\":\"flowId (agreementId) is the keccak256 hash of encoded sender and receiver\",\"params\":{\"agreementId\":\"The agreement ID\",\"token\":\"Super token address\"},\"returns\":{\"deposit\":\"The deposit amount of the flow\",\"flowRate\":\"The flow rate\",\"owedDeposit\":\"The owed deposit amount of the flow\",\"timestamp\":\"Timestamp of when the flow is updated\"}},\"getFlowOperatorData(address,address,address)\":{\"params\":{\"flowOperator\":\"The permission grantee address\",\"sender\":\"The permission granter address\",\"token\":\"Super token address\"},\"returns\":{\"flowOperatorId\":\"The keccak256 hash of encoded string \\\"flowOperator\\\", sender and flowOperator\",\"flowRateAllowance\":\"The flow rate allowance the `flowOperator` is granted (only goes down)\",\"permissions\":\"A bitmask representation of the granted permissions\"}},\"getFlowOperatorDataByID(address,bytes32)\":{\"params\":{\"flowOperatorId\":\"The keccak256 hash of encoded string \\\"flowOperator\\\", sender and flowOperator\",\"token\":\"Super token address\"},\"returns\":{\"flowRateAllowance\":\"The flow rate allowance the `flowOperator` is granted (only goes down)\",\"permissions\":\"A bitmask representation of the granted permissions\"}},\"getMaximumFlowRateFromDeposit(address,uint256)\":{\"details\":\"The deposit is clipped and rounded down\",\"params\":{\"deposit\":\"Deposit amount used for creating the flow\"},\"returns\":{\"flowRate\":\"The maximum flow rate\"}},\"getNetFlow(address,address)\":{\"details\":\"Get the net flow rate of the account\",\"params\":{\"account\":\"Account for the query\",\"token\":\"Super token address\"},\"returns\":{\"flowRate\":\"Net flow rate\"}},\"isPatricianPeriod(address,address,uint256)\":{\"details\":\"Returns whether it is the patrician period based on timestamp\",\"params\":{\"account\":\"The account we are interested in\",\"timestamp\":\"The timestamp we are interested in observing the result of isPatricianPeriod\"},\"returns\":{\"_0\":\"bool Whether it is currently the patrician period dictated by governance\"}},\"isPatricianPeriodNow(address,address)\":{\"details\":\"Returns whether it is the patrician period based on host.getNow()\",\"params\":{\"account\":\"The account we are interested in\"},\"returns\":{\"isCurrentlyPatricianPeriod\":\"Whether it is currently the patrician period dictated by governance\",\"timestamp\":\"The value of host.getNow()\"}},\"realtimeBalanceOf(address,address,uint256)\":{\"details\":\"Calculate the real-time balance for the account of this agreement class\",\"params\":{\"account\":\"Account the state belongs to\",\"time\":\"Time used for the calculation\"},\"returns\":{\"deposit\":\"Account deposit amount of this agreement\",\"dynamicBalance\":\"Dynamic balance portion of real-time balance of this agreement\",\"owedDeposit\":\"Account owed deposit amount of this agreement\"}},\"revokeFlowOperatorWithFullControl(address,address,bytes)\":{\"details\":\"`permissions` and `flowRateAllowance` will both be set to 0\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowOperator\":\"The permission grantee address\",\"token\":\"Super token address\"}},\"updateFlow(address,address,int96,bytes)\":{\"custom:callbacks\":\" - AgreementUpdated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver)\",\"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 - Deposit amount will be adjusted accordingly - No new gas fee is charged\",\"details\":\"flowId (agreementId) is the keccak256 hash of encoded sender and receiver\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowRate\":\"New flow rate in amount per second\",\"receiver\":\"Flow receiver address\",\"token\":\"Super token address\"}},\"updateFlowByOperator(address,address,address,int96,bytes)\":{\"details\":\"A flow updated by an approved flow operator (see above for details on callbacks)\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowRate\":\"New flow rate in amount per second\",\"receiver\":\"Flow receiver address\",\"sender\":\"Flow sender address (has granted permissions)\",\"token\":\"Super token address\"}},\"updateFlowOperatorPermissions(address,address,uint8,int96,bytes)\":{\"details\":\"msgSender from `ctx` updates permissions for the `flowOperator` with `flowRateAllowance`\",\"params\":{\"ctx\":\"Context bytes (see ISuperfluid.sol for Context struct)\",\"flowOperator\":\"The permission grantee address\",\"flowRateAllowance\":\"The flow rate allowance the `flowOperator` is granted (only goes down)\",\"permissions\":\"A bitmask representation of the granted permissions\",\"token\":\"Super token address\"}}},\"title\":\"Constant Flow Agreement interface\",\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{\"createFlow(address,address,int96,bytes)\":{\"notice\":\"Create a flow betwen ctx.msgSender and receiver\"},\"createFlowByOperator(address,address,address,int96,bytes)\":{\"notice\":\"Create a flow between sender and receiver\"},\"deleteFlow(address,address,address,bytes)\":{\"notice\":\"Delete the flow between sender and receiver\"},\"deleteFlowByOperator(address,address,address,bytes)\":{\"notice\":\"Delete the flow between sender and receiver\"},\"getDepositRequiredForFlowRate(address,int96)\":{\"notice\":\"Get the deposit required for creating the flow\"},\"getFlowByID(address,bytes32)\":{\"notice\":\"Get flow data using agreementId\"},\"getFlowOperatorData(address,address,address)\":{\"notice\":\"Get the permissions of a flow operator between `sender` and `flowOperator` for `token`\"},\"getFlowOperatorDataByID(address,bytes32)\":{\"notice\":\"Get flow operator using flowOperatorId\"},\"getMaximumFlowRateFromDeposit(address,uint256)\":{\"notice\":\"Get the maximum flow rate allowed with the deposit\"},\"revokeFlowOperatorWithFullControl(address,address,bytes)\":{\"notice\":\"msgSender from `ctx` revokes `flowOperator` create/update/delete permissions\"},\"updateFlow(address,address,int96,bytes)\":{\"notice\":\"Update the flow rate between ctx.msgSender and receiver\"},\"updateFlowByOperator(address,address,address,int96,bytes)\":{\"notice\":\"Update a flow between sender and receiver\"}},\"version\":1}},\"settings\":{\"compilationTarget\":{\"project:/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol\":\"IConstantFlowAgreementV1\"},\"evmVersion\":\"london\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"ipfs\"},\"optimizer\":{\"enabled\":true,\"runs\":200},\"remappings\":[]},\"sources\":{\"project:/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol\":{\"keccak256\":\"0x5da735cab1cf7114564ec7d81ed35037a56b6f216a60569aef6e65f3aaca5dd8\",\"license\":\"AGPLv3\",\"urls\":[\"bzz-raw://27a2ad0243469f7364d5e5a483493b16e2b57b9b36c24c6de0ea0e2c13465c71\",\"dweb:/ipfs/QmSfHTC7ewk8LA27TrDqojqFjdkkafCoZmWE1V6HEuFqox\"]},\"project:/contracts/interfaces/superfluid/ISuperAgreement.sol\":{\"keccak256\":\"0xc3a6a907245116bcecc70fe4b207454012e8ce4fa190228fb8bbe39e0b1bc5cf\",\"license\":\"AGPLv3\",\"urls\":[\"bzz-raw://83c116bdae48685d20e5a27c942111e685ec1ef6334e7ff6f6d9af66edbd8025\",\"dweb:/ipfs/QmTnVuNTaRFiDmkAmDk7NFYdfQTW1kqgBZiY2exC6k8jDx\"]},\"project:/contracts/interfaces/superfluid/ISuperfluidToken.sol\":{\"keccak256\":\"0x3eec5a3bf337cd319c1918fd1b16f350cf5f6850ac71f6859066fbf86e734ff4\",\"license\":\"AGPLv3\",\"urls\":[\"bzz-raw://cda19a2f5ca18e79c1e2300c8efac84c718df76c4fb313f59f84264a4c6b398a\",\"dweb:/ipfs/QmfQiwgDH5Q64w5ufBnDzVaeWv6WCZ6fLTrYu1FSYfBGhq\"]}},\"version\":1}",
   "bytecode": "0x",
   "deployedBytecode": "0x",
   "immutableReferences": {},
@@ -798,7 +798,7 @@
   "deployedGeneratedSources": [],
   "sourceMap": "",
   "deployedSourceMap": "",
-  "source": "// SPDX-License-Identifier: AGPLv3\npragma solidity >= 0.8.0;\n\nimport { ISuperAgreement } from \"../superfluid/ISuperAgreement.sol\";\nimport { ISuperfluidToken } from \"../superfluid/ISuperfluidToken.sol\";\n\n\n/**\n * @title Constant Flow Agreement interface\n * @author Superfluid\n */\nabstract contract IConstantFlowAgreementV1 is ISuperAgreement {\n\n    /// @dev ISuperAgreement.agreementType implementation\n    function agreementType() external override pure returns (bytes32) {\n        return keccak256(\"org.superfluid-finance.agreements.ConstantFlowAgreement.v1\");\n    }\n\n    /**\n     * @notice Get the maximum flow rate allowed with the deposit\n     * @dev The deposit is clipped and rounded down\n     * @param deposit Deposit amount used for creating the flow\n     * @return flowRate The maximum flow rate\n     */\n    function getMaximumFlowRateFromDeposit(\n        ISuperfluidToken token,\n        uint256 deposit)\n        external view virtual\n        returns (int96 flowRate);\n\n    /**\n     * @notice Get the deposit required for creating the flow\n     * @dev Calculates the deposit based on the liquidationPeriod and flowRate\n     * @param flowRate Flow rate to be tested\n     * @return deposit The deposit amount based on flowRate and liquidationPeriod\n     * NOTE:\n     * - if calculated deposit (flowRate * liquidationPeriod) is less\n     *   than the minimum deposit, we use the minimum deposit otherwise\n     *   we use the calculated deposit\n     */\n    function getDepositRequiredForFlowRate(\n        ISuperfluidToken token,\n        int96 flowRate)\n        external view virtual\n        returns (uint256 deposit);\n\n    /**\n     * @dev Returns whether it is the patrician period based on host.getNow()\n     * @param account The account we are interested in\n     * @return isCurrentlyPatricianPeriod Whether it is currently the patrician period dictated by governance\n     * @return timestamp The value of host.getNow()\n     */\n    function isPatricianPeriodNow(\n        ISuperfluidToken token,\n        address account)\n        public view virtual\n        returns (bool isCurrentlyPatricianPeriod, uint256 timestamp);\n\n    /**\n     * @dev Returns whether it is the patrician period based on timestamp\n     * @param account The account we are interested in\n     * @param timestamp The timestamp we are interested in observing the result of isPatricianPeriod\n     * @return bool Whether it is currently the patrician period dictated by governance\n     */\n    function isPatricianPeriod(\n        ISuperfluidToken token,\n        address account,\n        uint256 timestamp\n    )\n        public view virtual\n        returns (bool);\n\n    /**\n     * @dev msgSender from `ctx` updates permissions for the `flowOperator` with `flowRateAllowance`\n     * @param token Super token address\n     * @param flowOperator The permission grantee address\n     * @param permissions A bitmask representation of the granted permissions\n     * @param flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     */\n    function updateFlowOperatorPermissions(\n        ISuperfluidToken token,\n        address flowOperator,\n        uint8 permissions,\n        int96 flowRateAllowance,\n        bytes calldata ctx\n    ) \n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @dev msgSender from `ctx` grants `flowOperator` all permissions with flowRateAllowance as type(int96).max\n     * @param token Super token address\n     * @param flowOperator The permission grantee address\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     */\n    function authorizeFlowOperatorWithFullControl(\n        ISuperfluidToken token,\n        address flowOperator,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n     /**\n     * @notice msgSender from `ctx` revokes `flowOperator` create/update/delete permissions\n     * @dev `permissions` and `flowRateAllowance` will both be set to 0\n     * @param token Super token address\n     * @param flowOperator The permission grantee address\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     */\n    function revokeFlowOperatorWithFullControl(\n        ISuperfluidToken token,\n        address flowOperator,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @notice Get the permissions of a flow operator between `sender` and `flowOperator` for `token`\n     * @param token Super token address\n     * @param sender The permission granter address\n     * @param flowOperator The permission grantee address\n     * @return flowOperatorId The keccak256 hash of encoded string \"flowOperator\", sender and flowOperator\n     * @return permissions A bitmask representation of the granted permissions\n     * @return flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)\n     */\n    function getFlowOperatorData(\n       ISuperfluidToken token,\n       address sender,\n       address flowOperator\n    )\n        public view virtual\n        returns (\n            bytes32 flowOperatorId,\n            uint8 permissions,\n            int96 flowRateAllowance\n        );\n\n    /**\n     * @notice Get flow operator using flowOperatorId\n     * @param token Super token address\n     * @param flowOperatorId The keccak256 hash of encoded string \"flowOperator\", sender and flowOperator\n     * @return permissions A bitmask representation of the granted permissions\n     * @return flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)\n     */\n    function getFlowOperatorDataByID(\n       ISuperfluidToken token,\n       bytes32 flowOperatorId\n    )\n        external view virtual\n        returns (\n            uint8 permissions,\n            int96 flowRateAllowance\n        );\n\n    /**\n     * @notice Create a flow betwen ctx.msgSender and receiver\n     * @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n     * @param token Super token address\n     * @param receiver Flow receiver address\n     * @param flowRate New flow rate in amount per second\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     *\n     * # App callbacks\n     *\n     * - AgreementCreated\n     *   - agreementId - can be used in getFlowByID\n     *   - agreementData - abi.encode(address flowSender, address flowReceiver)\n     *\n     * NOTE:\n     * - A deposit is taken as safety margin for the solvency agents\n     * - A extra gas fee may be taken to pay for solvency agent liquidations\n     */\n    function createFlow(\n        ISuperfluidToken token,\n        address receiver,\n        int96 flowRate,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n    * @notice Create a flow between sender and receiver\n    * @dev A flow created by an approved flow operator (see above for details on callbacks)\n    * @param token Super token address\n    * @param sender Flow sender address (has granted permissions)\n    * @param receiver Flow receiver address\n    * @param flowRate New flow rate in amount per second\n    * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n    */\n    function createFlowByOperator(\n        ISuperfluidToken token,\n        address sender,\n        address receiver,\n        int96 flowRate,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @notice Update the flow rate between ctx.msgSender and receiver\n     * @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n     * @param token Super token address\n     * @param receiver Flow receiver address\n     * @param flowRate New flow rate in amount per second\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     *\n     * # App callbacks\n     *\n     * - AgreementUpdated\n     *   - agreementId - can be used in getFlowByID\n     *   - agreementData - abi.encode(address flowSender, address flowReceiver)\n     *\n     * NOTE:\n     * - Only the flow sender may update the flow rate\n     * - Even if the flow rate is zero, the flow is not deleted\n     * from the system\n     * - Deposit amount will be adjusted accordingly\n     * - No new gas fee is charged\n     */\n    function updateFlow(\n        ISuperfluidToken token,\n        address receiver,\n        int96 flowRate,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n    * @notice Update a flow between sender and receiver\n    * @dev A flow updated by an approved flow operator (see above for details on callbacks)\n    * @param token Super token address\n    * @param sender Flow sender address (has granted permissions)\n    * @param receiver Flow receiver address\n    * @param flowRate New flow rate in amount per second\n    * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n    */\n    function updateFlowByOperator(\n        ISuperfluidToken token,\n        address sender,\n        address receiver,\n        int96 flowRate,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @dev Get the flow data between `sender` and `receiver` of `token`\n     * @param token Super token address\n     * @param sender Flow receiver\n     * @param receiver Flow sender\n     * @return timestamp Timestamp of when the flow is updated\n     * @return flowRate The flow rate\n     * @return deposit The amount of deposit the flow\n     * @return owedDeposit The amount of owed deposit of the flow\n     */\n    function getFlow(\n        ISuperfluidToken token,\n        address sender,\n        address receiver\n    )\n        external view virtual\n        returns (\n            uint256 timestamp,\n            int96 flowRate,\n            uint256 deposit,\n            uint256 owedDeposit\n        );\n\n    /**\n     * @notice Get flow data using agreementId\n     * @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n     * @param token Super token address\n     * @param agreementId The agreement ID\n     * @return timestamp Timestamp of when the flow is updated\n     * @return flowRate The flow rate\n     * @return deposit The deposit amount of the flow\n     * @return owedDeposit The owed deposit amount of the flow\n     */\n    function getFlowByID(\n       ISuperfluidToken token,\n       bytes32 agreementId\n    )\n        external view virtual\n        returns (\n            uint256 timestamp,\n            int96 flowRate,\n            uint256 deposit,\n            uint256 owedDeposit\n        );\n\n    /**\n     * @dev Get the aggregated flow info of the account\n     * @param token Super token address\n     * @param account Account for the query\n     * @return timestamp Timestamp of when a flow was last updated for account\n     * @return flowRate The net flow rate of token for account\n     * @return deposit The sum of all deposits for account's flows\n     * @return owedDeposit The sum of all owed deposits for account's flows\n     */\n    function getAccountFlowInfo(\n        ISuperfluidToken token,\n        address account\n    )\n        external view virtual\n        returns (\n            uint256 timestamp,\n            int96 flowRate,\n            uint256 deposit,\n            uint256 owedDeposit);\n\n    /**\n     * @dev Get the net flow rate of the account\n     * @param token Super token address\n     * @param account Account for the query\n     * @return flowRate Net flow rate\n     */\n    function getNetFlow(\n        ISuperfluidToken token,\n        address account\n    )\n        external view virtual\n        returns (int96 flowRate);\n\n    /**\n     * @notice Delete the flow between sender and receiver\n     * @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n     * @param token Super token address\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     * @param receiver Flow receiver address\n     *\n     * # App callbacks\n     *\n     * - AgreementTerminated\n     *   - agreementId - can be used in getFlowByID\n     *   - agreementData - abi.encode(address flowSender, address flowReceiver)\n     *\n     * NOTE:\n     * - Both flow sender and receiver may delete the flow\n     * - If Sender account is insolvent or in critical state, a solvency agent may\n     *   also terminate the agreement\n     * - Gas fee may be returned to the sender\n     */\n    function deleteFlow(\n        ISuperfluidToken token,\n        address sender,\n        address receiver,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @notice Delete the flow between sender and receiver\n     * @dev A flow deleted by an approved flow operator (see above for details on callbacks)\n     * @param token Super token address\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     * @param receiver Flow receiver address\n     */\n    function deleteFlowByOperator(\n        ISuperfluidToken token,\n        address sender,\n        address receiver,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n     \n    /**\n     * @dev Flow operator updated event\n     * @param token Super token address\n     * @param sender Flow sender address\n     * @param flowOperator Flow operator address\n     * @param permissions Octo bitmask representation of permissions\n     * @param flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)\n     */\n    event FlowOperatorUpdated(\n        ISuperfluidToken indexed token,\n        address indexed sender,\n        address indexed flowOperator,\n        uint8 permissions,\n        int96 flowRateAllowance\n    );\n\n    /**\n     * @dev Flow updated event\n     * @param token Super token address\n     * @param sender Flow sender address\n     * @param receiver Flow recipient address\n     * @param flowRate Flow rate in amount per second for this flow\n     * @param totalSenderFlowRate Total flow rate in amount per second for the sender\n     * @param totalReceiverFlowRate Total flow rate in amount per second for the receiver\n     * @param userData The user provided data\n     *\n     */\n    event FlowUpdated(\n        ISuperfluidToken indexed token,\n        address indexed sender,\n        address indexed receiver,\n        int96 flowRate,\n        int256 totalSenderFlowRate,\n        int256 totalReceiverFlowRate,\n        bytes userData\n    );\n\n    /**\n     * @dev Flow updated extension event\n     * @param flowOperator Flow operator address - the Context.msgSender\n     * @param deposit The deposit amount for the stream\n     */\n    event FlowUpdatedExtension(\n        address indexed flowOperator,\n        uint256 deposit\n    );\n}\n",
+  "source": "// SPDX-License-Identifier: AGPLv3\npragma solidity >= 0.8.0;\n\nimport { ISuperAgreement } from \"../superfluid/ISuperAgreement.sol\";\nimport { ISuperfluidToken } from \"../superfluid/ISuperfluidToken.sol\";\n\n\n/**\n * @title Constant Flow Agreement interface\n * @author Superfluid\n */\nabstract contract IConstantFlowAgreementV1 is ISuperAgreement {\n\n    /// @dev ISuperAgreement.agreementType implementation\n    function agreementType() external override pure returns (bytes32) {\n        return keccak256(\"org.superfluid-finance.agreements.ConstantFlowAgreement.v1\");\n    }\n\n    /**\n     * @notice Get the maximum flow rate allowed with the deposit\n     * @dev The deposit is clipped and rounded down\n     * @param deposit Deposit amount used for creating the flow\n     * @return flowRate The maximum flow rate\n     */\n    function getMaximumFlowRateFromDeposit(\n        ISuperfluidToken token,\n        uint256 deposit)\n        external view virtual\n        returns (int96 flowRate);\n\n    /**\n     * @notice Get the deposit required for creating the flow\n     * @dev Calculates the deposit based on the liquidationPeriod and flowRate\n     * @param flowRate Flow rate to be tested\n     * @return deposit The deposit amount based on flowRate and liquidationPeriod\n     * @custom:note \n     * - if calculated deposit (flowRate * liquidationPeriod) is less\n     *   than the minimum deposit, we use the minimum deposit otherwise\n     *   we use the calculated deposit\n     */\n    function getDepositRequiredForFlowRate(\n        ISuperfluidToken token,\n        int96 flowRate)\n        external view virtual\n        returns (uint256 deposit);\n\n    /**\n     * @dev Returns whether it is the patrician period based on host.getNow()\n     * @param account The account we are interested in\n     * @return isCurrentlyPatricianPeriod Whether it is currently the patrician period dictated by governance\n     * @return timestamp The value of host.getNow()\n     */\n    function isPatricianPeriodNow(\n        ISuperfluidToken token,\n        address account)\n        public view virtual\n        returns (bool isCurrentlyPatricianPeriod, uint256 timestamp);\n\n    /**\n     * @dev Returns whether it is the patrician period based on timestamp\n     * @param account The account we are interested in\n     * @param timestamp The timestamp we are interested in observing the result of isPatricianPeriod\n     * @return bool Whether it is currently the patrician period dictated by governance\n     */\n    function isPatricianPeriod(\n        ISuperfluidToken token,\n        address account,\n        uint256 timestamp\n    )\n        public view virtual\n        returns (bool);\n\n    /**\n     * @dev msgSender from `ctx` updates permissions for the `flowOperator` with `flowRateAllowance`\n     * @param token Super token address\n     * @param flowOperator The permission grantee address\n     * @param permissions A bitmask representation of the granted permissions\n     * @param flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     */\n    function updateFlowOperatorPermissions(\n        ISuperfluidToken token,\n        address flowOperator,\n        uint8 permissions,\n        int96 flowRateAllowance,\n        bytes calldata ctx\n    ) \n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @dev msgSender from `ctx` grants `flowOperator` all permissions with flowRateAllowance as type(int96).max\n     * @param token Super token address\n     * @param flowOperator The permission grantee address\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     */\n    function authorizeFlowOperatorWithFullControl(\n        ISuperfluidToken token,\n        address flowOperator,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n     /**\n     * @notice msgSender from `ctx` revokes `flowOperator` create/update/delete permissions\n     * @dev `permissions` and `flowRateAllowance` will both be set to 0\n     * @param token Super token address\n     * @param flowOperator The permission grantee address\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     */\n    function revokeFlowOperatorWithFullControl(\n        ISuperfluidToken token,\n        address flowOperator,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @notice Get the permissions of a flow operator between `sender` and `flowOperator` for `token`\n     * @param token Super token address\n     * @param sender The permission granter address\n     * @param flowOperator The permission grantee address\n     * @return flowOperatorId The keccak256 hash of encoded string \"flowOperator\", sender and flowOperator\n     * @return permissions A bitmask representation of the granted permissions\n     * @return flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)\n     */\n    function getFlowOperatorData(\n       ISuperfluidToken token,\n       address sender,\n       address flowOperator\n    )\n        public view virtual\n        returns (\n            bytes32 flowOperatorId,\n            uint8 permissions,\n            int96 flowRateAllowance\n        );\n\n    /**\n     * @notice Get flow operator using flowOperatorId\n     * @param token Super token address\n     * @param flowOperatorId The keccak256 hash of encoded string \"flowOperator\", sender and flowOperator\n     * @return permissions A bitmask representation of the granted permissions\n     * @return flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)\n     */\n    function getFlowOperatorDataByID(\n       ISuperfluidToken token,\n       bytes32 flowOperatorId\n    )\n        external view virtual\n        returns (\n            uint8 permissions,\n            int96 flowRateAllowance\n        );\n\n    /**\n     * @notice Create a flow betwen ctx.msgSender and receiver\n     * @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n     * @param token Super token address\n     * @param receiver Flow receiver address\n     * @param flowRate New flow rate in amount per second\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     *\n     * @custom:callbacks \n     * - AgreementCreated\n     *   - agreementId - can be used in getFlowByID\n     *   - agreementData - abi.encode(address flowSender, address flowReceiver)\n     *\n     * @custom:note \n     * - A deposit is taken as safety margin for the solvency agents\n     * - A extra gas fee may be taken to pay for solvency agent liquidations\n     */\n    function createFlow(\n        ISuperfluidToken token,\n        address receiver,\n        int96 flowRate,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n    * @notice Create a flow between sender and receiver\n    * @dev A flow created by an approved flow operator (see above for details on callbacks)\n    * @param token Super token address\n    * @param sender Flow sender address (has granted permissions)\n    * @param receiver Flow receiver address\n    * @param flowRate New flow rate in amount per second\n    * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n    */\n    function createFlowByOperator(\n        ISuperfluidToken token,\n        address sender,\n        address receiver,\n        int96 flowRate,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @notice Update the flow rate between ctx.msgSender and receiver\n     * @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n     * @param token Super token address\n     * @param receiver Flow receiver address\n     * @param flowRate New flow rate in amount per second\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     *\n     * @custom:callbacks \n     * - AgreementUpdated\n     *   - agreementId - can be used in getFlowByID\n     *   - agreementData - abi.encode(address flowSender, address flowReceiver)\n     *\n     * @custom:note \n     * - Only the flow sender may update the flow rate\n     * - Even if the flow rate is zero, the flow is not deleted\n     * from the system\n     * - Deposit amount will be adjusted accordingly\n     * - No new gas fee is charged\n     */\n    function updateFlow(\n        ISuperfluidToken token,\n        address receiver,\n        int96 flowRate,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n    * @notice Update a flow between sender and receiver\n    * @dev A flow updated by an approved flow operator (see above for details on callbacks)\n    * @param token Super token address\n    * @param sender Flow sender address (has granted permissions)\n    * @param receiver Flow receiver address\n    * @param flowRate New flow rate in amount per second\n    * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n    */\n    function updateFlowByOperator(\n        ISuperfluidToken token,\n        address sender,\n        address receiver,\n        int96 flowRate,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @dev Get the flow data between `sender` and `receiver` of `token`\n     * @param token Super token address\n     * @param sender Flow receiver\n     * @param receiver Flow sender\n     * @return timestamp Timestamp of when the flow is updated\n     * @return flowRate The flow rate\n     * @return deposit The amount of deposit the flow\n     * @return owedDeposit The amount of owed deposit of the flow\n     */\n    function getFlow(\n        ISuperfluidToken token,\n        address sender,\n        address receiver\n    )\n        external view virtual\n        returns (\n            uint256 timestamp,\n            int96 flowRate,\n            uint256 deposit,\n            uint256 owedDeposit\n        );\n\n    /**\n     * @notice Get flow data using agreementId\n     * @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n     * @param token Super token address\n     * @param agreementId The agreement ID\n     * @return timestamp Timestamp of when the flow is updated\n     * @return flowRate The flow rate\n     * @return deposit The deposit amount of the flow\n     * @return owedDeposit The owed deposit amount of the flow\n     */\n    function getFlowByID(\n       ISuperfluidToken token,\n       bytes32 agreementId\n    )\n        external view virtual\n        returns (\n            uint256 timestamp,\n            int96 flowRate,\n            uint256 deposit,\n            uint256 owedDeposit\n        );\n\n    /**\n     * @dev Get the aggregated flow info of the account\n     * @param token Super token address\n     * @param account Account for the query\n     * @return timestamp Timestamp of when a flow was last updated for account\n     * @return flowRate The net flow rate of token for account\n     * @return deposit The sum of all deposits for account's flows\n     * @return owedDeposit The sum of all owed deposits for account's flows\n     */\n    function getAccountFlowInfo(\n        ISuperfluidToken token,\n        address account\n    )\n        external view virtual\n        returns (\n            uint256 timestamp,\n            int96 flowRate,\n            uint256 deposit,\n            uint256 owedDeposit);\n\n    /**\n     * @dev Get the net flow rate of the account\n     * @param token Super token address\n     * @param account Account for the query\n     * @return flowRate Net flow rate\n     */\n    function getNetFlow(\n        ISuperfluidToken token,\n        address account\n    )\n        external view virtual\n        returns (int96 flowRate);\n\n    /**\n     * @notice Delete the flow between sender and receiver\n     * @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n     * @param token Super token address\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     * @param receiver Flow receiver address\n     *\n     * @custom:callbacks \n     * - AgreementTerminated\n     *   - agreementId - can be used in getFlowByID\n     *   - agreementData - abi.encode(address flowSender, address flowReceiver)\n     *\n     * @custom:note \n     * - Both flow sender and receiver may delete the flow\n     * - If Sender account is insolvent or in critical state, a solvency agent may\n     *   also terminate the agreement\n     * - Gas fee may be returned to the sender\n     */\n    function deleteFlow(\n        ISuperfluidToken token,\n        address sender,\n        address receiver,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n\n    /**\n     * @notice Delete the flow between sender and receiver\n     * @dev A flow deleted by an approved flow operator (see above for details on callbacks)\n     * @param token Super token address\n     * @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n     * @param receiver Flow receiver address\n     */\n    function deleteFlowByOperator(\n        ISuperfluidToken token,\n        address sender,\n        address receiver,\n        bytes calldata ctx\n    )\n        external virtual\n        returns(bytes memory newCtx);\n     \n    /**\n     * @dev Flow operator updated event\n     * @param token Super token address\n     * @param sender Flow sender address\n     * @param flowOperator Flow operator address\n     * @param permissions Octo bitmask representation of permissions\n     * @param flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)\n     */\n    event FlowOperatorUpdated(\n        ISuperfluidToken indexed token,\n        address indexed sender,\n        address indexed flowOperator,\n        uint8 permissions,\n        int96 flowRateAllowance\n    );\n\n    /**\n     * @dev Flow updated event\n     * @param token Super token address\n     * @param sender Flow sender address\n     * @param receiver Flow recipient address\n     * @param flowRate Flow rate in amount per second for this flow\n     * @param totalSenderFlowRate Total flow rate in amount per second for the sender\n     * @param totalReceiverFlowRate Total flow rate in amount per second for the receiver\n     * @param userData The user provided data\n     *\n     */\n    event FlowUpdated(\n        ISuperfluidToken indexed token,\n        address indexed sender,\n        address indexed receiver,\n        int96 flowRate,\n        int256 totalSenderFlowRate,\n        int256 totalReceiverFlowRate,\n        bytes userData\n    );\n\n    /**\n     * @dev Flow updated extension event\n     * @param flowOperator Flow operator address - the Context.msgSender\n     * @param deposit The deposit amount for the stream\n     */\n    event FlowUpdatedExtension(\n        address indexed flowOperator,\n        uint256 deposit\n    );\n}\n",
   "sourcePath": "/home/runner/work/protocol-monorepo/protocol-monorepo/packages/ethereum-contracts/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol",
   "ast": {
     "absolutePath": "project:/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol",
@@ -1175,8 +1175,8 @@
             "documentation": {
               "id": 16076,
               "nodeType": "StructuredDocumentation",
-              "src": "982:474:39",
-              "text": " @notice Get the deposit required for creating the flow\n @dev Calculates the deposit based on the liquidationPeriod and flowRate\n @param flowRate Flow rate to be tested\n @return deposit The deposit amount based on flowRate and liquidationPeriod\n NOTE:\n - if calculated deposit (flowRate * liquidationPeriod) is less\n   than the minimum deposit, we use the minimum deposit otherwise\n   we use the calculated deposit"
+              "src": "982:482:39",
+              "text": " @notice Get the deposit required for creating the flow\n @dev Calculates the deposit based on the liquidationPeriod and flowRate\n @param flowRate Flow rate to be tested\n @return deposit The deposit amount based on flowRate and liquidationPeriod\n @custom:note \n - if calculated deposit (flowRate * liquidationPeriod) is less\n   than the minimum deposit, we use the minimum deposit otherwise\n   we use the calculated deposit"
             },
             "functionSelector": "8d997f6e",
             "id": 16086,
@@ -1184,7 +1184,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "getDepositRequiredForFlowRate",
-            "nameLocation": "1470:29:39",
+            "nameLocation": "1478:29:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16082,
@@ -1195,10 +1195,10 @@
                   "id": 16079,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "1526:5:39",
+                  "nameLocation": "1534:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16086,
-                  "src": "1509:22:39",
+                  "src": "1517:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1213,10 +1213,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "1509:16:39"
+                      "src": "1517:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "1509:16:39",
+                    "src": "1517:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -1229,10 +1229,10 @@
                   "id": 16081,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "1547:8:39",
+                  "nameLocation": "1555:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16086,
-                  "src": "1541:14:39",
+                  "src": "1549:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1243,7 +1243,7 @@
                     "id": 16080,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "1541:5:39",
+                    "src": "1549:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -1252,7 +1252,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "1499:57:39"
+              "src": "1507:57:39"
             },
             "returnParameters": {
               "id": 16085,
@@ -1263,10 +1263,10 @@
                   "id": 16084,
                   "mutability": "mutable",
                   "name": "deposit",
-                  "nameLocation": "1612:7:39",
+                  "nameLocation": "1620:7:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16086,
-                  "src": "1604:15:39",
+                  "src": "1612:15:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1277,7 +1277,7 @@
                     "id": 16083,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "1604:7:39",
+                    "src": "1612:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -1286,10 +1286,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "1603:17:39"
+              "src": "1611:17:39"
             },
             "scope": 16383,
-            "src": "1461:160:39",
+            "src": "1469:160:39",
             "stateMutability": "view",
             "virtual": true,
             "visibility": "external"
@@ -1298,7 +1298,7 @@
             "documentation": {
               "id": 16087,
               "nodeType": "StructuredDocumentation",
-              "src": "1627:306:39",
+              "src": "1635:306:39",
               "text": " @dev Returns whether it is the patrician period based on host.getNow()\n @param account The account we are interested in\n @return isCurrentlyPatricianPeriod Whether it is currently the patrician period dictated by governance\n @return timestamp The value of host.getNow()"
             },
             "functionSelector": "4fe9c291",
@@ -1307,7 +1307,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "isPatricianPeriodNow",
-            "nameLocation": "1947:20:39",
+            "nameLocation": "1955:20:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16093,
@@ -1318,10 +1318,10 @@
                   "id": 16090,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "1994:5:39",
+                  "nameLocation": "2002:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16099,
-                  "src": "1977:22:39",
+                  "src": "1985:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1336,10 +1336,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "1977:16:39"
+                      "src": "1985:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "1977:16:39",
+                    "src": "1985:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -1352,10 +1352,10 @@
                   "id": 16092,
                   "mutability": "mutable",
                   "name": "account",
-                  "nameLocation": "2017:7:39",
+                  "nameLocation": "2025:7:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16099,
-                  "src": "2009:15:39",
+                  "src": "2017:15:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1366,7 +1366,7 @@
                     "id": 16091,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "2009:7:39",
+                    "src": "2017:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -1376,7 +1376,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "1967:58:39"
+              "src": "1975:58:39"
             },
             "returnParameters": {
               "id": 16098,
@@ -1387,10 +1387,10 @@
                   "id": 16095,
                   "mutability": "mutable",
                   "name": "isCurrentlyPatricianPeriod",
-                  "nameLocation": "2076:26:39",
+                  "nameLocation": "2084:26:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16099,
-                  "src": "2071:31:39",
+                  "src": "2079:31:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1401,7 +1401,7 @@
                     "id": 16094,
                     "name": "bool",
                     "nodeType": "ElementaryTypeName",
-                    "src": "2071:4:39",
+                    "src": "2079:4:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bool",
                       "typeString": "bool"
@@ -1414,10 +1414,10 @@
                   "id": 16097,
                   "mutability": "mutable",
                   "name": "timestamp",
-                  "nameLocation": "2112:9:39",
+                  "nameLocation": "2120:9:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16099,
-                  "src": "2104:17:39",
+                  "src": "2112:17:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1428,7 +1428,7 @@
                     "id": 16096,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "2104:7:39",
+                    "src": "2112:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -1437,10 +1437,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "2070:52:39"
+              "src": "2078:52:39"
             },
             "scope": 16383,
-            "src": "1938:185:39",
+            "src": "1946:185:39",
             "stateMutability": "view",
             "virtual": true,
             "visibility": "public"
@@ -1449,7 +1449,7 @@
             "documentation": {
               "id": 16100,
               "nodeType": "StructuredDocumentation",
-              "src": "2129:329:39",
+              "src": "2137:329:39",
               "text": " @dev Returns whether it is the patrician period based on timestamp\n @param account The account we are interested in\n @param timestamp The timestamp we are interested in observing the result of isPatricianPeriod\n @return bool Whether it is currently the patrician period dictated by governance"
             },
             "functionSelector": "4b839e0b",
@@ -1458,7 +1458,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "isPatricianPeriod",
-            "nameLocation": "2472:17:39",
+            "nameLocation": "2480:17:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16108,
@@ -1469,10 +1469,10 @@
                   "id": 16103,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "2516:5:39",
+                  "nameLocation": "2524:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16112,
-                  "src": "2499:22:39",
+                  "src": "2507:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1487,10 +1487,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "2499:16:39"
+                      "src": "2507:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "2499:16:39",
+                    "src": "2507:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -1503,10 +1503,10 @@
                   "id": 16105,
                   "mutability": "mutable",
                   "name": "account",
-                  "nameLocation": "2539:7:39",
+                  "nameLocation": "2547:7:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16112,
-                  "src": "2531:15:39",
+                  "src": "2539:15:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1517,7 +1517,7 @@
                     "id": 16104,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "2531:7:39",
+                    "src": "2539:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -1531,10 +1531,10 @@
                   "id": 16107,
                   "mutability": "mutable",
                   "name": "timestamp",
-                  "nameLocation": "2564:9:39",
+                  "nameLocation": "2572:9:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16112,
-                  "src": "2556:17:39",
+                  "src": "2564:17:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1545,7 +1545,7 @@
                     "id": 16106,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "2556:7:39",
+                    "src": "2564:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -1554,7 +1554,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "2489:90:39"
+              "src": "2497:90:39"
             },
             "returnParameters": {
               "id": 16111,
@@ -1568,7 +1568,7 @@
                   "nameLocation": "-1:-1:-1",
                   "nodeType": "VariableDeclaration",
                   "scope": 16112,
-                  "src": "2625:4:39",
+                  "src": "2633:4:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1579,7 +1579,7 @@
                     "id": 16109,
                     "name": "bool",
                     "nodeType": "ElementaryTypeName",
-                    "src": "2625:4:39",
+                    "src": "2633:4:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bool",
                       "typeString": "bool"
@@ -1588,10 +1588,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "2624:6:39"
+              "src": "2632:6:39"
             },
             "scope": 16383,
-            "src": "2463:168:39",
+            "src": "2471:168:39",
             "stateMutability": "view",
             "virtual": true,
             "visibility": "public"
@@ -1600,7 +1600,7 @@
             "documentation": {
               "id": 16113,
               "nodeType": "StructuredDocumentation",
-              "src": "2637:464:39",
+              "src": "2645:464:39",
               "text": " @dev msgSender from `ctx` updates permissions for the `flowOperator` with `flowRateAllowance`\n @param token Super token address\n @param flowOperator The permission grantee address\n @param permissions A bitmask representation of the granted permissions\n @param flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)"
             },
             "functionSelector": "811b3d40",
@@ -1609,7 +1609,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "updateFlowOperatorPermissions",
-            "nameLocation": "3115:29:39",
+            "nameLocation": "3123:29:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16125,
@@ -1620,10 +1620,10 @@
                   "id": 16116,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "3171:5:39",
+                  "nameLocation": "3179:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16129,
-                  "src": "3154:22:39",
+                  "src": "3162:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1638,10 +1638,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "3154:16:39"
+                      "src": "3162:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "3154:16:39",
+                    "src": "3162:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -1654,10 +1654,10 @@
                   "id": 16118,
                   "mutability": "mutable",
                   "name": "flowOperator",
-                  "nameLocation": "3194:12:39",
+                  "nameLocation": "3202:12:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16129,
-                  "src": "3186:20:39",
+                  "src": "3194:20:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1668,7 +1668,7 @@
                     "id": 16117,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "3186:7:39",
+                    "src": "3194:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -1682,10 +1682,10 @@
                   "id": 16120,
                   "mutability": "mutable",
                   "name": "permissions",
-                  "nameLocation": "3222:11:39",
+                  "nameLocation": "3230:11:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16129,
-                  "src": "3216:17:39",
+                  "src": "3224:17:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1696,7 +1696,7 @@
                     "id": 16119,
                     "name": "uint8",
                     "nodeType": "ElementaryTypeName",
-                    "src": "3216:5:39",
+                    "src": "3224:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint8",
                       "typeString": "uint8"
@@ -1709,10 +1709,10 @@
                   "id": 16122,
                   "mutability": "mutable",
                   "name": "flowRateAllowance",
-                  "nameLocation": "3249:17:39",
+                  "nameLocation": "3257:17:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16129,
-                  "src": "3243:23:39",
+                  "src": "3251:23:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1723,7 +1723,7 @@
                     "id": 16121,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "3243:5:39",
+                    "src": "3251:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -1736,10 +1736,10 @@
                   "id": 16124,
                   "mutability": "mutable",
                   "name": "ctx",
-                  "nameLocation": "3291:3:39",
+                  "nameLocation": "3299:3:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16129,
-                  "src": "3276:18:39",
+                  "src": "3284:18:39",
                   "stateVariable": false,
                   "storageLocation": "calldata",
                   "typeDescriptions": {
@@ -1750,7 +1750,7 @@
                     "id": 16123,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "3276:5:39",
+                    "src": "3284:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -1759,7 +1759,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "3144:156:39"
+              "src": "3152:156:39"
             },
             "returnParameters": {
               "id": 16128,
@@ -1770,10 +1770,10 @@
                   "id": 16127,
                   "mutability": "mutable",
                   "name": "newCtx",
-                  "nameLocation": "3356:6:39",
+                  "nameLocation": "3364:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16129,
-                  "src": "3343:19:39",
+                  "src": "3351:19:39",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -1784,7 +1784,7 @@
                     "id": 16126,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "3343:5:39",
+                    "src": "3351:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -1793,10 +1793,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "3342:21:39"
+              "src": "3350:21:39"
             },
             "scope": 16383,
-            "src": "3106:258:39",
+            "src": "3114:258:39",
             "stateMutability": "nonpayable",
             "virtual": true,
             "visibility": "external"
@@ -1805,7 +1805,7 @@
             "documentation": {
               "id": 16130,
               "nodeType": "StructuredDocumentation",
-              "src": "3370:295:39",
+              "src": "3378:295:39",
               "text": " @dev msgSender from `ctx` grants `flowOperator` all permissions with flowRateAllowance as type(int96).max\n @param token Super token address\n @param flowOperator The permission grantee address\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)"
             },
             "functionSelector": "54b770e3",
@@ -1814,7 +1814,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "authorizeFlowOperatorWithFullControl",
-            "nameLocation": "3679:36:39",
+            "nameLocation": "3687:36:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16138,
@@ -1825,10 +1825,10 @@
                   "id": 16133,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "3742:5:39",
+                  "nameLocation": "3750:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16142,
-                  "src": "3725:22:39",
+                  "src": "3733:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1843,10 +1843,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "3725:16:39"
+                      "src": "3733:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "3725:16:39",
+                    "src": "3733:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -1859,10 +1859,10 @@
                   "id": 16135,
                   "mutability": "mutable",
                   "name": "flowOperator",
-                  "nameLocation": "3765:12:39",
+                  "nameLocation": "3773:12:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16142,
-                  "src": "3757:20:39",
+                  "src": "3765:20:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1873,7 +1873,7 @@
                     "id": 16134,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "3757:7:39",
+                    "src": "3765:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -1887,10 +1887,10 @@
                   "id": 16137,
                   "mutability": "mutable",
                   "name": "ctx",
-                  "nameLocation": "3802:3:39",
+                  "nameLocation": "3810:3:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16142,
-                  "src": "3787:18:39",
+                  "src": "3795:18:39",
                   "stateVariable": false,
                   "storageLocation": "calldata",
                   "typeDescriptions": {
@@ -1901,7 +1901,7 @@
                     "id": 16136,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "3787:5:39",
+                    "src": "3795:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -1910,7 +1910,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "3715:96:39"
+              "src": "3723:96:39"
             },
             "returnParameters": {
               "id": 16141,
@@ -1921,10 +1921,10 @@
                   "id": 16140,
                   "mutability": "mutable",
                   "name": "newCtx",
-                  "nameLocation": "3866:6:39",
+                  "nameLocation": "3874:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16142,
-                  "src": "3853:19:39",
+                  "src": "3861:19:39",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -1935,7 +1935,7 @@
                     "id": 16139,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "3853:5:39",
+                    "src": "3861:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -1944,10 +1944,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "3852:21:39"
+              "src": "3860:21:39"
             },
             "scope": 16383,
-            "src": "3670:204:39",
+            "src": "3678:204:39",
             "stateMutability": "nonpayable",
             "virtual": true,
             "visibility": "external"
@@ -1956,7 +1956,7 @@
             "documentation": {
               "id": 16143,
               "nodeType": "StructuredDocumentation",
-              "src": "3881:346:39",
+              "src": "3889:346:39",
               "text": " @notice msgSender from `ctx` revokes `flowOperator` create/update/delete permissions\n @dev `permissions` and `flowRateAllowance` will both be set to 0\n @param token Super token address\n @param flowOperator The permission grantee address\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)"
             },
             "functionSelector": "062e56ec",
@@ -1965,7 +1965,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "revokeFlowOperatorWithFullControl",
-            "nameLocation": "4241:33:39",
+            "nameLocation": "4249:33:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16151,
@@ -1976,10 +1976,10 @@
                   "id": 16146,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "4301:5:39",
+                  "nameLocation": "4309:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16155,
-                  "src": "4284:22:39",
+                  "src": "4292:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -1994,10 +1994,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "4284:16:39"
+                      "src": "4292:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "4284:16:39",
+                    "src": "4292:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -2010,10 +2010,10 @@
                   "id": 16148,
                   "mutability": "mutable",
                   "name": "flowOperator",
-                  "nameLocation": "4324:12:39",
+                  "nameLocation": "4332:12:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16155,
-                  "src": "4316:20:39",
+                  "src": "4324:20:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2024,7 +2024,7 @@
                     "id": 16147,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "4316:7:39",
+                    "src": "4324:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -2038,10 +2038,10 @@
                   "id": 16150,
                   "mutability": "mutable",
                   "name": "ctx",
-                  "nameLocation": "4361:3:39",
+                  "nameLocation": "4369:3:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16155,
-                  "src": "4346:18:39",
+                  "src": "4354:18:39",
                   "stateVariable": false,
                   "storageLocation": "calldata",
                   "typeDescriptions": {
@@ -2052,7 +2052,7 @@
                     "id": 16149,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "4346:5:39",
+                    "src": "4354:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -2061,7 +2061,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "4274:96:39"
+              "src": "4282:96:39"
             },
             "returnParameters": {
               "id": 16154,
@@ -2072,10 +2072,10 @@
                   "id": 16153,
                   "mutability": "mutable",
                   "name": "newCtx",
-                  "nameLocation": "4425:6:39",
+                  "nameLocation": "4433:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16155,
-                  "src": "4412:19:39",
+                  "src": "4420:19:39",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -2086,7 +2086,7 @@
                     "id": 16152,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "4412:5:39",
+                    "src": "4420:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -2095,10 +2095,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "4411:21:39"
+              "src": "4419:21:39"
             },
             "scope": 16383,
-            "src": "4232:201:39",
+            "src": "4240:201:39",
             "stateMutability": "nonpayable",
             "virtual": true,
             "visibility": "external"
@@ -2107,7 +2107,7 @@
             "documentation": {
               "id": 16156,
               "nodeType": "StructuredDocumentation",
-              "src": "4439:553:39",
+              "src": "4447:553:39",
               "text": " @notice Get the permissions of a flow operator between `sender` and `flowOperator` for `token`\n @param token Super token address\n @param sender The permission granter address\n @param flowOperator The permission grantee address\n @return flowOperatorId The keccak256 hash of encoded string \"flowOperator\", sender and flowOperator\n @return permissions A bitmask representation of the granted permissions\n @return flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)"
             },
             "functionSelector": "00422bbe",
@@ -2116,7 +2116,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "getFlowOperatorData",
-            "nameLocation": "5006:19:39",
+            "nameLocation": "5014:19:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16164,
@@ -2127,10 +2127,10 @@
                   "id": 16159,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "5051:5:39",
+                  "nameLocation": "5059:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16172,
-                  "src": "5034:22:39",
+                  "src": "5042:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2145,10 +2145,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "5034:16:39"
+                      "src": "5042:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "5034:16:39",
+                    "src": "5042:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -2161,10 +2161,10 @@
                   "id": 16161,
                   "mutability": "mutable",
                   "name": "sender",
-                  "nameLocation": "5073:6:39",
+                  "nameLocation": "5081:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16172,
-                  "src": "5065:14:39",
+                  "src": "5073:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2175,7 +2175,7 @@
                     "id": 16160,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "5065:7:39",
+                    "src": "5073:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -2189,10 +2189,10 @@
                   "id": 16163,
                   "mutability": "mutable",
                   "name": "flowOperator",
-                  "nameLocation": "5096:12:39",
+                  "nameLocation": "5104:12:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16172,
-                  "src": "5088:20:39",
+                  "src": "5096:20:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2203,7 +2203,7 @@
                     "id": 16162,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "5088:7:39",
+                    "src": "5096:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -2213,7 +2213,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "5025:89:39"
+              "src": "5033:89:39"
             },
             "returnParameters": {
               "id": 16171,
@@ -2224,10 +2224,10 @@
                   "id": 16166,
                   "mutability": "mutable",
                   "name": "flowOperatorId",
-                  "nameLocation": "5181:14:39",
+                  "nameLocation": "5189:14:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16172,
-                  "src": "5173:22:39",
+                  "src": "5181:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2238,7 +2238,7 @@
                     "id": 16165,
                     "name": "bytes32",
                     "nodeType": "ElementaryTypeName",
-                    "src": "5173:7:39",
+                    "src": "5181:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes32",
                       "typeString": "bytes32"
@@ -2251,10 +2251,10 @@
                   "id": 16168,
                   "mutability": "mutable",
                   "name": "permissions",
-                  "nameLocation": "5215:11:39",
+                  "nameLocation": "5223:11:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16172,
-                  "src": "5209:17:39",
+                  "src": "5217:17:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2265,7 +2265,7 @@
                     "id": 16167,
                     "name": "uint8",
                     "nodeType": "ElementaryTypeName",
-                    "src": "5209:5:39",
+                    "src": "5217:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint8",
                       "typeString": "uint8"
@@ -2278,10 +2278,10 @@
                   "id": 16170,
                   "mutability": "mutable",
                   "name": "flowRateAllowance",
-                  "nameLocation": "5246:17:39",
+                  "nameLocation": "5254:17:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16172,
-                  "src": "5240:23:39",
+                  "src": "5248:23:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2292,7 +2292,7 @@
                     "id": 16169,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "5240:5:39",
+                    "src": "5248:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -2301,10 +2301,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "5159:114:39"
+              "src": "5167:114:39"
             },
             "scope": 16383,
-            "src": "4997:277:39",
+            "src": "5005:277:39",
             "stateMutability": "view",
             "virtual": true,
             "visibility": "public"
@@ -2313,7 +2313,7 @@
             "documentation": {
               "id": 16173,
               "nodeType": "StructuredDocumentation",
-              "src": "5280:394:39",
+              "src": "5288:394:39",
               "text": " @notice Get flow operator using flowOperatorId\n @param token Super token address\n @param flowOperatorId The keccak256 hash of encoded string \"flowOperator\", sender and flowOperator\n @return permissions A bitmask representation of the granted permissions\n @return flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)"
             },
             "functionSelector": "09d256ef",
@@ -2322,7 +2322,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "getFlowOperatorDataByID",
-            "nameLocation": "5688:23:39",
+            "nameLocation": "5696:23:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16179,
@@ -2333,10 +2333,10 @@
                   "id": 16176,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "5737:5:39",
+                  "nameLocation": "5745:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16185,
-                  "src": "5720:22:39",
+                  "src": "5728:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2351,10 +2351,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "5720:16:39"
+                      "src": "5728:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "5720:16:39",
+                    "src": "5728:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -2367,10 +2367,10 @@
                   "id": 16178,
                   "mutability": "mutable",
                   "name": "flowOperatorId",
-                  "nameLocation": "5759:14:39",
+                  "nameLocation": "5767:14:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16185,
-                  "src": "5751:22:39",
+                  "src": "5759:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2381,7 +2381,7 @@
                     "id": 16177,
                     "name": "bytes32",
                     "nodeType": "ElementaryTypeName",
-                    "src": "5751:7:39",
+                    "src": "5759:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes32",
                       "typeString": "bytes32"
@@ -2390,7 +2390,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "5711:68:39"
+              "src": "5719:68:39"
             },
             "returnParameters": {
               "id": 16184,
@@ -2401,10 +2401,10 @@
                   "id": 16181,
                   "mutability": "mutable",
                   "name": "permissions",
-                  "nameLocation": "5846:11:39",
+                  "nameLocation": "5854:11:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16185,
-                  "src": "5840:17:39",
+                  "src": "5848:17:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2415,7 +2415,7 @@
                     "id": 16180,
                     "name": "uint8",
                     "nodeType": "ElementaryTypeName",
-                    "src": "5840:5:39",
+                    "src": "5848:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint8",
                       "typeString": "uint8"
@@ -2428,10 +2428,10 @@
                   "id": 16183,
                   "mutability": "mutable",
                   "name": "flowRateAllowance",
-                  "nameLocation": "5877:17:39",
+                  "nameLocation": "5885:17:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16185,
-                  "src": "5871:23:39",
+                  "src": "5879:23:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2442,7 +2442,7 @@
                     "id": 16182,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "5871:5:39",
+                    "src": "5879:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -2451,10 +2451,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "5826:78:39"
+              "src": "5834:78:39"
             },
             "scope": 16383,
-            "src": "5679:226:39",
+            "src": "5687:226:39",
             "stateMutability": "view",
             "virtual": true,
             "visibility": "external"
@@ -2463,8 +2463,8 @@
             "documentation": {
               "id": 16186,
               "nodeType": "StructuredDocumentation",
-              "src": "5911:737:39",
-              "text": " @notice Create a flow betwen ctx.msgSender and receiver\n @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n @param token Super token address\n @param receiver Flow receiver address\n @param flowRate New flow rate in amount per second\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n # App callbacks\n - AgreementCreated\n   - agreementId - can be used in getFlowByID\n   - agreementData - abi.encode(address flowSender, address flowReceiver)\n NOTE:\n - A deposit is taken as safety margin for the solvency agents\n - A extra gas fee may be taken to pay for solvency agent liquidations"
+              "src": "5919:741:39",
+              "text": " @notice Create a flow betwen ctx.msgSender and receiver\n @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n @param token Super token address\n @param receiver Flow receiver address\n @param flowRate New flow rate in amount per second\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n @custom:callbacks \n - AgreementCreated\n   - agreementId - can be used in getFlowByID\n   - agreementData - abi.encode(address flowSender, address flowReceiver)\n @custom:note \n - A deposit is taken as safety margin for the solvency agents\n - A extra gas fee may be taken to pay for solvency agent liquidations"
             },
             "functionSelector": "62fc305e",
             "id": 16200,
@@ -2472,7 +2472,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "createFlow",
-            "nameLocation": "6662:10:39",
+            "nameLocation": "6674:10:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16196,
@@ -2483,10 +2483,10 @@
                   "id": 16189,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "6699:5:39",
+                  "nameLocation": "6711:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16200,
-                  "src": "6682:22:39",
+                  "src": "6694:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2501,10 +2501,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "6682:16:39"
+                      "src": "6694:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "6682:16:39",
+                    "src": "6694:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -2517,10 +2517,10 @@
                   "id": 16191,
                   "mutability": "mutable",
                   "name": "receiver",
-                  "nameLocation": "6722:8:39",
+                  "nameLocation": "6734:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16200,
-                  "src": "6714:16:39",
+                  "src": "6726:16:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2531,7 +2531,7 @@
                     "id": 16190,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "6714:7:39",
+                    "src": "6726:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -2545,10 +2545,10 @@
                   "id": 16193,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "6746:8:39",
+                  "nameLocation": "6758:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16200,
-                  "src": "6740:14:39",
+                  "src": "6752:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2559,7 +2559,7 @@
                     "id": 16192,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "6740:5:39",
+                    "src": "6752:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -2572,10 +2572,10 @@
                   "id": 16195,
                   "mutability": "mutable",
                   "name": "ctx",
-                  "nameLocation": "6779:3:39",
+                  "nameLocation": "6791:3:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16200,
-                  "src": "6764:18:39",
+                  "src": "6776:18:39",
                   "stateVariable": false,
                   "storageLocation": "calldata",
                   "typeDescriptions": {
@@ -2586,7 +2586,7 @@
                     "id": 16194,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "6764:5:39",
+                    "src": "6776:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -2595,7 +2595,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "6672:116:39"
+              "src": "6684:116:39"
             },
             "returnParameters": {
               "id": 16199,
@@ -2606,10 +2606,10 @@
                   "id": 16198,
                   "mutability": "mutable",
                   "name": "newCtx",
-                  "nameLocation": "6843:6:39",
+                  "nameLocation": "6855:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16200,
-                  "src": "6830:19:39",
+                  "src": "6842:19:39",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -2620,7 +2620,7 @@
                     "id": 16197,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "6830:5:39",
+                    "src": "6842:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -2629,10 +2629,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "6829:21:39"
+              "src": "6841:21:39"
             },
             "scope": 16383,
-            "src": "6653:198:39",
+            "src": "6665:198:39",
             "stateMutability": "nonpayable",
             "virtual": true,
             "visibility": "external"
@@ -2641,7 +2641,7 @@
             "documentation": {
               "id": 16201,
               "nodeType": "StructuredDocumentation",
-              "src": "6857:436:39",
+              "src": "6869:436:39",
               "text": " @notice Create a flow between sender and receiver\n @dev A flow created by an approved flow operator (see above for details on callbacks)\n @param token Super token address\n @param sender Flow sender address (has granted permissions)\n @param receiver Flow receiver address\n @param flowRate New flow rate in amount per second\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)"
             },
             "functionSelector": "94229ecb",
@@ -2650,7 +2650,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "createFlowByOperator",
-            "nameLocation": "7307:20:39",
+            "nameLocation": "7319:20:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16213,
@@ -2661,10 +2661,10 @@
                   "id": 16204,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "7354:5:39",
+                  "nameLocation": "7366:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16217,
-                  "src": "7337:22:39",
+                  "src": "7349:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2679,10 +2679,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "7337:16:39"
+                      "src": "7349:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "7337:16:39",
+                    "src": "7349:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -2695,10 +2695,10 @@
                   "id": 16206,
                   "mutability": "mutable",
                   "name": "sender",
-                  "nameLocation": "7377:6:39",
+                  "nameLocation": "7389:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16217,
-                  "src": "7369:14:39",
+                  "src": "7381:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2709,7 +2709,7 @@
                     "id": 16205,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "7369:7:39",
+                    "src": "7381:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -2723,10 +2723,10 @@
                   "id": 16208,
                   "mutability": "mutable",
                   "name": "receiver",
-                  "nameLocation": "7401:8:39",
+                  "nameLocation": "7413:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16217,
-                  "src": "7393:16:39",
+                  "src": "7405:16:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2737,7 +2737,7 @@
                     "id": 16207,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "7393:7:39",
+                    "src": "7405:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -2751,10 +2751,10 @@
                   "id": 16210,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "7425:8:39",
+                  "nameLocation": "7437:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16217,
-                  "src": "7419:14:39",
+                  "src": "7431:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2765,7 +2765,7 @@
                     "id": 16209,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "7419:5:39",
+                    "src": "7431:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -2778,10 +2778,10 @@
                   "id": 16212,
                   "mutability": "mutable",
                   "name": "ctx",
-                  "nameLocation": "7458:3:39",
+                  "nameLocation": "7470:3:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16217,
-                  "src": "7443:18:39",
+                  "src": "7455:18:39",
                   "stateVariable": false,
                   "storageLocation": "calldata",
                   "typeDescriptions": {
@@ -2792,7 +2792,7 @@
                     "id": 16211,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "7443:5:39",
+                    "src": "7455:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -2801,7 +2801,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "7327:140:39"
+              "src": "7339:140:39"
             },
             "returnParameters": {
               "id": 16216,
@@ -2812,10 +2812,10 @@
                   "id": 16215,
                   "mutability": "mutable",
                   "name": "newCtx",
-                  "nameLocation": "7522:6:39",
+                  "nameLocation": "7534:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16217,
-                  "src": "7509:19:39",
+                  "src": "7521:19:39",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -2826,7 +2826,7 @@
                     "id": 16214,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "7509:5:39",
+                    "src": "7521:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -2835,10 +2835,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "7508:21:39"
+              "src": "7520:21:39"
             },
             "scope": 16383,
-            "src": "7298:232:39",
+            "src": "7310:232:39",
             "stateMutability": "nonpayable",
             "virtual": true,
             "visibility": "external"
@@ -2847,8 +2847,8 @@
             "documentation": {
               "id": 16218,
               "nodeType": "StructuredDocumentation",
-              "src": "7536:829:39",
-              "text": " @notice Update the flow rate between ctx.msgSender and receiver\n @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n @param token Super token address\n @param receiver Flow receiver address\n @param flowRate New flow rate in amount per second\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n # App callbacks\n - AgreementUpdated\n   - agreementId - can be used in getFlowByID\n   - agreementData - abi.encode(address flowSender, address flowReceiver)\n NOTE:\n - Only the flow sender may update the flow rate\n - Even if the flow rate is zero, the flow is not deleted\n from the system\n - Deposit amount will be adjusted accordingly\n - No new gas fee is charged"
+              "src": "7548:833:39",
+              "text": " @notice Update the flow rate between ctx.msgSender and receiver\n @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n @param token Super token address\n @param receiver Flow receiver address\n @param flowRate New flow rate in amount per second\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n @custom:callbacks \n - AgreementUpdated\n   - agreementId - can be used in getFlowByID\n   - agreementData - abi.encode(address flowSender, address flowReceiver)\n @custom:note \n - Only the flow sender may update the flow rate\n - Even if the flow rate is zero, the flow is not deleted\n from the system\n - Deposit amount will be adjusted accordingly\n - No new gas fee is charged"
             },
             "functionSelector": "50209a62",
             "id": 16232,
@@ -2856,7 +2856,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "updateFlow",
-            "nameLocation": "8379:10:39",
+            "nameLocation": "8395:10:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16228,
@@ -2867,10 +2867,10 @@
                   "id": 16221,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "8416:5:39",
+                  "nameLocation": "8432:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16232,
-                  "src": "8399:22:39",
+                  "src": "8415:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2885,10 +2885,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "8399:16:39"
+                      "src": "8415:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "8399:16:39",
+                    "src": "8415:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -2901,10 +2901,10 @@
                   "id": 16223,
                   "mutability": "mutable",
                   "name": "receiver",
-                  "nameLocation": "8439:8:39",
+                  "nameLocation": "8455:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16232,
-                  "src": "8431:16:39",
+                  "src": "8447:16:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2915,7 +2915,7 @@
                     "id": 16222,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "8431:7:39",
+                    "src": "8447:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -2929,10 +2929,10 @@
                   "id": 16225,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "8463:8:39",
+                  "nameLocation": "8479:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16232,
-                  "src": "8457:14:39",
+                  "src": "8473:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -2943,7 +2943,7 @@
                     "id": 16224,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "8457:5:39",
+                    "src": "8473:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -2956,10 +2956,10 @@
                   "id": 16227,
                   "mutability": "mutable",
                   "name": "ctx",
-                  "nameLocation": "8496:3:39",
+                  "nameLocation": "8512:3:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16232,
-                  "src": "8481:18:39",
+                  "src": "8497:18:39",
                   "stateVariable": false,
                   "storageLocation": "calldata",
                   "typeDescriptions": {
@@ -2970,7 +2970,7 @@
                     "id": 16226,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "8481:5:39",
+                    "src": "8497:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -2979,7 +2979,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "8389:116:39"
+              "src": "8405:116:39"
             },
             "returnParameters": {
               "id": 16231,
@@ -2990,10 +2990,10 @@
                   "id": 16230,
                   "mutability": "mutable",
                   "name": "newCtx",
-                  "nameLocation": "8560:6:39",
+                  "nameLocation": "8576:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16232,
-                  "src": "8547:19:39",
+                  "src": "8563:19:39",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -3004,7 +3004,7 @@
                     "id": 16229,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "8547:5:39",
+                    "src": "8563:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -3013,10 +3013,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "8546:21:39"
+              "src": "8562:21:39"
             },
             "scope": 16383,
-            "src": "8370:198:39",
+            "src": "8386:198:39",
             "stateMutability": "nonpayable",
             "virtual": true,
             "visibility": "external"
@@ -3025,7 +3025,7 @@
             "documentation": {
               "id": 16233,
               "nodeType": "StructuredDocumentation",
-              "src": "8574:436:39",
+              "src": "8590:436:39",
               "text": " @notice Update a flow between sender and receiver\n @dev A flow updated by an approved flow operator (see above for details on callbacks)\n @param token Super token address\n @param sender Flow sender address (has granted permissions)\n @param receiver Flow receiver address\n @param flowRate New flow rate in amount per second\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)"
             },
             "functionSelector": "354b9590",
@@ -3034,7 +3034,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "updateFlowByOperator",
-            "nameLocation": "9024:20:39",
+            "nameLocation": "9040:20:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16245,
@@ -3045,10 +3045,10 @@
                   "id": 16236,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "9071:5:39",
+                  "nameLocation": "9087:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16249,
-                  "src": "9054:22:39",
+                  "src": "9070:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3063,10 +3063,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "9054:16:39"
+                      "src": "9070:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "9054:16:39",
+                    "src": "9070:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -3079,10 +3079,10 @@
                   "id": 16238,
                   "mutability": "mutable",
                   "name": "sender",
-                  "nameLocation": "9094:6:39",
+                  "nameLocation": "9110:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16249,
-                  "src": "9086:14:39",
+                  "src": "9102:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3093,7 +3093,7 @@
                     "id": 16237,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9086:7:39",
+                    "src": "9102:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -3107,10 +3107,10 @@
                   "id": 16240,
                   "mutability": "mutable",
                   "name": "receiver",
-                  "nameLocation": "9118:8:39",
+                  "nameLocation": "9134:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16249,
-                  "src": "9110:16:39",
+                  "src": "9126:16:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3121,7 +3121,7 @@
                     "id": 16239,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9110:7:39",
+                    "src": "9126:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -3135,10 +3135,10 @@
                   "id": 16242,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "9142:8:39",
+                  "nameLocation": "9158:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16249,
-                  "src": "9136:14:39",
+                  "src": "9152:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3149,7 +3149,7 @@
                     "id": 16241,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9136:5:39",
+                    "src": "9152:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -3162,10 +3162,10 @@
                   "id": 16244,
                   "mutability": "mutable",
                   "name": "ctx",
-                  "nameLocation": "9175:3:39",
+                  "nameLocation": "9191:3:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16249,
-                  "src": "9160:18:39",
+                  "src": "9176:18:39",
                   "stateVariable": false,
                   "storageLocation": "calldata",
                   "typeDescriptions": {
@@ -3176,7 +3176,7 @@
                     "id": 16243,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9160:5:39",
+                    "src": "9176:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -3185,7 +3185,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "9044:140:39"
+              "src": "9060:140:39"
             },
             "returnParameters": {
               "id": 16248,
@@ -3196,10 +3196,10 @@
                   "id": 16247,
                   "mutability": "mutable",
                   "name": "newCtx",
-                  "nameLocation": "9239:6:39",
+                  "nameLocation": "9255:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16249,
-                  "src": "9226:19:39",
+                  "src": "9242:19:39",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -3210,7 +3210,7 @@
                     "id": 16246,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9226:5:39",
+                    "src": "9242:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -3219,10 +3219,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "9225:21:39"
+              "src": "9241:21:39"
             },
             "scope": 16383,
-            "src": "9015:232:39",
+            "src": "9031:232:39",
             "stateMutability": "nonpayable",
             "virtual": true,
             "visibility": "external"
@@ -3231,7 +3231,7 @@
             "documentation": {
               "id": 16250,
               "nodeType": "StructuredDocumentation",
-              "src": "9253:415:39",
+              "src": "9269:415:39",
               "text": " @dev Get the flow data between `sender` and `receiver` of `token`\n @param token Super token address\n @param sender Flow receiver\n @param receiver Flow sender\n @return timestamp Timestamp of when the flow is updated\n @return flowRate The flow rate\n @return deposit The amount of deposit the flow\n @return owedDeposit The amount of owed deposit of the flow"
             },
             "functionSelector": "e6a1e888",
@@ -3240,7 +3240,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "getFlow",
-            "nameLocation": "9682:7:39",
+            "nameLocation": "9698:7:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16258,
@@ -3251,10 +3251,10 @@
                   "id": 16253,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "9716:5:39",
+                  "nameLocation": "9732:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16268,
-                  "src": "9699:22:39",
+                  "src": "9715:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3269,10 +3269,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "9699:16:39"
+                      "src": "9715:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "9699:16:39",
+                    "src": "9715:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -3285,10 +3285,10 @@
                   "id": 16255,
                   "mutability": "mutable",
                   "name": "sender",
-                  "nameLocation": "9739:6:39",
+                  "nameLocation": "9755:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16268,
-                  "src": "9731:14:39",
+                  "src": "9747:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3299,7 +3299,7 @@
                     "id": 16254,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9731:7:39",
+                    "src": "9747:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -3313,10 +3313,10 @@
                   "id": 16257,
                   "mutability": "mutable",
                   "name": "receiver",
-                  "nameLocation": "9763:8:39",
+                  "nameLocation": "9779:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16268,
-                  "src": "9755:16:39",
+                  "src": "9771:16:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3327,7 +3327,7 @@
                     "id": 16256,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9755:7:39",
+                    "src": "9771:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -3337,7 +3337,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "9689:88:39"
+              "src": "9705:88:39"
             },
             "returnParameters": {
               "id": 16267,
@@ -3348,10 +3348,10 @@
                   "id": 16260,
                   "mutability": "mutable",
                   "name": "timestamp",
-                  "nameLocation": "9846:9:39",
+                  "nameLocation": "9862:9:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16268,
-                  "src": "9838:17:39",
+                  "src": "9854:17:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3362,7 +3362,7 @@
                     "id": 16259,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9838:7:39",
+                    "src": "9854:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -3375,10 +3375,10 @@
                   "id": 16262,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "9875:8:39",
+                  "nameLocation": "9891:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16268,
-                  "src": "9869:14:39",
+                  "src": "9885:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3389,7 +3389,7 @@
                     "id": 16261,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9869:5:39",
+                    "src": "9885:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -3402,10 +3402,10 @@
                   "id": 16264,
                   "mutability": "mutable",
                   "name": "deposit",
-                  "nameLocation": "9905:7:39",
+                  "nameLocation": "9921:7:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16268,
-                  "src": "9897:15:39",
+                  "src": "9913:15:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3416,7 +3416,7 @@
                     "id": 16263,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9897:7:39",
+                    "src": "9913:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -3429,10 +3429,10 @@
                   "id": 16266,
                   "mutability": "mutable",
                   "name": "owedDeposit",
-                  "nameLocation": "9934:11:39",
+                  "nameLocation": "9950:11:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16268,
-                  "src": "9926:19:39",
+                  "src": "9942:19:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3443,7 +3443,7 @@
                     "id": 16265,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "9926:7:39",
+                    "src": "9942:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -3452,10 +3452,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "9824:131:39"
+              "src": "9840:131:39"
             },
             "scope": 16383,
-            "src": "9673:283:39",
+            "src": "9689:283:39",
             "stateMutability": "view",
             "virtual": true,
             "visibility": "external"
@@ -3464,7 +3464,7 @@
             "documentation": {
               "id": 16269,
               "nodeType": "StructuredDocumentation",
-              "src": "9962:445:39",
+              "src": "9978:445:39",
               "text": " @notice Get flow data using agreementId\n @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n @param token Super token address\n @param agreementId The agreement ID\n @return timestamp Timestamp of when the flow is updated\n @return flowRate The flow rate\n @return deposit The deposit amount of the flow\n @return owedDeposit The owed deposit amount of the flow"
             },
             "functionSelector": "aabd2668",
@@ -3473,7 +3473,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "getFlowByID",
-            "nameLocation": "10421:11:39",
+            "nameLocation": "10437:11:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16275,
@@ -3484,10 +3484,10 @@
                   "id": 16272,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "10458:5:39",
+                  "nameLocation": "10474:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16285,
-                  "src": "10441:22:39",
+                  "src": "10457:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3502,10 +3502,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "10441:16:39"
+                      "src": "10457:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "10441:16:39",
+                    "src": "10457:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -3518,10 +3518,10 @@
                   "id": 16274,
                   "mutability": "mutable",
                   "name": "agreementId",
-                  "nameLocation": "10480:11:39",
+                  "nameLocation": "10496:11:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16285,
-                  "src": "10472:19:39",
+                  "src": "10488:19:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3532,7 +3532,7 @@
                     "id": 16273,
                     "name": "bytes32",
                     "nodeType": "ElementaryTypeName",
-                    "src": "10472:7:39",
+                    "src": "10488:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes32",
                       "typeString": "bytes32"
@@ -3541,7 +3541,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "10432:65:39"
+              "src": "10448:65:39"
             },
             "returnParameters": {
               "id": 16284,
@@ -3552,10 +3552,10 @@
                   "id": 16277,
                   "mutability": "mutable",
                   "name": "timestamp",
-                  "nameLocation": "10566:9:39",
+                  "nameLocation": "10582:9:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16285,
-                  "src": "10558:17:39",
+                  "src": "10574:17:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3566,7 +3566,7 @@
                     "id": 16276,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "10558:7:39",
+                    "src": "10574:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -3579,10 +3579,10 @@
                   "id": 16279,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "10595:8:39",
+                  "nameLocation": "10611:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16285,
-                  "src": "10589:14:39",
+                  "src": "10605:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3593,7 +3593,7 @@
                     "id": 16278,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "10589:5:39",
+                    "src": "10605:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -3606,10 +3606,10 @@
                   "id": 16281,
                   "mutability": "mutable",
                   "name": "deposit",
-                  "nameLocation": "10625:7:39",
+                  "nameLocation": "10641:7:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16285,
-                  "src": "10617:15:39",
+                  "src": "10633:15:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3620,7 +3620,7 @@
                     "id": 16280,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "10617:7:39",
+                    "src": "10633:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -3633,10 +3633,10 @@
                   "id": 16283,
                   "mutability": "mutable",
                   "name": "owedDeposit",
-                  "nameLocation": "10654:11:39",
+                  "nameLocation": "10670:11:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16285,
-                  "src": "10646:19:39",
+                  "src": "10662:19:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3647,7 +3647,7 @@
                     "id": 16282,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "10646:7:39",
+                    "src": "10662:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -3656,10 +3656,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "10544:131:39"
+              "src": "10560:131:39"
             },
             "scope": 16383,
-            "src": "10412:264:39",
+            "src": "10428:264:39",
             "stateMutability": "view",
             "virtual": true,
             "visibility": "external"
@@ -3668,7 +3668,7 @@
             "documentation": {
               "id": 16286,
               "nodeType": "StructuredDocumentation",
-              "src": "10682:436:39",
+              "src": "10698:436:39",
               "text": " @dev Get the aggregated flow info of the account\n @param token Super token address\n @param account Account for the query\n @return timestamp Timestamp of when a flow was last updated for account\n @return flowRate The net flow rate of token for account\n @return deposit The sum of all deposits for account's flows\n @return owedDeposit The sum of all owed deposits for account's flows"
             },
             "functionSelector": "0f1ac495",
@@ -3677,7 +3677,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "getAccountFlowInfo",
-            "nameLocation": "11132:18:39",
+            "nameLocation": "11148:18:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16292,
@@ -3688,10 +3688,10 @@
                   "id": 16289,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "11177:5:39",
+                  "nameLocation": "11193:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16302,
-                  "src": "11160:22:39",
+                  "src": "11176:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3706,10 +3706,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "11160:16:39"
+                      "src": "11176:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "11160:16:39",
+                    "src": "11176:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -3722,10 +3722,10 @@
                   "id": 16291,
                   "mutability": "mutable",
                   "name": "account",
-                  "nameLocation": "11200:7:39",
+                  "nameLocation": "11216:7:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16302,
-                  "src": "11192:15:39",
+                  "src": "11208:15:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3736,7 +3736,7 @@
                     "id": 16290,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "11192:7:39",
+                    "src": "11208:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -3746,7 +3746,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "11150:63:39"
+              "src": "11166:63:39"
             },
             "returnParameters": {
               "id": 16301,
@@ -3757,10 +3757,10 @@
                   "id": 16294,
                   "mutability": "mutable",
                   "name": "timestamp",
-                  "nameLocation": "11282:9:39",
+                  "nameLocation": "11298:9:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16302,
-                  "src": "11274:17:39",
+                  "src": "11290:17:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3771,7 +3771,7 @@
                     "id": 16293,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "11274:7:39",
+                    "src": "11290:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -3784,10 +3784,10 @@
                   "id": 16296,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "11311:8:39",
+                  "nameLocation": "11327:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16302,
-                  "src": "11305:14:39",
+                  "src": "11321:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3798,7 +3798,7 @@
                     "id": 16295,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "11305:5:39",
+                    "src": "11321:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -3811,10 +3811,10 @@
                   "id": 16298,
                   "mutability": "mutable",
                   "name": "deposit",
-                  "nameLocation": "11341:7:39",
+                  "nameLocation": "11357:7:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16302,
-                  "src": "11333:15:39",
+                  "src": "11349:15:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3825,7 +3825,7 @@
                     "id": 16297,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "11333:7:39",
+                    "src": "11349:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -3838,10 +3838,10 @@
                   "id": 16300,
                   "mutability": "mutable",
                   "name": "owedDeposit",
-                  "nameLocation": "11370:11:39",
+                  "nameLocation": "11386:11:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16302,
-                  "src": "11362:19:39",
+                  "src": "11378:19:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3852,7 +3852,7 @@
                     "id": 16299,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "11362:7:39",
+                    "src": "11378:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -3861,10 +3861,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "11260:122:39"
+              "src": "11276:122:39"
             },
             "scope": 16383,
-            "src": "11123:260:39",
+            "src": "11139:260:39",
             "stateMutability": "view",
             "virtual": true,
             "visibility": "external"
@@ -3873,7 +3873,7 @@
             "documentation": {
               "id": 16303,
               "nodeType": "StructuredDocumentation",
-              "src": "11389:182:39",
+              "src": "11405:182:39",
               "text": " @dev Get the net flow rate of the account\n @param token Super token address\n @param account Account for the query\n @return flowRate Net flow rate"
             },
             "functionSelector": "e8e7e2d1",
@@ -3882,7 +3882,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "getNetFlow",
-            "nameLocation": "11585:10:39",
+            "nameLocation": "11601:10:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16309,
@@ -3893,10 +3893,10 @@
                   "id": 16306,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "11622:5:39",
+                  "nameLocation": "11638:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16313,
-                  "src": "11605:22:39",
+                  "src": "11621:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3911,10 +3911,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "11605:16:39"
+                      "src": "11621:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "11605:16:39",
+                    "src": "11621:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -3927,10 +3927,10 @@
                   "id": 16308,
                   "mutability": "mutable",
                   "name": "account",
-                  "nameLocation": "11645:7:39",
+                  "nameLocation": "11661:7:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16313,
-                  "src": "11637:15:39",
+                  "src": "11653:15:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3941,7 +3941,7 @@
                     "id": 16307,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "11637:7:39",
+                    "src": "11653:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -3951,7 +3951,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "11595:63:39"
+              "src": "11611:63:39"
             },
             "returnParameters": {
               "id": 16312,
@@ -3962,10 +3962,10 @@
                   "id": 16311,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "11712:8:39",
+                  "nameLocation": "11728:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16313,
-                  "src": "11706:14:39",
+                  "src": "11722:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -3976,7 +3976,7 @@
                     "id": 16310,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "11706:5:39",
+                    "src": "11722:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -3985,10 +3985,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "11705:16:39"
+              "src": "11721:16:39"
             },
             "scope": 16383,
-            "src": "11576:146:39",
+            "src": "11592:146:39",
             "stateMutability": "view",
             "virtual": true,
             "visibility": "external"
@@ -3997,8 +3997,8 @@
             "documentation": {
               "id": 16314,
               "nodeType": "StructuredDocumentation",
-              "src": "11728:759:39",
-              "text": " @notice Delete the flow between sender and receiver\n @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n @param token Super token address\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n @param receiver Flow receiver address\n # App callbacks\n - AgreementTerminated\n   - agreementId - can be used in getFlowByID\n   - agreementData - abi.encode(address flowSender, address flowReceiver)\n NOTE:\n - Both flow sender and receiver may delete the flow\n - If Sender account is insolvent or in critical state, a solvency agent may\n   also terminate the agreement\n - Gas fee may be returned to the sender"
+              "src": "11744:763:39",
+              "text": " @notice Delete the flow between sender and receiver\n @dev flowId (agreementId) is the keccak256 hash of encoded sender and receiver\n @param token Super token address\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n @param receiver Flow receiver address\n @custom:callbacks \n - AgreementTerminated\n   - agreementId - can be used in getFlowByID\n   - agreementData - abi.encode(address flowSender, address flowReceiver)\n @custom:note \n - Both flow sender and receiver may delete the flow\n - If Sender account is insolvent or in critical state, a solvency agent may\n   also terminate the agreement\n - Gas fee may be returned to the sender"
             },
             "functionSelector": "b4b333c6",
             "id": 16328,
@@ -4006,7 +4006,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "deleteFlow",
-            "nameLocation": "12501:10:39",
+            "nameLocation": "12521:10:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16324,
@@ -4017,10 +4017,10 @@
                   "id": 16317,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "12538:5:39",
+                  "nameLocation": "12558:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16328,
-                  "src": "12521:22:39",
+                  "src": "12541:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4035,10 +4035,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "12521:16:39"
+                      "src": "12541:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "12521:16:39",
+                    "src": "12541:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -4051,10 +4051,10 @@
                   "id": 16319,
                   "mutability": "mutable",
                   "name": "sender",
-                  "nameLocation": "12561:6:39",
+                  "nameLocation": "12581:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16328,
-                  "src": "12553:14:39",
+                  "src": "12573:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4065,7 +4065,7 @@
                     "id": 16318,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "12553:7:39",
+                    "src": "12573:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -4079,10 +4079,10 @@
                   "id": 16321,
                   "mutability": "mutable",
                   "name": "receiver",
-                  "nameLocation": "12585:8:39",
+                  "nameLocation": "12605:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16328,
-                  "src": "12577:16:39",
+                  "src": "12597:16:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4093,7 +4093,7 @@
                     "id": 16320,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "12577:7:39",
+                    "src": "12597:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -4107,10 +4107,10 @@
                   "id": 16323,
                   "mutability": "mutable",
                   "name": "ctx",
-                  "nameLocation": "12618:3:39",
+                  "nameLocation": "12638:3:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16328,
-                  "src": "12603:18:39",
+                  "src": "12623:18:39",
                   "stateVariable": false,
                   "storageLocation": "calldata",
                   "typeDescriptions": {
@@ -4121,7 +4121,7 @@
                     "id": 16322,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "12603:5:39",
+                    "src": "12623:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -4130,7 +4130,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "12511:116:39"
+              "src": "12531:116:39"
             },
             "returnParameters": {
               "id": 16327,
@@ -4141,10 +4141,10 @@
                   "id": 16326,
                   "mutability": "mutable",
                   "name": "newCtx",
-                  "nameLocation": "12682:6:39",
+                  "nameLocation": "12702:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16328,
-                  "src": "12669:19:39",
+                  "src": "12689:19:39",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -4155,7 +4155,7 @@
                     "id": 16325,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "12669:5:39",
+                    "src": "12689:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -4164,10 +4164,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "12668:21:39"
+              "src": "12688:21:39"
             },
             "scope": 16383,
-            "src": "12492:198:39",
+            "src": "12512:198:39",
             "stateMutability": "nonpayable",
             "virtual": true,
             "visibility": "external"
@@ -4176,7 +4176,7 @@
             "documentation": {
               "id": 16329,
               "nodeType": "StructuredDocumentation",
-              "src": "12696:321:39",
+              "src": "12716:321:39",
               "text": " @notice Delete the flow between sender and receiver\n @dev A flow deleted by an approved flow operator (see above for details on callbacks)\n @param token Super token address\n @param ctx Context bytes (see ISuperfluid.sol for Context struct)\n @param receiver Flow receiver address"
             },
             "functionSelector": "4c8b181f",
@@ -4185,7 +4185,7 @@
             "kind": "function",
             "modifiers": [],
             "name": "deleteFlowByOperator",
-            "nameLocation": "13031:20:39",
+            "nameLocation": "13051:20:39",
             "nodeType": "FunctionDefinition",
             "parameters": {
               "id": 16339,
@@ -4196,10 +4196,10 @@
                   "id": 16332,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "13078:5:39",
+                  "nameLocation": "13098:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16343,
-                  "src": "13061:22:39",
+                  "src": "13081:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4214,10 +4214,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "13061:16:39"
+                      "src": "13081:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "13061:16:39",
+                    "src": "13081:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -4230,10 +4230,10 @@
                   "id": 16334,
                   "mutability": "mutable",
                   "name": "sender",
-                  "nameLocation": "13101:6:39",
+                  "nameLocation": "13121:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16343,
-                  "src": "13093:14:39",
+                  "src": "13113:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4244,7 +4244,7 @@
                     "id": 16333,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "13093:7:39",
+                    "src": "13113:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -4258,10 +4258,10 @@
                   "id": 16336,
                   "mutability": "mutable",
                   "name": "receiver",
-                  "nameLocation": "13125:8:39",
+                  "nameLocation": "13145:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16343,
-                  "src": "13117:16:39",
+                  "src": "13137:16:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4272,7 +4272,7 @@
                     "id": 16335,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "13117:7:39",
+                    "src": "13137:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -4286,10 +4286,10 @@
                   "id": 16338,
                   "mutability": "mutable",
                   "name": "ctx",
-                  "nameLocation": "13158:3:39",
+                  "nameLocation": "13178:3:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16343,
-                  "src": "13143:18:39",
+                  "src": "13163:18:39",
                   "stateVariable": false,
                   "storageLocation": "calldata",
                   "typeDescriptions": {
@@ -4300,7 +4300,7 @@
                     "id": 16337,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "13143:5:39",
+                    "src": "13163:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -4309,7 +4309,7 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "13051:116:39"
+              "src": "13071:116:39"
             },
             "returnParameters": {
               "id": 16342,
@@ -4320,10 +4320,10 @@
                   "id": 16341,
                   "mutability": "mutable",
                   "name": "newCtx",
-                  "nameLocation": "13222:6:39",
+                  "nameLocation": "13242:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16343,
-                  "src": "13209:19:39",
+                  "src": "13229:19:39",
                   "stateVariable": false,
                   "storageLocation": "memory",
                   "typeDescriptions": {
@@ -4334,7 +4334,7 @@
                     "id": 16340,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "13209:5:39",
+                    "src": "13229:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -4343,10 +4343,10 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "13208:21:39"
+              "src": "13228:21:39"
             },
             "scope": 16383,
-            "src": "13022:208:39",
+            "src": "13042:208:39",
             "stateMutability": "nonpayable",
             "virtual": true,
             "visibility": "external"
@@ -4356,13 +4356,13 @@
             "documentation": {
               "id": 16344,
               "nodeType": "StructuredDocumentation",
-              "src": "13241:353:39",
+              "src": "13261:353:39",
               "text": " @dev Flow operator updated event\n @param token Super token address\n @param sender Flow sender address\n @param flowOperator Flow operator address\n @param permissions Octo bitmask representation of permissions\n @param flowRateAllowance The flow rate allowance the `flowOperator` is granted (only goes down)"
             },
             "eventSelector": "c0d5d3a6ac18cc1769788c925e6e7fc89cd47e4270a42884736fa9b3ec09f3a8",
             "id": 16357,
             "name": "FlowOperatorUpdated",
-            "nameLocation": "13605:19:39",
+            "nameLocation": "13625:19:39",
             "nodeType": "EventDefinition",
             "parameters": {
               "id": 16356,
@@ -4374,10 +4374,10 @@
                   "indexed": true,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "13659:5:39",
+                  "nameLocation": "13679:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16357,
-                  "src": "13634:30:39",
+                  "src": "13654:30:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4392,10 +4392,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "13634:16:39"
+                      "src": "13654:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "13634:16:39",
+                    "src": "13654:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -4409,10 +4409,10 @@
                   "indexed": true,
                   "mutability": "mutable",
                   "name": "sender",
-                  "nameLocation": "13690:6:39",
+                  "nameLocation": "13710:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16357,
-                  "src": "13674:22:39",
+                  "src": "13694:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4423,7 +4423,7 @@
                     "id": 16348,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "13674:7:39",
+                    "src": "13694:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -4438,10 +4438,10 @@
                   "indexed": true,
                   "mutability": "mutable",
                   "name": "flowOperator",
-                  "nameLocation": "13722:12:39",
+                  "nameLocation": "13742:12:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16357,
-                  "src": "13706:28:39",
+                  "src": "13726:28:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4452,7 +4452,7 @@
                     "id": 16350,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "13706:7:39",
+                    "src": "13726:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -4467,10 +4467,10 @@
                   "indexed": false,
                   "mutability": "mutable",
                   "name": "permissions",
-                  "nameLocation": "13750:11:39",
+                  "nameLocation": "13770:11:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16357,
-                  "src": "13744:17:39",
+                  "src": "13764:17:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4481,7 +4481,7 @@
                     "id": 16352,
                     "name": "uint8",
                     "nodeType": "ElementaryTypeName",
-                    "src": "13744:5:39",
+                    "src": "13764:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint8",
                       "typeString": "uint8"
@@ -4495,10 +4495,10 @@
                   "indexed": false,
                   "mutability": "mutable",
                   "name": "flowRateAllowance",
-                  "nameLocation": "13777:17:39",
+                  "nameLocation": "13797:17:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16357,
-                  "src": "13771:23:39",
+                  "src": "13791:23:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4509,7 +4509,7 @@
                     "id": 16354,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "13771:5:39",
+                    "src": "13791:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -4518,22 +4518,22 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "13624:176:39"
+              "src": "13644:176:39"
             },
-            "src": "13599:202:39"
+            "src": "13619:202:39"
           },
           {
             "anonymous": false,
             "documentation": {
               "id": 16358,
               "nodeType": "StructuredDocumentation",
-              "src": "13807:466:39",
+              "src": "13827:466:39",
               "text": " @dev Flow updated event\n @param token Super token address\n @param sender Flow sender address\n @param receiver Flow recipient address\n @param flowRate Flow rate in amount per second for this flow\n @param totalSenderFlowRate Total flow rate in amount per second for the sender\n @param totalReceiverFlowRate Total flow rate in amount per second for the receiver\n @param userData The user provided data"
             },
             "eventSelector": "57269d2ebcccecdcc0d9d2c0a0b80ead95f344e28ec20f50f709811f209d4e0e",
             "id": 16375,
             "name": "FlowUpdated",
-            "nameLocation": "14284:11:39",
+            "nameLocation": "14304:11:39",
             "nodeType": "EventDefinition",
             "parameters": {
               "id": 16374,
@@ -4545,10 +4545,10 @@
                   "indexed": true,
                   "mutability": "mutable",
                   "name": "token",
-                  "nameLocation": "14330:5:39",
+                  "nameLocation": "14350:5:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16375,
-                  "src": "14305:30:39",
+                  "src": "14325:30:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4563,10 +4563,10 @@
                       "name": "ISuperfluidToken",
                       "nodeType": "IdentifierPath",
                       "referencedDeclaration": 18721,
-                      "src": "14305:16:39"
+                      "src": "14325:16:39"
                     },
                     "referencedDeclaration": 18721,
-                    "src": "14305:16:39",
+                    "src": "14325:16:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_contract$_ISuperfluidToken_$18721",
                       "typeString": "contract ISuperfluidToken"
@@ -4580,10 +4580,10 @@
                   "indexed": true,
                   "mutability": "mutable",
                   "name": "sender",
-                  "nameLocation": "14361:6:39",
+                  "nameLocation": "14381:6:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16375,
-                  "src": "14345:22:39",
+                  "src": "14365:22:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4594,7 +4594,7 @@
                     "id": 16362,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "14345:7:39",
+                    "src": "14365:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -4609,10 +4609,10 @@
                   "indexed": true,
                   "mutability": "mutable",
                   "name": "receiver",
-                  "nameLocation": "14393:8:39",
+                  "nameLocation": "14413:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16375,
-                  "src": "14377:24:39",
+                  "src": "14397:24:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4623,7 +4623,7 @@
                     "id": 16364,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "14377:7:39",
+                    "src": "14397:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -4638,10 +4638,10 @@
                   "indexed": false,
                   "mutability": "mutable",
                   "name": "flowRate",
-                  "nameLocation": "14417:8:39",
+                  "nameLocation": "14437:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16375,
-                  "src": "14411:14:39",
+                  "src": "14431:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4652,7 +4652,7 @@
                     "id": 16366,
                     "name": "int96",
                     "nodeType": "ElementaryTypeName",
-                    "src": "14411:5:39",
+                    "src": "14431:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int96",
                       "typeString": "int96"
@@ -4666,10 +4666,10 @@
                   "indexed": false,
                   "mutability": "mutable",
                   "name": "totalSenderFlowRate",
-                  "nameLocation": "14442:19:39",
+                  "nameLocation": "14462:19:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16375,
-                  "src": "14435:26:39",
+                  "src": "14455:26:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4680,7 +4680,7 @@
                     "id": 16368,
                     "name": "int256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "14435:6:39",
+                    "src": "14455:6:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int256",
                       "typeString": "int256"
@@ -4694,10 +4694,10 @@
                   "indexed": false,
                   "mutability": "mutable",
                   "name": "totalReceiverFlowRate",
-                  "nameLocation": "14478:21:39",
+                  "nameLocation": "14498:21:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16375,
-                  "src": "14471:28:39",
+                  "src": "14491:28:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4708,7 +4708,7 @@
                     "id": 16370,
                     "name": "int256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "14471:6:39",
+                    "src": "14491:6:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_int256",
                       "typeString": "int256"
@@ -4722,10 +4722,10 @@
                   "indexed": false,
                   "mutability": "mutable",
                   "name": "userData",
-                  "nameLocation": "14515:8:39",
+                  "nameLocation": "14535:8:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16375,
-                  "src": "14509:14:39",
+                  "src": "14529:14:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4736,7 +4736,7 @@
                     "id": 16372,
                     "name": "bytes",
                     "nodeType": "ElementaryTypeName",
-                    "src": "14509:5:39",
+                    "src": "14529:5:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_bytes_storage_ptr",
                       "typeString": "bytes"
@@ -4745,22 +4745,22 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "14295:234:39"
+              "src": "14315:234:39"
             },
-            "src": "14278:252:39"
+            "src": "14298:252:39"
           },
           {
             "anonymous": false,
             "documentation": {
               "id": 16376,
               "nodeType": "StructuredDocumentation",
-              "src": "14536:181:39",
+              "src": "14556:181:39",
               "text": " @dev Flow updated extension event\n @param flowOperator Flow operator address - the Context.msgSender\n @param deposit The deposit amount for the stream"
             },
             "eventSelector": "71e0c98e270fc3084227b473f176924d5303ece8c639e679998a2d7dc8e70f74",
             "id": 16382,
             "name": "FlowUpdatedExtension",
-            "nameLocation": "14728:20:39",
+            "nameLocation": "14748:20:39",
             "nodeType": "EventDefinition",
             "parameters": {
               "id": 16381,
@@ -4772,10 +4772,10 @@
                   "indexed": true,
                   "mutability": "mutable",
                   "name": "flowOperator",
-                  "nameLocation": "14774:12:39",
+                  "nameLocation": "14794:12:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16382,
-                  "src": "14758:28:39",
+                  "src": "14778:28:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4786,7 +4786,7 @@
                     "id": 16377,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
-                    "src": "14758:7:39",
+                    "src": "14778:7:39",
                     "stateMutability": "nonpayable",
                     "typeDescriptions": {
                       "typeIdentifier": "t_address",
@@ -4801,10 +4801,10 @@
                   "indexed": false,
                   "mutability": "mutable",
                   "name": "deposit",
-                  "nameLocation": "14804:7:39",
+                  "nameLocation": "14824:7:39",
                   "nodeType": "VariableDeclaration",
                   "scope": 16382,
-                  "src": "14796:15:39",
+                  "src": "14816:15:39",
                   "stateVariable": false,
                   "storageLocation": "default",
                   "typeDescriptions": {
@@ -4815,7 +4815,7 @@
                     "id": 16379,
                     "name": "uint256",
                     "nodeType": "ElementaryTypeName",
-                    "src": "14796:7:39",
+                    "src": "14816:7:39",
                     "typeDescriptions": {
                       "typeIdentifier": "t_uint256",
                       "typeString": "uint256"
@@ -4824,25 +4824,25 @@
                   "visibility": "internal"
                 }
               ],
-              "src": "14748:69:39"
+              "src": "14768:69:39"
             },
-            "src": "14722:96:39"
+            "src": "14742:96:39"
           }
         ],
         "scope": 16384,
-        "src": "278:14542:39",
+        "src": "278:14562:39",
         "usedErrors": []
       }
     ],
-    "src": "35:14786:39"
+    "src": "35:14806:39"
   },
   "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:13.975Z",
+  "updatedAt": "2022-06-16T09:19:12.145Z",
   "devdoc": {
     "author": "Superfluid",
     "events": {
@@ -4890,9 +4890,11 @@
         }
       },
       "createFlow(address,address,int96,bytes)": {
+        "custom:callbacks": " - AgreementCreated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver)",
+        "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",
         "details": "flowId (agreementId) is the keccak256 hash of encoded sender and receiver",
         "params": {
-          "ctx": "Context bytes (see ISuperfluid.sol for Context struct) # App callbacks - AgreementCreated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver) 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",
+          "ctx": "Context bytes (see ISuperfluid.sol for Context struct)",
           "flowRate": "New flow rate in amount per second",
           "receiver": "Flow receiver address",
           "token": "Super token address"
@@ -4909,10 +4911,12 @@
         }
       },
       "deleteFlow(address,address,address,bytes)": {
+        "custom:callbacks": " - AgreementTerminated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver)",
+        "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 - Gas fee may be returned to the sender",
         "details": "flowId (agreementId) is the keccak256 hash of encoded sender and receiver",
         "params": {
           "ctx": "Context bytes (see ISuperfluid.sol for Context struct)",
-          "receiver": "Flow receiver address # App callbacks - AgreementTerminated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver) 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 - Gas fee may be returned to the sender",
+          "receiver": "Flow receiver address",
           "token": "Super token address"
         }
       },
@@ -4938,12 +4942,13 @@
         }
       },
       "getDepositRequiredForFlowRate(address,int96)": {
+        "custom:note": " - if calculated deposit (flowRate * liquidationPeriod) is less   than the minimum deposit, we use the minimum deposit otherwise   we use the calculated deposit",
         "details": "Calculates the deposit based on the liquidationPeriod and flowRate",
         "params": {
           "flowRate": "Flow rate to be tested"
         },
         "returns": {
-          "deposit": "The deposit amount based on flowRate and liquidationPeriod NOTE: - if calculated deposit (flowRate * liquidationPeriod) is less   than the minimum deposit, we use the minimum deposit otherwise   we use the calculated deposit"
+          "deposit": "The deposit amount based on flowRate and liquidationPeriod"
         }
       },
       "getFlow(address,address,address)": {
@@ -5055,9 +5060,11 @@
         }
       },
       "updateFlow(address,address,int96,bytes)": {
+        "custom:callbacks": " - AgreementUpdated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver)",
+        "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 - Deposit amount will be adjusted accordingly - No new gas fee is charged",
         "details": "flowId (agreementId) is the keccak256 hash of encoded sender and receiver",
         "params": {
-          "ctx": "Context bytes (see ISuperfluid.sol for Context struct) # App callbacks - AgreementUpdated   - agreementId - can be used in getFlowByID   - agreementData - abi.encode(address flowSender, address flowReceiver) 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 - Deposit amount will be adjusted accordingly - No new gas fee is charged",
+          "ctx": "Context bytes (see ISuperfluid.sol for Context struct)",
           "flowRate": "New flow rate in amount per second",
           "receiver": "Flow receiver address",
           "token": "Super token address"