org.web3j.protocol.rx

Interface Web3jRx

All Known Subinterfaces:

Admin, Web3j

All Known Implementing Classes:

JsonRpc2_0Admin, JsonRpc2_0Web3j

public interface Web3jRx

The Observables JSON-RPC client event API.

Method Summary

Modifier and Type	Method and Description
rx.Observable<EthBlock>	blockObservable(boolean fullTransactionObjects) Create an Observable that emits newly created blocks on the blockchain.
rx.Observable<EthBlock>	catchUpToLatestAndSubscribeToNewBlocksObservable(DefaultBlockParameter startBlock, boolean fullTransactionObjects) Creates an Observable that emits all blocks from the requested block number to the most current.
rx.Observable<Transaction>	catchUpToLatestAndSubscribeToNewTransactionsObservable(DefaultBlockParameter startBlock) As per catchUpToLatestAndSubscribeToNewBlocksObservable(DefaultBlockParameter, boolean), except that all transactions contained within the blocks are emitted.
rx.Observable<EthBlock>	catchUpToLatestBlockObservable(DefaultBlockParameter startBlock, boolean fullTransactionObjects) Creates an Observable that emits all blocks from the requested block number to the most current.
rx.Observable<EthBlock>	catchUpToLatestBlockObservable(DefaultBlockParameter startBlock, boolean fullTransactionObjects, rx.Observable<EthBlock> onCompleteObservable) Create an Observable that emits all transactions from the blockchain starting with a provided block number.
rx.Observable<Transaction>	catchUpToLatestTransactionObservable(DefaultBlockParameter startBlock) Creates an Observable that emits all transactions from the requested block number to the most current.
rx.Observable<java.lang.String>	ethBlockHashObservable() Create an Observable to emit block hashes.
rx.Observable<Log>	ethLogObservable(EthFilter ethFilter) Create an observable to filter for specific log events on the blockchain.
rx.Observable<java.lang.String>	ethPendingTransactionHashObservable() Create an Observable to emit pending transactions, i.e.
rx.Observable<Transaction>	pendingTransactionObservable() Create an Observable to emit all pending transactions that have yet to be placed into a block on the blockchain.
rx.Observable<EthBlock>	replayBlocksObservable(DefaultBlockParameter startBlock, DefaultBlockParameter endBlock, boolean fullTransactionObjects) Create an Observable that emits all blocks from the blockchain contained within the requested range.
rx.Observable<EthBlock>	replayBlocksObservable(DefaultBlockParameter startBlock, DefaultBlockParameter endBlock, boolean fullTransactionObjects, boolean ascending) Create an Observable that emits all blocks from the blockchain contained within the requested range.
rx.Observable<Transaction>	replayTransactionsObservable(DefaultBlockParameter startBlock, DefaultBlockParameter endBlock) Create an Observable that emits all transactions from the blockchain contained within the requested range.
rx.Observable<Transaction>	transactionObservable() Create an Observable to emit all new transactions as they are confirmed on the blockchain.

Method Detail

ethLogObservable

rx.Observable<Log> ethLogObservable(EthFilter ethFilter)

Create an observable to filter for specific log events on the blockchain.

Parameters:

ethFilter - filter criteria

Returns:

Observable that emits all Log events matching the filter

ethBlockHashObservable

rx.Observable<java.lang.String> ethBlockHashObservable()

Create an Observable to emit block hashes.

Returns:

Observable that emits all new block hashes as new blocks are created on the blockchain

ethPendingTransactionHashObservable

rx.Observable<java.lang.String> ethPendingTransactionHashObservable()

Create an Observable to emit pending transactions, i.e. those transactions that have been submitted by a node, but don't yet form part of a block (haven't been mined yet).

Returns:

Observable to emit pending transaction hashes.

transactionObservable

rx.Observable<Transaction> transactionObservable()

Create an Observable to emit all new transactions as they are confirmed on the blockchain. i.e. they have been mined and are incorporated into a block.

Returns:

Observable to emit new transactions on the blockchain

pendingTransactionObservable

rx.Observable<Transaction> pendingTransactionObservable()

Create an Observable to emit all pending transactions that have yet to be placed into a block on the blockchain.

Returns:

Observable to emit pending transactions

blockObservable

rx.Observable<EthBlock> blockObservable(boolean fullTransactionObjects)

Create an Observable that emits newly created blocks on the blockchain.

