@superfluid-finance/sdk-core 0.1.1-dev.8caff13.0 → 0.1.1-dev.b8d3bbf.0

package/dist/main/Query.js

@@ -0,0 +1,310 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const SFError_1 = __importDefault(require("./SFError"));
+const mapGetAllEventsQueryEvents_1 = require("./mapGetAllEventsQueryEvents");
+const pagination_1 = require("./pagination");
+const SubgraphClient_1 = require("./subgraph/SubgraphClient");
+const getAccountTokenSnapshots_generated_1 = require("./subgraph/queries/getAccountTokenSnapshots.generated");
+const getAllEvents_generated_1 = require("./subgraph/queries/getAllEvents.generated");
+const getIndexSubscriptions_generated_1 = require("./subgraph/queries/getIndexSubscriptions.generated");
+const getIndexes_generated_1 = require("./subgraph/queries/getIndexes.generated");
+const getStreams_generated_1 = require("./subgraph/queries/getStreams.generated");
+const getTokens_generated_1 = require("./subgraph/queries/getTokens.generated");
+const validation_1 = require("./validation");
+/**
+ * @dev Query Helper Class
+ * @description A helper class to create `Query` objects which can be used to query different data.
+ */
+class Query {
+    constructor(options) {
+        /**
+         * A recursive function to fetch all possible results of a paged query.
+         * @param pagedQuery A paginated query that takes {@link Paging} as input.
+         */
+        this.listAllResults = async (pagedQuery) => {
+            const listAllRecursively = async (paging) => {
+                const pagedResult = await pagedQuery(paging);
+                if (!pagedResult.nextPaging)
+                    return pagedResult.data;
+                const nextResults = await listAllRecursively(pagedResult.nextPaging);
+                return pagedResult.data.concat(nextResults);
+            };
+            return listAllRecursively((0, pagination_1.createLastIdPaging)({ take: 999 }));
+        };
+        this.listAllSuperTokens = async (filter, paging = (0, pagination_1.createSkipPaging)(), ordering = {
+            orderBy: "createdAtBlockNumber",
+            orderDirection: "desc",
+        }) => {
+            if (this.options.dataMode === "WEB3_ONLY") {
+                throw new SFError_1.default({
+                    type: "UNSUPPORTED_WEB_3_ONLY",
+                    customMessage: "This query is not supported in WEB3_ONLY mode.",
+                });
+            }
+            (0, validation_1.validateSuperTokenRequest)(filter);
+            const response = await this.subgraphClient.request(getTokens_generated_1.GetTokensDocument, {
+                where: {
+                    isListed: filter.isListed,
+                    isSuperToken: true,
+                    id_gt: paging.lastId,
+                },
+                orderBy: ordering === null || ordering === void 0 ? void 0 : ordering.orderBy,
+                orderDirection: ordering === null || ordering === void 0 ? void 0 : ordering.orderDirection,
+                first: (0, pagination_1.takePlusOne)(paging),
+                skip: paging.skip,
+            });
+            const mappedResult = response.result.map((x) => typeGuard({
+                ...x,
+                createdAtTimestamp: Number(x.createdAtTimestamp),
+                createdAtBlockNumber: Number(x.createdAtBlockNumber),
+            }));
+            return (0, pagination_1.createPagedResult)(mappedResult, paging);
+        };
+        this.listIndexes = async (filter, paging = (0, pagination_1.createSkipPaging)(), ordering = {
+            orderBy: "createdAtBlockNumber",
+            orderDirection: "desc",
+        }) => {
+            var _a, _b;
+            if (this.options.dataMode === "WEB3_ONLY") {
+                throw new SFError_1.default({
+                    type: "UNSUPPORTED_WEB_3_ONLY",
+                    customMessage: "This query is not supported in WEB3_ONLY mode.",
+                });
+            }
+            (0, validation_1.validateIndexRequest)(filter);
+            const response = await this.subgraphClient.request(getIndexes_generated_1.GetIndexesDocument, {
+                where: {
+                    indexId: filter.indexId,
+                    publisher: (_a = filter.publisher) === null || _a === void 0 ? void 0 : _a.toLowerCase(),
+                    token: (_b = filter.token) === null || _b === void 0 ? void 0 : _b.toLowerCase(),
+                    id_gt: paging.lastId,
+                },
+                orderBy: ordering === null || ordering === void 0 ? void 0 : ordering.orderBy,
+                orderDirection: ordering === null || ordering === void 0 ? void 0 : ordering.orderDirection,
+                first: (0, pagination_1.takePlusOne)(paging),
+                skip: paging.skip,
+            });
+            const mappedResult = response.result.map((x) => typeGuard({
+                ...x,
+                publisher: x.publisher.id,
+                createdAtTimestamp: Number(x.createdAtTimestamp),
+                createdAtBlockNumber: Number(x.createdAtBlockNumber),
+                updatedAtTimestamp: Number(x.updatedAtTimestamp),
+                updatedAtBlockNumber: Number(x.updatedAtBlockNumber),
+                token: {
+                    ...x.token,
+                    createdAtTimestamp: Number(x.token.createdAtTimestamp),
+                    createdAtBlockNumber: Number(x.token.createdAtBlockNumber),
+                },
+            }));
+            return (0, pagination_1.createPagedResult)(mappedResult, paging);
+        };
+        this.listIndexSubscriptions = async (filter, paging = (0, pagination_1.createSkipPaging)(), ordering = {
+            orderBy: "createdAtBlockNumber",
+            orderDirection: "desc",
+        }) => {
+            var _a;
+            if (this.options.dataMode === "WEB3_ONLY") {
+                throw new SFError_1.default({
+                    type: "UNSUPPORTED_WEB_3_ONLY",
+                    customMessage: "This query is not supported in WEB3_ONLY mode.",
+                });
+            }
+            (0, validation_1.validateIndexSubscriptionRequest)(filter);
+            const response = await this.subgraphClient.request(getIndexSubscriptions_generated_1.GetIndexSubscriptionsDocument, {
+                where: {
+                    subscriber: (_a = filter.subscriber) === null || _a === void 0 ? void 0 : _a.toLowerCase(),
+                    approved: filter.approved,
+                    id_gt: paging.lastId,
+                },
+                orderBy: ordering === null || ordering === void 0 ? void 0 : ordering.orderBy,
+                orderDirection: ordering === null || ordering === void 0 ? void 0 : ordering.orderDirection,
+                first: (0, pagination_1.takePlusOne)(paging),
+                skip: paging.skip,
+            });
+            const mappedResult = response.result.map((x) => typeGuard({
+                ...x,
+                subscriber: x.subscriber.id,
+                createdAtTimestamp: Number(x.createdAtTimestamp),
+                createdAtBlockNumber: Number(x.createdAtBlockNumber),
+                updatedAtTimestamp: Number(x.updatedAtTimestamp),
+                updatedAtBlockNumber: Number(x.updatedAtBlockNumber),
+                index: {
+                    ...x.index,
+                    token: {
+                        ...x.index.token,
+                        createdAtTimestamp: Number(x.index.token.createdAtTimestamp),
+                        createdAtBlockNumber: Number(x.index.token.createdAtBlockNumber),
+                    },
+                },
+            }));
+            return (0, pagination_1.createPagedResult)(mappedResult, paging);
+        };
+        this.listStreams = async (filter, paging = (0, pagination_1.createSkipPaging)(), ordering = {
+            orderBy: "createdAtBlockNumber",
+            orderDirection: "desc",
+        }) => {
+            var _a, _b, _c;
+            if (this.options.dataMode === "WEB3_ONLY") {
+                throw new SFError_1.default({
+                    type: "UNSUPPORTED_WEB_3_ONLY",
+                    customMessage: "This query is not supported in WEB3_ONLY mode.",
+                });
+            }
+            (0, validation_1.validateStreamRequest)(filter);
+            const response = await this.subgraphClient.request(getStreams_generated_1.GetStreamsDocument, {
+                where: {
+                    sender: (_a = filter.sender) === null || _a === void 0 ? void 0 : _a.toLowerCase(),
+                    receiver: (_b = filter.receiver) === null || _b === void 0 ? void 0 : _b.toLowerCase(),
+                    token: (_c = filter.token) === null || _c === void 0 ? void 0 : _c.toLowerCase(),
+                    id_gt: paging.lastId,
+                },
+                orderBy: ordering === null || ordering === void 0 ? void 0 : ordering.orderBy,
+                orderDirection: ordering === null || ordering === void 0 ? void 0 : ordering.orderDirection,
+                first: (0, pagination_1.takePlusOne)(paging),
+                skip: paging.skip,
+            });
+            const mappedResult = response.result.map((x) => typeGuard({
+                ...x,
+                sender: x.sender.id,
+                receiver: x.receiver.id,
+                createdAtTimestamp: Number(x.createdAtTimestamp),
+                createdAtBlockNumber: Number(x.createdAtBlockNumber),
+                updatedAtTimestamp: Number(x.updatedAtTimestamp),
+                updatedAtBlockNumber: Number(x.updatedAtBlockNumber),
+                token: {
+                    ...x.token,
+                    createdAtTimestamp: Number(x.token.createdAtTimestamp),
+                    createdAtBlockNumber: Number(x.token.createdAtBlockNumber),
+                },
+                flowUpdatedEvents: x.flowUpdatedEvents.map((y) => ({
+                    ...y,
+                    blockNumber: Number(y.blockNumber),
+                    timestamp: Number(y.timestamp),
+                })),
+            }));
+            return (0, pagination_1.createPagedResult)(mappedResult, paging);
+        };
+        this.listUserInteractedSuperTokens = async (filter, paging = (0, pagination_1.createSkipPaging)(), ordering = {
+            orderBy: "updatedAtBlockNumber",
+            orderDirection: "desc",
+        }) => {
+            var _a, _b;
+            if (this.options.dataMode === "WEB3_ONLY") {
+                throw new SFError_1.default({
+                    type: "UNSUPPORTED_WEB_3_ONLY",
+                    customMessage: "This query is not supported in WEB3_ONLY mode.",
+                });
+            }
+            (0, validation_1.validateAccountTokenSnapshotRequest)(filter);
+            const response = await this.subgraphClient.request(getAccountTokenSnapshots_generated_1.GetAccountTokenSnapshotsDocument, {
+                where: {
+                    account: (_a = filter.account) === null || _a === void 0 ? void 0 : _a.toLowerCase(),
+                    token: (_b = filter.token) === null || _b === void 0 ? void 0 : _b.toLowerCase(),
+                    id_gt: paging.lastId,
+                },
+                orderBy: ordering === null || ordering === void 0 ? void 0 : ordering.orderBy,
+                orderDirection: ordering === null || ordering === void 0 ? void 0 : ordering.orderDirection,
+                first: (0, pagination_1.takePlusOne)(paging),
+                skip: paging.skip,
+            });
+            const mappedResult = response.result.map((x) => typeGuard({
+                ...x,
+                account: x.account.id,
+                updatedAtTimestamp: Number(x.updatedAtTimestamp),
+                updatedAtBlockNumber: Number(x.updatedAtBlockNumber),
+                token: {
+                    ...x.token,
+                    createdAtTimestamp: Number(x.token.createdAtTimestamp),
+                    createdAtBlockNumber: Number(x.token.createdAtBlockNumber),
+                },
+            }));
+            return (0, pagination_1.createPagedResult)(mappedResult, paging);
+        };
+        this.listEvents = async (filter, paging = (0, pagination_1.createSkipPaging)(), ordering = {
+            orderBy: "blockNumber",
+            orderDirection: "desc",
+        }) => {
+            var _a, _b;
+            if (this.options.dataMode === "WEB3_ONLY") {
+                throw new SFError_1.default({
+                    type: "UNSUPPORTED_WEB_3_ONLY",
+                    customMessage: "This query is not supported in WEB3_ONLY mode.",
+                });
+            }
+            (0, validation_1.validateEventRequest)(filter);
+            const response = await this.subgraphClient.request(getAllEvents_generated_1.GetAllEventsDocument, {
+                orderBy: ordering === null || ordering === void 0 ? void 0 : ordering.orderBy,
+                orderDirection: ordering === null || ordering === void 0 ? void 0 : ordering.orderDirection,
+                where: {
+                    addresses_contains: filter.account
+                        ? [(_a = filter.account) === null || _a === void 0 ? void 0 : _a.toLowerCase()]
+                        : undefined,
+                    timestamp_gt: (_b = filter.timestamp_gt) === null || _b === void 0 ? void 0 : _b.toString(),
+                    id_gt: paging.lastId,
+                },
+                first: (0, pagination_1.takePlusOne)(paging),
+                skip: paging.skip,
+            });
+            return (0, pagination_1.createPagedResult)((0, mapGetAllEventsQueryEvents_1.mapGetAllEventsQueryEvents)(response), paging);
+        };
+        this.options = options;
+        this.subgraphClient = new SubgraphClient_1.SubgraphClient(this.options.customSubgraphQueriesEndpoint);
+    }
+    // TODO(KK): error callback?
+    // TODO(KK): retries?
+    // TODO(KK): tests
+    on(callback, ms, account, timeout) {
+        if (ms < 1000)
+            throw Error("Let's not go crazy with the queries...");
+        // Account for the fact that Subgraph has lag and will insert events with the timestamp of the event from blockchain.
+        const clockSkew = 25000;
+        // Convert millisecond-based time to second-based time (which Subgraph uses).
+        let eventQueryTimestamp = Math.floor((new Date().getTime() - clockSkew) / 1000);
+        let isUnsubscribed = false;
+        const unsubscribe = () => {
+            isUnsubscribed = true;
+        };
+        const pollingStep = async () => {
+            if (isUnsubscribed) {
+                return;
+            }
+            const allEvents = await this.listAllResults((paging) => this.listEvents({
+                account: account,
+                timestamp_gt: eventQueryTimestamp,
+            }, paging, {
+                orderBy: "timestamp",
+                orderDirection: "asc",
+            }));
+            if (allEvents.length) {
+                callback(allEvents, unsubscribe);
+                // Filter next events by last timestamp of an event.
+                // NOTE: Make sure to order events by timestamp in ascending order.
+                const lastEvent = allEvents.slice(-1)[0];
+                // Next event polling is done for events that have a timestamp later than the current latest event.
+                eventQueryTimestamp = lastEvent.timestamp;
+            }
+            // This solution sets the interval based on last query returning, opposed to not taking request-response cycles into account at all.
+            // This solution is more friendly to the Subgraph & more effective resource-wise with slow internet.
+            return setTimeout(() => {
+                // Fire and forget
+                pollingStep();
+            }, ms);
+        };
+        if (timeout) {
+            setTimeout(() => {
+                unsubscribe();
+            }, timeout);
+        }
+        // Fire and forget
+        pollingStep();
+        return unsubscribe;
+    }
+}
+exports.default = Query;
+// Why? Because `return obj as T` and `return <T>obj` are not safe type casts.
+const typeGuard = (obj) => obj;
+//# sourceMappingURL=Query.js.map

