com.klaytn.caver.rpc

Class Klay

java.lang.Object

com.klaytn.caver.rpc.Klay

public class Klay
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.web3j.protocol.Web3jService	web3jService JSON-RPC service instance.

Constructor Summary

Constructors

Constructor and Description
Klay(org.web3j.protocol.Web3jService web3jService) Creates a Klay instance

Method Summary

Modifier and Type	Method and Description
org.web3j.protocol.core.Request<?,Boolean>	accountCreated(java.lang.String address) Returns true if the account associated with the address is created.
org.web3j.protocol.core.Request<?,Boolean>	accountCreated(java.lang.String address, org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns true if the account associated with the address is created.
org.web3j.protocol.core.Request<?,Boolean>	accountCreated(java.lang.String address, long blockNumber) Returns true if the account associated with the address is created.
org.web3j.protocol.core.Request<?,Bytes>	call(CallObject callObject) Executes a new message call immediately without creating a transaction on the block chain.
org.web3j.protocol.core.Request<?,Bytes>	call(CallObject callObject, org.web3j.protocol.core.DefaultBlockParameter blockTag) Executes a new message call immediately without creating a transaction on the block chain.
org.web3j.protocol.core.Request<?,Bytes>	call(CallObject callObject, Quantity blockNumber) Executes a new message call immediately without creating a transaction on the block chain.
org.web3j.protocol.core.Request<?,AccountKey>	decodeAccountKey(java.lang.String encodedAccountKey) Decodes an RLP encoded account key.
org.web3j.protocol.core.Request<?,Bytes>	encodeAccountKey(IAccountKey accountKey) Encodes an account key using the RLP encoding scheme.
org.web3j.protocol.core.Request<?,Quantity>	estimateComputationCost(CallObject callObject) Generates and returns an estimate of how much computation cost spent to execute the transaction.
org.web3j.protocol.core.Request<?,Quantity>	estimateComputationCost(CallObject callObject, org.web3j.protocol.core.DefaultBlockParameter blockTag) Generates and returns an estimate of how much computation cost spent to execute the transaction.
org.web3j.protocol.core.Request<?,Quantity>	estimateComputationCost(CallObject callObject, long blockNumber) Generates and returns an estimate of how much computation cost spent to execute the transaction.
org.web3j.protocol.core.Request<?,Quantity>	estimateGas(CallObject callObject) Generates and returns an estimate of how much gas is necessary to allow the transaction to complete.
org.web3j.protocol.core.Request<?,Account>	getAccount(java.lang.String address) Returns the account information of a given address.
org.web3j.protocol.core.Request<?,Account>	getAccount(java.lang.String address, org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns the account information of a given address.
org.web3j.protocol.core.Request<?,Account>	getAccount(java.lang.String address, long blockNumber) Returns the account information of a given address.
org.web3j.protocol.core.Request<?,AccountKey>	getAccountKey(java.lang.String address) Returns AccountKey of a given address.
org.web3j.protocol.core.Request<?,AccountKey>	getAccountKey(java.lang.String address, org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns AccountKey of a given address.
org.web3j.protocol.core.Request<?,AccountKey>	getAccountKey(java.lang.String address, long blockNumber) Returns AccountKey of a given address.
org.web3j.protocol.core.Request<?,Addresses>	getAccounts() Returns a list of addresses owned by client.
org.web3j.protocol.core.Request<?,Quantity>	getBalance(java.lang.String address) Returns the balance of the account of given address.
org.web3j.protocol.core.Request<?,Quantity>	getBalance(java.lang.String address, org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns the balance of the account of given address.
org.web3j.protocol.core.Request<?,Quantity>	getBalance(java.lang.String address, long blockNumber) Returns the balance of the account of given address.
org.web3j.protocol.core.Request<?,Block>	getBlockByHash(java.lang.String blockHash) Returns information about a block by block number.
org.web3j.protocol.core.Request<?,Block>	getBlockByHash(java.lang.String blockHash, boolean isFullTransaction) Returns information about a block by block number.
org.web3j.protocol.core.Request<?,Block>	getBlockByNumber(org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns information about a block by block number.
org.web3j.protocol.core.Request<?,Block>	getBlockByNumber(org.web3j.protocol.core.DefaultBlockParameter defaultBlockParameter, boolean isFullTransaction) Returns information about a block by block number.
org.web3j.protocol.core.Request<?,Block>	getBlockByNumber(long blockNumber) Returns information about a block by block number.
org.web3j.protocol.core.Request<?,Block>	getBlockByNumber(long blockNumber, boolean isFullTransaction) Returns information about a block by block number.
org.web3j.protocol.core.Request<?,Quantity>	getBlockNumber() Returns the number of most recent block.
org.web3j.protocol.core.Request<?,BlockTransactionReceipts>	getBlockReceipts(java.lang.String blockHash) Returns receipts included in a block identified by block hash.
org.web3j.protocol.core.Request<?,Quantity>	getBlockTransactionCountByHash(java.lang.String blockHash) Returns the number of transactions in a block from a block matching the given block hash.
org.web3j.protocol.core.Request<?,Quantity>	getBlockTransactionCountByNumber(org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns the number of transactions in a block matching the given block number.
org.web3j.protocol.core.Request<?,Quantity>	getBlockTransactionCountByNumber(long blockNumber) Returns the number of transactions in a block matching the given block number.
org.web3j.protocol.core.Request<?,BlockWithConsensusInfo>	getBlockWithConsensusInfoByHash(java.lang.String blockHash) Returns a block with consensus information matched by the given hash.
org.web3j.protocol.core.Request<?,BlockWithConsensusInfo>	getBlockWithConsensusInfoByNumber(org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns a block with consensus information matched by the given block number.
org.web3j.protocol.core.Request<?,BlockWithConsensusInfo>	getBlockWithConsensusInfoByNumber(long blockNumber) Returns a block with consensus information matched by the given block number.
org.web3j.protocol.core.Request<?,Quantity>	getChainID() Returns the chain ID of the chain.
org.web3j.protocol.core.Request<?,Bytes>	getClientVersion() Returns the current client version of a Klaytn node.
org.web3j.protocol.core.Request<?,Bytes>	getCode(java.lang.String address) Returns code at a given address.
org.web3j.protocol.core.Request<?,Bytes>	getCode(java.lang.String address, org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns code at a given address.
org.web3j.protocol.core.Request<?,Bytes>	getCode(java.lang.String address, long blockNumber) Returns code at a given address.
org.web3j.protocol.core.Request<?,Addresses>	getCommittee() Returns a list of all validators in the committee at the specified block.
org.web3j.protocol.core.Request<?,Addresses>	getCommittee(org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns a list of all validators in the committee at the specified block.
org.web3j.protocol.core.Request<?,Addresses>	getCommittee(long blockNumber) Returns a list of all validators in the committee at the specified block.
org.web3j.protocol.core.Request<?,Quantity>	getCommitteeSize() Returns the size of the committee at the specified block.
org.web3j.protocol.core.Request<?,Quantity>	getCommitteeSize(org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns the size of the committee at the specified block.
org.web3j.protocol.core.Request<?,Quantity>	getCommitteeSize(long blockNumber) Returns the size of the committee at the specified block.
org.web3j.protocol.core.Request<?,Addresses>	getCouncil() Returns a list of all validators of the council at the specified block.
org.web3j.protocol.core.Request<?,Addresses>	getCouncil(org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns a list of all validators of the council at the specified block.
org.web3j.protocol.core.Request<?,Addresses>	getCouncil(long blockNumber) Returns a list of all validators of the council at the specified block.
org.web3j.protocol.core.Request<?,Quantity>	getCouncilSize() Returns the size of the council at the specified block.
org.web3j.protocol.core.Request<?,Quantity>	getCouncilSize(org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns the size of the council at the specified block.
org.web3j.protocol.core.Request<?,Quantity>	getCouncilSize(long blockNumber) Returns the size of the council at the specified block.
org.web3j.protocol.core.Request<?,DecodeAnchoringTransaction>	getDecodedAnchoringTransaction(java.lang.String hash) Returns the decoded anchored data in the transaction for the given transaction hash.
org.web3j.protocol.core.Request<?,KlayLogs>	getFilterChanges(java.lang.String filterId) Polling method for a filter, which returns an array of logs which occurred since last poll.
org.web3j.protocol.core.Request<?,KlayLogs>	getFilterLogs(java.lang.String filterId) Returns an array of all logs matching filter with given id, which has been obtained using klay_newFilter.
org.web3j.protocol.core.Request<?,Quantity>	getGasPrice() Returns the current price per gas in peb.
org.web3j.protocol.core.Request<?,Quantity>	getGasPriceAt() Returns the unit price of the given block in peb.
org.web3j.protocol.core.Request<?,Quantity>	getGasPriceAt(org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns the unit price of the given block in peb.
org.web3j.protocol.core.Request<?,Quantity>	getGasPriceAt(long blockNumber) Returns the unit price of the given block in peb.
org.web3j.protocol.core.Request<?,KlayLogs>	getLogs(KlayLogFilter filterOption) Returns an array of all logs matching a given filter object.
org.web3j.protocol.core.Request<?,Bytes>	getProtocolVersion() Returns the Klaytn protocol version of the node.
org.web3j.protocol.core.Request<?,Bytes20>	getRewardbase() Returns the reward base of the current node.
org.web3j.protocol.core.Request<?,Bytes>	getStorageAt(java.lang.String address, org.web3j.protocol.core.DefaultBlockParameterNumber position, org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns the value from a storage position at a given address.
org.web3j.protocol.core.Request<?,Bytes>	getStorageAt(java.lang.String address, org.web3j.protocol.core.DefaultBlockParameterNumber position, long blockNumber) Returns the value from a storage position at a given address.
org.web3j.protocol.core.Request<?,Transaction>	getTransactionByBlockHashAndIndex(java.lang.String blockHash, long index) Returns information about a transaction by block hash and transaction index position.
org.web3j.protocol.core.Request<?,Transaction>	getTransactionByBlockNumberAndIndex(org.web3j.protocol.core.DefaultBlockParameter blockTag, org.web3j.protocol.core.DefaultBlockParameterNumber index) Returns information about a transaction by block number and transaction index position.
org.web3j.protocol.core.Request<?,Transaction>	getTransactionByBlockNumberAndIndex(long blockNumber, long index) Returns information about a transaction by block number and transaction index position.
org.web3j.protocol.core.Request<?,Transaction>	getTransactionByHash(java.lang.String txHash) Returns the information about a transaction requested by transaction hash.
org.web3j.protocol.core.Request<?,Transaction>	getTransactionBySenderTxHash(java.lang.String senderTxHash) Returns the information about a transaction requested by sender transaction hash.
org.web3j.protocol.core.Request<?,Quantity>	getTransactionCount(java.lang.String address) Returns the number of transactions sent from an address.
org.web3j.protocol.core.Request<?,Quantity>	getTransactionCount(java.lang.String address, org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns the number of transaction sent from an address
org.web3j.protocol.core.Request<?,Quantity>	getTransactionCount(java.lang.String address, long blockNumber) Returns the number of transactions sent from an address.
org.web3j.protocol.core.Request<?,Quantity>	getTransactionCountByHash(java.lang.String blockHash) Returns the number of transactions in a block from a block matching the given block hash.
org.web3j.protocol.core.Request<?,Quantity>	getTransactionCountByNumber(org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns the number of transactions in a block matching the given block number.
org.web3j.protocol.core.Request<?,Quantity>	getTransactionCountByNumber(long blockNumber) Returns the number of transactions in a block matching the given block number.
org.web3j.protocol.core.Request<?,TransactionReceipt>	getTransactionReceipt(java.lang.String transactionHash) Returns the receipt of a transaction by transaction hash.
org.web3j.protocol.core.Request<?,TransactionReceipt>	getTransactionReceiptBySenderTxHash(java.lang.String transactionHash) Returns the receipt of a transaction by sender transaction hash.
org.web3j.protocol.core.Request<?,Boolean>	isContractAccount(java.lang.String address) Returns true if an input account has a non-empty codeHash at the time of a specific block number.
org.web3j.protocol.core.Request<?,Boolean>	isContractAccount(java.lang.String address, org.web3j.protocol.core.DefaultBlockParameter blockTag) Returns true if an input account has a non-empty codeHash at the time of a specific block number.
org.web3j.protocol.core.Request<?,Boolean>	isContractAccount(java.lang.String address, long blockNumber) Returns true if an input account has a non-empty codeHash at the time of a specific block number.
org.web3j.protocol.core.Request<?,Boolean>	isParallelDBWrite() Returns true if the node is writing blockchain data in parallel manner.
org.web3j.protocol.core.Request<?,Boolean>	isSenderTxHashIndexingEnabled() Returns true if the node is indexing sender transaction hash to transaction hash mapping information.
org.web3j.protocol.core.Request<?,KlaySyncing>	isSyncing() Returns an object with data about the sync status or false.
org.web3j.protocol.core.Request<?,Quantity>	newBlockFilter() Creates a filter in the node, to notify when a new block arrives.
org.web3j.protocol.core.Request<?,Quantity>	newFilter(KlayFilter filterOption) Creates a filter object, based on filter options, to notify when the state changes (logs).
org.web3j.protocol.core.Request<?,Quantity>	newPendingTransactionFilter() Creates a filter in the node, to notify when new pending transactions arrive.
org.web3j.protocol.core.Request<?,Bytes32>	sendRawTransaction(AbstractTransaction transaction) Creates a new message call transaction or a contract creation for signed transactions.
org.web3j.protocol.core.Request<?,Bytes32>	sendRawTransaction(java.lang.String signedTransactionData) Creates a new message call transaction or a contract creation for signed transactions.
org.web3j.protocol.core.Request<?,Bytes32>	sendTransaction(AbstractTransaction transaction) Constructs a transaction with given parameters, signs the transaction with a sender's private key and propagates the transaction to Klaytn network.
org.web3j.protocol.core.Request<?,Bytes32>	sendTransactionAsFeePayer(AbstractFeeDelegatedTransaction transaction) Constructs a transaction with given parameters, signs the transaction with a fee payer's private key and propagates the transaction to Klaytn network.
org.web3j.protocol.core.Request<?,Bytes>	sha3(java.lang.String data) Returns Keccak-256 (not the standardized SHA3-256) of the given data.
org.web3j.protocol.core.Request<?,Bytes>	sign(java.lang.String address, java.lang.String message) The sign method calculates a Klaytn-specific signature.
org.web3j.protocol.core.Request<?,SignTransaction>	signTransaction(AbstractTransaction transaction) Constructs a transaction with given parameters and signs the transaction with a sender's private key.
org.web3j.protocol.core.Request<?,SignTransaction>	signTransactionAsFeePayer(AbstractFeeDelegatedTransaction transaction) Constructs a transaction with given parameters and signs the transaction with a fee payer's private key.
org.web3j.protocol.core.Request<?,Boolean>	uninstallFilter(java.lang.String filterId) Uninstalls a filter with given id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

web3jService

protected final org.web3j.protocol.Web3jService web3jService

JSON-RPC service instance.

Constructor Detail

Klay

public Klay(org.web3j.protocol.Web3jService web3jService)

Creates a Klay instance

Parameters:

web3jService - JSON-RPC service instance.

Method Detail

accountCreated

public org.web3j.protocol.core.Request<?,Boolean> accountCreated(java.lang.String address)

Returns true if the account associated with the address is created. It returns false otherwise. It sets block tag to "LATEST"

Parameters:

address - The account address

Returns:

Boolean - The existence of an input address

accountCreated

public org.web3j.protocol.core.Request<?,Boolean> accountCreated(java.lang.String address,
                                                                 long blockNumber)

Returns true if the account associated with the address is created. It returns false otherwise.

Parameters:

address - The account address

blockNumber - The block number.

Returns:

Boolean - The existence of an input address

accountCreated

public org.web3j.protocol.core.Request<?,Boolean> accountCreated(java.lang.String address,
                                                                 org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns true if the account associated with the address is created. It returns false otherwise.

Parameters:

address - The account address.

blockTag - The string "latest", "earliest" or "pending"

Returns:

Boolean - The existence of an input address

getAccounts

public org.web3j.protocol.core.Request<?,Addresses> getAccounts()

Returns a list of addresses owned by client.

Returns:

Addresses - Addresses owned by the client.

encodeAccountKey

public org.web3j.protocol.core.Request<?,Bytes> encodeAccountKey(IAccountKey accountKey)

Encodes an account key using the RLP encoding scheme.

Parameters:

accountKey - Account Key Object

Returns:

Bytes

decodeAccountKey

public org.web3j.protocol.core.Request<?,AccountKey> decodeAccountKey(java.lang.String encodedAccountKey)

Decodes an RLP encoded account key.

Parameters:

encodedAccountKey - RLP encoded account key

Returns:

AccountKeyResponse

getAccount

public org.web3j.protocol.core.Request<?,Account> getAccount(java.lang.String address)

Returns the account information of a given address. There are two different account types in Klaytn: Externally Owned Account (EOA) and Smart Contract Account. It sets block tag to "LATEST"

Parameters:

address - The account address.

Returns:

AccountResponse

getAccount

public org.web3j.protocol.core.Request<?,Account> getAccount(java.lang.String address,
                                                             long blockNumber)

Returns the account information of a given address. There are two different account types in Klaytn: Externally Owned Account (EOA) and Smart Contract Account.

Parameters:

address - The account address.

blockNumber - The block number..

Returns:

AccountResponse

getAccount

public org.web3j.protocol.core.Request<?,Account> getAccount(java.lang.String address,
                                                             org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns the account information of a given address. There are two different account types in Klaytn: Externally Owned Account (EOA) and Smart Contract Account.

Parameters:

address - The account address

blockTag - The string "latest", "earliest" or "pending"

Returns:

AccountResponse

getAccountKey

public org.web3j.protocol.core.Request<?,AccountKey> getAccountKey(java.lang.String address)

Returns AccountKey of a given address. If the account has AccountKeyLegacy or the account of the given address is a Smart Contract Account, it will return an empty key value. It sets block tag to "LATEST".

Parameters:

address - The account address

Returns:

AccountKeyResponse

getAccountKey

public org.web3j.protocol.core.Request<?,AccountKey> getAccountKey(java.lang.String address,
                                                                   long blockNumber)

Returns AccountKey of a given address. If the account has AccountKeyLegacy or the account of the given address is a Smart Contract Account, it will return an empty key value.

Parameters:

address - The account address

blockNumber - The block number..

Returns:

AccountKeyResponse

getAccountKey

public org.web3j.protocol.core.Request<?,AccountKey> getAccountKey(java.lang.String address,
                                                                   org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns AccountKey of a given address. If the account has AccountKeyLegacy or the account of the given address is a Smart Contract Account, it will return an empty key value.

Parameters:

address - The account address

blockTag - The string "latest", "earliest" or "pending"

Returns:

AccountKeyResponse

getBalance

public org.web3j.protocol.core.Request<?,Quantity> getBalance(java.lang.String address)

Returns the balance of the account of given address. It sets block tag to "LATEST".

Parameters:

address - The account address to check for balance.

Returns:

Quantity

getBalance

public org.web3j.protocol.core.Request<?,Quantity> getBalance(java.lang.String address,
                                                              long blockNumber)

Returns the balance of the account of given address.

Parameters:

address - The account address to check for balance.

blockNumber - The block number.

Returns:

Quantity

getBalance

public org.web3j.protocol.core.Request<?,Quantity> getBalance(java.lang.String address,
                                                              org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns the balance of the account of given address.

Parameters:

address - The account address to check for balance.

blockTag - The string "latest", "earliest" or "pending"

Returns:

Quantity

getCode

public org.web3j.protocol.core.Request<?,Bytes> getCode(java.lang.String address)

Returns code at a given address. It sets block tag to "LATEST"

Parameters:

address - The account address

Returns:

Bytes

getCode

public org.web3j.protocol.core.Request<?,Bytes> getCode(java.lang.String address,
                                                        long blockNumber)

Returns code at a given address.

Parameters:

address - The account address

blockNumber - The block number.

Returns:

Bytes

getCode

public org.web3j.protocol.core.Request<?,Bytes> getCode(java.lang.String address,
                                                        org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns code at a given address.

Parameters:

address - The account address

blockTag - The string "latest", "earliest" or "pending"

Returns:

Bytes

getTransactionCount

public org.web3j.protocol.core.Request<?,Quantity> getTransactionCount(java.lang.String address)

Returns the number of transactions sent from an address. It sets block tag to "LATEST".

Parameters:

address - The account address

Returns:

Quantity

getTransactionCount

public org.web3j.protocol.core.Request<?,Quantity> getTransactionCount(java.lang.String address,
                                                                       long blockNumber)

Returns the number of transactions sent from an address.

Parameters:

address - The account address

blockNumber - The block number.

Returns:

Quantity

getTransactionCount

public org.web3j.protocol.core.Request<?,Quantity> getTransactionCount(java.lang.String address,
                                                                       org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns the number of transaction sent from an address

Parameters:

address - The account address

blockTag - The string "latest", "earliest" or "pending"

Returns:

Quantity

isContractAccount

public org.web3j.protocol.core.Request<?,Boolean> isContractAccount(java.lang.String address)

Returns true if an input account has a non-empty codeHash at the time of a specific block number. It returns false if the account is an EOA or a smart contract account which doesn't have codeHash. It sets block tag to "LATEST".

Parameters:

address - The account address

Returns:

Boolean

isContractAccount

public org.web3j.protocol.core.Request<?,Boolean> isContractAccount(java.lang.String address,
                                                                    long blockNumber)

Returns true if an input account has a non-empty codeHash at the time of a specific block number. It returns false if the account is an EOA or a smart contract account which doesn't have codeHash.

Parameters:

address - The account address

blockNumber - The block number..

Returns:

Boolean

isContractAccount

public org.web3j.protocol.core.Request<?,Boolean> isContractAccount(java.lang.String address,
                                                                    org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns true if an input account has a non-empty codeHash at the time of a specific block number. It returns false if the account is an EOA or a smart contract account which doesn't have codeHash.

Parameters:

address - The account address

blockTag - The string "latest", "earliest" or "pending"

Returns:

Boolean

sign

public org.web3j.protocol.core.Request<?,Bytes> sign(java.lang.String address,
                                                     java.lang.String message)

The sign method calculates a Klaytn-specific signature. NOTE : The address to sign with must be unlocked.

Parameters:

address - The account address

message - The message to sign.

Returns:

Bytes

getBlockNumber

public org.web3j.protocol.core.Request<?,Quantity> getBlockNumber()

Returns the number of most recent block.

Returns:

Quantity

getBlockByNumber

public org.web3j.protocol.core.Request<?,Block> getBlockByNumber(long blockNumber)

Returns information about a block by block number. It set "isFullTransaction" param to true.

Parameters:

blockNumber - The block number.

Returns:

Block

getBlockByNumber

public org.web3j.protocol.core.Request<?,Block> getBlockByNumber(long blockNumber,
                                                                 boolean isFullTransaction)

Returns information about a block by block number. It set "isFullTransaction" param to true.

Parameters:

blockNumber - The block number.

isFullTransaction - If true it returns the full transaction objects, if false only the hashes of the transactions.

Returns:

Block

getBlockByNumber

public org.web3j.protocol.core.Request<?,Block> getBlockByNumber(org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns information about a block by block number. It set "isFullTransaction" param to true.

Parameters:

blockTag - The string "latest", "earliest" or "pending"

Returns:

KlayBlock

getBlockByNumber

public org.web3j.protocol.core.Request<?,Block> getBlockByNumber(org.web3j.protocol.core.DefaultBlockParameter defaultBlockParameter,
                                                                 boolean isFullTransaction)

Returns information about a block by block number.

Parameters:

defaultBlockParameter - The string "latest", "earliest" or "pending"

isFullTransaction - If true it returns the full transaction objects, if false only the hashes of the transactions.

Returns:

Block

getBlockByHash

public org.web3j.protocol.core.Request<?,Block> getBlockByHash(java.lang.String blockHash)

Returns information about a block by block number. It set "isFullTransaction" param to true.

Parameters:

blockHash - The hash of block.

Returns:

Block

getBlockByHash

public org.web3j.protocol.core.Request<?,Block> getBlockByHash(java.lang.String blockHash,
                                                               boolean isFullTransaction)

Returns information about a block by block number.

Parameters:

blockHash - The hash of block.

isFullTransaction - If true it returns the full transaction objects, if false only the hashes of the transactions.

Returns:

Block

getBlockReceipts

public org.web3j.protocol.core.Request<?,BlockTransactionReceipts> getBlockReceipts(java.lang.String blockHash)

Returns receipts included in a block identified by block hash.

Parameters:

blockHash - The hash of block.

Returns:

BlockReceipt

getBlockTransactionCountByNumber

public org.web3j.protocol.core.Request<?,Quantity> getBlockTransactionCountByNumber(long blockNumber)

Returns the number of transactions in a block matching the given block number.

Parameters:

blockNumber - The block number.

Returns:

Quantity

getBlockTransactionCountByNumber

public org.web3j.protocol.core.Request<?,Quantity> getBlockTransactionCountByNumber(org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns the number of transactions in a block matching the given block number.

Parameters:

blockTag - The string "latest", "earliest" or "pending"

Returns:

Quantity

getTransactionCountByNumber

public org.web3j.protocol.core.Request<?,Quantity> getTransactionCountByNumber(long blockNumber)

Returns the number of transactions in a block matching the given block number.

Parameters:

blockNumber - The block number.

Returns:

Quantity

getTransactionCountByNumber

public org.web3j.protocol.core.Request<?,Quantity> getTransactionCountByNumber(org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns the number of transactions in a block matching the given block number.

Parameters:

blockTag - The string "latest", "earliest" or "pending"

Returns:

Quantity

getBlockTransactionCountByHash

public org.web3j.protocol.core.Request<?,Quantity> getBlockTransactionCountByHash(java.lang.String blockHash)

Returns the number of transactions in a block from a block matching the given block hash.

Parameters:

blockHash - The hash of a block

Returns:

Quantity

getTransactionCountByHash

public org.web3j.protocol.core.Request<?,Quantity> getTransactionCountByHash(java.lang.String blockHash)

Returns the number of transactions in a block from a block matching the given block hash.

Parameters:

blockHash - The hash of a block

Returns:

Quantity

getBlockWithConsensusInfoByHash

public org.web3j.protocol.core.Request<?,BlockWithConsensusInfo> getBlockWithConsensusInfoByHash(java.lang.String blockHash)

Returns a block with consensus information matched by the given hash.

Parameters:

blockHash - The hash of a block.

Returns:

BlockWithConsensusInfo

getBlockWithConsensusInfoByNumber

public org.web3j.protocol.core.Request<?,BlockWithConsensusInfo> getBlockWithConsensusInfoByNumber(long blockNumber)

Returns a block with consensus information matched by the given block number.

Parameters:

blockNumber - The block number.

Returns:

BlockWithConsensusInfo

getBlockWithConsensusInfoByNumber

public org.web3j.protocol.core.Request<?,BlockWithConsensusInfo> getBlockWithConsensusInfoByNumber(org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns a block with consensus information matched by the given block number.

Parameters:

blockTag - The string "latest", "earliest"

Returns:

BlockWithConsensusInfo

getCommittee

public org.web3j.protocol.core.Request<?,Addresses> getCommittee()

Returns a list of all validators in the committee at the specified block. If the parameter is not set, returns a list of all validators in the committee at the latest block. It sets block tag to "LATEST".

Returns:

Addresses

getCommittee

public org.web3j.protocol.core.Request<?,Addresses> getCommittee(long blockNumber)

Returns a list of all validators in the committee at the specified block. If the parameter is not set, returns a list of all validators in the committee at the latest block.

Parameters:

blockNumber - The block number.

Returns:

Addresses

getCommittee

public org.web3j.protocol.core.Request<?,Addresses> getCommittee(org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns a list of all validators in the committee at the specified block. If the parameter is not set, returns a list of all validators in the committee at the latest block.

Parameters:

blockTag - The string "latest", "earliest"

Returns:

Addresses

getCommitteeSize

public org.web3j.protocol.core.Request<?,Quantity> getCommitteeSize()

Returns the size of the committee at the specified block. If the parameter is not set, returns the size of the committee at the latest block. It sets block tag to "LATEST".

Returns:

Quantity

getCommitteeSize

public org.web3j.protocol.core.Request<?,Quantity> getCommitteeSize(long blockNumber)

Returns the size of the committee at the specified block. If the parameter is not set, returns the size of the committee at the latest block.

Parameters:

blockNumber - The block number.

Returns:

Quantity

getCommitteeSize

public org.web3j.protocol.core.Request<?,Quantity> getCommitteeSize(org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns the size of the committee at the specified block. If the parameter is not set, returns the size of the committee at the latest block.

Parameters:

blockTag - The string "earliest" or "latest".

Returns:

getCouncil

public org.web3j.protocol.core.Request<?,Addresses> getCouncil()

Returns a list of all validators of the council at the specified block. If the parameter is not set, returns a list of all validators of the council at the latest block. It set to block tag to "LATEST".

Returns:

Addresses

getCouncil

public org.web3j.protocol.core.Request<?,Addresses> getCouncil(long blockNumber)

Returns a list of all validators of the council at the specified block. If the parameter is not set, returns a list of all validators of the council at the latest block.

Parameters:

blockNumber - The block number.

Returns:

Addresses

getCouncil

public org.web3j.protocol.core.Request<?,Addresses> getCouncil(org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns a list of all validators of the council at the specified block. If the parameter is not set, returns a list of all validators of the council at the latest block.

Parameters:

blockTag - The string "earliest" or "latest".

Returns:

Addresses

getCouncilSize

public org.web3j.protocol.core.Request<?,Quantity> getCouncilSize()

Returns the size of the council at the specified block. If the parameter is not set, returns the size of the council at the latest block. It sets block tag to "LATEST".

Returns:

Quantity

getCouncilSize

public org.web3j.protocol.core.Request<?,Quantity> getCouncilSize(long blockNumber)

Returns the size of the council at the specified block. If the parameter is not set, returns the size of the council at the latest block.

Parameters:

blockNumber - The block number

Returns:

Quantity

getCouncilSize

public org.web3j.protocol.core.Request<?,Quantity> getCouncilSize(org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns the size of the council at the specified block. If the parameter is not set, returns the size of the council at the latest block.

Parameters:

blockTag - The string "latest", "earliest" or "pending"

Returns:

Quantity

getStorageAt

public org.web3j.protocol.core.Request<?,Bytes> getStorageAt(java.lang.String address,
                                                             org.web3j.protocol.core.DefaultBlockParameterNumber position,
                                                             long blockNumber)

Returns the value from a storage position at a given address.

Parameters:

address - The account address.

position - Integer of the position in the storage.

blockNumber - The block number.

Returns:

Bytes

getStorageAt

public org.web3j.protocol.core.Request<?,Bytes> getStorageAt(java.lang.String address,
                                                             org.web3j.protocol.core.DefaultBlockParameterNumber position,
                                                             org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns the value from a storage position at a given address.

Parameters:

address - The account address.

position - Integer of the position in the storage.

blockTag - The string "latest", "earliest" or "pending"

Returns:

Bytes

isSyncing

public org.web3j.protocol.core.Request<?,KlaySyncing> isSyncing()

Returns an object with data about the sync status or false.

Returns:

KlaySyncing

getChainID

public org.web3j.protocol.core.Request<?,Quantity> getChainID()

Returns the chain ID of the chain.

Returns:

Quantity

call

public org.web3j.protocol.core.Request<?,Bytes> call(CallObject callObject)

Executes a new message call immediately without creating a transaction on the block chain. It returns data or an error object of JSON RPC if error occurs. It sets block tag to "LATEST".

Parameters:

callObject - The transaction call object.

Returns:

Bytes

call

public org.web3j.protocol.core.Request<?,Bytes> call(CallObject callObject,
                                                     Quantity blockNumber)

Executes a new message call immediately without creating a transaction on the block chain. It returns data or an error object of JSON RPC if error occurs.

Parameters:

callObject - The transaction call object.

blockNumber - The block number.

Returns:

Bytes

call

public org.web3j.protocol.core.Request<?,Bytes> call(CallObject callObject,
                                                     org.web3j.protocol.core.DefaultBlockParameter blockTag)

Executes a new message call immediately without creating a transaction on the block chain. It returns data or an error object of JSON RPC if error occurs.

Parameters:

callObject - The transaction call object.

blockTag - the string "latest", "earliest" or "pending"

Returns:

Bytes

estimateGas

public org.web3j.protocol.core.Request<?,Quantity> estimateGas(CallObject callObject)

Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain. Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including Klaytn Virtual Machine mechanics and node performance.

Parameters:

callObject - The transaction call object.

Returns:

Quantity

estimateComputationCost

public org.web3j.protocol.core.Request<?,Quantity> estimateComputationCost(CallObject callObject)

Generates and returns an estimate of how much computation cost spent to execute the transaction. Klaytn limits the computation cost of a transaction to 100000000 currently not to take too much time by a single transaction. The transaction will not be added to the blockchain like klay_estimateGas.

Parameters:

callObject - The transaction call object.

Returns:

Quantity

estimateComputationCost

public org.web3j.protocol.core.Request<?,Quantity> estimateComputationCost(CallObject callObject,
                                                                           long blockNumber)

Generates and returns an estimate of how much computation cost spent to execute the transaction. Klaytn limits the computation cost of a transaction to 100000000 currently not to take too much time by a single transaction. The transaction will not be added to the blockchain like klay_estimateGas.

Parameters:

callObject - The transaction call object.

Returns:

Quantity

estimateComputationCost

public org.web3j.protocol.core.Request<?,Quantity> estimateComputationCost(CallObject callObject,
                                                                           org.web3j.protocol.core.DefaultBlockParameter blockTag)

Generates and returns an estimate of how much computation cost spent to execute the transaction. Klaytn limits the computation cost of a transaction to 100000000 currently not to take too much time by a single transaction. The transaction will not be added to the blockchain like klay_estimateGas.

Parameters:

callObject - The transaction call object.

Returns:

Quantity

getTransactionByBlockHashAndIndex

public org.web3j.protocol.core.Request<?,Transaction> getTransactionByBlockHashAndIndex(java.lang.String blockHash,
                                                                                        long index)

Returns information about a transaction by block hash and transaction index position.

Parameters:

blockHash - The hash of a block.

index - Integer of the transaction index position.

Returns:

Transaction

getTransactionByBlockNumberAndIndex

public org.web3j.protocol.core.Request<?,Transaction> getTransactionByBlockNumberAndIndex(long blockNumber,
                                                                                          long index)

Returns information about a transaction by block number and transaction index position.

Parameters:

blockNumber - The block number

index - The transaction index position.

Returns:

Transaction

getTransactionByBlockNumberAndIndex

public org.web3j.protocol.core.Request<?,Transaction> getTransactionByBlockNumberAndIndex(org.web3j.protocol.core.DefaultBlockParameter blockTag,
                                                                                          org.web3j.protocol.core.DefaultBlockParameterNumber index)

Returns information about a transaction by block number and transaction index position.

Parameters:

blockTag - The string "latest", "earliest" or "pending"

index - The transaction index position.

Returns:

Transaction

getTransactionByHash

public org.web3j.protocol.core.Request<?,Transaction> getTransactionByHash(java.lang.String txHash)

Returns the information about a transaction requested by transaction hash.

Parameters:

txHash - The hash of a transaction

Returns:

Transaction

getTransactionBySenderTxHash

public org.web3j.protocol.core.Request<?,Transaction> getTransactionBySenderTxHash(java.lang.String senderTxHash)

Returns the information about a transaction requested by sender transaction hash. Please note that this API returns correct result only if indexing feature is enabled by --sendertxhashindexing. This can be checked by call klay_isSenderTxHashIndexingEnabled.

Parameters:

senderTxHash - The hash of a transaction before signing of feePayer(senderTransactionHash)

Returns:

Transaction

getTransactionReceipt

public org.web3j.protocol.core.Request<?,TransactionReceipt> getTransactionReceipt(java.lang.String transactionHash)

Returns the receipt of a transaction by transaction hash. NOTE: The receipt is not available for pending transactions.

Parameters:

transactionHash - The hash of a transaction.

Returns:

TransactionReceipt

getTransactionReceiptBySenderTxHash

public org.web3j.protocol.core.Request<?,TransactionReceipt> getTransactionReceiptBySenderTxHash(java.lang.String transactionHash)

Returns the receipt of a transaction by sender transaction hash.

Parameters:

transactionHash - The hash of a transaction before signing of feePayer(senderTransactionHash).

Returns:

TransactionReceipt

sendRawTransaction

public org.web3j.protocol.core.Request<?,Bytes32> sendRawTransaction(java.lang.String signedTransactionData)

Creates a new message call transaction or a contract creation for signed transactions.

Parameters:

signedTransactionData - The signed transaction data.

Returns:

Bytes32

sendRawTransaction

public org.web3j.protocol.core.Request<?,Bytes32> sendRawTransaction(AbstractTransaction transaction)

Creates a new message call transaction or a contract creation for signed transactions.

Parameters:

transaction - A transaction instance.

Returns:

Bytes32

sendTransaction

public org.web3j.protocol.core.Request<?,Bytes32> sendTransaction(AbstractTransaction transaction)

Constructs a transaction with given parameters, signs the transaction with a sender's private key and propagates the transaction to Klaytn network. NOTE: The address to sign with must be unlocked.

Parameters:

transaction - The object inherits AbstractTransaction.

Returns:

Bytes32

sendTransactionAsFeePayer

public org.web3j.protocol.core.Request<?,Bytes32> sendTransactionAsFeePayer(AbstractFeeDelegatedTransaction transaction)

Constructs a transaction with given parameters, signs the transaction with a fee payer's private key and propagates the transaction to Klaytn network. This API supports only fee delegated type (including partial fee delegated type) transactions. NOTE: The fee payer address to sign with must be unlocked.

Parameters:

transaction - The object inherits AbstractFeeDelegatedTransaction.

Returns:

Bytes32

signTransaction

public org.web3j.protocol.core.Request<?,SignTransaction> signTransaction(AbstractTransaction transaction)

Constructs a transaction with given parameters and signs the transaction with a sender's private key. This method can be used either to generate a sender signature or to make a final raw transaction that is ready to submit to Klaytn network. NOTE: The address to sign with must be unlocked.

Parameters:

transaction - The object inherits AbstractTransaction.

Returns:

KlaySignTransaction

signTransactionAsFeePayer

public org.web3j.protocol.core.Request<?,SignTransaction> signTransactionAsFeePayer(AbstractFeeDelegatedTransaction transaction)

Constructs a transaction with given parameters and signs the transaction with a fee payer's private key. This method can be used either to generate a fee payer signature or to make a final raw transaction that is ready to submit to Klaytn network. In case you just want to extract the fee-payer signature, simply take the feePayerSignatures from the result. Note that the raw transaction is not final if the sender's signature is not attached (that is, signatures in tx is empty). NOTE: The fee payer address to sign with must be unlocked.

Parameters:

transaction - The object inherits AbstractFeeDelegatedTransaction.

Returns:

KlaySignTransaction

getDecodedAnchoringTransaction

public org.web3j.protocol.core.Request<?,DecodeAnchoringTransaction> getDecodedAnchoringTransaction(java.lang.String hash)

Returns the decoded anchored data in the transaction for the given transaction hash.

Parameters:

hash - The hash of transaction

Returns:

DecodeAnchoringTransaction

getClientVersion

public org.web3j.protocol.core.Request<?,Bytes> getClientVersion()

Returns the current client version of a Klaytn node.

Returns:

Bytes

getGasPrice

public org.web3j.protocol.core.Request<?,Quantity> getGasPrice()

Returns the current price per gas in peb. NOTE: This API has different behavior from Ethereum's and returns a gas price of Klaytn instead of suggesting a gas price as in Ethereum.

Returns:

Quantity

getGasPriceAt

public org.web3j.protocol.core.Request<?,Quantity> getGasPriceAt()

Returns the unit price of the given block in peb. It returns latest unit price. NOTE: This API has different behavior from Ethereum's and returns a gas price of Klaytn instead of suggesting a gas price as in Ethereum.

Returns:

Quantity

getGasPriceAt

public org.web3j.protocol.core.Request<?,Quantity> getGasPriceAt(long blockNumber)

Returns the unit price of the given block in peb. NOTE: This API has different behavior from Ethereum's and returns a gas price of Klaytn instead of suggesting a gas price as in Ethereum.

Parameters:

blockNumber - The block number.

Returns:

Quantity

getGasPriceAt

public org.web3j.protocol.core.Request<?,Quantity> getGasPriceAt(org.web3j.protocol.core.DefaultBlockParameter blockTag)

Returns the unit price of the given block in peb. NOTE: This API has different behavior from Ethereum's and returns a gas price of Klaytn instead of suggesting a gas price as in Ethereum.

Parameters:

blockTag - The block tag.

Returns:

Quantity

isParallelDBWrite

public org.web3j.protocol.core.Request<?,Boolean> isParallelDBWrite()

Returns true if the node is writing blockchain data in parallel manner. It is enabled by default.

Returns:

Boolean

isSenderTxHashIndexingEnabled

public org.web3j.protocol.core.Request<?,Boolean> isSenderTxHashIndexingEnabled()

Returns true if the node is indexing sender transaction hash to transaction hash mapping information. It is disabled by default and can be enabled by --sendertxhashindexing.

Returns:

Boolean

getProtocolVersion

public org.web3j.protocol.core.Request<?,Bytes> getProtocolVersion()

Returns the Klaytn protocol version of the node.

Returns:

Bytes

getRewardbase

public org.web3j.protocol.core.Request<?,Bytes20> getRewardbase()

Returns the reward base of the current node. Reward base is the address of the account where the block rewards goes to. It is only required for CNs.

Returns:

Bytes20

getFilterChanges

public org.web3j.protocol.core.Request<?,KlayLogs> getFilterChanges(java.lang.String filterId)

Polling method for a filter, which returns an array of logs which occurred since last poll.

Parameters:

filterId - The filter id.

Returns:

KlayLogs

getFilterLogs

public org.web3j.protocol.core.Request<?,KlayLogs> getFilterLogs(java.lang.String filterId)

Returns an array of all logs matching filter with given id, which has been obtained using klay_newFilter. Note that filter ids returned by other filter creation functions, such as klay_newBlockFilter or klay_newPendingTransactionFilter, cannot be used with this function.

Parameters:

filterId - The filter id.

Returns:

KlayLogs

getLogs

public org.web3j.protocol.core.Request<?,KlayLogs> getLogs(KlayLogFilter filterOption)

Returns an array of all logs matching a given filter object.

Parameters:

filterOption - The filter options

Returns:

KlayLogs

newBlockFilter

public org.web3j.protocol.core.Request<?,Quantity> newBlockFilter()

Creates a filter in the node, to notify when a new block arrives. To check if the state has changed, call klay_getFilterChanges.

Returns:

Quantity

newFilter

public org.web3j.protocol.core.Request<?,Quantity> newFilter(KlayFilter filterOption)

Creates a filter object, based on filter options, to notify when the state changes (logs). To check if the state has changed, call getFilterChanges. To obtain all logs matching the filter created by klay_newFilter, call getFilterLogs(String).

Parameters:

filterOption - The filter option.

Returns:

Quantity

newPendingTransactionFilter

public org.web3j.protocol.core.Request<?,Quantity> newPendingTransactionFilter()

Creates a filter in the node, to notify when new pending transactions arrive. To check if the state has changed, call klay_getFilterChanges.

Returns:

Quantity

uninstallFilter

public org.web3j.protocol.core.Request<?,Boolean> uninstallFilter(java.lang.String filterId)

Uninstalls a filter with given id. Should always be called when watch is no longer needed. Additionally, filters timeout when they are not requested with klay_getFilterChanges for a period of time.

Parameters:

filterId - A filter id.

Returns:

Boolean

sha3

public org.web3j.protocol.core.Request<?,Bytes> sha3(java.lang.String data)

Returns Keccak-256 (not the standardized SHA3-256) of the given data.

Parameters:

data - The data to convert into a SHA3 hash.

Returns:

Bytes