@superfluid-finance/sdk-core 0.3.3-dev.a92870f.0 → 0.3.3-dev.bd59c6c.0

package/dist/main/BatchCall.d.ts

@@ -11,7 +11,7 @@ interface OperationStruct {
     readonly data: string;
 }
 /**
- * @dev BatchCall Helper Class
+ * BatchCall Helper Class
  * @description A helper class to create `BatchCall` objects which can be executed.
  */
 export default class BatchCall {
@@ -19,31 +19,31 @@ export default class BatchCall {
     host: Host;
     constructor(options: IBatchCallOptions);
     /**
-     * @dev Gets the call agreement function arguments.
+     * Gets the call agreement function arguments.
      * @param callData callData of the function
      * @returns {ethers.utils.Result} call agreement function arguments
      */
     getCallAgreementFunctionArgs: (callData: string) => ethers.utils.Result;
     /**
-     * @dev Given an `Operation` object, gets the `OperationStruct` object.
+     * Given an `Operation` object, gets the `OperationStruct` object.
      * @param operation an `Operation` object
      * @param index the index of the `Operation` in the batchCall
      * @returns {Promise<OperationStruct>} OperationStruct object for batchCall
      */
     getOperationStruct: (operation: Operation, index: number) => Promise<OperationStruct>;
     /**
-     * @dev Gets an array of `OperationStruct` objects to be passed to batchCall.
+     * Gets an array of `OperationStruct` objects to be passed to batchCall.
      * @returns {Promise<OperationStruct>[]} array of operation struct promises
      */
     get getOperationStructArrayPromises(): Promise<OperationStruct>[];
     /**
-     * @dev Executes a batch call given the operations on this class.
+     * Executes a batch call given the operations on this class.
      * @param signer the signer of the transaction
      * @returns {Promise<ethers.ContractTransaction>} ContractTransaction object
      */
     exec: (signer: ethers.Signer) => Promise<ethers.ContractTransaction>;
     /**
-     * @dev Executes a forward batch call given the operations on this class.
+     * Executes a forward batch call given the operations on this class.
      * @param signer the signer of the transaction
      * @returns {Promise<ethers.ContractTransaction>} ContractTransaction object
      */

package/dist/main/BatchCall.js

@@ -17,19 +17,19 @@ const operationTypeStringToTypeMap = new Map([
     ["CALL_APP_ACTION", 202],
 ]);
 /**
- * @dev BatchCall Helper Class
+ * BatchCall Helper Class
  * @description A helper class to create `BatchCall` objects which can be executed.
  */
 class BatchCall {
     constructor(options) {
         /**
-         * @dev Gets the call agreement function arguments.
+         * Gets the call agreement function arguments.
          * @param callData callData of the function
          * @returns {ethers.utils.Result} call agreement function arguments
          */
         this.getCallAgreementFunctionArgs = (callData) => (0, utils_1.getTransactionDescription)(Superfluid_json_1.default.abi, callData).args;
         /**
-         * @dev Given an `Operation` object, gets the `OperationStruct` object.
+         * Given an `Operation` object, gets the `OperationStruct` object.
          * @param operation an `Operation` object
          * @param index the index of the `Operation` in the batchCall
          * @returns {Promise<OperationStruct>} OperationStruct object for batchCall
@@ -71,14 +71,14 @@ class BatchCall {
             };
         };
         /**
-         * @dev Executes a batch call given the operations on this class.
+         * Executes a batch call given the operations on this class.
          * @param signer the signer of the transaction
          * @returns {Promise<ethers.ContractTransaction>} ContractTransaction object
          */
         this.exec = async (signer) => {
             try {
                 const operationStructArray = await Promise.all(this.getOperationStructArrayPromises);
-                return await this.host.hostContract
+                return await this.host.contract
                     .connect(signer)
                     .batchCall(operationStructArray);
             }
@@ -94,14 +94,14 @@ class BatchCall {
         // TODO: user signs the transaction they'd like to execute and gives
         // this data to the trusted forwarder to sign
         /**
-         * @dev Executes a forward batch call given the operations on this class.
+         * Executes a forward batch call given the operations on this class.
          * @param signer the signer of the transaction
          * @returns {Promise<ethers.ContractTransaction>} ContractTransaction object
          */
         this.execForward = async (signer) => {
             try {
                 const operationStructArray = await Promise.all(this.getOperationStructArrayPromises);
-                return await this.host.hostContract
+                return await this.host.contract
                     .connect(signer)
                     .forwardBatchCall(operationStructArray);
             }
@@ -117,7 +117,7 @@ class BatchCall {
         this.host = new Host_1.default(options.hostAddress);
     }
     /**
-     * @dev Gets an array of `OperationStruct` objects to be passed to batchCall.
+     * Gets an array of `OperationStruct` objects to be passed to batchCall.
      * @returns {Promise<OperationStruct>[]} array of operation struct promises
      */
     get getOperationStructArrayPromises() {

package/dist/main/BatchCall.js.map

@@ -1 +1 @@
-{"version":3,"file":"BatchCall.js","sourceRoot":"","sources":["../../src/BatchCall.ts"],"names":[],"mappings":";;;;;AAAA,mCAAgC;AAEhC,kDAA0B;AAE1B,uCAAoC;AACpC,4EAAkD;AAClD,mCAA+E;AAa/E,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAwB;IAChE,CAAC,eAAe,EAAE,CAAC,CAAC;IACpB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC1B,CAAC,oBAAoB,EAAE,GAAG,CAAC;IAC3B,CAAC,sBAAsB,EAAE,GAAG,CAAC;IAC7B,CAAC,2BAA2B,EAAE,GAAG,CAAC;IAClC,CAAC,iBAAiB,EAAE,GAAG,CAAC;CAC3B,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAqB,SAAS;IAI1B,YAAY,OAA0B;QAKtC;;;;WAIG;QACH,iCAA4B,GAAG,CAAC,QAAgB,EAAuB,EAAE,CACrE,IAAA,iCAAyB,EAAC,yBAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC;QAEhE;;;;;WAKG;QACH,uBAAkB,GAAG,KAAK,EACtB,SAAoB,EACpB,KAAa,EACW,EAAE;YAC1B,MAAM,aAAa,GAAG,4BAA4B,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACvE,MAAM,oBAAoB,GAAG,MAAM,SAAS,CAAC,0BAA0B,CAAC;YACxE,IAAI,CAAC,aAAa,EAAE;gBAChB,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,uBAAuB;oBAC7B,aAAa,EACT,yBAAyB,GAAG,KAAK,GAAG,kBAAkB;iBAC7D,CAAC,CAAC;aACN;YAED,0BAA0B;YAC1B,IAAI,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE;gBACxD,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,gCAAgC;oBACtC,aAAa,EACT,qDAAqD;iBAC5D,CAAC,CAAC;aACN;YAED,wCAAwC;YACxC,wDAAwD;YACxD,8CAA8C;YAC9C,IAAI,SAAS,CAAC,IAAI,KAAK,2BAA2B,EAAE;gBAChD,MAAM,OAAO,GAAG,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC;gBAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,4BAA4B,CAClD,oBAAoB,CAAC,IAAI,CAC5B,CAAC;gBACF,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CACvB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClB,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CACvD,CAAC;gBAEF,OAAO;oBACH,aAAa;oBACb,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC;oBACtC,IAAI;iBACP,CAAC;aACL;YAED,8DAA8D;YAC9D,OAAO;gBACH,aAAa;gBACb,MAAM,EAAE,oBAAoB,CAAC,EAAE;gBAC/B,IAAI,EAAE,IAAA,iCAAyB,EAAC,oBAAoB,CAAC,IAAI,CAAC;aAC7D,CAAC;QACN,CAAC,CAAC;QAYF;;;;WAIG;QACH,SAAI,GAAG,KAAK,EACR,MAAqB,EACc,EAAE;YACrC,IAAI;gBACA,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,IAAI,CAAC,+BAA+B,CACvC,CAAC;gBACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY;qBAC9B,OAAO,CAAC,MAAM,CAAC;qBACf,SAAS,CAAC,oBAAoB,CAAC,CAAC;aACxC;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,kBAAkB;oBACxB,aAAa,EAAE,+CAA+C;oBAC9D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,0BAA0B;QAC1B,oEAAoE;QACpE,6CAA6C;QAC7C;;;;WAIG;QACH,gBAAW,GAAG,KAAK,EACf,MAAqB,EACc,EAAE;YACrC,IAAI;gBACA,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,IAAI,CAAC,+BAA+B,CACvC,CAAC;gBACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY;qBAC9B,OAAO,CAAC,MAAM,CAAC;qBACf,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;aAC/C;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,kBAAkB;oBACxB,aAAa,EAAE,+CAA+C;oBAC9D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAhIE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAmED;;;OAGG;IACH,IAAI,+BAA+B;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACxC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAChC,CAAC;IACN,CAAC;CAoDJ;AAtID,4BAsIC"}
+{"version":3,"file":"BatchCall.js","sourceRoot":"","sources":["../../src/BatchCall.ts"],"names":[],"mappings":";;;;;AAAA,mCAAgC;AAEhC,kDAA0B;AAE1B,uCAAoC;AACpC,4EAAkD;AAClD,mCAA+E;AAa/E,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAwB;IAChE,CAAC,eAAe,EAAE,CAAC,CAAC;IACpB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC1B,CAAC,oBAAoB,EAAE,GAAG,CAAC;IAC3B,CAAC,sBAAsB,EAAE,GAAG,CAAC;IAC7B,CAAC,2BAA2B,EAAE,GAAG,CAAC;IAClC,CAAC,iBAAiB,EAAE,GAAG,CAAC;CAC3B,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAqB,SAAS;IAI1B,YAAY,OAA0B;QAKtC;;;;WAIG;QACH,iCAA4B,GAAG,CAAC,QAAgB,EAAuB,EAAE,CACrE,IAAA,iCAAyB,EAAC,yBAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC;QAEhE;;;;;WAKG;QACH,uBAAkB,GAAG,KAAK,EACtB,SAAoB,EACpB,KAAa,EACW,EAAE;YAC1B,MAAM,aAAa,GAAG,4BAA4B,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACvE,MAAM,oBAAoB,GAAG,MAAM,SAAS,CAAC,0BAA0B,CAAC;YACxE,IAAI,CAAC,aAAa,EAAE;gBAChB,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,uBAAuB;oBAC7B,aAAa,EACT,yBAAyB,GAAG,KAAK,GAAG,kBAAkB;iBAC7D,CAAC,CAAC;aACN;YAED,0BAA0B;YAC1B,IAAI,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE;gBACxD,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,gCAAgC;oBACtC,aAAa,EACT,qDAAqD;iBAC5D,CAAC,CAAC;aACN;YAED,wCAAwC;YACxC,wDAAwD;YACxD,8CAA8C;YAC9C,IAAI,SAAS,CAAC,IAAI,KAAK,2BAA2B,EAAE;gBAChD,MAAM,OAAO,GAAG,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC;gBAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,4BAA4B,CAClD,oBAAoB,CAAC,IAAI,CAC5B,CAAC;gBACF,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CACvB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClB,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CACvD,CAAC;gBAEF,OAAO;oBACH,aAAa;oBACb,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC;oBACtC,IAAI;iBACP,CAAC;aACL;YAED,8DAA8D;YAC9D,OAAO;gBACH,aAAa;gBACb,MAAM,EAAE,oBAAoB,CAAC,EAAE;gBAC/B,IAAI,EAAE,IAAA,iCAAyB,EAAC,oBAAoB,CAAC,IAAI,CAAC;aAC7D,CAAC;QACN,CAAC,CAAC;QAYF;;;;WAIG;QACH,SAAI,GAAG,KAAK,EACR,MAAqB,EACc,EAAE;YACrC,IAAI;gBACA,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,IAAI,CAAC,+BAA+B,CACvC,CAAC;gBACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ;qBAC1B,OAAO,CAAC,MAAM,CAAC;qBACf,SAAS,CAAC,oBAAoB,CAAC,CAAC;aACxC;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,kBAAkB;oBACxB,aAAa,EAAE,+CAA+C;oBAC9D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,0BAA0B;QAC1B,oEAAoE;QACpE,6CAA6C;QAC7C;;;;WAIG;QACH,gBAAW,GAAG,KAAK,EACf,MAAqB,EACc,EAAE;YACrC,IAAI;gBACA,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,IAAI,CAAC,+BAA+B,CACvC,CAAC;gBACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ;qBAC1B,OAAO,CAAC,MAAM,CAAC;qBACf,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;aAC/C;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,kBAAkB;oBACxB,aAAa,EAAE,+CAA+C;oBAC9D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAhIE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAmED;;;OAGG;IACH,IAAI,+BAA+B;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACxC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAChC,CAAC;IACN,CAAC;CAoDJ;AAtID,4BAsIC"}

package/dist/main/ConstantFlowAgreementV1.d.ts

@@ -1,42 +1,72 @@
 import Host from "./Host";
 import Operation from "./Operation";
-import { IAgreementV1Options, ICreateFlowParams, IDeleteFlowParams, IGetAccountFlowInfoParams, IGetFlowParams, IUpdateFlowParams, IWeb3FlowInfo, IWeb3FlowInfoParams } from "./interfaces";
+import { IAgreementV1Options, ICreateFlowParams, IDeleteFlowParams, IFullControlParams, IGetAccountFlowInfoParams, IGetFlowOperatorDataByIDParams, IGetFlowOperatorDataParams, IGetFlowParams, IUpdateFlowByOperatorParams, IUpdateFlowOperatorPermissionsParams, IUpdateFlowParams, IWeb3FlowInfo, IWeb3FlowInfoParams, IWeb3FlowOperatorData, IWeb3FlowOperatorDataParams } from "./interfaces";
+import { IConstantFlowAgreementV1 } from "./typechain";
 /**
- * @dev Constant Flow Agreement V1 Helper Class
+ * Constant Flow Agreement V1 Helper Class
  * @description A helper class to interact with the CFAV1 contract.
  */
 export default class ConstantFlowAgreementV1 {
     readonly options: IAgreementV1Options;
     readonly host: Host;
+    readonly contract: IConstantFlowAgreementV1;
     constructor(options: IAgreementV1Options);
-    private get cfaContract();
+    /** ### CFA Read Functions ### */
     /**
-     * @dev Get the details of a flow.
+     * Get the details of a flow.
      * @param superToken the superToken of the agreement
      * @param sender the sender of the flow
      * @param receiver the receiver of the flow
      * @param providerOrSigner a provider or signer object
      * @returns {Promise<IWeb3FlowInfo>} Web3 Flow info object
      */
-    getFlow: ({ superToken, sender, receiver, providerOrSigner, }: IGetFlowParams) => Promise<IWeb3FlowInfo>;
+    getFlow: (params: IGetFlowParams) => Promise<IWeb3FlowInfo>;
     /**
-     * @dev Get the flow info of an account (net flow).
+     * Get the flow info of an account (net flow).
      * @param superToken the superToken of the agreement
      * @param account the account we're querying
      * @param providerOrSigner a provider or signer object
      * @returns {Promise<IWeb3FlowInfo>} Web3 Flow info object
      */
-    getAccountFlowInfo: ({ superToken, account, providerOrSigner, }: IGetAccountFlowInfoParams) => Promise<IWeb3FlowInfo>;
+    getAccountFlowInfo: (params: IGetAccountFlowInfoParams) => Promise<IWeb3FlowInfo>;
     /**
-     * @dev Get the net flow of an account.
+     * Get the net flow of an account.
      * @param superToken the superToken of the agreement
      * @param account the account we're querying
      * @param providerOrSigner a provider or signer object
      * @returns {Promise<string>} Web3 Flow info object
      */
-    getNetFlow: ({ superToken, account, providerOrSigner, }: IGetAccountFlowInfoParams) => Promise<string>;
+    getNetFlow: (params: IGetAccountFlowInfoParams) => Promise<string>;
     /**
-     * @dev Create a flow.
+     * Get flow operator data.
+     * @param superToken the superToken of the agreement
+     * @param sender the sender
+     * @param flowOperator the flowOperator
+     * @param providerOrSigner a provider or signer object
+     * @returns {Promise<IWeb3FlowOperatorData>} Web3 Flow info object
+     */
+    getFlowOperatorData: (params: IGetFlowOperatorDataParams) => Promise<IWeb3FlowOperatorData>;
+    /**
+     * Get flow operator data using the flowOperatorId.
+     * @param superToken the superToken of the agreement
+     * @param flowOperatorId The keccak256 hash of encoded string "flowOperator", sender and flowOperator
+     * @param providerOrSigner a provider or signer object
+     * @returns {Promise<IWeb3FlowOperatorData>} Web3 Flow info object
+     */
+    getFlowOperatorDataByID: (params: IGetFlowOperatorDataByIDParams) => Promise<IWeb3FlowOperatorData>;
+    /** ### CFA Write Functions ### */
+    /**
+     * Create a flow.
+     * @param flowRate The specified flow rate.
+     * @param receiver The receiver of the flow.
+     * @param superToken The token to be flowed.
+     * @param userData Extra user data provided.
+     * @param overrides ethers overrides object for more control over the transaction sent.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    createFlow: (params: ICreateFlowParams) => Operation;
+    /**
+     * Update a flow.
      * @param flowRate The specified flow rate.
      * @param receiver The receiver of the flow.
      * @param superToken The token to be flowed.
@@ -44,35 +74,94 @@ export default class ConstantFlowAgreementV1 {
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    createFlow: ({ flowRate, receiver, superToken, userData, overrides, }: ICreateFlowParams) => Operation;
+    updateFlow: (params: IUpdateFlowParams) => Operation;
+    /**
+     * Delete a flow.
+     * @param superToken The token to be flowed.
+     * @param sender The sender of the flow.
+     * @param receiver The receiver of the flow.
+     * @param userData Extra user data provided.
+     * @param overrides ethers overrides object for more control over the transaction sent.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    deleteFlow: (params: IDeleteFlowParams) => Operation;
+    /** ### CFA ACL Write Functions (byOperator) ### */
+    /**
+     * Update permissions for a flow operator as a sender.
+     * @param superToken The token to be flowed.
+     * @param flowOperator The permission grantee address
+     * @param permission The permissions to set.
+     * @param flowRateAllowance The flowRateAllowance granted to the flow operator.
+     * @param userData Extra user data provided.
+     * @param overrides ethers overrides object for more control over the transaction sent.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    updateFlowOperatorPermissions(params: IUpdateFlowOperatorPermissionsParams): Operation;
+    /**
+     * Give flow operator full control - max flow rate and create/update/delete permissions.
+     * @param superToken The token to be flowed.
+     * @param flowOperator The permission grantee address
+     * @param userData Extra user data provided.
+     * @param overrides ethers overrides object for more control over the transaction sent.
+     */
+    authorizeFlowOperatorWithFullControl(params: IFullControlParams): Operation;
+    /**
+     * Revoke flow operator control - set flow rate to 0 with no permissions.
+     * @param superToken The token to be flowed.
+     * @param flowOperator The permission grantee address
+     * @param userData Extra user data provided.
+     * @param overrides ethers overrides object for more control over the transaction sent.
+     */
+    revokeFlowOperatorWithFullControl(params: IFullControlParams): Operation;
     /**
-     * @dev Update a flow.
+     * Create a flow as an operator
      * @param flowRate The specified flow rate.
+     * @param sender The sender of the flow.
      * @param receiver The receiver of the flow.
      * @param superToken The token to be flowed.
      * @param userData Extra user data provided.
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    updateFlow: ({ flowRate, receiver, superToken, userData, overrides, }: IUpdateFlowParams) => Operation;
+    createFlowByOperator: (params: ICreateFlowParams) => Operation;
     /**
-     * @dev Delete a flow.
+     * Update a flow as an operator.
+     * @param flowRate The specified flow rate.
+     * @param sender The sender of the flow.
+     * @param receiver The receiver of the flow.
      * @param superToken The token to be flowed.
+     * @param userData Extra user data provided.
+     * @param overrides ethers overrides object for more control over the transaction sent.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    updateFlowByOperator: (params: IUpdateFlowByOperatorParams) => Operation;
+    /**
+     * Delete a flow as an operator.
      * @param sender The sender of the flow.
      * @param receiver The receiver of the flow.
+     * @param superToken The token to be flowed.
      * @param userData Extra user data provided.
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    deleteFlow: ({ superToken, sender, receiver, userData, overrides, }: IDeleteFlowParams) => Operation;
+    deleteFlowByOperator: (params: IDeleteFlowParams) => Operation;
+    /** ### Private Functions ### */
     /**
-     * @dev Sanitizes flow info, converting BigNumber to string.
+     * Sanitizes flow info, converting BigNumber to string.
      * @param timestamp last updated timestamp of flow
      * @param flowRate the current flow rate
      * @param deposit the deposit amount
      * @param owedDeposit any owed depsit
      * @returns {IWeb3FlowInfo} sanitized web3 flow info
      */
-    _sanitizeflowInfo: ({ timestamp, flowRate, deposit, owedDeposit, }: IWeb3FlowInfoParams) => IWeb3FlowInfo;
+    _sanitizeFlowInfo: (params: IWeb3FlowInfoParams) => IWeb3FlowInfo;
+    /**
+     * Sanitizes flow operator data, converting BigNumber to string.
+     * @param flowOperatorId The keccak256 hash of encoded string "flowOperator", sender and flowOperator
+     * @param permissions the permissions
+     * @param flowRateAllowance the flow rate allowance granted to the flow operator
+     * @returns {IWeb3FlowOperatorData} sanitized web3 flow info
+     */
+    _sanitizeFlowOperatorData: (params: IWeb3FlowOperatorDataParams) => IWeb3FlowOperatorData;
 }
 //# sourceMappingURL=ConstantFlowAgreementV1.d.ts.map

package/dist/main/ConstantFlowAgreementV1.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConstantFlowAgreementV1.d.ts","sourceRoot":"","sources":["../../src/ConstantFlowAgreementV1.ts"],"names":[],"mappings":"AAEA,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,SAAS,MAAM,aAAa,CAAC;AAGpC,OAAO,EACH,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,yBAAyB,EACzB,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACtB,MAAM,cAAc,CAAC;AAQtB;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,uBAAuB;IACxC,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;gBAER,OAAO,EAAE,mBAAmB;IAKxC,OAAO,KAAK,WAAW,GAKtB;IAID;;;;;;;OAOG;IACH,OAAO,wDAKJ,cAAc,KAAG,QAAQ,aAAa,CAAC,CAgBxC;IAEF;;;;;;OAMG;IACH,kBAAkB,+CAIf,yBAAyB,KAAG,QAAQ,aAAa,CAAC,CAgBnD;IAEF;;;;;;OAMG;IACH,UAAU,+CAIP,yBAAyB,KAAG,QAAQ,MAAM,CAAC,CAgB5C;IAIF;;;;;;;;OAQG;IACH,UAAU,6DAMP,iBAAiB,KAAG,SAAS,CAiB9B;IAEF;;;;;;;;OAQG;IACH,UAAU,6DAMP,iBAAiB,KAAG,SAAS,CAiB9B;IAEF;;;;;;;;OAQG;IACH,UAAU,2DAMP,iBAAiB,KAAG,SAAS,CAkB9B;IAEF;;;;;;;OAOG;IACH,iBAAiB,mDAKd,mBAAmB,KAAG,aAAa,CAOpC;CACL"}
+{"version":3,"file":"ConstantFlowAgreementV1.d.ts","sourceRoot":"","sources":["../../src/ConstantFlowAgreementV1.ts"],"names":[],"mappings":"AAEA,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,SAAS,MAAM,aAAa,CAAC;AAGpC,OAAO,EACH,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,8BAA8B,EAC9B,0BAA0B,EAC1B,cAAc,EACd,2BAA2B,EAC3B,oCAAoC,EACpC,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,2BAA2B,EAC9B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAWvD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,uBAAuB;IACxC,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,wBAAwB,CAAC;gBAEhC,OAAO,EAAE,mBAAmB;IASxC,iCAAiC;IAEjC;;;;;;;OAOG;IACH,OAAO,WAAkB,cAAc,KAAG,QAAQ,aAAa,CAAC,CAgB9D;IAEF;;;;;;OAMG;IACH,kBAAkB,WACN,yBAAyB,KAClC,QAAQ,aAAa,CAAC,CAgBvB;IAEF;;;;;;OAMG;IACH,UAAU,WAAkB,yBAAyB,KAAG,QAAQ,MAAM,CAAC,CAgBrE;IAEF;;;;;;;OAOG;IACH,mBAAmB,WACP,0BAA0B,KACnC,QAAQ,qBAAqB,CAAC,CAoB/B;IAEF;;;;;;OAMG;IACH,uBAAuB,WACX,8BAA8B,KACvC,QAAQ,qBAAqB,CAAC,CAoB/B;IAEF,kCAAkC;IAElC;;;;;;;;OAQG;IACH,UAAU,WAAY,iBAAiB,KAAG,SAAS,CAiBjD;IAEF;;;;;;;;OAQG;IACH,UAAU,WAAY,iBAAiB,KAAG,SAAS,CAiBjD;IAEF;;;;;;;;OAQG;IACH,UAAU,WAAY,iBAAiB,KAAG,SAAS,CAkBjD;IAEF,mDAAmD;IAEnD;;;;;;;;;OASG;IACH,6BAA6B,CACzB,MAAM,EAAE,oCAAoC,GAC7C,SAAS;IAoCZ;;;;;;OAMG;IACH,oCAAoC,CAChC,MAAM,EAAE,kBAAkB,GAC3B,SAAS;IAiBZ;;;;;;OAMG;IACH,iCAAiC,CAAC,MAAM,EAAE,kBAAkB,GAAG,SAAS;IAiBxE;;;;;;;;;OASG;IACH,oBAAoB,WAAY,iBAAiB,KAAG,SAAS,CAsB3D;IAEF;;;;;;;;;OASG;IACH,oBAAoB,WAAY,2BAA2B,KAAG,SAAS,CAsBrE;IAEF;;;;;;;;OAQG;IACH,oBAAoB,WAAY,iBAAiB,KAAG,SAAS,CAgB3D;IAEF,gCAAgC;IAEhC;;;;;;;OAOG;IACH,iBAAiB,WAAY,mBAAmB,KAAG,aAAa,CAO9D;IAEF;;;;;;OAMG;IACH,yBAAyB,WACb,2BAA2B,KACpC,qBAAqB,CAMtB;CACL"}