Welcome to @superfluid-finance/sdk-redux 👋

🏠 Homepage

✨ Superfluid App

📖 Docs

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-finance/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

• SDK-Core
• 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:

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>
>;
Copy

We need to plug in the Superfluid SDK-Redux parts.

Import the following function:

import {
    allRpcEndpoints,
    allSubgraphEndpoints,
    createApiWithReactHooks,
    initializeRpcApiSlice,
    initializeSubgraphApiSlice,
    initializeTransactionTrackerSlice
} from "@superfluid-finance/sdk-redux";
Copy

Create the Redux slices:

export const rpcApi = initializeRpcApiSlice(createApiWithReactHooks).injectEndpoints(allRpcEndpoints);
export const subgraphApi = initializeSubgraphApiSlice(createApiWithReactHooks).injectEndpoints(allSubgraphEndpoints);
export const transactionTracker = initializeTransactionTrackerSlice();

Copy

Plug in the slices to the Redux store:

export const store = configureStore({
    reducer: {
        [rpcApi.reducerPath]: rpcApi.reducer,
        [subgraphApi.reducerPath]: subgraphApi.reducer
        [transactionTracker.reducerPath]: transactionTracker.reducer,
    }
});
Copy

Add the middlewares (important to add for both rpcApi & subgraphApi):

export const store = configureStore({
    reducer: {
        [rpcApi.reducerPath]: rpcApi.reducer,
        [subgraphApi.reducerPath]: subgraphApi.reducer
        [transactionTracker.reducerPath]: transactionTracker.reducer,
    },
    middleware: (getDefaultMiddleware) =>
        getDefaultMiddleware().concat(rpcApi.middleware).concat(subgraphApi.middleware),
});
Copy

Somewhere in your code, give instructions to the sdkReduxConfig to locate Framework:

import { setFrameworkForSdkRedux } from "@superfluid-finance/sdk-redux";

setFrameworkForSdkRedux(chainId, sdkCoreFramework);
Copy

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:

const {
    data: pagedStreams,
    isUninitialized,
    isFetching,
    isLoading,
    isError,
    error,
    refetch,
} = sfSubgraph.useStreamsQuery({
    chainId: queryChainId,
    filter: {
      token: superTokenAddress,
      sender: senderAddress
    },
    pagination: {
        skip: (page - 1) * pageSize,
        take: pageSize
    },
    ordering: {
      orderBy: "currentFlowRate",
      orderDirection: "desc"
    }
}, {
    pollingInterval: 5000 // Not necessary to use but nice-to-have additional option by RTK-Query.
});
Copy

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:

const tx = await rpcApi.createFlow({
    signer,
    chainId,
    senderAddress: senderAddress,
    receiverAddress: receiver,
    flowRateWei: flowRate,
    superTokenAddress: superToken
}).unwrap();
Copy

Transaction Tracking

All mutations trigger tracking for transaction progress (stored in transactionTrackerSlice) 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.