redux-persist-blockstack

Storage engine for redux-persist for use with Blockstack Gaia .

Installation

Requires Blockstack JS.

Yarn: yarn add redux-persist-blockstack

npm: npm install --save redux-persist-blockstack

Usage

Use as a redux-persist global storage engine:

import createBlockstackStore from "redux-persist-blockstack";
import * as blockstack from "blockstack";

import { compose, applyMiddleware, createStore } from "redux";
import { persistStore, persistCombineReducers } from "redux-persist";
import reducers from "./reducers";

// Secure storage
const storage = createBlockstackStore(blockstack);
const config = {
    key: "root",
    storage
};

const reducer = persistCombineReducers(config, reducers);

function configureStore () {
  // ...
  let store = createStore(reducer);
  let persistor = persistStore(store);

  return { persistor, store };
}

Use as an engine for only a reducer:

import createBlockstackStore from "redux-persist-blockstack";
import * as blockstack from "blockstack";

import { combineReducers } from "redux";
import { persistReducer } from "redux-persist";

import { mainReducer, blockstackReducer } from "./reducers";

// Secure storage
const storage = createBlockstackStore(blockstack);
const blockstackPersistConfig = {
  key: "blockstack",
  storage
};

// Combine them together
const rootReducer = combineReducers({
  main: mainReducer,
  blockstack: persistReducer(blockstackPersistConfig, blockstackReducer)
});

function configureStore () {
  // ...
  let store = createStore(rootReducer);
  let persistor = persistStore(store);

  return { persistor, store };
}

API

createBlockstackStore([blockstack], [options])

[blockstack]: instance

[options]: object

Options to pass to Blockstack JS:

decrypt: boolean (default false)

Try to decrypt the data with the app private key

username: string

The Blockstack ID to lookup for multi-player storage

app: string

The app to lookup for multi-player storage - defaults to current origin

zoneFileLookupURL: string (default http://localhost:6270/v1/names/)

The Blockstack core endpoint URL to use for zonefile lookup

Redux-persist-blockstack specific options:

replacer: function(key: string): string

Replacer used to determine file path. Default: replace persist:foo with foo.json

function defaultReplacer(key) {
  const removePersist = str => str.replace("persist:", "");
  return `${ removePersist(key) }.json`;
}

Inspiration

My partner and I are building a React Native and Web app that utilize the same underlying Redux store. Since Blockstack does not yet fully support mobile (written 01/25/2018), we are using Redux Persist with the redux-persist-expo-securestore to store encrypted data on the user's native device, while saving to Blockstack through Redux Persist on web.

With redux-persist-expo-securestore and this library, redux-persist-blockstack, we can now simply swap out the storage driver when initializing the redux store, and redux-persist will watch the redux state of the data we've specified for it to watch and update Blockstack storage automatically.

Note

Inspired by redux-persist-expo-securestore