package/dist/main/Query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Query.js","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":";;;;;AAAA,wDAAgC;AAehC,6EAA0E;AAE1E,6CAOsB;AACtB,8DAA2D;AAC3D,8GAI+D;AAC/D,sFAImD;AACnD,wGAI4D;AAC5D,kFAIiD;AACjD,kFAIiD;AACjD,gFAIgD;AAUhD,6CAOsB;AAOtB;;;GAGG;AACH,MAAqB,KAAK;IAItB,YAAY,OAAsB;QAOlC;;;WAGG;QACH,mBAAc,GAAG,KAAK,EAClB,UAAuD,EAC3C,EAAE;YACd,MAAM,kBAAkB,GAAG,KAAK,EAAE,MAAc,EAAgB,EAAE;gBAC9D,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;gBAC7C,IAAI,CAAC,WAAW,CAAC,UAAU;oBAAE,OAAO,WAAW,CAAC,IAAI,CAAC;gBACrD,MAAM,WAAW,GAAG,MAAM,kBAAkB,CACxC,WAAW,CAAC,UAAU,CACzB,CAAC;gBACF,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAChD,CAAC,CAAC;YACF,OAAO,kBAAkB,CAAC,IAAA,+BAAkB,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACjE,CAAC,CAAC;QAEF,uBAAkB,GAAG,KAAK,EACtB,MAAgC,EAChC,SAAiB,IAAA,6BAAgB,GAAE,EACnC,WAAoC;YAChC,OAAO,EAAE,sBAAsB;YAC/B,cAAc,EAAE,MAAM;SACzB,EACgC,EAAE;YACnC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE;gBACvC,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,wBAAwB;oBAC9B,aAAa,EAAE,gDAAgD;iBAClE,CAAC,CAAC;aACN;YAED,IAAA,sCAAyB,EAAC,MAAM,CAAC,CAAC;YAElC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAGhD,uCAAiB,EAAE;gBACjB,KAAK,EAAE;oBACH,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,YAAY,EAAE,IAAI;oBAClB,KAAK,EAAE,MAAM,CAAC,MAAM;iBACvB;gBACD,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;gBAC1B,cAAc,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,cAAc;gBACxC,KAAK,EAAE,IAAA,wBAAW,EAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,MAAM,CAAC,IAAI;aACpB,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3C,SAAS,CAAc;gBACnB,GAAG,CAAC;gBACJ,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBAChD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC;aACvD,CAAC,CACL,CAAC;YAEF,OAAO,IAAA,8BAAiB,EAAc,YAAY,EAAE,MAAM,CAAC,CAAC;QAChE,CAAC,CAAC;QAEF,gBAAW,GAAG,KAAK,EACf,MAA2B,EAC3B,SAAiB,IAAA,6BAAgB,GAAE,EACnC,WAAoC;YAChC,OAAO,EAAE,sBAAsB;YAC/B,cAAc,EAAE,MAAM;SACzB,EAC2B,EAAE;;YAC9B,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE;gBACvC,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,wBAAwB;oBAC9B,aAAa,EAAE,gDAAgD;iBAClE,CAAC,CAAC;aACN;YAED,IAAA,iCAAoB,EAAC,MAAM,CAAC,CAAC;YAE7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAGhD,yCAAkB,EAAE;gBAClB,KAAK,EAAE;oBACH,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,0CAAE,WAAW,EAAE;oBAC1C,KAAK,EAAE,MAAA,MAAM,CAAC,KAAK,0CAAE,WAAW,EAAE;oBAClC,KAAK,EAAE,MAAM,CAAC,MAAM;iBACvB;gBACD,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;gBAC1B,cAAc,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,cAAc;gBACxC,KAAK,EAAE,IAAA,wBAAW,EAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,MAAM,CAAC,IAAI;aACpB,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3C,SAAS,CAAS;gBACd,GAAG,CAAC;gBACJ,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE;gBACzB,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBAChD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBACpD,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBAChD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBACpD,KAAK,EAAE;oBACH,GAAG,CAAC,CAAC,KAAK;oBACV,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;oBACtD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;iBAC7D;aACJ,CAAC,CACL,CAAC;YAEF,OAAO,IAAA,8BAAiB,EAAS,YAAY,EAAE,MAAM,CAAC,CAAC;QAC3D,CAAC,CAAC;QAEF,2BAAsB,GAAG,KAAK,EAC1B,MAAuC,EACvC,SAAiB,IAAA,6BAAgB,GAAE,EACnC,WAAgD;YAC5C,OAAO,EAAE,sBAAsB;YAC/B,cAAc,EAAE,MAAM;SACzB,EACuC,EAAE;;YAC1C,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE;gBACvC,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,wBAAwB;oBAC9B,aAAa,EAAE,gDAAgD;iBAClE,CAAC,CAAC;aACN;YAED,IAAA,6CAAgC,EAAC,MAAM,CAAC,CAAC;YAEzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAGhD,+DAA6B,EAAE;gBAC7B,KAAK,EAAE;oBACH,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,WAAW,EAAE;oBAC5C,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,KAAK,EAAE,MAAM,CAAC,MAAM;iBACvB;gBACD,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;gBAC1B,cAAc,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,cAAc;gBACxC,KAAK,EAAE,IAAA,wBAAW,EAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,MAAM,CAAC,IAAI;aACpB,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3C,SAAS,CAAqB;gBAC1B,GAAG,CAAC;gBACJ,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,EAAE;gBAC3B,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBAChD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBACpD,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBAChD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBACpD,KAAK,EAAE;oBACH,GAAG,CAAC,CAAC,KAAK;oBACV,KAAK,EAAE;wBACH,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK;wBAChB,kBAAkB,EAAE,MAAM,CACtB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,CACnC;wBACD,oBAAoB,EAAE,MAAM,CACxB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,oBAAoB,CACrC;qBACJ;iBACJ;aACJ,CAAC,CACL,CAAC;YAEF,OAAO,IAAA,8BAAiB,EAAqB,YAAY,EAAE,MAAM,CAAC,CAAC;QACvE,CAAC,CAAC;QAEF,gBAAW,GAAG,KAAK,EACf,MAA4B,EAC5B,SAAiB,IAAA,6BAAgB,GAAE,EACnC,WAAqC;YACjC,OAAO,EAAE,sBAAsB;YAC/B,cAAc,EAAE,MAAM;SACzB,EAC4B,EAAE;;YAC/B,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE;gBACvC,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,wBAAwB;oBAC9B,aAAa,EAAE,gDAAgD;iBAClE,CAAC,CAAC;aACN;YAED,IAAA,kCAAqB,EAAC,MAAM,CAAC,CAAC;YAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAGhD,yCAAkB,EAAE;gBAClB,KAAK,EAAE;oBACH,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,0CAAE,WAAW,EAAE;oBACpC,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,0CAAE,WAAW,EAAE;oBACxC,KAAK,EAAE,MAAA,MAAM,CAAC,KAAK,0CAAE,WAAW,EAAE;oBAClC,KAAK,EAAE,MAAM,CAAC,MAAM;iBACvB;gBACD,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;gBAC1B,cAAc,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,cAAc;gBACxC,KAAK,EAAE,IAAA,wBAAW,EAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,MAAM,CAAC,IAAI;aACpB,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3C,SAAS,CAAU;gBACf,GAAG,CAAC;gBACJ,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE;gBACnB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE;gBACvB,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBAChD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBACpD,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBAChD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBACpD,KAAK,EAAE;oBACH,GAAG,CAAC,CAAC,KAAK;oBACV,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;oBACtD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;iBAC7D;gBACD,iBAAiB,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC/C,GAAG,CAAC;oBACJ,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC;oBAClC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjC,CAAC,CAAC;aACN,CAAC,CACL,CAAC;YAEF,OAAO,IAAA,8BAAiB,EAAU,YAAY,EAAE,MAAM,CAAC,CAAC;QAC5D,CAAC,CAAC;QAEF,kCAA6B,GAAG,KAAK,EACjC,MAAmC,EACnC,SAAiB,IAAA,6BAAgB,GAAE,EACnC,WAAmD;YAC/C,OAAO,EAAE,sBAAsB;YAC/B,cAAc,EAAE,MAAM;SACzB,EAC+C,EAAE;;YAClD,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE;gBACvC,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,wBAAwB;oBAC9B,aAAa,EAAE,gDAAgD;iBAClE,CAAC,CAAC;aACN;YAED,IAAA,gDAAmC,EAAC,MAAM,CAAC,CAAC;YAE5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAGhD,qEAAgC,EAAE;gBAChC,KAAK,EAAE;oBACH,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,0CAAE,WAAW,EAAE;oBACtC,KAAK,EAAE,MAAA,MAAM,CAAC,KAAK,0CAAE,WAAW,EAAE;oBAClC,KAAK,EAAE,MAAM,CAAC,MAAM;iBACvB;gBACD,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;gBAC1B,cAAc,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,cAAc;gBACxC,KAAK,EAAE,IAAA,wBAAW,EAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,MAAM,CAAC,IAAI;aACpB,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3C,SAAS,CAA6B;gBAClC,GAAG,CAAC;gBACJ,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE;gBACrB,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBAChD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBACpD,KAAK,EAAE;oBACH,GAAG,CAAC,CAAC,KAAK;oBACV,kBAAkB,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;oBACtD,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;iBAC7D;aACJ,CAAC,CACL,CAAC;YAEF,OAAO,IAAA,8BAAiB,EACpB,YAAY,EACZ,MAAM,CACT,CAAC;QACN,CAAC,CAAC;QAEF,eAAU,GAAG,KAAK,EACd,MAAoB,EACpB,SAAiB,IAAA,6BAAgB,GAAE,EACnC,WAAoC;YAChC,OAAO,EAAE,aAAa;YACtB,cAAc,EAAE,MAAM;SACzB,EAC8B,EAAE;;YACjC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE;gBACvC,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,wBAAwB;oBAC9B,aAAa,EAAE,gDAAgD;iBAClE,CAAC,CAAC;aACN;YAED,IAAA,iCAAoB,EAAC,MAAM,CAAC,CAAC;YAE7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAGhD,6CAAoB,EAAE;gBACpB,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;gBAC1B,cAAc,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,cAAc;gBACxC,KAAK,EAAE;oBACH,kBAAkB,EAAE,MAAM,CAAC,OAAO;wBAC9B,CAAC,CAAC,CAAC,MAAA,MAAM,CAAC,OAAO,0CAAE,WAAW,EAAE,CAAC;wBACjC,CAAC,CAAC,SAAS;oBACf,YAAY,EAAE,MAAA,MAAM,CAAC,YAAY,0CAAE,QAAQ,EAAE;oBAC7C,KAAK,EAAE,MAAM,CAAC,MAAM;iBACvB;gBACD,KAAK,EAAE,IAAA,wBAAW,EAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,MAAM,CAAC,IAAI;aACpB,CAAC,CAAC;YAEH,OAAO,IAAA,8BAAiB,EACpB,IAAA,uDAA0B,EAAC,QAAQ,CAAC,EACpC,MAAM,CACT,CAAC;QACN,CAAC,CAAC;QArUE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,cAAc,GAAG,IAAI,+BAAc,CACpC,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAC7C,CAAC;IACN,CAAC;IAmUD,4BAA4B;IAC5B,qBAAqB;IACrB,kBAAkB;IAClB,EAAE,CACE,QAAgE,EAChE,EAAU,EACV,OAAgB,EAChB,OAAgB;QAEhB,IAAI,EAAE,GAAG,IAAI;YAAE,MAAM,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAErE,qHAAqH;QACrH,MAAM,SAAS,GAAG,KAAK,CAAC;QAExB,6EAA6E;QAC7E,IAAI,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAChC,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAC5C,CAAC;QAEF,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,MAAM,WAAW,GAAG,GAAG,EAAE;YACrB,cAAc,GAAG,IAAI,CAAC;QAC1B,CAAC,CAAC;QAEF,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;YAC3B,IAAI,cAAc,EAAE;gBAChB,OAAO;aACV;YAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,EAAE,CACnD,IAAI,CAAC,UAAU,CACX;gBACI,OAAO,EAAE,OAAO;gBAChB,YAAY,EAAE,mBAAmB;aACpC,EACD,MAAM,EACN;gBACI,OAAO,EAAE,WAAW;gBACpB,cAAc,EAAE,KAAK;aACxB,CACJ,CACJ,CAAC;YAEF,IAAI,SAAS,CAAC,MAAM,EAAE;gBAClB,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;gBACjC,oDAAoD;gBACpD,mEAAmE;gBACnE,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzC,mGAAmG;gBACnG,mBAAmB,GAAG,SAAU,CAAC,SAAS,CAAC;aAC9C;YAED,oIAAoI;YACpI,oGAAoG;YACpG,OAAO,UAAU,CAAC,GAAG,EAAE;gBACnB,kBAAkB;gBAClB,WAAW,EAAE,CAAC;YAClB,CAAC,EAAE,EAAE,CAAC,CAAC;QACX,CAAC,CAAC;QAEF,IAAI,OAAO,EAAE;YACT,UAAU,CAAC,GAAG,EAAE;gBACZ,WAAW,EAAE,CAAC;YAClB,CAAC,EAAE,OAAO,CAAC,CAAC;SACf;QAED,kBAAkB;QAClB,WAAW,EAAE,CAAC;QAEd,OAAO,WAAW,CAAC;IACvB,CAAC;CACJ;AAnZD,wBAmZC;AAED,8EAA8E;AAC9E,MAAM,SAAS,GAAG,CAAI,GAAM,EAAE,EAAE,CAAC,GAAG,CAAC"}

