Usage docs Reference Examples

References

summary
public

F initWeb3(fallback: *): *

Initializes web3 in a fairly standard way.

public

F * saga(web3: *, defaultNetworkId: *, getRootState: *): ReduxSaga

Forks to tracking and contracts saga.

public

Root reducer of redapp.

public

A redux action type.

public

T ReduxReducer: Reducer<any>|Reducer<any, AnyAction>

A redux reducer.

public

A redux saga (a generator returned by a generator function).

public

Redux state selector.

public

T ReduxThunk: function(dispatch: *, getState: *) | function(dispatch: *)

A redux thunk, dispatch this to run it.

contracts

summary
public

F * contractsSaga(web3: *, defaultNetworkId: *, getContractsState: ReduxStateSelector): ReduxSaga

Handles ReDApp contract background processing, e.g.

contracts/AT

summary
public

Load a contract (binding it to an web3js Contract instance), and add it to the redux store.

public

When the contract is loaded, the reducer adds it to the store now.

public

Remove a contract from redux store.

contracts/actions

summary
public

F addContract(contractName: *, abi: *, networks: *): ReduxThunk

Load a contract (binding it to an web3js Contract instance), and add it to the redux store.

public

F forgetContract(contractName: *): ReduxThunk

Removes the contract from the local redux store.

tracking

summary
public

F * trackingSaga(web3: *, getTrackingState: ReduxStateSelector): ReduxSaga

Forks to tracking and contracts saga.

public

Tracking reducer of redapp.

tracking/accounts/AT

summary
public

Get data (like the balance) for each account in the tracker.

public

Whenever accounts polling failed, fired with "err" property containing the error.

public

Start polling accounts (runs a ACCOUNTS_START_FETCH, followed by a ACCOUNTS_GET_ALL).

public

Stop polling accounts (Polling can be resumed with ACCOUNTS_START_POLLING again).

public

When an account gets a new updated balance.

public

Get data for an individual account.

public

To start updating the balance of an account.

public

When balance updating fails.

public

Add an account to track locally.

public

Forget local account.

tracking/accounts/actions

summary
public

F addLocalAcount(address: *): ReduxThunk

Add an account to track locally.

public

Update the list of wallet accounts.

public

Forget local account.

public

Get data (like the balance) for each account in the tracker

public

F getBalance(address: *): ReduxThunk

To start updating the balance of an account

public

F getSingleAccount(address: *): ReduxThunk

Get data for an individual account.

public

Start polling for accounts.

public

Stop polling for accounts.

tracking/blocks

summary
public

F * blocksSaga(web3: *, getBlocksState: ReduxStateSelector): ReduxSaga

Handles ReDApp block background processing.

public

F * getSpecificBlock(web3: *, action: *): ReduxSaga

tracking/blocks/AT

summary
public

When an error occurs during listening for blocks.

public

When an error occurs during polling for blocks.

public

Starts listening, for websocket based Web3 providers.

public

Start polling, for simple non-websocket based Web3 providers such as Metamask.

public

Stops listening, for websocket based Web3 providers.

public

Stop polling, for simple non-websocket based Web3 providers such as Metamask

public

Trigger that is used to tunnel the subscription event to a block check.

public

When block data from "BLOCK_RECEIVED" could not be processed.

public

When block data from "BLOCK_RECEIVED" was processed successfully.

public

When raw block data was received.

public

When retrieving a block fails.

public

Force get a specific block (passed with 'blockHandle').

public

Force get latest block.

tracking/blocks/actions

summary
public

F getBlock(blockHandle: *): ReduxThunk

Get a specific block.

public

Force retrieval of the latest block.

public

Start listening for block headers, a new header will trigger the retrieval of the latest block.

public

F startBlockPolling(interval: *): ReduxThunk

Start polling blocks.

public

Stop listening for block headers.

public

Stop polling blocks.

tracking/calls

summary
public

F * awaitCall(callPromise: *, callID: *): Promise

Awaits a web3 call, and fires the corresponding redux events

public

F * callsSaga(web3: *, getCallsState: ReduxStateSelector): ReduxSaga

Handles ReDApp call background processing.

public

F initiateCall(web3: *, callID: *, blockNr: *, callParams: *): Promise

Initiate a web3 call, it starts waiting for a promise that is mapped to our redux call system.

tracking/calls/AT

summary
public

Call, but try to hit local redux cache first.

public

When a call failed to be decoded but was otherwise successful.

public

When a call is decoded, after CALL_RETURNED.

public

When the call failed, (e.g.

public

When a call promise is completed by web3, adds the raw result to the cache.

public

Wipe the cache.

public

Call, ignoring the cache.

public

Remove a single call from the cache.

tracking/calls/actions

summary
public

F cacheCall(options: *): ReduxThunk

Start a new call, but try to hit the cache for an existing call result first.

public

F forceCall(options: *): ReduxThunk

Start a new call, ignoring previous call data, forcing an overwrite when getting the result.

public

F forgetCall(callID: *): ReduxThunk

Remove a call from the tracking system.

tracking/transactions

summary
public

F openTxChannel(promiEvent: *, txID: *): Channel<any>

Open a TX channel: this channel maps web3 events to our redux tracking system.

public

F createTransactionPromiEvent(web3: *, txID: *, txParams: *): PromiEvent<TransactionReceipt>

Web3 returns a "promise combined with an event emitter": we map this to redux events.

public

F * transactionsSaga(web3: *, getTransactionsState: ReduxStateSelector): ReduxSaga

Handles ReDApp transaction background processing.

tracking/transactions/AT

summary
public

Remove TX from the tracker.

public

Send a transaction, to be tracked.

public

When sending errors, i.e.

public

When a tx has been broadcast.

public

Has a "receipt" if it was a mining failure (e.g.

public

When web3 explicitly provided us with 12 chained confirmations.

public

When a receipt was received, may be multiple times in case of chain re-organization.

public

After starting sending a transaction to the web3provider successfully, it's not broadcast yet!

tracking/transactions/actions

summary
public

F forgetTX(txID: *): ReduxThunk

Remove a transaction from the tracking system.

public

F sendTX(options: *): ReduxThunk

Send a transaction, which will be tracked in the ReDApp tracking system.

util

summary
public

F mappedreducer(mapping: *, initialState: *): Function

Creates a simple reducer, based on a mapping and an initial state.

public

F poller(startAT: *, stopAT: *, workerInner: *, errorHandler: *, workerArgs: *): pollWatcher

Simple redux saga utility for polling.

public

F subber(startAT: *, stopAT: *, dataAT: *, changedAT: *, errorAT: *, openEventSub: *): subscriptionWatcher

Maps an event-emitter (like web3.js uses) to a redux-saga event-channel, with support for being started/stopped/resumed.