@superfluid-finance/sdk-redux 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright © 2021 Superfluid Finance Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,175 @@
+<h1 align="center">sdk-redux</h1>
+<div align="center">
+<img  width="300" padding="0 0 10px" alt="Superfluid logo" src="/sf-logo.png" />
+<p>
+  <a href="https://www.npmjs.com/package/@superfluid-finance/sdk-redux" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/@superfluid-finance/sdk-redux.svg">
+  </a>
+  <a href="#" target="_blank">
+    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
+  </a>
+  <a href="https://twitter.com/Superfluid_HQ/" target="blank">
+    <img alt="Twitter: Superfluid_HQ" src="https://img.shields.io/twitter/follow/Superfluid_HQ.svg?style=social" />
+  </a>
+</p>
+</div>
+
+### 🏠 [Homepage](https://superfluid.finance)
+
+### ✨ [Superfluid App](https://app.superfluid.finance/)
+
+### 📖 [Docs](https://docs.superfluid.finance)
+
+# Introduction
+SDK-Redux is an application framework for building front-end applications that interact with the Superfluid Protocol.
+
+More specifically, SDK-Redux is a wrapper library around `@superfluid-fincance/sdk-core` which adds state management to Superfluid related queries and operations.
+Under the hood, SDK-Redux leverages popular Redux libraries Redux Toolkit & RTK Query.
+
+## Important Disclaimer
+SDK-Redux is in early active development and can have breaking releases without warning and without consideration for semantic versioning.
+
+# Features
+* Tracking loading state in order to show UI spinners
+* Avoiding duplicate requests for the same data
+* Managing cache lifetimes as the user interacts with the UI
+* Tracking blockchain transactions produced by user interactions
+
+# Notable Used Technologies
+* TypeScript
+* Redux
+* Redux Toolkit
+* RTK Query
+* Ethers
+
+# Requirements
+* Redux store & Redux Toolkit
+* React* (The SDK-Redux generates React Hooks which are recommended but not strictly necessary to use. The SDK-Redux is UI-framework agnostic but we currently have example only for React)
+
+# Getting Started
+## Plugging Into Redux Store
+Requirements:
+
+A brand-new scaffolded Redux store configuration looks something like this:
+```ts
+import { configureStore, ThunkAction, Action } from '@reduxjs/toolkit';
+
+export const store = configureStore({
+  reducer: {
+  },
+});
+
+export type AppDispatch = typeof store.dispatch;
+export type RootState = ReturnType<typeof store.getState>;
+export type AppThunk<ReturnType = void> = ThunkAction<
+  ReturnType,
+  RootState,
+  unknown,
+  Action<string>
+>;
+```
+
+We need to plug in the Superfluid SDK-Redux parts.
+
+Import this function: `import { createSdkReduxParts } from "@superfluid-finance/sdk-redux";`
+
+Then create the pieces:
+```ts
+const {
+    superfluidContext,
+    apiSlice,
+    transactionSlice,
+} = createSdkReduxParts();
+```
+
+Plug in the reducer slices:
+```ts
+export const store = configureStore({
+  reducer: {
+    //
+    [apiSlice.reducerPath]: apiSlice.reducer,
+    [transactionSlice.reducerPath]: transactionSlice.reducer,
+    //
+  },
+});
+```
+
+Add the middleware:
+```ts
+export const store = configureStore({
+  reducer: {
+    [apiSlice.reducerPath]: apiSlice.reducer,
+    [transactionSlice.reducerPath]: transactionSlice.reducer,
+  },
+  //
+  middleware: (getDefaultMiddleware) =>
+    getDefaultMiddleware().concat(apiSlice.middleware)
+  //
+});
+```
+
+Export the Superfluid Context:
+```ts
+export { superfluidContext };
+```
+
+Somewhere in your code, give instructions to the `superfluidContext` to locate `Framework` and `Signer`:
+```ts
+superfluidContext
+    .setFramework(
+        chainId,
+        superfluidFramework
+    )
+    .setSigner(
+        chainId,
+        ethersWeb3Provider.getSigner()
+    );
+```
+
+That should be it! You should now be able to dispatch messages to Superfluid reducers & use the React hooks.
+
+## Using Queries (i.e. "read" operations)
+Read about RTK-Query queries here: https://redux-toolkit.js.org/rtk-query/usage/queries
+
+Example using React Hook:
+```ts
+const {
+    data: pagedStreams,
+    isUninitialized,
+    isFetching,
+    isLoading,
+    isError,
+    error,
+    refetch,
+} = useListStreamsQuery({
+    chainId: queryChainId,
+    senderAddress,
+    receiverAddress,
+    superTokenAddress,
+    skip: (page - 1) * pageSize,
+    take: pageSize,
+}, {
+    pollingInterval: 5000 // Not necessary to use but nice-to-have additional option by RTK-Query.
+});
+```
+
+## Using Mutations (i.e. "write" operations)
+Read about RTK-Query queries here: https://redux-toolkit.js.org/rtk-query/usage/mutations
+
+Example using React Hook:
+```ts
+const tx = await createFlow({
+    senderAddress: signerAddress,
+    receiverAddress: receiver,
+    flowRateWei: flowRate,
+    chainId,
+    superTokenAddress: superToken,
+    waitForConfirmation,
+}).unwrap();
+```
+
+### Transaction Tracking
+All mutations trigger tracking for transaction progress (stored in `transactionSlice`) and transaction monitoring for re-orgs (all cached data is re-fetched in case of a re-org).
+
+# Examples
+Check out the extensive demo here: `examples/sdk-redux-react-typescript`.

