@connext/store¶

Exported Types:

IAsyncStorage
IBackupService
IStoreService

Exported Classes:

PisaBackupService

Exported Functions:

getAsyncStore
getFileStore
getLocalStore
getMemoryStore
getPostgresStore

Types¶

IAsyncStorage¶

The interface for React Native’s AsyncStorage. For example, what you get from importing @react-native-community/async-storage.

interface IAsyncStorage {
  getItem(key: string): Promise<string | null>;
  setItem(key: string, value: string): Promise<void>;
  removeItem(key: string): Promise<void>;
}

IBackupService¶

The interface implemented by backup services such as Pisa which provide a remote location for storing channel commitments (required for on-chain disputes). If an IBackupService is given to a store then it will send all generated commitments to that service for safe keeping or to enable it to act as a watchtower on your behalf.

interface IBackupService {
  restore(): Promise<Array<{ path: string, value: any }>>;
  backup(pair: { path: string, value: any }): Promise<void>;
}

IStoreService¶

The interface containing all the read/write methods that the core protocol needs to interact with your off-chain state. It’s relatively complicated, you can see the type definition at indra/modules/types/src/store.ts but you shouldn’t ever need to deal w this type directly, that’s what the functions exported by this lib are for. 😉

Classes¶

PisaBackupService¶

An IBackupService configured to work with Pisa’s state backup service.

class PisaBackupService implements IBackupService {
  constructor(pisaClient: string, wallet: Wallet)
}

Constructor Params¶

pisaUrl: The URL that points to our Pisa backup service endpoint.
wallet: an ethers Wallet, used to authenticate with Pisa.

Example Usage¶

import { PisaBackupService, getLocalStore } from "@connext/store";
import { connect } from "@connext/client";
import { Wallet } from "ethers";

const pisaUrl = "https://example.com";
const wallet = Wallet.createRandom();

const channel = connect({
  store: getLocalStore({ backupService: new PisaBackupService(pisaUrl, wallet) }),
});

channel.deposit({ ... });
channel.transfer({ ... });
channel.withdraw({ ... });

Functions¶

getAsyncStore¶

getAsyncStore(storage: IAsyncStorage, backupService?: IBackupService): IStoreService;

Params¶

storage:: IAsyncStorage
backupService: IBackupService (optional)

Returns¶

An IStoreService configured to save data in React Native’s Async Storage.

getFileStore¶

getFileStore(fileDir: string, backupService?: IBackupService): IStoreService;

Params¶

fileDir:: string (optional) The path to a folder where the files containing store data will be saved. Defaults to ./.connext-store;
backupService: IBackupService (optional)

Returns¶

An IStoreService configured to save data to a collection of files in fileDir.

getLocalStore¶

getLocalStore(backupService?: IBackupService): IStoreService;

Params¶

backupService: IBackupService (optional)

Returns¶

An IStoreService configured to save data to a browser’s localStorage.

getMemoryStore¶

getMemoryStore(backupService?: IBackupService): IStoreService;

Params¶

backupService: IBackupService (optional)

Returns¶

Returns an IStoreService configured to not save data & keep everything in memory. Good for testing, not good for managing real channel data.

getPostgresStore¶

getPostgresgStore(connectionUri: string, backupService?: IBackupService): IStoreService;

Params¶

connectionUri:: string Should look something like postgres://user:password@host:port/database.
backupService: IBackupService (optional)

Returns¶

Returns an IStoreService configured to save data to a postgres database.