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	V reducer: ReduxReducer Root reducer of redapp.
public	T ReduxActionType: string A redux action type.
public	T ReduxReducer: Reducer<any>\|Reducer<any, AnyAction> A redux reducer.
public	T ReduxSaga: Generator<*> A redux saga (a generator returned by a generator function).
public	T ReduxStateSelector: function(state: object): * 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	V ADD_CONTRACT: ReduxActionType Load a contract (binding it to an web3js Contract instance), and add it to the redux store.
public	V CONTRACT_ADDED: ReduxActionType When the contract is loaded, the reducer adds it to the store now.
public	V FORGET_CONTRACT: ReduxActionType 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	V trackingRed: ReduxReducer Tracking reducer of redapp.

tracking/accounts/AT

summary
public	V ACCOUNTS_GET_ALL: ReduxActionType Get data (like the balance) for each account in the tracker.
public	V ACCOUNTS_POLL_ERROR: ReduxActionType Whenever accounts polling failed, fired with "err" property containing the error.
public	V ACCOUNTS_START_POLLING: ReduxActionType Start polling accounts (runs a ACCOUNTS_START_FETCH, followed by a ACCOUNTS_GET_ALL).
public	V ACCOUNTS_STOP_POLLING: ReduxActionType Stop polling accounts (Polling can be resumed with ACCOUNTS_START_POLLING again).
public	V ACCOUNT_BALANCE: ReduxActionType When an account gets a new updated balance.
public	V ACCOUNT_GET: ReduxActionType Get data for an individual account.
public	V ACCOUNT_GET_BALANCE: ReduxActionType To start updating the balance of an account.
public	V ACCOUNT_GET_BALANCE_FAILED: ReduxActionType When balance updating fails.
public	V ADD_LOCAL_ACCOUNT: ReduxActionType Add an account to track locally.
public	V FORGET_LOCAL_ACCOUNT: ReduxActionType Forget local account.

tracking/accounts/actions

summary
public	F addLocalAcount(address: *): ReduxThunk Add an account to track locally.
public	F fetchAllAcounts(): ReduxThunk Update the list of wallet accounts.
public	F forgetLocalAccount(address: *): ReduxThunk Forget local account.
public	F getAllAccounts(): ReduxThunk 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	F startAccountPolling(interval: *): ReduxThunk Start polling for accounts.
public	F stopAccountPolling(): ReduxThunk 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	V BLOCKS_LISTEN_ERROR: ReduxActionType When an error occurs during listening for blocks.
public	V BLOCKS_POLL_ERROR: ReduxActionType When an error occurs during polling for blocks.
public	V BLOCKS_START_LISTENING: ReduxActionType Starts listening, for websocket based Web3 providers.
public	V BLOCKS_START_POLLING: ReduxActionType Start polling, for simple non-websocket based Web3 providers such as Metamask.
public	V BLOCKS_STOP_LISTENING: ReduxActionType Stops listening, for websocket based Web3 providers.
public	V BLOCKS_STOP_POLLING: ReduxActionType Stop polling, for simple non-websocket based Web3 providers such as Metamask
public	V BLOCKS_SUB_NEW_BLOCK_CHECK: ReduxActionType Trigger that is used to tunnel the subscription event to a block check.
public	V BLOCK_FAILED: ReduxActionType When block data from "BLOCK_RECEIVED" could not be processed.
public	V BLOCK_PROCESSED: ReduxActionType When block data from "BLOCK_RECEIVED" was processed successfully.
public	V BLOCK_RECEIVED: ReduxActionType When raw block data was received.
public	V BLOCK_RETRIEVAL_ERROR: ReduxActionType When retrieving a block fails.
public	V GET_BLOCK: ReduxActionType Force get a specific block (passed with 'blockHandle').
public	V GET_LATEST_BLOCK: ReduxActionType Force get latest block.

tracking/blocks/actions

summary
public	F getBlock(blockHandle: *): ReduxThunk Get a specific block.
public	F getLatestBlock(): ReduxThunk Force retrieval of the latest block.
public	F startBlockListening(): ReduxThunk 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	F stopBlockListening(): ReduxThunk Stop listening for block headers.
public	F stopBlockPolling(): ReduxThunk 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	V CACHE_CALL: ReduxActionType Call, but try to hit local redux cache first.
public	V CALL_DECODE_FAIL: ReduxActionType When a call failed to be decoded but was otherwise successful.
public	V CALL_DECODE_SUCCESS: ReduxActionType When a call is decoded, after `CALL_RETURNED`.
public	V CALL_FAILED: ReduxActionType When the call failed, (e.g.
public	V CALL_RETURNED: ReduxActionType When a call promise is completed by web3, adds the raw result to the cache.
public	V CLEAR_CACHE: ReduxActionType Wipe the cache.
public	V FORCE_CALL: ReduxActionType Call, ignoring the cache.
public	V FORGET_CALL: ReduxActionType 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	V FORGET_TX: ReduxActionType Remove TX from the tracker.
public	V SEND_TX: ReduxActionType Send a transaction, to be tracked.
public	V SEND_TX_FAILED: ReduxActionType When sending errors, i.e.
public	V TX_BROADCAST: ReduxActionType When a tx has been broadcast.
public	V TX_FAILED: ReduxActionType Has a "receipt" if it was a mining failure (e.g.
public	V TX_FINAL: ReduxActionType When web3 explicitly provided us with 12 chained confirmations.
public	V TX_RECEIPT: ReduxActionType When a receipt was received, may be multiple times in case of chain re-organization.
public	V TX_SENT: ReduxActionType 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.

Directories