openethereum/crates/rpc/src/v1/traits/parity.rs

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.

// OpenEthereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// OpenEthereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.

//! Parity-specific rpc interface.

use std::collections::BTreeMap;

use ethereum_types::{H160, H256, H512, H64, U256, U64};
use jsonrpc_core::{BoxFuture, Result};
use jsonrpc_derive::rpc;

use ethcore::miner::TransactionFilter;
use v1::types::{
    BlockNumber, Bytes, CallRequest, ChainStatus, Histogram, LocalTransactionStatus, Peers,
    Receipt, RecoveredAccount, RichHeader, RpcSettings, Transaction, TransactionStats,
};

/// Parity-specific rpc interface.
#[rpc(server)]
pub trait Parity {
    /// RPC Metadata
    type Metadata;

    /// Returns current transactions limit.
    #[rpc(name = "parity_transactionsLimit")]
    fn transactions_limit(&self) -> Result<usize>;

    /// Returns mining extra data.
    #[rpc(name = "parity_extraData")]
    fn extra_data(&self) -> Result<Bytes>;

    /// Returns mining gas floor target.
    #[rpc(name = "parity_gasFloorTarget")]
    fn gas_floor_target(&self) -> Result<U256>;

    /// Returns mining gas floor cap.
    #[rpc(name = "parity_gasCeilTarget")]
    fn gas_ceil_target(&self) -> Result<U256>;

    /// Returns minimal gas price for transaction to be included in queue.
    #[rpc(name = "parity_minGasPrice")]
    fn min_gas_price(&self) -> Result<U256>;

    /// Returns latest logs
    #[rpc(name = "parity_devLogs")]
    fn dev_logs(&self) -> Result<Vec<String>>;

    /// Returns logs levels
    #[rpc(name = "parity_devLogsLevels")]
    fn dev_logs_levels(&self) -> Result<String>;

    /// Returns chain name - DEPRECATED. Use `parity_chainName` instead.
    #[rpc(name = "parity_netChain")]
    fn net_chain(&self) -> Result<String>;

    /// Returns peers details
    #[rpc(name = "parity_netPeers")]
    fn net_peers(&self) -> Result<Peers>;

    /// Returns network port
    #[rpc(name = "parity_netPort")]
    fn net_port(&self) -> Result<u16>;

    /// Returns rpc settings
    #[rpc(name = "parity_rpcSettings")]
    fn rpc_settings(&self) -> Result<RpcSettings>;

    /// Returns node name
    #[rpc(name = "parity_nodeName")]
    fn node_name(&self) -> Result<String>;

    /// Returns default extra data
    #[rpc(name = "parity_defaultExtraData")]
    fn default_extra_data(&self) -> Result<Bytes>;

    /// Returns distribution of gas price in latest blocks.
    #[rpc(name = "parity_gasPriceHistogram")]
    fn gas_price_histogram(&self) -> BoxFuture<Histogram>;

    /// Returns number of unsigned transactions waiting in the signer queue (if signer enabled)
    /// Returns error when signer is disabled
    #[rpc(name = "parity_unsignedTransactionsCount")]
    fn unsigned_transactions_count(&self) -> Result<usize>;

    /// Returns a cryptographically random phrase sufficient for securely seeding a secret key.
    #[rpc(name = "parity_generateSecretPhrase")]
    fn generate_secret_phrase(&self) -> Result<String>;

    /// Returns whatever address would be derived from the given phrase if it were to seed a brainwallet.
    #[rpc(name = "parity_phraseToAddress")]
    fn phrase_to_address(&self, _: String) -> Result<H160>;

    /// Returns the value of the registrar for this network.
    #[rpc(name = "parity_registryAddress")]
    fn registry_address(&self) -> Result<Option<H160>>;

    /// Returns all addresses if Fat DB is enabled (`--fat-db`), or null if not.
    #[rpc(name = "parity_listAccounts")]
    fn list_accounts(
        &self,
        _: u64,
        _: Option<H160>,
        _: Option<BlockNumber>,
    ) -> Result<Option<Vec<H160>>>;

    /// Returns all storage keys of the given address (first parameter) if Fat DB is enabled (`--fat-db`),
    /// or null if not.
    #[rpc(name = "parity_listStorageKeys")]
    fn list_storage_keys(
        &self,
        _: H160,
        _: u64,
        _: Option<H256>,
        _: Option<BlockNumber>,
    ) -> Result<Option<Vec<H256>>>;