package/build/main/SuperfluidContext.d.ts

@@ -0,0 +1,31 @@
+import { Framework } from '@superfluid-finance/sdk-core';
+import { Signer } from 'ethers';
+/**
+ * Context is a way for SDK-Redux reducers to access the current SDK-Core Framework instance
+ * and the current active signer for transaction broadcasting.
+ *
+ * The context object is a way to do "dependency injection" or "service location", if you will.
+ */
+export interface SuperfluidContext {
+    getFramework: (chainId: number) => Promise<Framework>;
+    getSigner: (chainId: number) => Promise<Signer>;
+    /**
+     *
+     * @param chainId
+     * @param framework
+     * @returns Returns itself for fluent API.
+     */
+    setFramework: (chainId: number, framework: (() => Promise<Framework>) | Framework) => SuperfluidContext;
+    /**
+     *
+     * @param chainId
+     * @param signer
+     * @returns Returns itself for fluent API.
+     */
+    setSigner: (chainId: number, signer: (() => Promise<Signer>) | Signer) => SuperfluidContext;
+    getFrameworkAndSigner: (chainId: number) => Promise<[framework: Framework, signer: Signer]>;
+}
+/**
+ * A preinitialized instance of a {@link SuperfluidContext}.
+ */
+export declare const preinitializedSuperfluidContext: SuperfluidContext;

