@superfluid-finance/sdk-core 0.3.3-dev.c77270b.0 → 0.3.3-dev.c9bc19b.0

package/dist/module/Host.d.ts

@@ -2,14 +2,14 @@ import { ethers } from "ethers";
 import Operation from "./Operation";
 import { Superfluid } from "./typechain";
 /**
- * @dev Host Helper Class
+ * Host Helper Class
  * @description A helper class which can be used as a standalone class to populate call agreement transactions.
  */
 export default class Host {
-    hostContract: Superfluid;
+    contract: Superfluid;
     constructor(hostAddress: string);
     /**
-     * @dev Creates an Operation of the `callAgreement` function on the host contract.
+     * Creates an Operation of the `callAgreement` function on the host contract.
      * @param agreementAddress the agreement address (cfa or ida address)
      * @param callData the encoded callData for the function
      * @param userData any additional user data

package/dist/module/Host.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Host.d.ts","sourceRoot":"","sources":["../../src/Host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAa,MAAM,QAAQ,CAAC;AAE3C,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IACrB,YAAY,EAAE,UAAU,CAAC;gBAEb,WAAW,EAAE,MAAM;IAO/B;;;;;;;OAOG;IACH,0CAA0C,qBACpB,MAAM,YACd,MAAM,YACN,MAAM,GAAG,SAAS;;uBAE7B,SAAS,CAQV;CACL"}
+{"version":3,"file":"Host.d.ts","sourceRoot":"","sources":["../../src/Host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAa,MAAM,QAAQ,CAAC;AAE3C,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IACrB,QAAQ,EAAE,UAAU,CAAC;gBAET,WAAW,EAAE,MAAM;IAO/B;;;;;;;OAOG;IACH,0CAA0C,qBACpB,MAAM,YACd,MAAM,YACN,MAAM,GAAG,SAAS;;uBAE7B,SAAS,CAQV;CACL"}

package/dist/module/Host.js

@@ -2,13 +2,13 @@ import { ethers } from "ethers";
 import Operation from "./Operation";
 import SuperfluidABI from "./abi/Superfluid.json";
 /**
- * @dev Host Helper Class
+ * Host Helper Class
  * @description A helper class which can be used as a standalone class to populate call agreement transactions.
  */
 export default class Host {
     constructor(hostAddress) {
         /**
-         * @dev Creates an Operation of the `callAgreement` function on the host contract.
+         * Creates an Operation of the `callAgreement` function on the host contract.
          * @param agreementAddress the agreement address (cfa or ida address)
          * @param callData the encoded callData for the function
          * @param userData any additional user data
@@ -16,10 +16,10 @@ export default class Host {
          * @returns {Operation} an `Operation` class
          */
         this.populateCallAgreementTxnAndReturnOperation = (agreementAddress, callData, userData, overrides) => {
-            const txn = this.hostContract.populateTransaction.callAgreement(agreementAddress, callData, userData || "0x", overrides || {});
+            const txn = this.contract.populateTransaction.callAgreement(agreementAddress, callData, userData || "0x", overrides || {});
             return new Operation(txn, "SUPERFLUID_CALL_AGREEMENT");
         };
-        this.hostContract = new ethers.Contract(hostAddress, SuperfluidABI.abi);
+        this.contract = new ethers.Contract(hostAddress, SuperfluidABI.abi);
     }
 }
 //# sourceMappingURL=Host.js.map

package/dist/module/Host.js.map

@@ -1 +1 @@
-{"version":3,"file":"Host.js","sourceRoot":"","sources":["../../src/Host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAa,MAAM,QAAQ,CAAC;AAE3C,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAGlD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IAGrB,YAAY,WAAmB;QAO/B;;;;;;;WAOG;QACH,+CAA0C,GAAG,CACzC,gBAAwB,EACxB,QAAgB,EAChB,QAA4B,EAC5B,SAA2D,EAClD,EAAE;YACX,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,aAAa,CAC3D,gBAAgB,EAChB,QAAQ,EACR,QAAQ,IAAI,IAAI,EAChB,SAAS,IAAI,EAAE,CAClB,CAAC;YACF,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,2BAA2B,CAAC,CAAC;QAC3D,CAAC,CAAC;QA3BE,IAAI,CAAC,YAAY,GAAG,IAAI,MAAM,CAAC,QAAQ,CACnC,WAAW,EACX,aAAa,CAAC,GAAG,CACN,CAAC;IACpB,CAAC;CAwBJ"}
+{"version":3,"file":"Host.js","sourceRoot":"","sources":["../../src/Host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAa,MAAM,QAAQ,CAAC;AAE3C,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAGlD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IAGrB,YAAY,WAAmB;QAO/B;;;;;;;WAOG;QACH,+CAA0C,GAAG,CACzC,gBAAwB,EACxB,QAAgB,EAChB,QAA4B,EAC5B,SAA2D,EAClD,EAAE;YACX,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,aAAa,CACvD,gBAAgB,EAChB,QAAQ,EACR,QAAQ,IAAI,IAAI,EAChB,SAAS,IAAI,EAAE,CAClB,CAAC;YACF,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,2BAA2B,CAAC,CAAC;QAC3D,CAAC,CAAC;QA3BE,IAAI,CAAC,QAAQ,GAAG,IAAI,MAAM,CAAC,QAAQ,CAC/B,WAAW,EACX,aAAa,CAAC,GAAG,CACN,CAAC;IACpB,CAAC;CAwBJ"}

package/dist/module/InstantDistributionAgreementV1.d.ts

@@ -1,17 +1,19 @@
 import Host from "./Host";
 import Operation from "./Operation";
 import { IAgreementV1Options, IApproveSubscriptionParams, IClaimParams, ICreateIndexParams, IDeleteSubscriptionParams, IDistributeParams, IGetIndexParams, IGetSubscriptionParams, IRevokeSubscriptionParams, IUpdateIndexValueParams, IUpdateSubscriptionUnitsParams, IWeb3Index, IWeb3Subscription } from "./interfaces";
+import { IInstantDistributionAgreementV1 } from "./typechain";
 /**
- * @dev Instant Distribution Agreement V1 Helper Class
+ * Instant Distribution Agreement V1 Helper Class
  * @description A helper class to interact with the IDAV1 contract.
  */
 export default class InstantDistributionAgreementV1 {
     readonly options: IAgreementV1Options;
     readonly host: Host;
+    readonly contract: IInstantDistributionAgreementV1;
     constructor(options: IAgreementV1Options);
-    private get idaContract();
+    /** ### IDA Read Functions ### */
     /**
-     * @dev Get the details of a `Subscription`.
+     * Get the details of a `Subscription`.
      * @param superToken the superToken of the agreement
      * @param publisher the address of the publisher of the index
      * @param indexId the index id
@@ -19,27 +21,28 @@ export default class InstantDistributionAgreementV1 {
      * @param providerOrSigner a provider or signer object
      * @returns {Promise<IWeb3Subscription>} Web3 Subscription object
      */
-    getSubscription: ({ superToken, publisher, indexId, subscriber, providerOrSigner, }: IGetSubscriptionParams) => Promise<IWeb3Subscription>;
+    getSubscription: (params: IGetSubscriptionParams) => Promise<IWeb3Subscription>;
     /**
-     * @dev Get the details of an `Index`.
+     * Get the details of an `Index`.
      * @param superToken the superToken of the agreement
      * @param publisher the address of the publisher of the index
      * @param indexId the index id
      * @param providerOrSigner a provider or signer object
      * @returns {Promise<IWeb3Index>} Web3 Index object
      */
-    getIndex: ({ superToken, publisher, indexId, providerOrSigner, }: IGetIndexParams) => Promise<IWeb3Index>;
+    getIndex: (params: IGetIndexParams) => Promise<IWeb3Index>;
+    /** ### IDA Write Functions ### */
     /**
-     * @dev Creates an IDA Index.
+     * Creates an IDA Index.
      * @param indexId The id of the index.
      * @param superToken The address of the `index` superToken.
      * @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.
      */
-    createIndex: ({ indexId, superToken, userData, overrides, }: ICreateIndexParams) => Operation;
+    createIndex: (params: ICreateIndexParams) => Operation;
     /**
-     * @dev Distributes `amount` of `superToken` to an index
+     * Distributes `amount` of `superToken` to an index
      * @param indexId The id of the index.
      * @param amount The amount of `superToken` to be distributed.
      * @param superToken The superToken to be distributed.
@@ -47,9 +50,9 @@ export default class InstantDistributionAgreementV1 {
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    distribute: ({ indexId, amount, superToken, userData, overrides, }: IDistributeParams) => Operation;
+    distribute: (params: IDistributeParams) => Operation;
     /**
-     * @dev Updates the `indexValue` of an index.
+     * Updates the `indexValue` of an index.
      * @description NOTE: It has the same effect as `distribute`, but is closer to the low level data structure of the index.
      * @param indexId The id of the index.
      * @param indexValue The new indexValue.
@@ -58,9 +61,9 @@ export default class InstantDistributionAgreementV1 {
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    updateIndexValue: ({ indexId, indexValue, superToken, userData, overrides, }: IUpdateIndexValueParams) => Operation;
+    updateIndexValue: (params: IUpdateIndexValueParams) => Operation;
     /**
-     * @dev Updates the `units` allocated to a Subscription.
+     * Updates the `units` allocated to a Subscription.
      * @param indexId The id of the index.
      * @param superToken The superToken of the index.
      * @param subscriber The subscriber address whose units you want to update.
@@ -69,9 +72,9 @@ export default class InstantDistributionAgreementV1 {
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    updateSubscriptionUnits: ({ indexId, superToken, subscriber, units, userData, overrides, }: IUpdateSubscriptionUnitsParams) => Operation;
+    updateSubscriptionUnits: (params: IUpdateSubscriptionUnitsParams) => Operation;
     /**
-     * @dev Approves a Subscription, so the Subscriber won't need to claim tokens when the Publisher distributes.
+     * Approves a Subscription, so the Subscriber won't need to claim tokens when the Publisher distributes.
      * @param indexId The id of the index.
      * @param superToken The superToken of the index.
      * @param publisher The publisher of the index you want to approve.
@@ -79,9 +82,9 @@ export default class InstantDistributionAgreementV1 {
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    approveSubscription: ({ indexId, superToken, publisher, userData, overrides, }: IApproveSubscriptionParams) => Operation;
+    approveSubscription: (params: IApproveSubscriptionParams) => Operation;
     /**
-     * @dev Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributres.
+     * Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributres.
      * @param indexId The id of the index.
      * @param superToken The superToken of the index.
      * @param subscriber The subscriber address whose subscription you want to revoke.
@@ -89,9 +92,9 @@ export default class InstantDistributionAgreementV1 {
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    revokeSubscription: ({ indexId, superToken, publisher, userData, overrides, }: IRevokeSubscriptionParams) => Operation;
+    revokeSubscription: (params: IRevokeSubscriptionParams) => Operation;
     /**
-     * @dev Deletes a Subscription by setting the `units` allocated to the Subscriber to 0.
+     * Deletes a Subscription by setting the `units` allocated to the Subscriber to 0.
      * @param indexId The id of the index.
      * @param superToken The superToken of the index.
      * @param subscriber The subscriber address whose subscription you want to delete.
@@ -100,9 +103,9 @@ export default class InstantDistributionAgreementV1 {
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    deleteSubscription: ({ indexId, superToken, subscriber, publisher, userData, overrides, }: IDeleteSubscriptionParams) => Operation;
+    deleteSubscription: (params: IDeleteSubscriptionParams) => Operation;
     /**
-     * @dev Claims any pending tokens allocated to the Subscription (unapproved).
+     * Claims any pending tokens allocated to the Subscription (unapproved).
      * @param indexId The id of the index.
      * @param superToken The superToken of the index.
      * @param subscriber The subscriber address whose subscription you want to delete.
@@ -111,6 +114,6 @@ export default class InstantDistributionAgreementV1 {
      * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    claim: ({ indexId, superToken, subscriber, publisher, userData, overrides, }: IClaimParams) => Operation;
+    claim: (params: IClaimParams) => Operation;
 }
 //# sourceMappingURL=InstantDistributionAgreementV1.d.ts.map

package/dist/module/InstantDistributionAgreementV1.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InstantDistributionAgreementV1.d.ts","sourceRoot":"","sources":["../../src/InstantDistributionAgreementV1.ts"],"names":[],"mappings":"AAEA,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,SAAS,MAAM,aAAa,CAAC;AAGpC,OAAO,EACH,mBAAmB,EACnB,0BAA0B,EAC1B,YAAY,EACZ,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,eAAe,EACf,sBAAsB,EACtB,yBAAyB,EACzB,uBAAuB,EACvB,8BAA8B,EAC9B,UAAU,EACV,iBAAiB,EACpB,MAAM,cAAc,CAAC;AAQtB;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,8BAA8B;IAC/C,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;gBAER,OAAO,EAAE,mBAAmB;IAKxC,OAAO,KAAK,WAAW,GAKtB;IAID;;;;;;;;OAQG;IACH,eAAe,sEAMZ,sBAAsB,KAAG,QAAQ,iBAAiB,CAAC,CA4BpD;IAEF;;;;;;;OAOG;IACH,QAAQ,0DAKL,eAAe,KAAG,QAAQ,UAAU,CAAC,CAoBtC;IAIF;;;;;;;OAOG;IACH,WAAW,kDAKR,kBAAkB,KAAG,SAAS,CAc/B;IAEF;;;;;;;;OAQG;IACH,UAAU,0DAMP,iBAAiB,KAAG,SAAS,CAe9B;IAEF;;;;;;;;;OASG;IACH,gBAAgB,8DAMb,uBAAuB,KAAG,SAAS,CAepC;IAEF;;;;;;;;;OASG;IACH,uBAAuB,qEAOpB,8BAA8B,KAAG,SAAS,CAiB3C;IAEF;;;;;;;;OAQG;IACH,mBAAmB,6DAMhB,0BAA0B,KAAG,SAAS,CAcvC;IAEF;;;;;;;;OAQG;IACH,kBAAkB,6DAMf,yBAAyB,KAAG,SAAS,CAgBtC;IAEF;;;;;;;;;OASG;IACH,kBAAkB,yEAOf,yBAAyB,KAAG,SAAS,CAkBtC;IAEF;;;;;;;;;OASG;IACH,KAAK,yEAOF,YAAY,KAAG,SAAS,CAkBzB;CACL"}
+{"version":3,"file":"InstantDistributionAgreementV1.d.ts","sourceRoot":"","sources":["../../src/InstantDistributionAgreementV1.ts"],"names":[],"mappings":"AAEA,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,SAAS,MAAM,aAAa,CAAC;AAGpC,OAAO,EACH,mBAAmB,EACnB,0BAA0B,EAC1B,YAAY,EACZ,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,eAAe,EACf,sBAAsB,EACtB,yBAAyB,EACzB,uBAAuB,EACvB,8BAA8B,EAC9B,UAAU,EACV,iBAAiB,EACpB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,+BAA+B,EAAE,MAAM,aAAa,CAAC;AAO9D;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,8BAA8B;IAC/C,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,+BAA+B,CAAC;gBAEvC,OAAO,EAAE,mBAAmB;IASxC,iCAAiC;IAEjC;;;;;;;;OAQG;IACH,eAAe,WACH,sBAAsB,KAC/B,QAAQ,iBAAiB,CAAC,CA4B3B;IAEF;;;;;;;OAOG;IACH,QAAQ,WAAkB,eAAe,KAAG,QAAQ,UAAU,CAAC,CAoB7D;IAEF,kCAAkC;IAElC;;;;;;;OAOG;IACH,WAAW,WAAY,kBAAkB,KAAG,SAAS,CAcnD;IAEF;;;;;;;;OAQG;IACH,UAAU,WAAY,iBAAiB,KAAG,SAAS,CAejD;IAEF;;;;;;;;;OASG;IACH,gBAAgB,WAAY,uBAAuB,KAAG,SAAS,CAe7D;IAEF;;;;;;;;;OASG;IACH,uBAAuB,WACX,8BAA8B,KACvC,SAAS,CAiBV;IAEF;;;;;;;;OAQG;IACH,mBAAmB,WAAY,0BAA0B,KAAG,SAAS,CAcnE;IAEF;;;;;;;;OAQG;IACH,kBAAkB,WAAY,yBAAyB,KAAG,SAAS,CAgBjE;IAEF;;;;;;;;;OASG;IACH,kBAAkB,WAAY,yBAAyB,KAAG,SAAS,CAkBjE;IAEF;;;;;;;;;OASG;IACH,KAAK,WAAY,YAAY,KAAG,SAAS,CAkBvC;CACL"}

package/dist/module/InstantDistributionAgreementV1.js

@@ -5,14 +5,14 @@ import IInstantDistributionAgreementV1ABI from "./abi/IInstantDistributionAgreem
 import { normalizeAddress } from "./utils";
 const idaInterface = new ethers.utils.Interface(IInstantDistributionAgreementV1ABI.abi);
 /**
- * @dev Instant Distribution Agreement V1 Helper Class
+ * Instant Distribution Agreement V1 Helper Class
  * @description A helper class to interact with the IDAV1 contract.
  */
 export default class InstantDistributionAgreementV1 {
     constructor(options) {
-        // IDA Read Functions
+        /** ### IDA Read Functions ### */
         /**
-         * @dev Get the details of a `Subscription`.
+         * Get the details of a `Subscription`.
          * @param superToken the superToken of the agreement
          * @param publisher the address of the publisher of the index
          * @param indexId the index id
@@ -20,14 +20,14 @@ export default class InstantDistributionAgreementV1 {
          * @param providerOrSigner a provider or signer object
          * @returns {Promise<IWeb3Subscription>} Web3 Subscription object
          */
-        this.getSubscription = async ({ superToken, publisher, indexId, subscriber, providerOrSigner, }) => {
-            const normalizedToken = normalizeAddress(superToken);
-            const normalizedPublisher = normalizeAddress(publisher);
-            const normalizedSubscriber = normalizeAddress(subscriber);
+        this.getSubscription = async (params) => {
+            const normalizedToken = normalizeAddress(params.superToken);
+            const normalizedPublisher = normalizeAddress(params.publisher);
+            const normalizedSubscriber = normalizeAddress(params.subscriber);
             try {
-                const subscription = await this.idaContract
-                    .connect(providerOrSigner)
-                    .getSubscription(normalizedToken, normalizedPublisher, indexId, normalizedSubscriber);
+                const subscription = await this.contract
+                    .connect(params.providerOrSigner)
+                    .getSubscription(normalizedToken, normalizedPublisher, params.indexId, normalizedSubscriber);
                 return {
                     exist: subscription.exist,
                     approved: subscription.approved,
@@ -44,20 +44,20 @@ export default class InstantDistributionAgreementV1 {
             }
         };
         /**
-         * @dev Get the details of an `Index`.
+         * Get the details of an `Index`.
          * @param superToken the superToken of the agreement
          * @param publisher the address of the publisher of the index
          * @param indexId the index id
          * @param providerOrSigner a provider or signer object
          * @returns {Promise<IWeb3Index>} Web3 Index object
          */
-        this.getIndex = async ({ superToken, publisher, indexId, providerOrSigner, }) => {
-            const normalizedToken = normalizeAddress(superToken);
-            const normalizedPublisher = normalizeAddress(publisher);
+        this.getIndex = async (params) => {
+            const normalizedToken = normalizeAddress(params.superToken);
+            const normalizedPublisher = normalizeAddress(params.publisher);
             try {
-                const index = await this.idaContract
-                    .connect(providerOrSigner)
-                    .getIndex(normalizedToken, normalizedPublisher, indexId);
+                const index = await this.contract
+                    .connect(params.providerOrSigner)
+                    .getIndex(normalizedToken, normalizedPublisher, params.indexId);
                 return {
                     exist: index.exist,
                     indexValue: index.indexValue.toString(),
@@ -73,26 +73,26 @@ export default class InstantDistributionAgreementV1 {
                 });
             }
         };
-        // IDA Write Functions
+        /** ### IDA Write Functions ### */
         /**
-         * @dev Creates an IDA Index.
+         * Creates an IDA Index.
          * @param indexId The id of the index.
          * @param superToken The address of the `index` superToken.
          * @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.
          */
-        this.createIndex = ({ indexId, superToken, userData, overrides, }) => {
-            const normalizedToken = normalizeAddress(superToken);
+        this.createIndex = (params) => {
+            const normalizedToken = normalizeAddress(params.superToken);
             const callData = idaInterface.encodeFunctionData("createIndex", [
                 normalizedToken,
-                indexId,
+                params.indexId,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
-         * @dev Distributes `amount` of `superToken` to an index
+         * Distributes `amount` of `superToken` to an index
          * @param indexId The id of the index.
          * @param amount The amount of `superToken` to be distributed.
          * @param superToken The superToken to be distributed.
@@ -100,18 +100,18 @@ export default class InstantDistributionAgreementV1 {
          * @param overrides ethers overrides object for more control over the transaction sent.
          * @returns {Operation} An instance of Operation which can be executed or batched.
          */
-        this.distribute = ({ indexId, amount, superToken, userData, overrides, }) => {
-            const normalizedToken = normalizeAddress(superToken);
+        this.distribute = (params) => {
+            const normalizedToken = normalizeAddress(params.superToken);
             const callData = idaInterface.encodeFunctionData("distribute", [
                 normalizedToken,
-                indexId,
-                amount,
+                params.indexId,
+                params.amount,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
-         * @dev Updates the `indexValue` of an index.
+         * Updates the `indexValue` of an index.
          * @description NOTE: It has the same effect as `distribute`, but is closer to the low level data structure of the index.
          * @param indexId The id of the index.
          * @param indexValue The new indexValue.
@@ -120,18 +120,18 @@ export default class InstantDistributionAgreementV1 {
          * @param overrides ethers overrides object for more control over the transaction sent.
          * @returns {Operation} An instance of Operation which can be executed or batched.
          */
-        this.updateIndexValue = ({ indexId, indexValue, superToken, userData, overrides, }) => {
-            const normalizedToken = normalizeAddress(superToken);
+        this.updateIndexValue = (params) => {
+            const normalizedToken = normalizeAddress(params.superToken);
             const callData = idaInterface.encodeFunctionData("updateIndex", [
                 normalizedToken,
-                indexId,
-                indexValue,
+                params.indexId,
+                params.indexValue,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
-         * @dev Updates the `units` allocated to a Subscription.
+         * Updates the `units` allocated to a Subscription.
          * @param indexId The id of the index.
          * @param superToken The superToken of the index.
          * @param subscriber The subscriber address whose units you want to update.
@@ -140,20 +140,20 @@ export default class InstantDistributionAgreementV1 {
          * @param overrides ethers overrides object for more control over the transaction sent.
          * @returns {Operation} An instance of Operation which can be executed or batched.
          */
-        this.updateSubscriptionUnits = ({ indexId, superToken, subscriber, units, userData, overrides, }) => {
-            const normalizedToken = normalizeAddress(superToken);
-            const normalizedSubscriber = normalizeAddress(subscriber);
+        this.updateSubscriptionUnits = (params) => {
+            const normalizedToken = normalizeAddress(params.superToken);
+            const normalizedSubscriber = normalizeAddress(params.subscriber);
             const callData = idaInterface.encodeFunctionData("updateSubscription", [
                 normalizedToken,
-                indexId,
+                params.indexId,
                 normalizedSubscriber,
-                units,
+                params.units,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
-         * @dev Approves a Subscription, so the Subscriber won't need to claim tokens when the Publisher distributes.
+         * Approves a Subscription, so the Subscriber won't need to claim tokens when the Publisher distributes.
          * @param indexId The id of the index.
          * @param superToken The superToken of the index.
          * @param publisher The publisher of the index you want to approve.
@@ -161,14 +161,14 @@ export default class InstantDistributionAgreementV1 {
          * @param overrides ethers overrides object for more control over the transaction sent.
          * @returns {Operation} An instance of Operation which can be executed or batched.
          */
-        this.approveSubscription = ({ indexId, superToken, publisher, userData, overrides, }) => {
-            const normalizedPublisher = normalizeAddress(publisher);
-            const normalizedToken = normalizeAddress(superToken);
-            const callData = idaInterface.encodeFunctionData("approveSubscription", [normalizedToken, normalizedPublisher, indexId, "0x"]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+        this.approveSubscription = (params) => {
+            const normalizedPublisher = normalizeAddress(params.publisher);
+            const normalizedToken = normalizeAddress(params.superToken);
+            const callData = idaInterface.encodeFunctionData("approveSubscription", [normalizedToken, normalizedPublisher, params.indexId, "0x"]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
-         * @dev Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributres.
+         * Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributres.
          * @param indexId The id of the index.
          * @param superToken The superToken of the index.
          * @param subscriber The subscriber address whose subscription you want to revoke.
@@ -176,19 +176,19 @@ export default class InstantDistributionAgreementV1 {
          * @param overrides ethers overrides object for more control over the transaction sent.
          * @returns {Operation} An instance of Operation which can be executed or batched.
          */
-        this.revokeSubscription = ({ indexId, superToken, publisher, userData, overrides, }) => {
-            const normalizedPublisher = normalizeAddress(publisher);
-            const normalizedToken = normalizeAddress(superToken);
+        this.revokeSubscription = (params) => {
+            const normalizedPublisher = normalizeAddress(params.publisher);
+            const normalizedToken = normalizeAddress(params.superToken);
             const callData = idaInterface.encodeFunctionData("revokeSubscription", [
                 normalizedToken,
                 normalizedPublisher,
-                indexId,
+                params.indexId,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
-         * @dev Deletes a Subscription by setting the `units` allocated to the Subscriber to 0.
+         * Deletes a Subscription by setting the `units` allocated to the Subscriber to 0.
          * @param indexId The id of the index.
          * @param superToken The superToken of the index.
          * @param subscriber The subscriber address whose subscription you want to delete.
@@ -197,21 +197,21 @@ export default class InstantDistributionAgreementV1 {
          * @param overrides ethers overrides object for more control over the transaction sent.
          * @returns {Operation} An instance of Operation which can be executed or batched.
          */
-        this.deleteSubscription = ({ indexId, superToken, subscriber, publisher, userData, overrides, }) => {
-            const normalizedPublisher = normalizeAddress(publisher);
-            const normalizedToken = normalizeAddress(superToken);
-            const normalizedSubscriber = normalizeAddress(subscriber);
+        this.deleteSubscription = (params) => {
+            const normalizedPublisher = normalizeAddress(params.publisher);
+            const normalizedToken = normalizeAddress(params.superToken);
+            const normalizedSubscriber = normalizeAddress(params.subscriber);
             const callData = idaInterface.encodeFunctionData("deleteSubscription", [
                 normalizedToken,
                 normalizedPublisher,
-                indexId,
+                params.indexId,
                 normalizedSubscriber,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
-         * @dev Claims any pending tokens allocated to the Subscription (unapproved).
+         * Claims any pending tokens allocated to the Subscription (unapproved).
          * @param indexId The id of the index.
          * @param superToken The superToken of the index.
          * @param subscriber The subscriber address whose subscription you want to delete.
@@ -220,24 +220,22 @@ export default class InstantDistributionAgreementV1 {
          * @param overrides ethers overrides object for more control over the transaction sent.
          * @returns {Operation} An instance of Operation which can be executed or batched.
          */
-        this.claim = ({ indexId, superToken, subscriber, publisher, userData, overrides, }) => {
-            const normalizedPublisher = normalizeAddress(publisher);
-            const normalizedToken = normalizeAddress(superToken);
-            const normalizedSubscriber = normalizeAddress(subscriber);
+        this.claim = (params) => {
+            const normalizedPublisher = normalizeAddress(params.publisher);
+            const normalizedToken = normalizeAddress(params.superToken);
+            const normalizedSubscriber = normalizeAddress(params.subscriber);
             const callData = idaInterface.encodeFunctionData("claim", [
                 normalizedToken,
                 normalizedPublisher,
-                indexId,
+                params.indexId,
                 normalizedSubscriber,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         this.options = options;
         this.host = new Host(options.config.hostAddress);
-    }
-    get idaContract() {
-        return new ethers.Contract(this.options.config.idaV1Address, IInstantDistributionAgreementV1ABI.abi);
+        this.contract = new ethers.Contract(this.options.config.idaV1Address, IInstantDistributionAgreementV1ABI.abi);
     }
 }
 //# sourceMappingURL=InstantDistributionAgreementV1.js.map

package/dist/module/InstantDistributionAgreementV1.js.map

@@ -1 +1 @@
-{"version":3,"file":"InstantDistributionAgreementV1.js","sourceRoot":"","sources":["../../src/InstantDistributionAgreementV1.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,kCAAkC,MAAM,4CAA4C,CAAC;AAiB5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3C,kCAAkC,CAAC,GAAG,CACzC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,8BAA8B;IAI/C,YAAY,OAA4B;QAYxC,qBAAqB;QAErB;;;;;;;;WAQG;QACH,oBAAe,GAAG,KAAK,EAAE,EACrB,UAAU,EACV,SAAS,EACT,OAAO,EACP,UAAU,EACV,gBAAgB,GACK,EAA8B,EAAE;YACrD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1D,IAAI;gBACA,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,WAAW;qBACtC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,eAAe,CACZ,eAAe,EACf,mBAAmB,EACnB,OAAO,EACP,oBAAoB,CACvB,CAAC;gBAEN,OAAO;oBACH,KAAK,EAAE,YAAY,CAAC,KAAK;oBACzB,QAAQ,EAAE,YAAY,CAAC,QAAQ;oBAC/B,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,QAAQ,EAAE;oBACpC,mBAAmB,EACf,YAAY,CAAC,mBAAmB,CAAC,QAAQ,EAAE;iBAClD,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,YAAY;oBAClB,aAAa,EAAE,6CAA6C;oBAC5D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,aAAQ,GAAG,KAAK,EAAE,EACd,UAAU,EACV,SAAS,EACT,OAAO,EACP,gBAAgB,GACF,EAAuB,EAAE;YACvC,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,IAAI;gBACA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW;qBAC/B,OAAO,CAAC,gBAAgB,CAAC;qBACzB,QAAQ,CAAC,eAAe,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;gBAC7D,OAAO;oBACH,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE;oBACvC,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE;oBACvD,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC,QAAQ,EAAE;iBACxD,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,YAAY;oBAClB,aAAa,EAAE,sCAAsC;oBACrD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,sBAAsB;QAEtB;;;;;;;WAOG;QACH,gBAAW,GAAG,CAAC,EACX,OAAO,EACP,UAAU,EACV,QAAQ,EACR,SAAS,GACQ,EAAa,EAAE;YAChC,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,aAAa,EAAE;gBAC5D,eAAe;gBACf,OAAO;gBACP,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,eAAU,GAAG,CAAC,EACV,OAAO,EACP,MAAM,EACN,UAAU,EACV,QAAQ,EACR,SAAS,GACO,EAAa,EAAE;YAC/B,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,YAAY,EAAE;gBAC3D,eAAe;gBACf,OAAO;gBACP,MAAM;gBACN,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,qBAAgB,GAAG,CAAC,EAChB,OAAO,EACP,UAAU,EACV,UAAU,EACV,QAAQ,EACR,SAAS,GACa,EAAa,EAAE;YACrC,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,aAAa,EAAE;gBAC5D,eAAe;gBACf,OAAO;gBACP,UAAU;gBACV,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,4BAAuB,GAAG,CAAC,EACvB,OAAO,EACP,UAAU,EACV,UAAU,EACV,KAAK,EACL,QAAQ,EACR,SAAS,GACoB,EAAa,EAAE;YAC5C,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,oBAAoB,EAAE;gBACnE,eAAe;gBACf,OAAO;gBACP,oBAAoB;gBACpB,KAAK;gBACL,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,wBAAmB,GAAG,CAAC,EACnB,OAAO,EACP,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACgB,EAAa,EAAE;YACxC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAC5C,qBAAqB,EACrB,CAAC,eAAe,EAAE,mBAAmB,EAAE,OAAO,EAAE,IAAI,CAAC,CACxD,CAAC;YAEF,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,uBAAkB,GAAG,CAAC,EAClB,OAAO,EACP,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACe,EAAa,EAAE;YACvC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,oBAAoB,EAAE;gBACnE,eAAe;gBACf,mBAAmB;gBACnB,OAAO;gBACP,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,uBAAkB,GAAG,CAAC,EAClB,OAAO,EACP,UAAU,EACV,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACe,EAAa,EAAE;YACvC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,oBAAoB,EAAE;gBACnE,eAAe;gBACf,mBAAmB;gBACnB,OAAO;gBACP,oBAAoB;gBACpB,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,UAAK,GAAG,CAAC,EACL,OAAO,EACP,UAAU,EACV,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACE,EAAa,EAAE;YAC1B,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,OAAO,EAAE;gBACtD,eAAe;gBACf,mBAAmB;gBACnB,OAAO;gBACP,oBAAoB;gBACpB,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAzWE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;IAED,IAAY,WAAW;QACnB,OAAO,IAAI,MAAM,CAAC,QAAQ,CACtB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,kCAAkC,CAAC,GAAG,CACN,CAAC;IACzC,CAAC;CAiWJ"}
+{"version":3,"file":"InstantDistributionAgreementV1.js","sourceRoot":"","sources":["../../src/InstantDistributionAgreementV1.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,kCAAkC,MAAM,4CAA4C,CAAC;AAiB5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3C,kCAAkC,CAAC,GAAG,CACzC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,8BAA8B;IAK/C,YAAY,OAA4B;QASxC,iCAAiC;QAEjC;;;;;;;;WAQG;QACH,oBAAe,GAAG,KAAK,EACnB,MAA8B,EACJ,EAAE;YAC5B,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/D,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACjE,IAAI;gBACA,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ;qBACnC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;qBAChC,eAAe,CACZ,eAAe,EACf,mBAAmB,EACnB,MAAM,CAAC,OAAO,EACd,oBAAoB,CACvB,CAAC;gBAEN,OAAO;oBACH,KAAK,EAAE,YAAY,CAAC,KAAK;oBACzB,QAAQ,EAAE,YAAY,CAAC,QAAQ;oBAC/B,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,QAAQ,EAAE;oBACpC,mBAAmB,EACf,YAAY,CAAC,mBAAmB,CAAC,QAAQ,EAAE;iBAClD,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,YAAY;oBAClB,aAAa,EAAE,6CAA6C;oBAC5D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,aAAQ,GAAG,KAAK,EAAE,MAAuB,EAAuB,EAAE;YAC9D,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/D,IAAI;gBACA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ;qBAC5B,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;qBAChC,QAAQ,CAAC,eAAe,EAAE,mBAAmB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;gBACpE,OAAO;oBACH,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE;oBACvC,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE;oBACvD,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC,QAAQ,EAAE;iBACxD,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,YAAY;oBAClB,aAAa,EAAE,sCAAsC;oBACrD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,kCAAkC;QAElC;;;;;;;WAOG;QACH,gBAAW,GAAG,CAAC,MAA0B,EAAa,EAAE;YACpD,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,aAAa,EAAE;gBAC5D,eAAe;gBACf,MAAM,CAAC,OAAO;gBACd,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACnB,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,eAAU,GAAG,CAAC,MAAyB,EAAa,EAAE;YAClD,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,YAAY,EAAE;gBAC3D,eAAe;gBACf,MAAM,CAAC,OAAO;gBACd,MAAM,CAAC,MAAM;gBACb,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACnB,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,qBAAgB,GAAG,CAAC,MAA+B,EAAa,EAAE;YAC9D,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,aAAa,EAAE;gBAC5D,eAAe;gBACf,MAAM,CAAC,OAAO;gBACd,MAAM,CAAC,UAAU;gBACjB,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACnB,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,4BAAuB,GAAG,CACtB,MAAsC,EAC7B,EAAE;YACX,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACjE,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,oBAAoB,EAAE;gBACnE,eAAe;gBACf,MAAM,CAAC,OAAO;gBACd,oBAAoB;gBACpB,MAAM,CAAC,KAAK;gBACZ,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACnB,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,wBAAmB,GAAG,CAAC,MAAkC,EAAa,EAAE;YACpE,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/D,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAC5C,qBAAqB,EACrB,CAAC,eAAe,EAAE,mBAAmB,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAC/D,CAAC;YAEF,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACnB,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,uBAAkB,GAAG,CAAC,MAAiC,EAAa,EAAE;YAClE,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/D,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,oBAAoB,EAAE;gBACnE,eAAe;gBACf,mBAAmB;gBACnB,MAAM,CAAC,OAAO;gBACd,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACnB,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,uBAAkB,GAAG,CAAC,MAAiC,EAAa,EAAE;YAClE,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/D,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACjE,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,oBAAoB,EAAE;gBACnE,eAAe;gBACf,mBAAmB;gBACnB,MAAM,CAAC,OAAO;gBACd,oBAAoB;gBACpB,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACnB,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,UAAK,GAAG,CAAC,MAAoB,EAAa,EAAE;YACxC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/D,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACjE,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,OAAO,EAAE;gBACtD,eAAe;gBACf,mBAAmB;gBACnB,MAAM,CAAC,OAAO;gBACd,oBAAoB;gBACpB,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACnB,CAAC;QACN,CAAC,CAAC;QA7SE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,GAAG,IAAI,MAAM,CAAC,QAAQ,CAC/B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,kCAAkC,CAAC,GAAG,CACN,CAAC;IACzC,CAAC;CAwSJ"}

package/dist/module/Operation.d.ts

@@ -2,7 +2,7 @@ import { TransactionRequest } from "@ethersproject/abstract-provider";
 import { ethers } from "ethers";
 export declare type OperationType = "UNSUPPORTED" | "ERC20_APPROVE" | "ERC20_TRANSFER_FROM" | "SUPERTOKEN_UPGRADE" | "SUPERTOKEN_DOWNGRADE" | "SUPERFLUID_CALL_AGREEMENT" | "CALL_APP_ACTION";
 /**
- * @dev Operation Helper Class
+ * Operation Helper Class
  * @description A helper class to create `Operation` objects which can be executed or batched.
  */
 export default class Operation {
@@ -10,26 +10,26 @@ export default class Operation {
     readonly type: OperationType;
     constructor(txn: Promise<ethers.PopulatedTransaction>, type: OperationType);
     /**
-     * @dev Executes the operation via the provided signer.
+     * Executes the operation via the provided signer.
      * @description Populates all fields of the transaction, signs it and sends it to the network.
      * @param signer The signer of the transacation
      * @returns {ethers.providers.TransactionResponse} A TransactionResponse object which can be awaited
      */
     exec: (signer: ethers.Signer) => Promise<ethers.providers.TransactionResponse>;
     /**
-     * @dev Get the populated transaction by awaiting `populateTransactionPromise`.
+     * Get the populated transaction by awaiting `populateTransactionPromise`.
      * @description Note that we need to populate the txn with the signer.
      * @returns {Promise<TransactionRequest>}
      */
     getPopulatedTransactionRequest: (signer: ethers.Signer) => Promise<TransactionRequest>;
     /**
-     * @dev Signs the populated transaction via the provided signer (what you intend on sending to the network).
+     * Signs the populated transaction via the provided signer (what you intend on sending to the network).
      * @param signer The signer of the transacation
      * @returns {Promise<string>} Fully serialized, signed transaction
      */
     getSignedTransaction: (signer: ethers.Signer) => Promise<string>;
     /**
-     * @dev Gets the transaction hash of the transaction.
+     * Gets the transaction hash of the transaction.
      * @description Calculates this by getting the keccak256 hash of the signedTxn.
      * @param signer The signer of the transacation
      * @returns {Promise<string>} The transaction hash of the transaction

package/dist/module/Operation.js

@@ -1,13 +1,13 @@
 import { ethers } from "ethers";
 import { SFError } from "./SFError";
 /**
- * @dev Operation Helper Class
+ * Operation Helper Class
  * @description A helper class to create `Operation` objects which can be executed or batched.
  */
 export default class Operation {
     constructor(txn, type) {
         /**
-         * @dev Executes the operation via the provided signer.
+         * Executes the operation via the provided signer.
          * @description Populates all fields of the transaction, signs it and sends it to the network.
          * @param signer The signer of the transacation
          * @returns {ethers.providers.TransactionResponse} A TransactionResponse object which can be awaited
@@ -26,7 +26,7 @@ export default class Operation {
             }
         };
         /**
-         * @dev Get the populated transaction by awaiting `populateTransactionPromise`.
+         * Get the populated transaction by awaiting `populateTransactionPromise`.
          * @description Note that we need to populate the txn with the signer.
          * @returns {Promise<TransactionRequest>}
          */
@@ -45,7 +45,7 @@ export default class Operation {
             }
         };
         /**
-         * @dev Signs the populated transaction via the provided signer (what you intend on sending to the network).
+         * Signs the populated transaction via the provided signer (what you intend on sending to the network).
          * @param signer The signer of the transacation
          * @returns {Promise<string>} Fully serialized, signed transaction
          */
@@ -64,7 +64,7 @@ export default class Operation {
             }
         };
         /**
-         * @dev Gets the transaction hash of the transaction.
+         * Gets the transaction hash of the transaction.
          * @description Calculates this by getting the keccak256 hash of the signedTxn.
          * @param signer The signer of the transacation
          * @returns {Promise<string>} The transaction hash of the transaction