@superfluid-finance/ethereum-contracts 1.2.3-dev.7365205.0 → 1.2.3-dev.7dc62cd.0

package/contracts/apps/IDAv1Library.sol

@@ -186,11 +186,13 @@ library IDAv1Library {
     ) internal {
         idaLibrary.host.callAgreement(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.createIndex.selector,
-                token,
-                indexId,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.createIndex,
+                (
+                    token,
+                    indexId,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData
         );
@@ -225,11 +227,13 @@ library IDAv1Library {
     ) internal returns (bytes memory newCtx) {
         (newCtx, ) = idaLibrary.host.callAgreementWithContext(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.createIndex.selector,
-                token,
-                indexId,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.createIndex,
+                (
+                    token,
+                    indexId,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData,
             ctx
@@ -268,12 +272,14 @@ library IDAv1Library {
     ) internal {
         idaLibrary.host.callAgreement(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.updateIndex.selector,
-                token,
-                indexId,
-                indexValue,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.updateIndex,
+                (
+                    token,
+                    indexId,
+                    indexValue,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData
         );
@@ -321,12 +327,14 @@ library IDAv1Library {
     ) internal returns (bytes memory newCtx) {
         (newCtx, ) = idaLibrary.host.callAgreementWithContext(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.updateIndex.selector,
-                token,
-                indexId,
-                indexValue,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.updateIndex,
+                (
+                    token,
+                    indexId,
+                    indexValue,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData,
             ctx
@@ -365,12 +373,14 @@ library IDAv1Library {
     ) internal {
         idaLibrary.host.callAgreement(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.distribute.selector,
-                token,
-                indexId,
-                amount,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.distribute,
+                (
+                    token,
+                    indexId,
+                    amount,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData
         );
@@ -411,13 +421,15 @@ library IDAv1Library {
         bytes memory userData
     ) internal returns (bytes memory newCtx) {
         (newCtx, ) = idaLibrary.host.callAgreementWithContext(
-            idaLibrary.ida, 
-            abi.encodeWithSelector(
-                idaLibrary.ida.distribute.selector,
-                token,
-                indexId,
-                amount,
-                new bytes(0) // ctx placeholder
+            idaLibrary.ida,
+            abi.encodeCall(
+                idaLibrary.ida.distribute,
+                (
+                    token,
+                    indexId,
+                    amount,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData,
             ctx
@@ -462,12 +474,14 @@ library IDAv1Library {
     ) internal {
         idaLibrary.host.callAgreement(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.approveSubscription.selector,
-                token,
-                publisher,
-                indexId,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.approveSubscription,
+                (
+                    token,
+                    publisher,
+                    indexId,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData
         );
@@ -517,12 +531,14 @@ library IDAv1Library {
     ) internal returns (bytes memory newCtx) {
         (newCtx, ) = idaLibrary.host.callAgreementWithContext(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.approveSubscription.selector,
-                token,
-                publisher,
-                indexId,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.approveSubscription,
+                (
+                    token,
+                    publisher,
+                    indexId,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData,
             ctx
@@ -558,12 +574,14 @@ library IDAv1Library {
     ) internal {
         idaLibrary.host.callAgreement(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.revokeSubscription.selector,
-                token,
-                publisher,
-                indexId,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.revokeSubscription,
+                (
+                    token,
+                    publisher,
+                    indexId,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData
         );
@@ -610,12 +628,14 @@ library IDAv1Library {
     ) internal returns (bytes memory newCtx) {
         (newCtx, ) = idaLibrary.host.callAgreementWithContext(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.revokeSubscription.selector,
-                token,
-                publisher,
-                indexId,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.revokeSubscription,
+                (
+                    token,
+                    publisher,
+                    indexId,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData,
             ctx
@@ -657,13 +677,15 @@ library IDAv1Library {
     ) internal {
         idaLibrary.host.callAgreement(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.updateSubscription.selector,
-                token,
-                indexId,
-                subscriber,
-                units,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.updateSubscription,
+                (
+                    token,
+                    indexId,
+                    subscriber,
+                    units,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData
         );
@@ -716,13 +738,15 @@ library IDAv1Library {
     ) internal returns (bytes memory newCtx) {
         (newCtx, ) = idaLibrary.host.callAgreementWithContext(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.updateSubscription.selector,
-                token,
-                indexId,
-                subscriber,
-                units,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.updateSubscription,
+                (
+                    token,
+                    indexId,
+                    subscriber,
+                    units,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData,
             ctx
@@ -763,13 +787,15 @@ library IDAv1Library {
     ) internal {
         idaLibrary.host.callAgreement(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.deleteSubscription.selector,
-                token,
-                publisher,
-                indexId,
-                subscriber,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.deleteSubscription,
+                (
+                    token,
+                    publisher,
+                    indexId,
+                    subscriber,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData
         );
@@ -821,13 +847,15 @@ library IDAv1Library {
     ) internal returns (bytes memory newCtx) {
         (newCtx, ) = idaLibrary.host.callAgreementWithContext(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.deleteSubscription.selector,
-                token,
-                publisher,
-                indexId,
-                subscriber,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.deleteSubscription,
+                (
+                    token,
+                    publisher,
+                    indexId,
+                    subscriber,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData,
             ctx
@@ -868,13 +896,15 @@ library IDAv1Library {
     ) internal {
         idaLibrary.host.callAgreement(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.claim.selector,
-                token,
-                publisher,
-                indexId,
-                subscriber,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.claim,
+                (
+                    token,
+                    publisher,
+                    indexId,
+                    subscriber,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData
         );
@@ -925,13 +955,15 @@ library IDAv1Library {
     ) internal returns (bytes memory newCtx) {
         (newCtx, ) = idaLibrary.host.callAgreementWithContext(
             idaLibrary.ida,
-            abi.encodeWithSelector(
-                idaLibrary.ida.claim.selector,
-                token,
-                publisher,
-                indexId,
-                subscriber,
-                new bytes(0) // ctx placeholder
+            abi.encodeCall(
+                idaLibrary.ida.claim,
+                (
+                    token,
+                    publisher,
+                    indexId,
+                    subscriber,
+                    new bytes(0) // ctx placeholder
+                )
             ),
             userData,
             ctx

package/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol

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

package/contracts/interfaces/agreements/IInstantDistributionAgreementV1.sol

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

package/contracts/interfaces/superfluid/ISuperApp.sol

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