1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
use cfx_rpc_eth_types::{
Block, BlockNumber as BlockId, EthRpcLogFilter as Filter, FeeHistory,
Header, Log, Receipt, SyncStatus, Transaction, TransactionRequest,
};
use cfx_rpc_primitives::{Bytes, Index};
use cfx_types::{Address, H256, H64, U256, U64};
use jsonrpsee::{core::RpcResult, proc_macros::rpc};
type BlockNumberOrTag = BlockId;
type JsonStorageKey = U256;
#[rpc(server, namespace = "eth")]
pub trait EthApi {
/// Returns the protocol version encoded as a string.
#[method(name = "protocolVersion")]
async fn protocol_version(&self) -> RpcResult<U64>;
/// Returns an object with data about the sync status or false.
#[method(name = "syncing")]
fn syncing(&self) -> RpcResult<SyncStatus>;
/// Returns the client coinbase address.
#[method(name = "coinbase")]
async fn author(&self) -> RpcResult<Address>;
/// Returns a list of addresses owned by client.
#[method(name = "accounts")]
fn accounts(&self) -> RpcResult<Vec<Address>>;
/// Returns the number of most recent block.
#[method(name = "blockNumber")]
fn block_number(&self) -> RpcResult<U256>;
/// Returns the chain ID of the current network.
#[method(name = "chainId")]
async fn chain_id(&self) -> RpcResult<Option<U64>>;
/// Returns information about a block by hash.
#[method(name = "getBlockByHash")]
async fn block_by_hash(
&self, hash: H256, full: bool,
) -> RpcResult<Option<Block>>;
/// Returns information about a block by number.
#[method(name = "getBlockByNumber")]
async fn block_by_number(
&self, number: BlockNumberOrTag, full: bool,
) -> RpcResult<Option<Block>>;
/// Returns the number of transactions in a block from a block matching the
/// given block hash.
#[method(name = "getBlockTransactionCountByHash")]
async fn block_transaction_count_by_hash(
&self, hash: H256,
) -> RpcResult<Option<U256>>;
/// Returns the number of transactions in a block matching the given block
/// number.
#[method(name = "getBlockTransactionCountByNumber")]
async fn block_transaction_count_by_number(
&self, number: BlockNumberOrTag,
) -> RpcResult<Option<U256>>;
/// Returns the number of uncles in a block from a block matching the given
/// block hash.
#[method(name = "getUncleCountByBlockHash")]
async fn block_uncles_count_by_hash(
&self, hash: H256,
) -> RpcResult<Option<U256>>;
/// Returns the number of uncles in a block with given block number.
#[method(name = "getUncleCountByBlockNumber")]
async fn block_uncles_count_by_number(
&self, number: BlockNumberOrTag,
) -> RpcResult<Option<U256>>;
/// Returns all transaction receipts for a given block.
#[method(name = "getBlockReceipts")]
async fn block_receipts(
&self, block_id: BlockId,
) -> RpcResult<Option<Vec<Receipt>>>;
/// Returns an uncle block of the given block and index.
#[method(name = "getUncleByBlockHashAndIndex")]
async fn uncle_by_block_hash_and_index(
&self, hash: H256, index: Index,
) -> RpcResult<Option<Block>>;
/// Returns an uncle block of the given block and index.
#[method(name = "getUncleByBlockNumberAndIndex")]
async fn uncle_by_block_number_and_index(
&self, number: BlockNumberOrTag, index: Index,
) -> RpcResult<Option<Block>>;
/// Returns the EIP-2718 encoded transaction if it exists.
///
/// If this is a EIP-4844 transaction that is in the pool it will include
/// the sidecar.
#[method(name = "getRawTransactionByHash")]
async fn raw_transaction_by_hash(
&self, hash: H256,
) -> RpcResult<Option<Bytes>>;
/// Returns the information about a transaction requested by transaction
/// hash.
#[method(name = "getTransactionByHash")]
async fn transaction_by_hash(
&self, hash: H256,
) -> RpcResult<Option<Transaction>>;
/// Returns information about a raw transaction by block hash and
/// transaction index position.
#[method(name = "getRawTransactionByBlockHashAndIndex")]
async fn raw_transaction_by_block_hash_and_index(
&self, hash: H256, index: Index,
) -> RpcResult<Option<Bytes>>;
/// Returns information about a transaction by block hash and transaction
/// index position.
#[method(name = "getTransactionByBlockHashAndIndex")]
async fn transaction_by_block_hash_and_index(
&self, hash: H256, index: Index,
) -> RpcResult<Option<Transaction>>;
/// Returns information about a raw transaction by block number and
/// transaction index position.
#[method(name = "getRawTransactionByBlockNumberAndIndex")]
async fn raw_transaction_by_block_number_and_index(
&self, number: BlockNumberOrTag, index: Index,
) -> RpcResult<Option<Bytes>>;
/// Returns information about a transaction by block number and transaction
/// index position.
#[method(name = "getTransactionByBlockNumberAndIndex")]
async fn transaction_by_block_number_and_index(
&self, number: BlockNumberOrTag, index: Index,
) -> RpcResult<Option<Transaction>>;
/// Returns information about a transaction by sender and nonce.
#[method(name = "getTransactionBySenderAndNonce")]
async fn transaction_by_sender_and_nonce(
&self, address: Address, nonce: U64,
) -> RpcResult<Option<Transaction>>;
/// Returns the receipt of a transaction by transaction hash.
#[method(name = "getTransactionReceipt")]
async fn transaction_receipt(
&self, hash: H256,
) -> RpcResult<Option<Receipt>>;
/// Returns the balance of the account of given address.
#[method(name = "getBalance")]
async fn balance(
&self, address: Address, block_number: Option<BlockId>,
) -> RpcResult<U256>;
/// Returns the value from a storage position at a given address
#[method(name = "getStorageAt")]
async fn storage_at(
&self, address: Address, index: JsonStorageKey,
block_number: Option<BlockId>,
) -> RpcResult<H256>;
/// Returns the number of transactions sent from an address at given block
/// number.
#[method(name = "getTransactionCount")]
async fn transaction_count(
&self, address: Address, block_number: Option<BlockId>,
) -> RpcResult<U256>;
/// Returns code at a given address at given block number.
#[method(name = "getCode")]
async fn get_code(
&self, address: Address, block_number: Option<BlockId>,
) -> RpcResult<Bytes>;
/// Returns the block's header at given number.
#[method(name = "getHeaderByNumber")]
async fn header_by_number(
&self, hash: BlockNumberOrTag,
) -> RpcResult<Option<Header>>;
/// Returns the block's header at given hash.
#[method(name = "getHeaderByHash")]
async fn header_by_hash(&self, hash: H256) -> RpcResult<Option<Header>>;
/// `eth_simulateV1` executes an arbitrary number of transactions on top of
/// the requested state. The transactions are packed into individual
/// blocks. Overrides can be provided.
// #[method(name = "simulateV1")]
// async fn simulate_v1(
// &self,
// opts: SimBlock,
// block_number: Option<BlockId>,
// ) -> RpcResult<Vec<SimulatedBlock>>;
/// Executes a new message call immediately without creating a transaction
/// on the block chain.
#[method(name = "call")]
async fn call(
&self,
request: TransactionRequest,
block_number: Option<BlockId>,
// state_overrides: Option<StateOverride>,
// block_overrides: Option<Box<BlockOverrides>>,
) -> RpcResult<Bytes>;
/// Simulate arbitrary number of transactions at an arbitrary blockchain
/// index, with the optionality of state overrides
// #[method(name = "callMany")]
// async fn call_many(
// &self,
// bundle: Bundle,
// state_context: Option<StateContext>,
// state_override: Option<StateOverride>,
// ) -> RpcResult<Vec<EthCallResponse>>;
/// Generates an access list for a transaction.
///
/// This method creates an [EIP2930](https://eips.ethereum.org/EIPS/eip-2930) type accessList based on a given Transaction.
///
/// An access list contains all storage slots and addresses touched by the
/// transaction, except for the sender account and the chain's
/// precompiles.
///
/// It returns list of addresses and storage keys used by the transaction,
/// plus the gas consumed when the access list is added. That is, it
/// gives you the list of addresses and storage keys that will be used
/// by that transaction, plus the gas consumed if the access
/// list is included. Like eth_estimateGas, this is an estimation; the list
/// could change when the transaction is actually mined. Adding an
/// accessList to your transaction does not necessary result in lower
/// gas usage compared to a transaction without an access list.
// #[method(name = "createAccessList")]
// async fn create_access_list(
// &self,
// request: TransactionRequest,
// block_number: Option<BlockId>,
// ) -> RpcResult<AccessListResult>;
/// Generates and returns an estimate of how much gas is necessary to allow
/// the transaction to complete.
#[method(name = "estimateGas")]
async fn estimate_gas(
&self,
request: TransactionRequest,
block_number: Option<BlockId>,
// state_override: Option<StateOverride>,
) -> RpcResult<U256>;
/// Returns the current price per gas in wei.
#[method(name = "gasPrice")]
async fn gas_price(&self) -> RpcResult<U256>;
/// Returns the account details by specifying an address and a block
/// number/tag
// #[method(name = "getAccount")]
// async fn get_account(
// &self,
// address: Address,
// block: BlockId,
// ) -> RpcResult<Option<reth_rpc_types::Account>>;
/// Introduced in EIP-1559, returns suggestion for the priority for dynamic
/// fee transactions.
#[method(name = "maxPriorityFeePerGas")]
async fn max_priority_fee_per_gas(&self) -> RpcResult<U256>;
/// Introduced in EIP-4844, returns the current blob base fee in wei.
// #[method(name = "blobBaseFee")]
// async fn blob_base_fee(&self) -> RpcResult<U256>;
/// Returns the Transaction fee history
///
/// Introduced in EIP-1559 for getting information on the appropriate
/// priority fee to use.
///
/// Returns transaction base fee per gas and effective priority fee per gas
/// for the requested/supported block range. The returned Fee history
/// for the returned block range can be a subsection of the requested
/// range if not all blocks are available.
#[method(name = "feeHistory")]
async fn fee_history(
&self, block_count: U64, newest_block: BlockNumberOrTag,
reward_percentiles: Option<Vec<f64>>,
) -> RpcResult<FeeHistory>;
/// Returns whether the client is actively mining new blocks.
#[method(name = "mining")]
async fn is_mining(&self) -> RpcResult<bool>;
/// Returns the number of hashes per second that the node is mining with.
#[method(name = "hashrate")]
async fn hashrate(&self) -> RpcResult<U256>;
/// Returns the hash of the current block, the seedHash, and the boundary
/// condition to be met (“target”)
// #[method(name = "getWork")]
// async fn get_work(&self) -> RpcResult<Work>;
/// Used for submitting mining hashrate.
///
/// Can be used for remote miners to submit their hash rate.
/// It accepts the miner hash rate and an identifier which must be unique
/// between nodes. Returns `true` if the block was successfully
/// submitted, `false` otherwise.
#[method(name = "submitHashrate")]
async fn submit_hashrate(
&self, hashrate: U256, id: H256,
) -> RpcResult<bool>;
/// Used for submitting a proof-of-work solution.
#[method(name = "submitWork")]
async fn submit_work(
&self, nonce: H64, pow_hash: H256, mix_digest: H256,
) -> RpcResult<bool>;
/// Sends transaction; will block waiting for signer to return the
/// transaction hash.
#[method(name = "sendTransaction")]
async fn send_transaction(
&self, request: TransactionRequest,
) -> RpcResult<H256>;
/// Sends signed transaction, returning its hash.
#[method(name = "sendRawTransaction")]
async fn send_raw_transaction(&self, bytes: Bytes) -> RpcResult<H256>;
/// Returns an Ethereum specific signature with:
/// sign(keccak256("\x19Ethereum Signed Message:\n"
/// + len(message) + message))).
#[method(name = "sign")]
async fn sign(&self, address: Address, message: Bytes) -> RpcResult<Bytes>;
/// Signs a transaction that can be submitted to the network at a later time
/// using with `sendRawTransaction.`
#[method(name = "signTransaction")]
async fn sign_transaction(
&self, transaction: TransactionRequest,
) -> RpcResult<Bytes>;
// Signs data via [EIP-712](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-712.md).
// #[method(name = "signTypedData")]
// async fn sign_typed_data(&self, address: Address, data: TypedData) ->
// RpcResult<Bytes>;
// Returns the account and storage values of the specified account including
// the Merkle-proof. This call can be used to verify that the data you
// are pulling from is not tampered with.
// #[method(name = "getProof")]
// async fn get_proof(
// &self,
// address: Address,
// keys: Vec<JsonStorageKey>,
// block_number: Option<BlockId>,
// ) -> RpcResult<EIP1186AccountProofResponse>;
/// Returns logs matching given filter object.
#[method(name = "getLogs")]
async fn logs(&self, filter: Filter) -> RpcResult<Vec<Log>>;
}