@superfluid-finance/sdk-core 0.1.1-dev.fa49a94.0 → 0.2.1-dev.64549c3.0

package/dist/module/ConstantFlowAgreementV1.js

@@ -0,0 +1,172 @@
+import { ethers } from "ethers";
+import Host from "./Host";
+import SFError from "./SFError";
+import IConstantFlowAgreementV1ABI from "./abi/IConstantFlowAgreementV1.json";
+import { getSanitizedTimestamp, normalizeAddress } from "./utils";
+const cfaInterface = new ethers.utils.Interface(IConstantFlowAgreementV1ABI.abi);
+/**
+ * @dev Constant Flow Agreement V1 Helper Class
+ * @description A helper class to interact with the CFAV1 contract.
+ */
+export default class ConstantFlowAgreementV1 {
+    constructor(options) {
+        // CFA Read Functions
+        /**
+         * @dev 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
+         */
+        this.getFlow = async ({ superToken, sender, receiver, providerOrSigner, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedSender = normalizeAddress(sender);
+            const normalizedReceiver = normalizeAddress(receiver);
+            try {
+                const flowData = await this.cfaContract
+                    .connect(providerOrSigner)
+                    .getFlow(normalizedToken, normalizedSender, normalizedReceiver);
+                return this._sanitizeflowInfo(flowData);
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "CFAV1_READ",
+                    customMessage: "There was an error getting the flow",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @dev 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
+         */
+        this.getAccountFlowInfo = async ({ superToken, account, providerOrSigner, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedAccount = normalizeAddress(account);
+            try {
+                const flowData = await this.cfaContract
+                    .connect(providerOrSigner)
+                    .getAccountFlowInfo(normalizedToken, normalizedAccount);
+                return this._sanitizeflowInfo(flowData);
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "CFAV1_READ",
+                    customMessage: "There was an error getting the account flow information",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @dev 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
+         */
+        this.getNetFlow = async ({ superToken, account, providerOrSigner, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedAccount = normalizeAddress(account);
+            try {
+                return (await this.cfaContract
+                    .connect(providerOrSigner)
+                    .getNetFlow(normalizedToken, normalizedAccount)).toString();
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "CFAV1_READ",
+                    customMessage: "There was an error getting net flow",
+                    errorObject: err,
+                });
+            }
+        };
+        // CFA Write Functions
+        /**
+         * @dev 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.
+         */
+        this.createFlow = ({ flowRate, receiver, superToken, userData, overrides, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedReceiver = normalizeAddress(receiver);
+            const callData = cfaInterface.encodeFunctionData("createFlow", [
+                normalizedToken,
+                normalizedReceiver,
+                flowRate,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, userData, overrides);
+        };
+        /**
+         * @dev Update 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.
+         */
+        this.updateFlow = ({ flowRate, receiver, superToken, userData, overrides, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedReceiver = normalizeAddress(receiver);
+            const callData = cfaInterface.encodeFunctionData("updateFlow", [
+                normalizedToken,
+                normalizedReceiver,
+                flowRate,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, userData, overrides);
+        };
+        /**
+         * @dev 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.
+         */
+        this.deleteFlow = ({ superToken, sender, receiver, userData, overrides, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedSender = normalizeAddress(sender);
+            const normalizedReceiver = normalizeAddress(receiver);
+            const callData = cfaInterface.encodeFunctionData("deleteFlow", [
+                normalizedToken,
+                normalizedSender,
+                normalizedReceiver,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, userData, overrides);
+        };
+        /**
+         * @dev 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
+         */
+        this._sanitizeflowInfo = ({ timestamp, flowRate, deposit, owedDeposit, }) => {
+            return {
+                timestamp: getSanitizedTimestamp(timestamp),
+                flowRate: flowRate.toString(),
+                deposit: deposit.toString(),
+                owedDeposit: owedDeposit.toString(),
+            };
+        };
+        this.options = options;
+        this.host = new Host(options.config.hostAddress);
+    }
+    get cfaContract() {
+        return new ethers.Contract(this.options.config.cfaV1Address, IConstantFlowAgreementV1ABI.abi);
+    }
+}
+//# sourceMappingURL=ConstantFlowAgreementV1.js.map

package/dist/module/ConstantFlowAgreementV1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConstantFlowAgreementV1.js","sourceRoot":"","sources":["../../src/ConstantFlowAgreementV1.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,2BAA2B,MAAM,qCAAqC,CAAC;AAY9E,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAElE,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3C,2BAA2B,CAAC,GAAG,CAClC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,uBAAuB;IAIxC,YAAY,OAA4B;QAYxC,qBAAqB;QAErB;;;;;;;WAOG;QACH,YAAO,GAAG,KAAK,EAAE,EACb,UAAU,EACV,MAAM,EACN,QAAQ,EACR,gBAAgB,GACH,EAA0B,EAAE;YACzC,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAClD,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACtD,IAAI;gBACA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW;qBAClC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,OAAO,CAAC,eAAe,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;gBACpE,OAAO,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;aAC3C;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,YAAY;oBAClB,aAAa,EAAE,qCAAqC;oBACpD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;;;WAMG;QACH,uBAAkB,GAAG,KAAK,EAAE,EACxB,UAAU,EACV,OAAO,EACP,gBAAgB,GACQ,EAA0B,EAAE;YACpD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI;gBACA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW;qBAClC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,kBAAkB,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;gBAC5D,OAAO,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;aAC3C;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,YAAY;oBAClB,aAAa,EACT,yDAAyD;oBAC7D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;;;WAMG;QACH,eAAU,GAAG,KAAK,EAAE,EAChB,UAAU,EACV,OAAO,EACP,gBAAgB,GACQ,EAAmB,EAAE;YAC7C,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI;gBACA,OAAO,CACH,MAAM,IAAI,CAAC,WAAW;qBACjB,OAAO,CAAC,gBAAgB,CAAC;qBACzB,UAAU,CAAC,eAAe,EAAE,iBAAiB,CAAC,CACtD,CAAC,QAAQ,EAAE,CAAC;aAChB;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,YAAY;oBAClB,aAAa,EAAE,qCAAqC;oBACpD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,sBAAsB;QAEtB;;;;;;;;WAQG;QACH,eAAU,GAAG,CAAC,EACV,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,SAAS,GACO,EAAa,EAAE;YAC/B,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAEtD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,YAAY,EAAE;gBAC3D,eAAe;gBACf,kBAAkB;gBAClB,QAAQ;gBACR,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,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,SAAS,GACO,EAAa,EAAE;YAC/B,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAEtD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,YAAY,EAAE;gBAC3D,eAAe;gBACf,kBAAkB;gBAClB,QAAQ;gBACR,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,UAAU,EACV,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,SAAS,GACO,EAAa,EAAE;YAC/B,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAClD,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAEtD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,YAAY,EAAE;gBAC3D,eAAe;gBACf,gBAAgB;gBAChB,kBAAkB;gBAClB,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;;;;;;;WAOG;QACH,sBAAiB,GAAG,CAAC,EACjB,SAAS,EACT,QAAQ,EACR,OAAO,EACP,WAAW,GACO,EAAiB,EAAE;YACrC,OAAO;gBACH,SAAS,EAAE,qBAAqB,CAAC,SAAS,CAAC;gBAC3C,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE;gBAC7B,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;gBAC3B,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE;aACtC,CAAC;QACN,CAAC,CAAC;QAnOE,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,2BAA2B,CAAC,GAAG,CACN,CAAC;IAClC,CAAC;CA2NJ"}

package/dist/module/Framework.d.ts

@@ -1,5 +1,7 @@
 import { Signer } from "@ethersproject/abstract-signer";
+import { HardhatEthersHelpers } from "@nomiclabs/hardhat-ethers/types";
 import { ethers } from "ethers";
+import Web3 from "web3";
 import BatchCall from "./BatchCall";
 import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
 import Host from "./Host";
@@ -9,6 +11,7 @@ import Query from "./Query";
 import SuperToken from "./SuperToken";
 import { IConfig, ISignerConstructorOptions } from "./interfaces";
 import { DataMode } from "./types";
+declare type SupportedProvider = ethers.providers.Provider | (typeof ethers & HardhatEthersHelpers) | Web3;
 export interface IFrameworkOptions {
     chainId?: number;
     customSubgraphQueriesEndpoint?: string;
@@ -16,7 +19,7 @@ export interface IFrameworkOptions {
     networkName?: string;
     resolverAddress?: string;
     protocolReleaseVersion?: string;
-    provider: ethers.providers.Provider;
+    provider: SupportedProvider;
 }
 export interface IFrameworkSettings {
     chainId: number;
@@ -47,7 +50,7 @@ export default class Framework {
      * @param options.networkName the desired network (e.g. "matic", "rinkeby", etc.)
      * @param options.resolverAddress a custom resolver address (advanced use for testing)
      * @param options.protocolReleaseVersion a custom release version (advanced use for testing)
-     * @param options.provider a provider object necessary for initializing the framework
+     * @param options.provider a provider object (injected web3, injected ethers, ethers provider) necessary for initializing the framework
      * @returns `Framework` class
      */
     static create: (options: IFrameworkOptions) => Promise<Framework>;
@@ -73,3 +76,5 @@ export default class Framework {
      */
     loadSuperToken: (address: string) => Promise<SuperToken>;
 }
+export {};
+//# sourceMappingURL=Framework.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Framework.d.ts","sourceRoot":"","sources":["../../src/Framework.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,8BAA8B,MAAM,kCAAkC,CAAC;AAC9E,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,OAAO,UAAU,MAAM,cAAc,CAAC;AAStC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAElE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGnC,aAAK,iBAAiB,GAChB,MAAM,CAAC,SAAS,CAAC,QAAQ,GACzB,CAAC,OAAO,MAAM,GAAG,oBAAoB,CAAC,GACtC,IAAI,CAAC;AAIX,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,EAAE,iBAAiB,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B,EAAE,MAAM,CAAC;IACtC,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;IACpC,MAAM,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,QAAQ,CAAC,gBAAgB,EAAE,iBAAiB,CAAC;IAC7C,QAAQ,EAAE,kBAAkB,CAAC;IAE7B,KAAK,EAAE,uBAAuB,CAAC;IAC/B,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,8BAA8B,CAAC;IACtC,KAAK,EAAE,KAAK,CAAC;IAEb,OAAO;IAiBP;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,YAAmB,iBAAiB,wBA+F/C;IAEF;;;;;;;OAOG;IACH,YAAY,YAAa,yBAAyB,KAAG,MAAM,CAqCzD;IAEF;;;;OAIG;IACH,SAAS,eAAgB,SAAS,EAAE,eAKlC;IAEF;;;;OAIG;IACH,cAAc,YAAmB,MAAM,KAAG,QAAQ,UAAU,CAAC,CAE3D;CACL"}

package/dist/module/Framework.js

@@ -0,0 +1,175 @@
+var _a;
+import { ethers } from "ethers";
+import BatchCall from "./BatchCall";
+import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
+import Host from "./Host";
+import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
+import Query from "./Query";
+import SFError from "./SFError";
+import SuperToken from "./SuperToken";
+import IResolverABI from "./abi/IResolver.json";
+import SuperfluidLoaderABI from "./abi/SuperfluidLoader.json";
+import { chainIdToResolverDataMap, networkNameToChainIdMap } from "./constants";
+import { getNetworkName, getSubgraphQueriesEndpoint, validateFrameworkConstructorOptions, } from "./frameworkHelpers";
+import { isEthersProvider, isInjectedWeb3 } from "./utils";
+/**
+ * @dev Superfluid Framework Class
+ * @description The entrypoint for the SDK-core, `create` an instance of this for full functionality.
+ */
+export default class Framework {
+    constructor(options, settings) {
+        /**
+         * @dev Create a signer which can be used to sign transactions.
+         * @param options.web3Provider a Web3Provider object (e.g. client side - metamask, web3modal)
+         * @param options.provider an ethers Provider object (e.g. via Hardhat ethers)
+         * @param options.privateKey a test account private key
+         * @param options.signer a signer object (e.g. ethers.Wallet instance)
+         * @returns `ethers.Signer` object
+         */
+        this.createSigner = (options) => {
+            if (!options.privateKey &&
+                !options.provider &&
+                !options.signer &&
+                !options.web3Provider) {
+                throw new SFError({
+                    type: "CREATE_SIGNER",
+                    customMessage: "You must pass in a private key, provider or signer.",
+                });
+            }
+            /* istanbul ignore else  */
+            if (options.privateKey) {
+                if (!options.provider) {
+                    throw new SFError({
+                        type: "CREATE_SIGNER",
+                        customMessage: "You must pass in a provider with your private key.",
+                    });
+                }
+                return new ethers.Wallet(options.privateKey, options.provider);
+            }
+            else if (options.signer) {
+                return options.signer;
+            }
+            // NOTE: tested by sdk-redux already
+            else if (options.web3Provider) {
+                return options.web3Provider.getSigner();
+            }
+            /* istanbul ignore next */
+            throw new SFError({
+                type: "CREATE_SIGNER",
+                customMessage: "Something went wrong, this should never occur.",
+            });
+        };
+        /**
+         * @dev Create a `BatchCall` class from the `Framework`.
+         * @param operations the list of operations to execute
+         * @returns `BatchCall` class
+         */
+        this.batchCall = (operations) => {
+            return new BatchCall({
+                operations,
+                hostAddress: this.settings.config.hostAddress,
+            });
+        };
+        /**
+         * @dev Load a `SuperToken` class from the `Framework`.
+         * @param address the `SuperToken` address
+         * @returns `SuperToken` class
+         */
+        this.loadSuperToken = async (address) => {
+            return await SuperToken.create({ ...this.settings, address });
+        };
+        this.userInputOptions = options;
+        this.settings = settings;
+        this.cfaV1 = new ConstantFlowAgreementV1({
+            config: this.settings.config,
+        });
+        this.host = new Host(this.settings.config.hostAddress);
+        this.idaV1 = new InstantDistributionAgreementV1({
+            config: this.settings.config,
+        });
+        this.query = new Query(this.settings);
+    }
+}
+_a = Framework;
+/**
+ * @dev Creates the Framework object based on user provided `options`.
+ * @param options.chainId the chainId of your desired network (e.g. 137 = matic)
+ * @param options.customSubgraphQueriesEndpoint your custom subgraph endpoint
+ * @param options.dataMode the data mode you'd like the framework to use (SUBGRAPH_ONLY, SUBGRAPH_WEB3, WEB3_ONLY)
+ * @param options.networkName the desired network (e.g. "matic", "rinkeby", etc.)
+ * @param options.resolverAddress a custom resolver address (advanced use for testing)
+ * @param options.protocolReleaseVersion a custom release version (advanced use for testing)
+ * @param options.provider a provider object (injected web3, injected ethers, ethers provider) necessary for initializing the framework
+ * @returns `Framework` class
+ */
+Framework.create = async (options) => {
+    validateFrameworkConstructorOptions({
+        ...options,
+        dataMode: options.dataMode || "SUBGRAPH_ONLY",
+        protocolReleaseVersion: options.protocolReleaseVersion || "v1",
+    });
+    const networkName = getNetworkName(options);
+    const chainId = 
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    options.chainId || networkNameToChainIdMap.get(networkName);
+    const releaseVersion = options.protocolReleaseVersion || "v1";
+    // NOTE: endpoint can be empty in WEB3_ONLY mode
+    const customSubgraphQueriesEndpoint = options.dataMode === "WEB3_ONLY"
+        ? ""
+        : options.customSubgraphQueriesEndpoint ||
+            getSubgraphQueriesEndpoint(options);
+    const provider = isEthersProvider(options.provider)
+        ? options.provider
+        : isInjectedWeb3(options.provider)
+            ? // must explicitly cast web3 provider type because
+                // ethers.providers.Web3Provider doesn't like
+                // the type passed.
+                new ethers.providers.Web3Provider(options.provider.currentProvider)
+            : options.provider.provider;
+    const network = await provider.getNetwork();
+    if (network.chainId !== chainId && chainId != null) {
+        throw new SFError({
+            type: "NETWORK_MISMATCH",
+            customMessage: "Your provider network chainId is: " +
+                network.chainId +
+                " whereas your desired chainId is: " +
+                chainId,
+        });
+    }
+    try {
+        const resolverData = chainIdToResolverDataMap.get(chainId) || {
+            subgraphAPIEndpoint: "",
+            resolverAddress: "",
+            networkName: "",
+        };
+        const resolverAddress = options.resolverAddress
+            ? options.resolverAddress
+            : resolverData.resolverAddress;
+        const resolver = new ethers.Contract(resolverAddress, IResolverABI.abi, provider);
+        const superfluidLoaderAddress = await resolver.get("SuperfluidLoader-v1");
+        const superfluidLoader = new ethers.Contract(superfluidLoaderAddress, SuperfluidLoaderABI.abi, provider);
+        const framework = await superfluidLoader.loadFramework(releaseVersion);
+        const settings = {
+            chainId,
+            customSubgraphQueriesEndpoint,
+            dataMode: options.dataMode || "SUBGRAPH_ONLY",
+            protocolReleaseVersion: options.protocolReleaseVersion || "v1",
+            provider,
+            networkName,
+            config: {
+                hostAddress: framework.superfluid,
+                cfaV1Address: framework.agreementCFAv1,
+                idaV1Address: framework.agreementIDAv1,
+            },
+        };
+        return new Framework(options, settings);
+    }
+    catch (err) {
+        throw new SFError({
+            type: "FRAMEWORK_INITIALIZATION",
+            customMessage: "There was an error initializing the framework",
+            errorObject: err,
+        });
+    }
+};
+//# sourceMappingURL=Framework.js.map

package/dist/module/Framework.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Framework.js","sourceRoot":"","sources":["../../src/Framework.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,8BAA8B,MAAM,kCAAkC,CAAC;AAE9E,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,YAAY,MAAM,sBAAsB,CAAC;AAChD,OAAO,mBAAmB,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,EACH,cAAc,EACd,0BAA0B,EAC1B,mCAAmC,GACtC,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AA6B3D;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAS1B,YACI,OAA0B,EAC1B,QAA4B;QA2HhC;;;;;;;WAOG;QACH,iBAAY,GAAG,CAAC,OAAkC,EAAU,EAAE;YAC1D,IACI,CAAC,OAAO,CAAC,UAAU;gBACnB,CAAC,OAAO,CAAC,QAAQ;gBACjB,CAAC,OAAO,CAAC,MAAM;gBACf,CAAC,OAAO,CAAC,YAAY,EACvB;gBACE,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,eAAe;oBACrB,aAAa,EACT,qDAAqD;iBAC5D,CAAC,CAAC;aACN;YAED,2BAA2B;YAC3B,IAAI,OAAO,CAAC,UAAU,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;oBACnB,MAAM,IAAI,OAAO,CAAC;wBACd,IAAI,EAAE,eAAe;wBACrB,aAAa,EACT,oDAAoD;qBAC3D,CAAC,CAAC;iBACN;gBACD,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;aAClE;iBAAM,IAAI,OAAO,CAAC,MAAM,EAAE;gBACvB,OAAO,OAAO,CAAC,MAAM,CAAC;aACzB;YACD,oCAAoC;iBAC/B,IAAI,OAAO,CAAC,YAAY,EAAE;gBAC3B,OAAO,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;aAC3C;YAED,0BAA0B;YAC1B,MAAM,IAAI,OAAO,CAAC;gBACd,IAAI,EAAE,eAAe;gBACrB,aAAa,EAAE,gDAAgD;aAClE,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;WAIG;QACH,cAAS,GAAG,CAAC,UAAuB,EAAE,EAAE;YACpC,OAAO,IAAI,SAAS,CAAC;gBACjB,UAAU;gBACV,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW;aAChD,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;WAIG;QACH,mBAAc,GAAG,KAAK,EAAE,OAAe,EAAuB,EAAE;YAC5D,OAAO,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAClE,CAAC,CAAC;QA3LE,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,CAAC,KAAK,GAAG,IAAI,uBAAuB,CAAC;YACrC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,8BAA8B,CAAC;YAC5C,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;;;AAED;;;;;;;;;;GAUG;AACI,gBAAM,GAAG,KAAK,EAAE,OAA0B,EAAE,EAAE;IACjD,mCAAmC,CAAC;QAChC,GAAG,OAAO;QACV,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,eAAe;QAC7C,sBAAsB,EAAE,OAAO,CAAC,sBAAsB,IAAI,IAAI;KACjE,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,OAAO;IACT,oEAAoE;IACpE,OAAO,CAAC,OAAO,IAAI,uBAAuB,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;IACjE,MAAM,cAAc,GAAG,OAAO,CAAC,sBAAsB,IAAI,IAAI,CAAC;IAE9D,gDAAgD;IAChD,MAAM,6BAA6B,GAC/B,OAAO,CAAC,QAAQ,KAAK,WAAW;QAC5B,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,OAAO,CAAC,6BAA6B;YACrC,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC/C,CAAC,CAAC,OAAO,CAAC,QAAQ;QAClB,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC;YAClC,CAAC,CAAC,kDAAkD;gBAClD,6CAA6C;gBAC7C,mBAAmB;gBACnB,IAAI,MAAM,CAAC,SAAS,CAAC,YAAY,CAC7B,OAAO,CAAC,QAAQ,CAAC,eAEsB,CAC1C;YACH,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAEhC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;IAC5C,IAAI,OAAO,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,IAAI,IAAI,EAAE;QAChD,MAAM,IAAI,OAAO,CAAC;YACd,IAAI,EAAE,kBAAkB;YACxB,aAAa,EACT,oCAAoC;gBACpC,OAAO,CAAC,OAAO;gBACf,oCAAoC;gBACpC,OAAO;SACd,CAAC,CAAC;KACN;IAED,IAAI;QACA,MAAM,YAAY,GAAG,wBAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI;YAC1D,mBAAmB,EAAE,EAAE;YACvB,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,EAAE;SAClB,CAAC;QACF,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe;YAC3C,CAAC,CAAC,OAAO,CAAC,eAAe;YACzB,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC;QACnC,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,QAAQ,CAChC,eAAe,EACf,YAAY,CAAC,GAAG,EAChB,QAAQ,CACE,CAAC;QAEf,MAAM,uBAAuB,GAAG,MAAM,QAAQ,CAAC,GAAG,CAC9C,qBAAqB,CACxB,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,MAAM,CAAC,QAAQ,CACxC,uBAAuB,EACvB,mBAAmB,CAAC,GAAG,EACvB,QAAQ,CACS,CAAC;QAEtB,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,aAAa,CAClD,cAAc,CACjB,CAAC;QAEF,MAAM,QAAQ,GAAuB;YACjC,OAAO;YACP,6BAA6B;YAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,eAAe;YAC7C,sBAAsB,EAAE,OAAO,CAAC,sBAAsB,IAAI,IAAI;YAC9D,QAAQ;YACR,WAAW;YACX,MAAM,EAAE;gBACJ,WAAW,EAAE,SAAS,CAAC,UAAU;gBACjC,YAAY,EAAE,SAAS,CAAC,cAAc;gBACtC,YAAY,EAAE,SAAS,CAAC,cAAc;aACzC;SACJ,CAAC;QAEF,OAAO,IAAI,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;KAC3C;IAAC,OAAO,GAAG,EAAE;QACV,MAAM,IAAI,OAAO,CAAC;YACd,IAAI,EAAE,0BAA0B;YAChC,aAAa,EAAE,+CAA+C;YAC9D,WAAW,EAAE,GAAG;SACnB,CAAC,CAAC;KACN;AACL,CAAE,CAAA"}

package/dist/module/Host.d.ts

@@ -1,3 +1,4 @@
+import { ethers } from "ethers";
 import Operation from "./Operation";
 import { Superfluid } from "./typechain";
 /**
@@ -12,7 +13,11 @@ export default class Host {
      * @param agreementAddress the agreement address (cfa or ida address)
      * @param callData the encoded callData for the function
      * @param userData any additional user data
+     * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} an `Operation` class
      */
-    populateCallAgreementTxnAndReturnOperation: (agreementAddress: string, callData: string, userData: string | undefined) => Operation;
+    populateCallAgreementTxnAndReturnOperation: (agreementAddress: string, callData: string, userData: string | undefined, overrides?: (ethers.Overrides & {
+        from?: string | Promise<string> | undefined;
+    }) | undefined) => Operation;
 }
+//# sourceMappingURL=Host.d.ts.map

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

@@ -0,0 +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"}

package/dist/module/Host.js

@@ -0,0 +1,25 @@
+import { ethers } from "ethers";
+import Operation from "./Operation";
+import SuperfluidABI from "./abi/Superfluid.json";
+/**
+ * @dev 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.
+         * @param agreementAddress the agreement address (cfa or ida address)
+         * @param callData the encoded callData for the function
+         * @param userData any additional user data
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} an `Operation` class
+         */
+        this.populateCallAgreementTxnAndReturnOperation = (agreementAddress, callData, userData, overrides) => {
+            const txn = this.hostContract.populateTransaction.callAgreement(agreementAddress, callData, userData || "0x", overrides || {});
+            return new Operation(txn, "SUPERFLUID_CALL_AGREEMENT");
+        };
+        this.hostContract = new ethers.Contract(hostAddress, SuperfluidABI.abi);
+    }
+}
+//# sourceMappingURL=Host.js.map

package/dist/module/Host.js.map

@@ -0,0 +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"}

package/dist/module/InstantDistributionAgreementV1.d.ts

@@ -1,6 +1,6 @@
 import Host from "./Host";
 import Operation from "./Operation";
-import { IAgreementV1Options, IBaseIDAParams, IBaseSubscriptionParams, IDistributeParams, IGetIndexParams, IGetSubscriptionParams, IUpdateIndexValueParams, IUpdateSubscriptionUnitsParams, IWeb3Index, IWeb3Subscription } from "./interfaces";
+import { IAgreementV1Options, IApproveSubscriptionParams, IClaimParams, ICreateIndexParams, IDeleteSubscriptionParams, IDistributeParams, IGetIndexParams, IGetSubscriptionParams, IRevokeSubscriptionParams, IUpdateIndexValueParams, IUpdateSubscriptionUnitsParams, IWeb3Index, IWeb3Subscription } from "./interfaces";
 /**
  * @dev Instant Distribution Agreement V1 Helper Class
  * @description A helper class to interact with the IDAV1 contract.
@@ -34,18 +34,20 @@ export default class InstantDistributionAgreementV1 {
      * @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, }: IBaseIDAParams) => Operation;
+    createIndex: ({ indexId, superToken, userData, overrides, }: ICreateIndexParams) => Operation;
     /**
      * @dev 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.
      * @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.
      */
-    distribute: ({ indexId, amount, superToken, userData, }: IDistributeParams) => Operation;
+    distribute: ({ indexId, amount, superToken, userData, overrides, }: IDistributeParams) => Operation;
     /**
      * @dev 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.
@@ -53,9 +55,10 @@ export default class InstantDistributionAgreementV1 {
      * @param indexValue The new indexValue.
      * @param superToken The superToken to be distributed.
      * @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.
      */
-    updateIndexValue: ({ indexId, indexValue, superToken, userData, }: IUpdateIndexValueParams) => Operation;
+    updateIndexValue: ({ indexId, indexValue, superToken, userData, overrides, }: IUpdateIndexValueParams) => Operation;
     /**
      * @dev Updates the `units` allocated to a Subscription.
      * @param indexId The id of the index.
@@ -63,27 +66,30 @@ export default class InstantDistributionAgreementV1 {
      * @param subscriber The subscriber address whose units you want to update.
      * @param units The amount of units you want to update to.
      * @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.
      */
-    updateSubscriptionUnits: ({ indexId, superToken, subscriber, units, userData, }: IUpdateSubscriptionUnitsParams) => Operation;
+    updateSubscriptionUnits: ({ indexId, superToken, subscriber, units, userData, overrides, }: IUpdateSubscriptionUnitsParams) => Operation;
     /**
      * @dev 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.
      * @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.
      */
-    approveSubscription: ({ indexId, superToken, publisher, userData, }: IBaseIDAParams) => Operation;
+    approveSubscription: ({ indexId, superToken, publisher, userData, overrides, }: IApproveSubscriptionParams) => Operation;
     /**
      * @dev 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.
      * @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.
      */
-    revokeSubscription: ({ indexId, superToken, publisher, userData, }: IBaseIDAParams) => Operation;
+    revokeSubscription: ({ indexId, superToken, publisher, userData, overrides, }: IRevokeSubscriptionParams) => Operation;
     /**
      * @dev Deletes a Subscription by setting the `units` allocated to the Subscriber to 0.
      * @param indexId The id of the index.
@@ -91,9 +97,10 @@ export default class InstantDistributionAgreementV1 {
      * @param subscriber The subscriber address whose subscription you want to delete.
      * @param publisher The publisher address of the index you are targetting.
      * @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.
      */
-    deleteSubscription: ({ indexId, superToken, subscriber, publisher, userData, }: IBaseSubscriptionParams) => Operation;
+    deleteSubscription: ({ indexId, superToken, subscriber, publisher, userData, overrides, }: IDeleteSubscriptionParams) => Operation;
     /**
      * @dev Claims any pending tokens allocated to the Subscription (unapproved).
      * @param indexId The id of the index.
@@ -101,7 +108,9 @@ export default class InstantDistributionAgreementV1 {
      * @param subscriber The subscriber address whose subscription you want to delete.
      * @param publisher The publisher address of the index you are targetting.
      * @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.
      */
-    claim: ({ indexId, superToken, subscriber, publisher, userData, }: IBaseSubscriptionParams) => Operation;
+    claim: ({ indexId, superToken, subscriber, publisher, userData, overrides, }: IClaimParams) => Operation;
 }
+//# sourceMappingURL=InstantDistributionAgreementV1.d.ts.map

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

@@ -0,0 +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"}