one.block.eosiojava.interfaces

Interface IRPCProvider

public interface IRPCProvider

The interface of an RPC provider.

Method Summary

Modifier and Type	Method and Description
@NotNull GetBlockResponse	getBlock(GetBlockRequest getBlockRequest) Returns an object containing various details about a specific block on the blockchain.
@NotNull GetInfoResponse	getInfo() Returns an object containing various details about the blockchain.
@NotNull GetRawAbiResponse	getRawAbi(GetRawAbiRequest getRawAbiRequest) Gets raw abi for a given contract.
@NotNull GetRequiredKeysResponse	getRequiredKeys(GetRequiredKeysRequest getRequiredKeysRequest) Returns the required keys needed to sign a transaction.
@NotNull PushTransactionResponse	pushTransaction(PushTransactionRequest pushTransactionRequest) This method expects a transaction in JSON format and will attempt to apply it to the blockchain.

Method Detail

getInfo

@NotNull
@NotNull GetInfoResponse getInfo()
                                   throws GetInfoRpcError

Returns an object containing various details about the blockchain.

Returns:

the latest info/status of a chain.

Throws:

GetInfoRpcError - thrown if there are any exceptions/backend errors during the getInfo() process.

getBlock

@NotNull
@NotNull GetBlockResponse getBlock(GetBlockRequest getBlockRequest)
                                     throws GetBlockRpcError

Returns an object containing various details about a specific block on the blockchain.

Parameters:

getBlockRequest - Info of a specific block.

Returns:

the info/status of a specific block in the request

Throws:

GetBlockRpcError - thrown if there are any exceptions/backend error during the getBlock() process.

getRawAbi

@NotNull
@NotNull GetRawAbiResponse getRawAbi(GetRawAbiRequest getRawAbiRequest)
                                       throws GetRawAbiRpcError

Gets raw abi for a given contract.

Parameters:

getRawAbiRequest - Info of a specific smart contract.

Returns:

the serialized ABI of a smart contract in the request.

Throws:

GetRawAbiRpcError - thrown if there are any exceptions/backend error during the getRawAbi() process.

getRequiredKeys

@NotNull
@NotNull GetRequiredKeysResponse getRequiredKeys(GetRequiredKeysRequest getRequiredKeysRequest)
                                                   throws GetRequiredKeysRpcError

Returns the required keys needed to sign a transaction.

Parameters:

getRequiredKeysRequest - Info to get required keys

Returns:

the required keys to sign a transaction

Throws:

GetRequiredKeysRpcError - thrown if there are any exceptions/backend error during the getRequiredKeys() process.

pushTransaction

@NotNull
@NotNull PushTransactionResponse pushTransaction(PushTransactionRequest pushTransactionRequest)
                                                   throws PushTransactionRpcError

This method expects a transaction in JSON format and will attempt to apply it to the blockchain.

Parameters:

pushTransactionRequest - the transaction to push with signatures.

Returns:

the push transaction response

Throws:

PushTransactionRpcError - thrown if there are any exceptions/backend error during the pushTransaction() process.