      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

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

    // Parity 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.

    // Parity 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 Parity.  If not, see <http://www.gnu.org/licenses/>.

    //! Parity-specific rpc interface.

    use std::collections::BTreeMap;

    use jsonrpc_core::Error;
    use jsonrpc_macros::Trailing;
    use futures::BoxFuture;

    use v1::types::{
    	H160, H256, H512, U256, Bytes,
    	Peers, Transaction, RpcSettings, Histogram,
    	TransactionStats, LocalTransactionStatus,
    	BlockNumber, ConsensusCapability, VersionInfo,
    	OperationsInfo, DappId, ChainStatus,
    };

    build_rpc_trait! {
    	/// Parity-specific rpc interface.
    	pub trait Parity {
    		type Metadata;

    		/// Returns accounts information.
    		#[rpc(name = "parity_accountsInfo")]
    		fn accounts_info(&self, Trailing<DappId>) -> Result<BTreeMap<String, BTreeMap<String, String>>, Error>;

    		/// Returns default account for dapp.
    		#[rpc(meta, name = "parity_defaultAccount")]
    		fn default_account(&self, Self::Metadata) -> BoxFuture<H160, Error>;

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

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

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

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

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

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

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

    		/// Returns chain name
    		#[rpc(name = "parity_netChain")]
    		fn net_chain(&self) -> Result<String, Error>;

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

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

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

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

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

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

    		/// 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, Error>;

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

    		/// 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, Error>;

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

    		/// 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>, Trailing<BlockNumber>) -> Result<Option<Vec<H160>>, Error>;

    		/// 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>, Trailing<BlockNumber>) -> Result<Option<Vec<H256>>, Error>;

    		/// 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, Error>;

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

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

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

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

    		/// Returns current Trusted Signer port or an error if signer is disabled.
    		#[rpc(name = "parity_signerPort")]
    		fn signer_port(&self) -> Result<u16, Error>;

    		/// Returns current Dapps Server port or an error if dapps server is disabled.
    		#[rpc(name = "parity_dappsPort")]
    		fn dapps_port(&self) -> Result<u16, Error>;

    		/// Returns current Dapps Server interface address or an error if dapps server is disabled.
    		#[rpc(name = "parity_dappsInterface")]
    		fn dapps_interface(&self) -> Result<String, Error>;

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

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

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

    		/// Returns information on current consensus capability.
    		#[rpc(name = "parity_consensusCapability")]
    		fn consensus_capability(&self) -> Result<ConsensusCapability, Error>;

    		/// Get our version information in a nice object.
    		#[rpc(name = "parity_versionInfo")]
    		fn version_info(&self) -> Result<VersionInfo, Error>;

    		/// Get information concerning the latest releases if available.
    		#[rpc(name = "parity_releasesInfo")]
    		fn releases_info(&self) -> Result<Option<OperationsInfo>, Error>;

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

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)