@superfluid-finance/sdk-redux 0.1.0

package/build/module/redux-slices/transactions/trackTransaction.js

@@ -0,0 +1,62 @@
+// Having a single "track" action makes it easy to use transaction tracking logic.
+import { createAsyncThunk } from '@reduxjs/toolkit';
+import { ethers } from 'ethers';
+import { preinitializedSuperfluidContext } from '../../SuperfluidContext';
+import { MillisecondTimes } from '../../utils';
+import { rtkQuerySlice } from '../rtk-query/rtkQuerySlice';
+import { transactionSlice, transactionSlicePrefix } from './transactionSlice';
+/**
+ *
+ * @param provider
+ * @param transactionHash
+ */
+export const waitForOneConfirmation = (provider, transactionHash) => provider.waitForTransaction(transactionHash, 1, MillisecondTimes.TenMinutes);
+/**
+ *
+ */
+export const trackTransaction = createAsyncThunk(`${transactionSlicePrefix}/trackTransaction`, async (arg, { dispatch }) => {
+    dispatch(transactionSlice.actions.upsertTransaction({
+        chainId: arg.chainId,
+        hash: arg.hash,
+        status: 'Pending',
+    }));
+    const framework = await preinitializedSuperfluidContext.getFramework(arg.chainId);
+    waitForOneConfirmation(framework.settings.provider, arg.hash)
+        .then((_transactionReceipt) => {
+        // When Ethers successfully returns then we assume the transaction was mined as per documentation: https://docs.ethers.io/v5/api/providers/provider/#Provider-waitForTransaction
+        dispatch(transactionSlice.actions.upsertTransaction({
+            chainId: arg.chainId,
+            hash: arg.hash,
+            status: 'Succeeded',
+        }));
+        monitorForLateErrors(framework.settings.provider, arg, dispatch);
+    })
+        .catch((ethersError) => {
+        notifyOfError(ethersError, arg, dispatch);
+    });
+});
+// i.e. monitor for re-orgs...
+const monitorForLateErrors = (provider, { chainId, hash }, dispatch) => {
+    provider
+        .waitForTransaction(hash, 5, MillisecondTimes.TenMinutes)
+        // When there's no error then that means a re-org didn't happen.
+        .catch((ethersError) => {
+        if (ethersError.code != ethers.errors.TIMEOUT) {
+            // Completely reset API cache.
+            dispatch(rtkQuerySlice.util.resetApiState());
+            notifyOfError(ethersError, { chainId, hash: hash }, dispatch);
+        }
+    });
+};
+const notifyOfError = (ethersError, { chainId, hash }, dispatch) => {
+    dispatch(transactionSlice.actions.upsertTransaction({
+        chainId: chainId,
+        hash: hash,
+        status: ethersError.code === ethers.errors.TIMEOUT
+            ? 'Unknown'
+            : 'Failed',
+        ethersErrorCode: ethersError.code,
+        ethersErrorMessage: ethersError.message,
+    }));
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhY2tUcmFuc2FjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9yZWR1eC1zbGljZXMvdHJhbnNhY3Rpb25zL3RyYWNrVHJhbnNhY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsa0ZBQWtGO0FBQ2xGLE9BQU8sRUFBQyxnQkFBZ0IsRUFBVyxNQUFNLGtCQUFrQixDQUFDO0FBQzVELE9BQU8sRUFBQyxNQUFNLEVBQUMsTUFBTSxRQUFRLENBQUM7QUFFOUIsT0FBTyxFQUFDLCtCQUErQixFQUFDLE1BQU0seUJBQXlCLENBQUM7QUFDeEUsT0FBTyxFQUFDLGdCQUFnQixFQUFDLE1BQU0sYUFBYSxDQUFDO0FBRTdDLE9BQU8sRUFBQyxhQUFhLEVBQUMsTUFBTSw0QkFBNEIsQ0FBQztBQUV6RCxPQUFPLEVBQUMsZ0JBQWdCLEVBQUUsc0JBQXNCLEVBQUMsTUFBTSxvQkFBb0IsQ0FBQztBQVc1RTs7OztHQUlHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sc0JBQXNCLEdBQUcsQ0FDbEMsUUFBbUMsRUFDbkMsZUFBdUIsRUFDcUIsRUFBRSxDQUM5QyxRQUFRLENBQUMsa0JBQWtCLENBQ3ZCLGVBQWUsRUFDZixDQUFDLEVBQ0QsZ0JBQWdCLENBQUMsVUFBVSxDQUM5QixDQUFDO0FBRU47O0dBRUc7QUFDSCxNQUFNLENBQUMsTUFBTSxnQkFBZ0IsR0FBRyxnQkFBZ0IsQ0FDNUMsR0FBRyxzQkFBc0IsbUJBQW1CLEVBQzVDLEtBQUssRUFBRSxHQUFHLEVBQUUsRUFBQyxRQUFRLEVBQUMsRUFBRSxFQUFFO0lBQ3RCLFFBQVEsQ0FDSixnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsaUJBQWlCLENBQUM7UUFDdkMsT0FBTyxFQUFFLEdBQUcsQ0FBQyxPQUFPO1FBQ3BCLElBQUksRUFBRSxHQUFHLENBQUMsSUFBSTtRQUNkLE1BQU0sRUFBRSxTQUFTO0tBQ3BCLENBQUMsQ0FDTCxDQUFDO0lBRUYsTUFBTSxTQUFTLEdBQUcsTUFBTSwrQkFBK0IsQ0FBQyxZQUFZLENBQ2hFLEdBQUcsQ0FBQyxPQUFPLENBQ2QsQ0FBQztJQUVGLHNCQUFzQixDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFLEdBQUcsQ0FBQyxJQUFJLENBQUM7U0FDeEQsSUFBSSxDQUNELENBQUMsbUJBQXdELEVBQUUsRUFBRTtRQUN6RCxnTEFBZ0w7UUFFaEwsUUFBUSxDQUNKLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxpQkFBaUIsQ0FBQztZQUN2QyxPQUFPLEVBQUUsR0FBRyxDQUFDLE9BQU87WUFDcEIsSUFBSSxFQUFFLEdBQUcsQ0FBQyxJQUFJO1lBQ2QsTUFBTSxFQUFFLFdBQVc7U0FDdEIsQ0FBQyxDQUNMLENBQUM7UUFFRixvQkFBb0IsQ0FDaEIsU0FBUyxDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQzNCLEdBQUcsRUFDSCxRQUFRLENBQ1gsQ0FBQztJQUNOLENBQUMsQ0FDSjtTQUNBLEtBQUssQ0FBQyxDQUFDLFdBQXdCLEVBQUUsRUFBRTtRQUNoQyxhQUFhLENBQUMsV0FBVyxFQUFFLEdBQUcsRUFBRSxRQUFRLENBQUMsQ0FBQztJQUM5QyxDQUFDLENBQUMsQ0FBQztBQUNYLENBQUMsQ0FDSixDQUFDO0FBRUYsOEJBQThCO0FBQzlCLE1BQU0sb0JBQW9CLEdBQUcsQ0FDekIsUUFBbUMsRUFDbkMsRUFBQyxPQUFPLEVBQUUsSUFBSSxFQUFrQixFQUNoQyxRQUFrQixFQUNwQixFQUFFO0lBQ0EsUUFBUTtTQUNILGtCQUFrQixDQUFDLElBQUksRUFBRSxDQUFDLEVBQUUsZ0JBQWdCLENBQUMsVUFBVSxDQUFDO1FBQ3pELGdFQUFnRTtTQUMvRCxLQUFLLENBQUMsQ0FBQyxXQUF3QixFQUFFLEVBQUU7UUFDaEMsSUFBSSxXQUFXLENBQUMsSUFBSSxJQUFJLE1BQU0sQ0FBQyxNQUFNLENBQUMsT0FBTyxFQUFFO1lBQzNDLDhCQUE4QjtZQUM5QixRQUFRLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxhQUFhLEVBQUUsQ0FBQyxDQUFDO1lBQzdDLGFBQWEsQ0FBQyxXQUFXLEVBQUUsRUFBQyxPQUFPLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBQyxFQUFFLFFBQVEsQ0FBQyxDQUFDO1NBQy9EO0lBQ0wsQ0FBQyxDQUFDLENBQUM7QUFDWCxDQUFDLENBQUM7QUFFRixNQUFNLGFBQWEsR0FBRyxDQUNsQixXQUF3QixFQUN4QixFQUFDLE9BQU8sRUFBRSxJQUFJLEVBQWtCLEVBQ2hDLFFBQWtCLEVBQ3BCLEVBQUU7SUFDQSxRQUFRLENBQ0osZ0JBQWdCLENBQUMsT0FBTyxDQUFDLGlCQUFpQixDQUFDO1FBQ3ZDLE9BQU8sRUFBRSxPQUFPO1FBQ2hCLElBQUksRUFBRSxJQUFJO1FBQ1YsTUFBTSxFQUNGLFdBQVcsQ0FBQyxJQUFJLEtBQUssTUFBTSxDQUFDLE1BQU0sQ0FBQyxPQUFPO1lBQ3RDLENBQUMsQ0FBQyxTQUFTO1lBQ1gsQ0FBQyxDQUFDLFFBQVE7UUFDbEIsZUFBZSxFQUFFLFdBQVcsQ0FBQyxJQUFJO1FBQ2pDLGtCQUFrQixFQUFFLFdBQVcsQ0FBQyxPQUFPO0tBQzFDLENBQUMsQ0FDTCxDQUFDO0FBQ04sQ0FBQyxDQUFDIn0=

package/build/module/redux-slices/transactions/transactionSlice.d.ts

@@ -0,0 +1,36 @@
+import { ethers } from 'ethers';
+export declare type TransactionStatus = 'Pending' | 'Succeeded' | 'Failed' | 'Unknown';
+export interface TrackedTransaction {
+    chainId: number;
+    hash: string;
+    status: TransactionStatus;
+    ethersErrorCode?: ethers.errors;
+    ethersErrorMessage?: string;
+}
+export declare const transactionsAdapter: import("@reduxjs/toolkit").EntityAdapter<TrackedTransaction>;
+export declare const transactionSelectors: import("@reduxjs/toolkit").EntitySelectors<TrackedTransaction, import("@reduxjs/toolkit").EntityState<TrackedTransaction>>;
+export declare const transactionSlicePrefix: "sfTransactions";
+export declare const transactionSlice: {
+    name: "sfTransactions";
+    reducer: import("redux").Reducer<import("@reduxjs/toolkit").EntityState<TrackedTransaction>, import("redux").AnyAction>;
+    actions: import("@reduxjs/toolkit").CaseReducerActions<{
+        upsertTransaction: {
+            <S extends import("@reduxjs/toolkit").EntityState<TrackedTransaction>>(state: import("@reduxjs/toolkit/dist/tsHelpers").IsAny<S, import("@reduxjs/toolkit").EntityState<TrackedTransaction>, S>, entity: TrackedTransaction): S;
+            <S_1 extends import("@reduxjs/toolkit").EntityState<TrackedTransaction>>(state: import("@reduxjs/toolkit/dist/tsHelpers").IsAny<S_1, import("@reduxjs/toolkit").EntityState<TrackedTransaction>, S_1>, entity: {
+                payload: TrackedTransaction;
+                type: string;
+            }): S_1;
+        };
+    }>;
+    caseReducers: {
+        upsertTransaction: {
+            <S extends import("@reduxjs/toolkit").EntityState<TrackedTransaction>>(state: import("@reduxjs/toolkit/dist/tsHelpers").IsAny<S, import("@reduxjs/toolkit").EntityState<TrackedTransaction>, S>, entity: TrackedTransaction): S;
+            <S_1 extends import("@reduxjs/toolkit").EntityState<TrackedTransaction>>(state: import("@reduxjs/toolkit/dist/tsHelpers").IsAny<S_1, import("@reduxjs/toolkit").EntityState<TrackedTransaction>, S_1>, entity: {
+                payload: TrackedTransaction;
+                type: string;
+            }): S_1;
+        };
+    };
+    reducerPath: "sfTransactions";
+};
+export declare type SuperfluidTransactionReduxSlice = typeof transactionSlice;

package/build/module/redux-slices/transactions/transactionSlice.js

@@ -0,0 +1,19 @@
+import { createEntityAdapter, createSlice } from '@reduxjs/toolkit';
+const getTransactionId = (transaction) => `${transaction.chainId}_${transaction.hash}`;
+export const transactionsAdapter = createEntityAdapter({
+    selectId: (transaction) => getTransactionId(transaction),
+    sortComparer: (a, b) => getTransactionId(a).localeCompare(getTransactionId(b)),
+});
+export const transactionSelectors = transactionsAdapter.getSelectors();
+export const transactionSlicePrefix = 'sfTransactions';
+export const transactionSlice = {
+    reducerPath: transactionSlicePrefix,
+    ...createSlice({
+        name: transactionSlicePrefix,
+        initialState: transactionsAdapter.getInitialState(),
+        reducers: {
+            upsertTransaction: transactionsAdapter.upsertOne,
+        },
+    }),
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhbnNhY3Rpb25TbGljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9yZWR1eC1zbGljZXMvdHJhbnNhY3Rpb25zL3RyYW5zYWN0aW9uU2xpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFDLG1CQUFtQixFQUFFLFdBQVcsRUFBQyxNQUFNLGtCQUFrQixDQUFDO0FBY2xFLE1BQU0sZ0JBQWdCLEdBQUcsQ0FBQyxXQUErQixFQUFFLEVBQUUsQ0FDekQsR0FBRyxXQUFXLENBQUMsT0FBTyxJQUFJLFdBQVcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztBQUVqRCxNQUFNLENBQUMsTUFBTSxtQkFBbUIsR0FBRyxtQkFBbUIsQ0FBcUI7SUFDdkUsUUFBUSxFQUFFLENBQUMsV0FBVyxFQUFFLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FBQyxXQUFXLENBQUM7SUFDeEQsWUFBWSxFQUFFLENBQUMsQ0FBQyxFQUFFLENBQUMsRUFBRSxFQUFFLENBQ25CLGdCQUFnQixDQUFDLENBQUMsQ0FBQyxDQUFDLGFBQWEsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUMsQ0FBQztDQUM3RCxDQUFDLENBQUM7QUFFSCxNQUFNLENBQUMsTUFBTSxvQkFBb0IsR0FBRyxtQkFBbUIsQ0FBQyxZQUFZLEVBQUUsQ0FBQztBQUV2RSxNQUFNLENBQUMsTUFBTSxzQkFBc0IsR0FBRyxnQkFBeUIsQ0FBQztBQUVoRSxNQUFNLENBQUMsTUFBTSxnQkFBZ0IsR0FBRztJQUM1QixXQUFXLEVBQUUsc0JBQXNCO0lBQ25DLEdBQUcsV0FBVyxDQUFDO1FBQ1gsSUFBSSxFQUFFLHNCQUFzQjtRQUM1QixZQUFZLEVBQUUsbUJBQW1CLENBQUMsZUFBZSxFQUFFO1FBQ25ELFFBQVEsRUFBRTtZQUNOLGlCQUFpQixFQUFFLG1CQUFtQixDQUFDLFNBQVM7U0FDbkQ7S0FDSixDQUFDO0NBQ0wsQ0FBQyJ9

package/build/module/utils.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Helper function to make sure an object instance does not have any fields extra or missing and is in fact the correct type.
+ * The problem stems from the fact that `return obj as T` and `return <T>obj` are not safe type casts.
+ * @private
+ */
+export declare const typeGuard: <T>(obj: T) => T;
+/**
+ * A helper function that returns the inputted elements when condition is true or an empty array otherwise.
+ * The reasoning for such a helper is to conditionally add items to an array in a nice syntax.
+ * @private
+ */
+export declare function insertIf<T>(condition: boolean | unknown, ...elements: T[]): T[];
+/**
+ *
+ * @private
+ */
+export declare enum MillisecondTimes {
+    OneSecond = 1000,
+    FiveSeconds = 5000,
+    TwentySeconds = 20000,
+    OneMinute = 60000,
+    TenMinutes = 600000,
+    ThreeMinutes = 180000,
+    FiveMinutes = 300000
+}

package/build/module/utils.js

@@ -0,0 +1,29 @@
+/**
+ * Helper function to make sure an object instance does not have any fields extra or missing and is in fact the correct type.
+ * The problem stems from the fact that `return obj as T` and `return <T>obj` are not safe type casts.
+ * @private
+ */
+export const typeGuard = (obj) => obj;
+/**
+ * A helper function that returns the inputted elements when condition is true or an empty array otherwise.
+ * The reasoning for such a helper is to conditionally add items to an array in a nice syntax.
+ * @private
+ */
+export function insertIf(condition, ...elements) {
+    return condition ? elements : [];
+}
+/**
+ *
+ * @private
+ */
+export var MillisecondTimes;
+(function (MillisecondTimes) {
+    MillisecondTimes[MillisecondTimes["OneSecond"] = 1000] = "OneSecond";
+    MillisecondTimes[MillisecondTimes["FiveSeconds"] = 5000] = "FiveSeconds";
+    MillisecondTimes[MillisecondTimes["TwentySeconds"] = 20000] = "TwentySeconds";
+    MillisecondTimes[MillisecondTimes["OneMinute"] = 60000] = "OneMinute";
+    MillisecondTimes[MillisecondTimes["TenMinutes"] = 600000] = "TenMinutes";
+    MillisecondTimes[MillisecondTimes["ThreeMinutes"] = 180000] = "ThreeMinutes";
+    MillisecondTimes[MillisecondTimes["FiveMinutes"] = 300000] = "FiveMinutes";
+})(MillisecondTimes || (MillisecondTimes = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7R0FJRztBQUNILE1BQU0sQ0FBQyxNQUFNLFNBQVMsR0FBRyxDQUFJLEdBQU0sRUFBRSxFQUFFLENBQUMsR0FBRyxDQUFDO0FBRTVDOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsUUFBUSxDQUNwQixTQUE0QixFQUM1QixHQUFHLFFBQWE7SUFFaEIsT0FBTyxTQUFTLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDO0FBQ3JDLENBQUM7QUFFRDs7O0dBR0c7QUFDSCxNQUFNLENBQU4sSUFBWSxnQkFRWDtBQVJELFdBQVksZ0JBQWdCO0lBQ3hCLG9FQUFnQixDQUFBO0lBQ2hCLHdFQUFrQixDQUFBO0lBQ2xCLDZFQUFxQixDQUFBO0lBQ3JCLHFFQUFpQixDQUFBO0lBQ2pCLHdFQUFtQixDQUFBO0lBQ25CLDRFQUFxQixDQUFBO0lBQ3JCLDBFQUFvQixDQUFBO0FBQ3hCLENBQUMsRUFSVyxnQkFBZ0IsS0FBaEIsZ0JBQWdCLFFBUTNCIn0=

package/package.json

@@ -0,0 +1,87 @@
+{
+    "name": "@superfluid-finance/sdk-redux",
+    "version": "0.1.0",
+    "description": "SDK Redux for streamlined front-end application development with Superfluid Protocol",
+    "homepage": "https://docs.superfluid.finance/",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/superfluid-finance/protocol-monorepo.git#dev"
+    },
+    "license": "MIT",
+    "main": "build/main/index.js",
+    "typings": "build/main/index.d.ts",
+    "module": "build/module/index.js",
+    "keywords": [],
+    "scripts": {
+        "pre-commit": "run-s lint:*",
+        "build": "run-p build:*",
+        "build:main": "tsc -p tsconfig.json",
+        "build:module": "tsc -p tsconfig.module.json",
+        "lint": "run-s lint:*",
+        "lint:prettier": "prettier \"src/**/*.ts\" --write",
+        "lint:eslint": "eslint src --ext .ts --fix",
+        "test": "echo 'TODO: Tests'",
+        "test:lint": "eslint src --ext .ts",
+        "test:prettier": "prettier \"src/**/*.ts\" --list-different",
+        "watch:build": "tsc -p tsconfig.json -w",
+        "doc": "run-s doc:html && open-cli build/docs/index.html",
+        "doc:html": "typedoc src/ --out build/docs",
+        "doc:json": "typedoc src/ --json build/docs/typedoc.json",
+        "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
+        "reset-hard": "git clean -dfx && git reset --hard && yarn",
+        "prepare-release": "run-s reset-hard test cov:check doc:html version doc:publish"
+    },
+    "engines": {
+        "node": ">=10"
+    },
+    "dependencies": {
+        "@superfluid-finance/sdk-core": "^0.1.0",
+        "@reduxjs/toolkit": "^1.6.1",
+        "ethers": "^5.4.5",
+        "graphql-request": "^3.5.0",
+        "lodash": "^4.17.21"
+    },
+    "devDependencies": {
+        "@istanbuljs/nyc-config-typescript": "^1.0.1",
+        "@typescript-eslint/eslint-plugin": "^4.0.1",
+        "@typescript-eslint/parser": "^4.0.1",
+        "codecov": "^3.5.0",
+        "cspell": "^4.1.0",
+        "cz-conventional-changelog": "^3.3.0",
+        "eslint": "^7.8.0",
+        "eslint-config-prettier": "^6.11.0",
+        "eslint-plugin-eslint-comments": "^3.2.0",
+        "eslint-plugin-import": "^2.22.0",
+        "gh-pages": "^3.1.0",
+        "npm-run-all": "^4.1.5",
+        "nyc": "^15.1.0",
+        "open-cli": "^6.0.1",
+        "prettier": "^2.1.1",
+        "ts-node": "^9.0.0",
+        "typedoc": "^0.22.10",
+        "typescript": "^4.3.5"
+    },
+    "files": [
+        "build/main",
+        "build/module",
+        "build/docs",
+        "!**/*.json",
+        "CHANGELOG.md",
+        "LICENSE",
+        "README.md"
+    ],
+    "config": {
+        "commitizen": {
+            "path": "cz-conventional-changelog"
+        }
+    },
+    "prettier": {
+        "singleQuote": true
+    },
+    "bugs": {
+        "url": "https://github.com/superfluid-finance/protocol-monorepo/issues"
+    },
+    "directories": {
+        "test": "test"
+    }
+}