package/dist/main/SFError.d.ts

@@ -11,3 +11,4 @@ export default class SFError {
     constructor(props: ISFErrorProps);
 }
 export {};
+//# sourceMappingURL=SFError.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SFError.d.ts","sourceRoot":"","sources":["../../src/SFError.ts"],"names":[],"mappings":"AAAA,aAAK,SAAS,GACR,0BAA0B,GAC1B,2BAA2B,GAC3B,eAAe,GACf,iBAAiB,GACjB,gBAAgB,GAChB,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,gBAAgB,GAChB,qBAAqB,GACrB,sBAAsB,GACtB,kBAAkB,GAClB,uBAAuB,GACvB,gCAAgC,GAChC,kBAAkB,GAClB,kBAAkB,GAClB,wBAAwB,CAAC;AAsB/B,UAAU,aAAa;IACnB,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,GAAG,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,OAAO,OAAO;IACxB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;gBAEf,KAAK,EAAE,aAAa;CAYnC"}

package/dist/main/SFError.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const errorTypeToTitleMap = new Map([
+    ["FRAMEWORK_INITIALIZATION", "Framework Initialization"],
+    ["SUPERTOKEN_INITIALIZATION", "SuperToken Initialization"],
+    ["CREATE_SIGNER", "Create Signer"],
+    ["SUPERTOKEN_READ", "SuperToken Read"],
+    ["SUBGRAPH_ERROR", "Subgraph"],
+    ["CFAV1_READ", "ConstantFlowAgreementV1 Read"],
+    ["IDAV1_READ", "InstantDistributionAgreementV1 Read"],
+    ["INVALID_ADDRESS", "Invalid Address"],
+    ["INVALID_OBJECT", "Invalid Object"],
+    ["POPULATE_TRANSACTION", "Populate Transaction"],
+    ["EXECUTE_TRANSACTION", "Execute Transaction"],
+    ["SIGN_TRANSACTION", "Sign Transaction"],
+    ["UNSUPPORTED_OPERATION", "Unsupported Batch Call Operation"],
+    ["MISSING_TRANSACTION_PROPERTIES", "Missing Transaction Properties"],
+    ["BATCH_CALL_ERROR", "Batch Call"],
+    ["NETWORK_MISMATCH", "Network Mismatch"],
+    ["UNSUPPORTED_WEB_3_ONLY", "Unsupported Web 3 Only"],
+]);
+class SFError {
+    constructor(props) {
+        const { type, errorObject, customMessage } = props;
+        const title = errorTypeToTitleMap.get(type);
+        const formattedErrorObject = errorObject
+            ? ": " + JSON.stringify(errorObject)
+            : "";
+        this.type = type;
+        this.errorObject = errorObject;
+        this.message =
+            title + " Error - " + customMessage + formattedErrorObject;
+    }
+}
+exports.default = SFError;
+//# sourceMappingURL=SFError.js.map