package/build/main/SuperfluidContext.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preinitializedSuperfluidContext = void 0;
+const sdk_core_1 = require("@superfluid-finance/sdk-core");
+const ethers_1 = require("ethers");
+const frameworks = new Map();
+const signers = new Map();
+/**
+ * A preinitialized instance of a {@link SuperfluidContext}.
+ */
+exports.preinitializedSuperfluidContext = {
+    getFramework: (chainId) => {
+        const frameworkGetter = frameworks.get(chainId);
+        if (!frameworkGetter)
+            throw Error(`Don't know how to get Superfluid Framework. :( Please set up a *framework* source for chain [${chainId}].`);
+        return frameworkGetter();
+    },
+    getSigner: (chainId) => {
+        const signerGetter = signers.get(chainId);
+        if (!signerGetter)
+            throw Error(`Don't know how to get a signer. :( Please set up a *signer* source for chain [${chainId}].`);
+        return signerGetter();
+    },
+    setFramework: (chainId, framework) => {
+        if (framework instanceof sdk_core_1.Framework) {
+            frameworks.set(chainId, () => Promise.resolve(framework));
+        }
+        else {
+            frameworks.set(chainId, framework);
+        }
+        return exports.preinitializedSuperfluidContext;
+    },
+    setSigner: (chainId, signer) => {
+        if (signer instanceof ethers_1.Signer) {
+            signers.set(chainId, () => Promise.resolve(signer));
+        }
+        else {
+            signers.set(chainId, signer);
+        }
+        return exports.preinitializedSuperfluidContext;
+    },
+    getFrameworkAndSigner: async (chainId) => {
+        return await Promise.all([
+            exports.preinitializedSuperfluidContext.getFramework(chainId),
+            exports.preinitializedSuperfluidContext.getSigner(chainId),
+        ]);
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU3VwZXJmbHVpZENvbnRleHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvU3VwZXJmbHVpZENvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsMkRBQXVEO0FBQ3ZELG1DQUE4QjtBQUU5QixNQUFNLFVBQVUsR0FBRyxJQUFJLEdBQUcsRUFBb0MsQ0FBQztBQUMvRCxNQUFNLE9BQU8sR0FBRyxJQUFJLEdBQUcsRUFBaUMsQ0FBQztBQW9DekQ7O0dBRUc7QUFDVSxRQUFBLCtCQUErQixHQUFzQjtJQUM5RCxZQUFZLEVBQUUsQ0FBQyxPQUFlLEVBQXNCLEVBQUU7UUFDbEQsTUFBTSxlQUFlLEdBQUcsVUFBVSxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNoRCxJQUFJLENBQUMsZUFBZTtZQUNoQixNQUFNLEtBQUssQ0FDUCxnR0FBZ0csT0FBTyxJQUFJLENBQzlHLENBQUM7UUFDTixPQUFPLGVBQWUsRUFBRSxDQUFDO0lBQzdCLENBQUM7SUFDRCxTQUFTLEVBQUUsQ0FBQyxPQUFlLEVBQW1CLEVBQUU7UUFDNUMsTUFBTSxZQUFZLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUMxQyxJQUFJLENBQUMsWUFBWTtZQUNiLE1BQU0sS0FBSyxDQUNQLGlGQUFpRixPQUFPLElBQUksQ0FDL0YsQ0FBQztRQUNOLE9BQU8sWUFBWSxFQUFFLENBQUM7SUFDMUIsQ0FBQztJQUNELFlBQVksRUFBRSxDQUNWLE9BQWUsRUFDZixTQUFpRCxFQUNuRCxFQUFFO1FBQ0EsSUFBSSxTQUFTLFlBQVksb0JBQVMsRUFBRTtZQUNoQyxVQUFVLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxHQUFHLEVBQUUsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUM7U0FDN0Q7YUFBTTtZQUNILFVBQVUsQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLFNBQVMsQ0FBQyxDQUFDO1NBQ3RDO1FBQ0QsT0FBTyx1Q0FBK0IsQ0FBQztJQUMzQyxDQUFDO0lBQ0QsU0FBUyxFQUFFLENBQUMsT0FBZSxFQUFFLE1BQXdDLEVBQUUsRUFBRTtRQUNyRSxJQUFJLE1BQU0sWUFBWSxlQUFNLEVBQUU7WUFDMUIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1NBQ3ZEO2FBQU07WUFDSCxPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsQ0FBQztTQUNoQztRQUNELE9BQU8sdUNBQStCLENBQUM7SUFDM0MsQ0FBQztJQUNELHFCQUFxQixFQUFFLEtBQUssRUFDeEIsT0FBZSxFQUNnQyxFQUFFO1FBQ2pELE9BQU8sTUFBTSxPQUFPLENBQUMsR0FBRyxDQUFDO1lBQ3JCLHVDQUErQixDQUFDLFlBQVksQ0FBQyxPQUFPLENBQUM7WUFDckQsdUNBQStCLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQztTQUNyRCxDQUFDLENBQUM7SUFDUCxDQUFDO0NBQ0osQ0FBQyJ9

package/build/main/createSdkReduxParts.d.ts

@@ -0,0 +1,23 @@
+import { SuperfluidContext } from './SuperfluidContext';
+import { SuperfluidApiReduxSliceType } from './redux-slices/rtk-query/rtkQuerySlice';
+import { SuperfluidTransactionReduxSlice, transactionSlice } from './redux-slices/transactions/transactionSlice';
+export declare let initializedSuperfluidContext: SuperfluidContext;
+/**
+ * First initialization point of SDK-Redux.
+ * Creates the necessary parts to set up redux store and dependency injection for SDk-Redux.
+ * @param superfluidContext Optional user-defined instance of {@link SuperfluidContext}.
+ */
+export declare const createSdkReduxParts: (superfluidContext?: SuperfluidContext | undefined) => {
+    /**
+     * Returns the initialized instance of {@link SuperfluidContext}. When user passes in their own instance then that is returned.
+     */
+    superfluidContext: SuperfluidContext;
+    /**
+     * Instance of {@link SuperfluidApiReduxSliceType} to plug into the redux store.
+     */
+    apiSlice: SuperfluidApiReduxSliceType;
+    /**
+     * Instance of {@link SuperfluidTransactionReduxSlice} to plug into the Redux store.
+     */
+    transactionSlice: SuperfluidTransactionReduxSlice;
+};

package/build/main/createSdkReduxParts.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSdkReduxParts = exports.initializedSuperfluidContext = void 0;
+const SuperfluidContext_1 = require("./SuperfluidContext");
+const rtkQuerySlice_1 = require("./redux-slices/rtk-query/rtkQuerySlice");
+const transactionSlice_1 = require("./redux-slices/transactions/transactionSlice");
+exports.initializedSuperfluidContext = null;
+/**
+ * First initialization point of SDK-Redux.
+ * Creates the necessary parts to set up redux store and dependency injection for SDk-Redux.
+ * @param superfluidContext Optional user-defined instance of {@link SuperfluidContext}.
+ */
+const createSdkReduxParts = (superfluidContext) => {
+    if (exports.initializedSuperfluidContext) {
+        throw Error("You shouldn't create the slice multiple times.");
+    }
+    if (superfluidContext) {
+        exports.initializedSuperfluidContext = superfluidContext;
+    }
+    else {
+        exports.initializedSuperfluidContext = SuperfluidContext_1.preinitializedSuperfluidContext;
+    }
+    return {
+        superfluidContext: exports.initializedSuperfluidContext,
+        apiSlice: rtkQuerySlice_1.rtkQuerySlice,
+        transactionSlice: transactionSlice_1.transactionSlice,
+    };
+};
+exports.createSdkReduxParts = createSdkReduxParts;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY3JlYXRlU2RrUmVkdXhQYXJ0cy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jcmVhdGVTZGtSZWR1eFBhcnRzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDJEQUc2QjtBQUM3QiwwRUFHZ0Q7QUFDaEQsbUZBR3NEO0FBRTNDLFFBQUEsNEJBQTRCLEdBQXNCLElBQUssQ0FBQztBQUVuRTs7OztHQUlHO0FBQ0ksTUFBTSxtQkFBbUIsR0FBRyxDQUMvQixpQkFBcUMsRUFjdkMsRUFBRTtJQUNBLElBQUksb0NBQTRCLEVBQUU7UUFDOUIsTUFBTSxLQUFLLENBQUMsZ0RBQWdELENBQUMsQ0FBQztLQUNqRTtJQUVELElBQUksaUJBQWlCLEVBQUU7UUFDbkIsb0NBQTRCLEdBQUcsaUJBQWlCLENBQUM7S0FDcEQ7U0FBTTtRQUNILG9DQUE0QixHQUFHLG1EQUErQixDQUFDO0tBQ2xFO0lBRUQsT0FBTztRQUNILGlCQUFpQixFQUFFLG9DQUE0QjtRQUMvQyxRQUFRLEVBQUUsNkJBQWE7UUFDdkIsZ0JBQWdCLEVBQUUsbUNBQWdCO0tBQ3JDLENBQUM7QUFDTixDQUFDLENBQUM7QUEvQlcsUUFBQSxtQkFBbUIsdUJBK0I5QiJ9

package/build/main/index.d.ts

@@ -0,0 +1,29 @@
+export * from '@superfluid-finance/sdk-core';
+export * from './createSdkReduxParts';
+export * from './SuperfluidContext';
+export * from './redux-slices/rtk-query/queries/listStreams';
+export * from './redux-slices/rtk-query/queries/listEvents';
+export * from './redux-slices/rtk-query/queries/listSuperTokens';
+export * from './redux-slices/rtk-query/queries/listIndexes';
+export * from './redux-slices/rtk-query/queries/listIndexSubscriptions';
+export * from './redux-slices/rtk-query/queries/listUserInteractedSuperTokens';
+export * from './redux-slices/rtk-query/queries/getRealtimeBalance';
+export * from './redux-slices/rtk-query/queries/getAllowanceForUpgradeToSuperToken';
+export * from './redux-slices/rtk-query/mutations/createFlow';
+export * from './redux-slices/rtk-query/mutations/updateFlow';
+export * from './redux-slices/rtk-query/mutations/deleteFlow';
+export * from './redux-slices/rtk-query/mutations/transferSuperToken';
+export * from './redux-slices/rtk-query/mutations/upgradeToSuperToken';
+export * from './redux-slices/rtk-query/mutations/downgradeFromSuperToken';
+export * from './redux-slices/rtk-query/mutations/approveIndexSubscription';
+export * from './redux-slices/rtk-query/mutations/updateIndexSubscriptionUnits';
+export * from './redux-slices/rtk-query/mutations/createIndex';
+export * from './redux-slices/rtk-query/mutations/distributeToIndex';
+export * from './redux-slices/rtk-query/mutations/claimFromIndexSubscription';
+export * from './redux-slices/rtk-query/mutations/deleteIndexSubscription';
+export * from './redux-slices/rtk-query/mutations/revokeIndexSubscription';
+export * from './redux-slices/rtk-query/mutations/monitorForEventsToInvalidateCache';
+export { ValidationError, PossibleErrors, } from './redux-slices/rtk-query/rtkQuerySliceBaseQuery';
+export * from './redux-slices/transactions/transactionSlice';
+export * from './redux-slices/transactions/trackTransaction';
+export { SuperfluidApiReduxSliceType } from './redux-slices/rtk-query/rtkQuerySlice';

package/build/main/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Export everything from SDK-Core.
+__exportStar(require("@superfluid-finance/sdk-core"), exports);
+__exportStar(require("./createSdkReduxParts"), exports);
+__exportStar(require("./SuperfluidContext"), exports);
+__exportStar(require("./redux-slices/rtk-query/queries/listStreams"), exports);
+__exportStar(require("./redux-slices/rtk-query/queries/listEvents"), exports);
+__exportStar(require("./redux-slices/rtk-query/queries/listSuperTokens"), exports);
+__exportStar(require("./redux-slices/rtk-query/queries/listIndexes"), exports);
+__exportStar(require("./redux-slices/rtk-query/queries/listIndexSubscriptions"), exports);
+__exportStar(require("./redux-slices/rtk-query/queries/listUserInteractedSuperTokens"), exports);
+__exportStar(require("./redux-slices/rtk-query/queries/getRealtimeBalance"), exports);
+__exportStar(require("./redux-slices/rtk-query/queries/getAllowanceForUpgradeToSuperToken"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/createFlow"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/updateFlow"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/deleteFlow"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/transferSuperToken"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/upgradeToSuperToken"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/downgradeFromSuperToken"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/approveIndexSubscription"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/updateIndexSubscriptionUnits"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/createIndex"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/distributeToIndex"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/claimFromIndexSubscription"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/deleteIndexSubscription"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/revokeIndexSubscription"), exports);
+__exportStar(require("./redux-slices/rtk-query/mutations/monitorForEventsToInvalidateCache"), exports);
+__exportStar(require("./redux-slices/transactions/transactionSlice"), exports);
+__exportStar(require("./redux-slices/transactions/trackTransaction"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsbUNBQW1DO0FBQ25DLCtEQUE2QztBQUU3Qyx3REFBc0M7QUFDdEMsc0RBQW9DO0FBRXBDLCtFQUE2RDtBQUM3RCw4RUFBNEQ7QUFDNUQsbUZBQWlFO0FBQ2pFLCtFQUE2RDtBQUM3RCwwRkFBd0U7QUFDeEUsaUdBQStFO0FBQy9FLHNGQUFvRTtBQUNwRSxzR0FBb0Y7QUFDcEYsZ0ZBQThEO0FBQzlELGdGQUE4RDtBQUM5RCxnRkFBOEQ7QUFDOUQsd0ZBQXNFO0FBQ3RFLHlGQUF1RTtBQUN2RSw2RkFBMkU7QUFDM0UsOEZBQTRFO0FBQzVFLGtHQUFnRjtBQUNoRixpRkFBK0Q7QUFDL0QsdUZBQXFFO0FBQ3JFLGdHQUE4RTtBQUM5RSw2RkFBMkU7QUFDM0UsNkZBQTJFO0FBQzNFLHVHQUFxRjtBQU1yRiwrRUFBNkQ7QUFDN0QsK0VBQTZEIn0=

package/build/main/redux-slices/argTypes.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Information about the transaction to locate it.
+ */
+export declare type TransactionInfo = {
+    /** The transaction's network chain ID. */
+    chainId: number;
+    /** The transaction hash. */
+    hash: string;
+};
+/**
+ *
+ */
+export declare type QueryArg = {
+    /** Queried network's chain ID. */
+    chainId: number;
+};
+/**
+ *
+ */
+export declare type PaginatedQueryArg = QueryArg & {
+    /** How many entries to skip. */
+    skip: number;
+    /** How many entries to return. */
+    take: number;
+};
+/**
+ * TEST
+ */
+export declare type SuperTokenMutationArg = {
+    /**  The network's chain ID where transactions will be broadcast. */
+    chainId: number;
+    /** SuperToken the mutation will affect. */
+    superTokenAddress: string;
+    /**
+     * Whether to wait for one confirmation to the transaction or not.
+     *
+     * If set to `true` then the mutation will be blocking, i.e. the react hook / redux thunk will return control flow after first confirmation for the transaction broadcast.
+     * If set to `false` then the mutation will not be blocking, i.e. the react hook / redux thunk will not return.
+     */
+    waitForConfirmation: boolean | NothingBoolean;
+};
+/**
+ * Input for strings that is ignored.
+ */
+export declare type NothingString = '' | undefined;
+/**
+ * Input for numbers that is ignored.
+ */
+export declare type NothingNumber = undefined;
+/**
+ * Input for booleans that is ignored.
+ */
+export declare type NothingBoolean = undefined;

package/build/main/redux-slices/argTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJnVHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvcmVkdXgtc2xpY2VzL2FyZ1R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/build/main/redux-slices/rtk-query/cacheTags/CacheTagTypes.d.ts

@@ -0,0 +1,15 @@
+/**
+ * All possible cache tag types.
+ * @private
+ * @category Cache Tags
+ */
+export declare type CacheTagTypes = 'Event' | 'Index' | 'Stream' | 'Token';
+/**
+ * Create a cache tag for RTK-Query.
+ * @private
+ * @category Cache Tags
+ */
+export declare const createTag: (type: CacheTagTypes, ...keys: (string | number)[]) => {
+    type: CacheTagTypes;
+    id: string;
+};

package/build/main/redux-slices/rtk-query/cacheTags/CacheTagTypes.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTag = void 0;
+/**
+ * Create a cache tag for RTK-Query.
+ * @private
+ * @category Cache Tags
+ */
+const createTag = (type, ...keys) => ({
+    type: type,
+    id: keys.join('_').toLowerCase(),
+});
+exports.createTag = createTag;
+// Order of address priorities if all present:
+// 1. SuperToken Address
+// 2. Publisher / Sender / From Address
+// 3. Subscriber / Receiver / To Address
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ2FjaGVUYWdUeXBlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9yZWR1eC1zbGljZXMvcnRrLXF1ZXJ5L2NhY2hlVGFncy9DYWNoZVRhZ1R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQVFBOzs7O0dBSUc7QUFDSSxNQUFNLFNBQVMsR0FBRyxDQUNyQixJQUFtQixFQUNuQixHQUFHLElBQXlCLEVBQzlCLEVBQUUsQ0FBQyxDQUFDO0lBQ0YsSUFBSSxFQUFFLElBQUk7SUFDVixFQUFFLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQyxXQUFXLEVBQUU7Q0FDbkMsQ0FBQyxDQUFDO0FBTlUsUUFBQSxTQUFTLGFBTW5CO0FBRUgsOENBQThDO0FBQzlDLHdCQUF3QjtBQUN4Qix1Q0FBdUM7QUFDdkMsd0NBQXdDIn0=

package/build/main/redux-slices/rtk-query/cacheTags/eventTags.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The simplest cache tag.
+ * @private
+ * @category Cache Tags
+ */
+export declare const createEventTag: (chainId: number) => {
+    type: import("./CacheTagTypes").CacheTagTypes;
+    id: string;
+};

package/build/main/redux-slices/rtk-query/cacheTags/eventTags.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEventTag = void 0;
+const CacheTagTypes_1 = require("./CacheTagTypes");
+/**
+ * The simplest cache tag.
+ * @private
+ * @category Cache Tags
+ */
+const createEventTag = (chainId) => (0, CacheTagTypes_1.createTag)('Event', chainId);
+exports.createEventTag = createEventTag;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXZlbnRUYWdzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL3JlZHV4LXNsaWNlcy9ydGstcXVlcnkvY2FjaGVUYWdzL2V2ZW50VGFncy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxtREFBMEM7QUFFMUM7Ozs7R0FJRztBQUNJLE1BQU0sY0FBYyxHQUFHLENBQUMsT0FBZSxFQUFFLEVBQUUsQ0FBQyxJQUFBLHlCQUFTLEVBQUMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0FBQWxFLFFBQUEsY0FBYyxrQkFBb0QifQ==

package/build/main/redux-slices/rtk-query/cacheTags/indexTags.d.ts

@@ -0,0 +1,36 @@
+import { NothingString } from '../../argTypes';
+/**
+ * NOTE:
+ * Always order addresses in the following priority (if all addresses present):
+ * * 1. SuperToken Address
+ * * 2. Publisher / Sender / From Address
+ * * 3. Subscriber / Receiver / To Address
+ * If an address is not present then the rest of the addresses move up in priority.
+ * @private
+ * @category Cache Tags
+ */
+declare type IndexTagArg = {
+    chainId: number;
+    address1: string | NothingString;
+    address2: string | NothingString;
+    address3: string | NothingString;
+    indexId: string | NothingString;
+};
+/**
+ * Creates all possible index cache tag combinations.
+ * @private
+ * @category Cache Tags
+ */
+export declare const createIndexTags: ({ chainId, address1, address2, address3, indexId, }: IndexTagArg) => {
+    type: import("./CacheTagTypes").CacheTagTypes;
+    id: string;
+}[];
+/**
+ * @private
+ * @category Cache Tags
+ */
+export declare const getMostSpecificIndexTag: (arg: IndexTagArg) => {
+    type: import("./CacheTagTypes").CacheTagTypes;
+    id: string;
+};
+export {};

package/build/main/redux-slices/rtk-query/cacheTags/indexTags.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMostSpecificIndexTag = exports.createIndexTags = void 0;
+const utils_1 = require("../../../utils");
+const CacheTagTypes_1 = require("./CacheTagTypes");
+/**
+ * Creates all possible index cache tag combinations.
+ * @private
+ * @category Cache Tags
+ */
+const createIndexTags = ({ chainId, address1, address2, address3, indexId, }) => [
+    indexTag(chainId),
+    ...(0, utils_1.insertIf)(address1, indexTag(chainId, address1)),
+    ...(0, utils_1.insertIf)(address2, indexTag(chainId, address2)),
+    ...(0, utils_1.insertIf)(address3, indexTag(chainId, address3)),
+    ...(0, utils_1.insertIf)(address1 && address2, indexTag(chainId, address1, address2)),
+    ...(0, utils_1.insertIf)(address1 && address3, indexTag(chainId, address1, address3)),
+    ...(0, utils_1.insertIf)(address1 && address2 && address3, indexTag(chainId, address1, address2, address3)),
+    ...(0, utils_1.insertIf)(address1 && address2 && address3 && indexId, indexTag(chainId, address1, address2, address3, indexId)),
+];
+exports.createIndexTags = createIndexTags;
+/**
+ * @private
+ * @category Cache Tags
+ */
+const getMostSpecificIndexTag = (arg) => {
+    return (0, exports.createIndexTags)(arg).reverse()[0];
+};
+exports.getMostSpecificIndexTag = getMostSpecificIndexTag;
+const indexTag = (chainId, ...keys) => (0, CacheTagTypes_1.createTag)('Index', chainId, ...keys);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXhUYWdzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL3JlZHV4LXNsaWNlcy9ydGstcXVlcnkvY2FjaGVUYWdzL2luZGV4VGFncy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwwQ0FBd0M7QUFHeEMsbURBQTBDO0FBb0IxQzs7OztHQUlHO0FBQ0ksTUFBTSxlQUFlLEdBQUcsQ0FBQyxFQUM1QixPQUFPLEVBQ1AsUUFBUSxFQUNSLFFBQVEsRUFDUixRQUFRLEVBQ1IsT0FBTyxHQUNHLEVBQUUsRUFBRSxDQUFDO0lBQ2YsUUFBUSxDQUFDLE9BQU8sQ0FBQztJQUNqQixHQUFHLElBQUEsZ0JBQVEsRUFBQyxRQUFRLEVBQUUsUUFBUSxDQUFDLE9BQU8sRUFBRSxRQUFTLENBQUMsQ0FBQztJQUNuRCxHQUFHLElBQUEsZ0JBQVEsRUFBQyxRQUFRLEVBQUUsUUFBUSxDQUFDLE9BQU8sRUFBRSxRQUFTLENBQUMsQ0FBQztJQUNuRCxHQUFHLElBQUEsZ0JBQVEsRUFBQyxRQUFRLEVBQUUsUUFBUSxDQUFDLE9BQU8sRUFBRSxRQUFTLENBQUMsQ0FBQztJQUNuRCxHQUFHLElBQUEsZ0JBQVEsRUFBQyxRQUFRLElBQUksUUFBUSxFQUFFLFFBQVEsQ0FBQyxPQUFPLEVBQUUsUUFBUyxFQUFFLFFBQVMsQ0FBQyxDQUFDO0lBQzFFLEdBQUcsSUFBQSxnQkFBUSxFQUFDLFFBQVEsSUFBSSxRQUFRLEVBQUUsUUFBUSxDQUFDLE9BQU8sRUFBRSxRQUFTLEVBQUUsUUFBUyxDQUFDLENBQUM7SUFDMUUsR0FBRyxJQUFBLGdCQUFRLEVBQ1AsUUFBUSxJQUFJLFFBQVEsSUFBSSxRQUFRLEVBQ2hDLFFBQVEsQ0FBQyxPQUFPLEVBQUUsUUFBUyxFQUFFLFFBQVMsRUFBRSxRQUFTLENBQUMsQ0FDckQ7SUFDRCxHQUFHLElBQUEsZ0JBQVEsRUFDUCxRQUFRLElBQUksUUFBUSxJQUFJLFFBQVEsSUFBSSxPQUFPLEVBQzNDLFFBQVEsQ0FBQyxPQUFPLEVBQUUsUUFBUyxFQUFFLFFBQVMsRUFBRSxRQUFTLEVBQUUsT0FBUSxDQUFDLENBQy9EO0NBQ0osQ0FBQztBQXJCVyxRQUFBLGVBQWUsbUJBcUIxQjtBQUVGOzs7R0FHRztBQUNJLE1BQU0sdUJBQXVCLEdBQUcsQ0FBQyxHQUFnQixFQUFFLEVBQUU7SUFDeEQsT0FBTyxJQUFBLHVCQUFlLEVBQUMsR0FBRyxDQUFDLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDN0MsQ0FBQyxDQUFDO0FBRlcsUUFBQSx1QkFBdUIsMkJBRWxDO0FBRUYsTUFBTSxRQUFRLEdBQUcsQ0FBQyxPQUFlLEVBQUUsR0FBRyxJQUFjLEVBQUUsRUFBRSxDQUNwRCxJQUFBLHlCQUFTLEVBQUMsT0FBTyxFQUFFLE9BQU8sRUFBRSxHQUFHLElBQUksQ0FBQyxDQUFDIn0=

package/build/main/redux-slices/rtk-query/cacheTags/invalidateCacheTagsForEvents.d.ts

@@ -0,0 +1,9 @@
+import { AnyAction, ThunkDispatch } from '@reduxjs/toolkit';
+import { AllEvents } from '@superfluid-finance/sdk-core';
+/**
+ * Based on event type, invalidate all possible relevant cache tags.
+ * Cache tag invalidation will trigger re-querying of data.
+ * @private
+ * @category Cache Tags
+ */
+export declare const invalidateCacheTagsForEvents: (chainId: number, events: AllEvents[], dispatch: ThunkDispatch<any, any, AnyAction>) => void;