Parameters:

fullTransactionObjects - if true, provides transactions embedded in blocks, otherwise transaction hashes

Returns:

Observable that emits all new blocks as they are added to the blockchain

replayBlocksObservable

rx.Observable<EthBlock> replayBlocksObservable(DefaultBlockParameter startBlock,
                                               DefaultBlockParameter endBlock,
                                               boolean fullTransactionObjects)

Create an Observable that emits all blocks from the blockchain contained within the requested range.

Parameters:

startBlock - block number to commence with

endBlock - block number to finish with

fullTransactionObjects - if true, provides transactions embedded in blocks, otherwise transaction hashes

Returns:

Observable to emit these blocks

replayBlocksObservable

rx.Observable<EthBlock> replayBlocksObservable(DefaultBlockParameter startBlock,
                                               DefaultBlockParameter endBlock,
                                               boolean fullTransactionObjects,
                                               boolean ascending)

Create an Observable that emits all blocks from the blockchain contained within the requested range.

Parameters:

startBlock - block number to commence with

endBlock - block number to finish with

fullTransactionObjects - if true, provides transactions embedded in blocks, otherwise transaction hashes

ascending - if true, emits blocks in ascending order between range, otherwise in descending order

Returns:

Observable to emit these blocks

replayTransactionsObservable

rx.Observable<Transaction> replayTransactionsObservable(DefaultBlockParameter startBlock,
                                                        DefaultBlockParameter endBlock)

Create an Observable that emits all transactions from the blockchain contained within the requested range.

Parameters:

startBlock - block number to commence with

endBlock - block number to finish with

Returns:

Observable to emit these transactions in the order they appear in the blocks

catchUpToLatestBlockObservable

rx.Observable<EthBlock> catchUpToLatestBlockObservable(DefaultBlockParameter startBlock,
                                                       boolean fullTransactionObjects,
                                                       rx.Observable<EthBlock> onCompleteObservable)

Create an Observable that emits all transactions from the blockchain starting with a provided block number. Once it has replayed up to the most current block, the provided Observable is invoked.

To automatically subscribe to new blocks, use catchUpToLatestAndSubscribeToNewBlocksObservable(DefaultBlockParameter, boolean).

Parameters:

startBlock - the block number we wish to request from

fullTransactionObjects - if we require full Transaction objects to be provided in the EthBlock responses

onCompleteObservable - a subsequent Observable that we wish to run once we are caught up with the latest block

Returns:

Observable to emit all requested blocks

catchUpToLatestBlockObservable

rx.Observable<EthBlock> catchUpToLatestBlockObservable(DefaultBlockParameter startBlock,
                                                       boolean fullTransactionObjects)

Creates an Observable that emits all blocks from the requested block number to the most current. Once it has emitted the most current block, onComplete is called.

Parameters:

startBlock - the block number we wish to request from

fullTransactionObjects - if we require full Transaction objects to be provided in the EthBlock responses

Returns:

Observable to emit all requested blocks

catchUpToLatestTransactionObservable

rx.Observable<Transaction> catchUpToLatestTransactionObservable(DefaultBlockParameter startBlock)

Creates an Observable that emits all transactions from the requested block number to the most current. Once it has emitted the most current block's transactions, onComplete is called.

Parameters:

startBlock - the block number we wish to request from

Returns:

Observable to emit all requested transactions

catchUpToLatestAndSubscribeToNewBlocksObservable

rx.Observable<EthBlock> catchUpToLatestAndSubscribeToNewBlocksObservable(DefaultBlockParameter startBlock,
                                                                         boolean fullTransactionObjects)

Creates an Observable that emits all blocks from the requested block number to the most current. Once it has emitted the most current block, it starts emitting new blocks as they are created.

Parameters:

startBlock - the block number we wish to request from

fullTransactionObjects - if we require full Transaction objects to be provided in the EthBlock responses

Returns:

Observable to emit all requested blocks and future

catchUpToLatestAndSubscribeToNewTransactionsObservable

rx.Observable<Transaction> catchUpToLatestAndSubscribeToNewTransactionsObservable(DefaultBlockParameter startBlock)

As per catchUpToLatestAndSubscribeToNewBlocksObservable(DefaultBlockParameter, boolean), except that all transactions contained within the blocks are emitted.

Parameters:

startBlock - the block number we wish to request from

Returns:

Observable to emit all requested transactions and future