package/dist/main/SFError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SFError.js","sourceRoot":"","sources":["../../src/SFError.ts"],"names":[],"mappings":";;AAmBA,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAoB;IACnD,CAAC,0BAA0B,EAAE,0BAA0B,CAAC;IACxD,CAAC,2BAA2B,EAAE,2BAA2B,CAAC;IAC1D,CAAC,eAAe,EAAE,eAAe,CAAC;IAClC,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IACtC,CAAC,gBAAgB,EAAE,UAAU,CAAC;IAC9B,CAAC,YAAY,EAAE,8BAA8B,CAAC;IAC9C,CAAC,YAAY,EAAE,qCAAqC,CAAC;IACrD,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IACtC,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IACpC,CAAC,sBAAsB,EAAE,sBAAsB,CAAC;IAChD,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;IAC9C,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IACxC,CAAC,uBAAuB,EAAE,kCAAkC,CAAC;IAC7D,CAAC,gCAAgC,EAAE,gCAAgC,CAAC;IACpE,CAAC,kBAAkB,EAAE,YAAY,CAAC;IAClC,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IACxC,CAAC,wBAAwB,EAAE,wBAAwB,CAAC;CACvD,CAAC,CAAC;AAQH,MAAqB,OAAO;IAKxB,YAAY,KAAoB;QAC5B,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;QAEnD,MAAM,KAAK,GAAG,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,oBAAoB,GAAG,WAAW;YACpC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;YACpC,CAAC,CAAC,EAAE,CAAC;QACT,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO;YACR,KAAK,GAAG,WAAW,GAAG,aAAa,GAAG,oBAAoB,CAAC;IACnE,CAAC;CACJ;AAjBD,0BAiBC"}