    /// Encrypt some data with a public key under ECIES.
    /// First parameter is the 512-byte destination public key, second is the message.
    #[rpc(name = "parity_encryptMessage")]
    fn encrypt_message(&self, _: H512, _: Bytes) -> Result<Bytes>;

    /// Returns all pending transactions from transaction queue.
    #[rpc(name = "parity_pendingTransactions")]
    fn pending_transactions(
        &self,
        _: Option<usize>,
        _: Option<TransactionFilter>,
    ) -> Result<Vec<Transaction>>;

    /// Returns all transactions from transaction queue.
    ///
    /// Some of them might not be ready to be included in a block yet.
    #[rpc(name = "parity_allTransactions")]
    fn all_transactions(&self) -> Result<Vec<Transaction>>;

    /// Same as parity_allTransactions, but return only transactions hashes.
    #[rpc(name = "parity_allTransactionHashes")]
    fn all_transaction_hashes(&self) -> Result<Vec<H256>>;

    /// Returns all future transactions from transaction queue (deprecated)
    #[rpc(name = "parity_futureTransactions")]
    fn future_transactions(&self) -> Result<Vec<Transaction>>;

    /// Returns propagation statistics on transactions pending in the queue.
    #[rpc(name = "parity_pendingTransactionsStats")]
    fn pending_transactions_stats(&self) -> Result<BTreeMap<H256, TransactionStats>>;

    /// Returns a list of current and past local transactions with status details.
    #[rpc(name = "parity_localTransactions")]
    fn local_transactions(&self) -> Result<BTreeMap<H256, LocalTransactionStatus>>;

    /// Returns current WS Server interface and port or an error if ws server is disabled.
    #[rpc(name = "parity_wsUrl")]
    fn ws_url(&self) -> Result<String>;

    /// Returns next nonce for particular sender. Should include all transactions in the queue.
    #[rpc(name = "parity_nextNonce")]
    fn next_nonce(&self, _: H160) -> BoxFuture<U256>;

    /// Get the mode. Returns one of: "active", "passive", "dark", "offline".
    #[rpc(name = "parity_mode")]
    fn mode(&self) -> Result<String>;

    /// Get the chain name. Returns one of the pre-configured chain names or a filename.
    #[rpc(name = "parity_chain")]
    fn chain(&self) -> Result<String>;

    /// Get the enode of this node.
    #[rpc(name = "parity_enode")]
    fn enode(&self) -> Result<String>;

    /// Get the current chain status.
    #[rpc(name = "parity_chainStatus")]
    fn chain_status(&self) -> Result<ChainStatus>;

    /// Get node kind info.
    #[rpc(name = "parity_nodeKind")]
    fn node_kind(&self) -> Result<::v1::types::NodeKind>;

    /// Get block header.
    /// Same as `eth_getBlockByNumber` but without uncles and transactions.
    #[rpc(name = "parity_getBlockHeaderByNumber")]
    fn block_header(&self, _: Option<BlockNumber>) -> BoxFuture<RichHeader>;

    /// Get block receipts.
    /// Allows you to fetch receipts from the entire block at once.
    /// If no parameter is provided defaults to `latest`.
    #[rpc(name = "parity_getBlockReceipts")]
    fn block_receipts(&self, _: Option<BlockNumber>) -> BoxFuture<Vec<Receipt>>;

    /// Call contract, returning the output data.
    #[rpc(name = "parity_call")]
    fn call(&self, _: Vec<CallRequest>, _: Option<BlockNumber>) -> Result<Vec<Bytes>>;

    /// Used for submitting a proof-of-work solution (similar to `eth_submitWork`,
    /// but returns block hash on success, and returns an explicit error message on failure).
    #[rpc(name = "parity_submitWorkDetail")]
    fn submit_work_detail(&self, _: H64, _: H256, _: H256) -> Result<H256>;

    /// Returns the status of the node. Used as the health endpoint.
    ///
    /// The RPC returns successful response if:
    /// - The node have a peer (unless running a dev chain)
    /// - The node is not syncing.
    ///
    /// Otherwise the RPC returns error.
    #[rpc(name = "parity_nodeStatus")]
    fn status(&self) -> Result<()>;

    /// Extracts Address and public key from signature using the r, s and v params. Equivalent to Solidity erecover
    /// as well as checks the signature for chain replay protection
    #[rpc(name = "parity_verifySignature")]
    fn verify_signature(
        &self,
        _: bool,
        _: Bytes,
        _: H256,
        _: H256,
        _: U64,
    ) -> Result<RecoveredAccount>;
}