package/dist/main/SuperToken.d.ts

@@ -1,4 +1,4 @@
-import { ethers } from "ethers";
+import { ethers, Overrides } from "ethers";
 import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
 import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
 import Operation from "./Operation";
@@ -42,18 +42,26 @@ export default class SuperToken extends Token {
     /**
      * @dev Downgrade `amount` SuperToken's.
      * @param amount The amount to be downgraded.
+     * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    downgrade: ({ amount }: {
+    downgrade: ({ amount, overrides, }: {
         amount: string;
+        overrides?: (ethers.Overrides & {
+            from?: string | Promise<string> | undefined;
+        }) | undefined;
     }) => Operation;
     /**
      * @dev Upgrade `amount` SuperToken's.
      * @param amount The amount to be upgraded.
+     * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    upgrade: ({ amount }: {
+    upgrade: ({ amount, overrides, }: {
         amount: string;
+        overrides?: (ethers.Overrides & {
+            from?: string | Promise<string> | undefined;
+        }) | undefined;
     }) => Operation;
     /**
      * @dev Get the details of a flow.
@@ -83,26 +91,29 @@ export default class SuperToken extends Token {
      * @param receiver The receiver of the flow.
      * @param flowRate The specified flow rate.
      * @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: ({ sender, receiver, flowRate, userData, }: ISuperTokenCreateFlowParams) => Operation;
+    createFlow: ({ sender, receiver, flowRate, userData, overrides, }: ISuperTokenCreateFlowParams) => Operation;
     /**
      * @dev Update a flow of the token of this class.
      * @param sender The sender of the flow.
      * @param receiver The receiver of the flow.
      * @param flowRate The specified flow rate.
      * @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: ({ sender, receiver, flowRate, userData, }: ISuperTokenUpdateFlowParams) => Operation;
+    updateFlow: ({ sender, receiver, flowRate, userData, overrides, }: ISuperTokenUpdateFlowParams) => Operation;
     /**
      * @dev Delete a flow of the token of this class.
      * @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: ({ sender, receiver, userData, }: ISuperTokenDeleteFlowParams) => Operation;
+    deleteFlow: ({ sender, receiver, userData, overrides, }: ISuperTokenDeleteFlowParams) => Operation;
     /**
      * @dev Get the details of a `Subscription`.
      * @param publisher the address of the publisher of the index
@@ -124,68 +135,77 @@ export default class SuperToken extends Token {
      * @dev Creates an IDA Index.
      * @param indexId The id of the index.
      * @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, userData, }: ISuperTokenBaseIDAParams) => Operation;
+    createIndex: ({ indexId, userData, overrides, }: ISuperTokenBaseIDAParams) => Operation;
     /**
      * @dev Distributes `amount` of token to an index
      * @param indexId The id of the index.
      * @param amount The amount of tokens 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, userData, }: ISuperTokenDistributeParams) => Operation;
+    distribute: ({ indexId, amount, userData, overrides, }: ISuperTokenDistributeParams) => Operation;
     /**
      * @dev Updates the `IndexValue` field of an index.
      * @param indexId The id of the index.
      * @param indexValue The new indexValue.
      * @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.
      *
      * NOTE: It has the same effect as `distribute`, but is closer to the low level data structure of the index.
      */
-    updateIndexValue: ({ indexId, indexValue, userData, }: ISuperTokenUpdateIndexValueParams) => Operation;
+    updateIndexValue: ({ indexId, indexValue, userData, overrides, }: ISuperTokenUpdateIndexValueParams) => Operation;
     /**
      * @dev Updates the `units` allocated to a Subscription.
      * @param indexId The id of the index.
      * @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, subscriber, units, userData, }: ISuperTokenUpdateSubscriptionUnitsParams) => Operation;
+    updateSubscriptionUnits: ({ indexId, subscriber, units, userData, overrides, }: ISuperTokenUpdateSubscriptionUnitsParams) => 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 publisher The publisher address whose subscription 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, publisher, userData, }: ISuperTokenPublisherOperationParams) => Operation;
+    approveSubscription: ({ indexId, publisher, userData, overrides, }: ISuperTokenPublisherOperationParams) => Operation;
     /**
      * @dev Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributes.
      * @param indexId The id of the index.
      * @param publisher The index publisher address you want to revoke for the subscriber.
      * @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, publisher, userData, }: ISuperTokenPublisherOperationParams) => Operation;
+    revokeSubscription: ({ indexId, publisher, userData, overrides, }: ISuperTokenPublisherOperationParams) => Operation;
     /**
      * @dev Deletes a Subscription by setting the `units` allocated to the Subscriber to 0.
      * @param indexId The id of the index.
      * @param subscriber The subscriber address whose subscription you want to delete.
      * @param publisher The publisher address of the index you are targeting.
      * @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, subscriber, publisher, userData, }: ISuperTokenPubSubParams) => Operation;
+    deleteSubscription: ({ indexId, subscriber, publisher, userData, overrides, }: ISuperTokenPubSubParams) => Operation;
     /**
      * @dev Claims any pending tokens allocated to the Subscription (unapproved).
      * @param indexId The id of the index.
      * @param subscriber The subscriber address who you are claiming for.
      * @param publisher The publisher address of the index you are targeting.
      * @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, subscriber, publisher, userData, }: ISuperTokenPubSubParams) => Operation;
+    claim: ({ indexId, subscriber, publisher, userData, overrides, }: ISuperTokenPubSubParams) => Operation;
 }
+//# sourceMappingURL=SuperToken.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SuperToken.d.ts","sourceRoot":"","sources":["../../src/SuperToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAE3C,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,8BAA8B,MAAM,kCAAkC,CAAC;AAC9E,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,OAAO,KAAK,MAAM,SAAS,CAAC;AAI5B,OAAO,EACH,OAAO,EACP,wBAAwB,EACxB,wBAAwB,EACxB,2BAA2B,EAC3B,2BAA2B,EAC3B,2BAA2B,EAC3B,4BAA4B,EAC5B,wBAAwB,EACxB,yBAAyB,EACzB,gCAAgC,EAChC,mCAAmC,EACnC,uBAAuB,EACvB,2BAA2B,EAC3B,iCAAiC,EACjC,wCAAwC,EACxC,aAAa,EACb,UAAU,EACV,sBAAsB,EACtB,iBAAiB,EACpB,MAAM,cAAc,CAAC;AAQtB,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;CAC3C;AAED,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;IAC7C,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,KAAK;IACzC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,uBAAuB,CAAC;IACxC,QAAQ,CAAC,KAAK,EAAE,8BAA8B,CAAC;IAC/C,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC;IAEhC,OAAO;IAeP,MAAM,CAAC,MAAM,YAAmB,aAAa,yBAiC3C;IAEF,OAAO,KAAK,kBAAkB,GAK7B;IAID;;;;;;OAMG;IACH,iBAAiB,8CAId,wBAAwB,KAAG,QAAQ,sBAAsB,CAAC,CAmB3D;IAIF;;;;;OAKG;IACH,SAAS;gBAIG,MAAM;;;;UAEd,SAAS,CAMX;IAEF;;;;;OAKG;IACH,OAAO;gBAIK,MAAM;;;;UAEd,SAAS,CAMX;IAIF;;;;;;OAMG;IACH,OAAO,4CAIJ,wBAAwB,KAAG,QAAQ,aAAa,CAAC,CAOlD;IAEF;;;;;OAKG;IACH,kBAAkB,mCAGf,4BAA4B,KAAG,QAAQ,aAAa,CAAC,CAMtD;IAEF;;;;;OAKG;IACH,UAAU,mCAGP,4BAA4B,KAAG,QAAQ,MAAM,CAAC,CAM/C;IAIF;;;;;;;;OAQG;IACH,UAAU,yDAMP,2BAA2B,KAAG,SAAS,CASxC;IAEF;;;;;;;;OAQG;IACH,UAAU,yDAMP,2BAA2B,KAAG,SAAS,CASxC;IAEF;;;;;;;OAOG;IACH,UAAU,+CAKP,2BAA2B,KAAG,SAAS,CAQxC;IAIF;;;;;;;OAOG;IACH,eAAe,0DAKZ,gCAAgC,KAAG,QAAQ,iBAAiB,CAAC,CAQ9D;IAEF;;;;;;OAMG;IACH,QAAQ,8CAIL,yBAAyB,KAAG,QAAQ,UAAU,CAAC,CAOhD;IAIF;;;;;;OAMG;IACH,WAAW,sCAIR,wBAAwB,KAAG,SAAS,CAOrC;IAEF;;;;;;;OAOG;IACH,UAAU,8CAKP,2BAA2B,KAAG,SAAS,CAQxC;IAEF;;;;;;;;;OASG;IACH,gBAAgB,kDAKb,iCAAiC,KAAG,SAAS,CAQ9C;IAEF;;;;;;;;OAQG;IACH,uBAAuB,yDAMpB,wCAAwC,KAAG,SAAS,CASrD;IAEF;;;;;;;OAOG;IACH,mBAAmB,iDAKhB,mCAAmC,KAAG,SAAS,CAQhD;IAEF;;;;;;;OAOG;IACH,kBAAkB,iDAKf,mCAAmC,KAAG,SAAS,CAQhD;IAEF;;;;;;;;OAQG;IACH,kBAAkB,6DAMf,uBAAuB,KAAG,SAAS,CASpC;IAEF;;;;;;;;OAQG;IACH,KAAK,6DAMF,uBAAuB,KAAG,SAAS,CASpC;CACL"}