      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

    // 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 for operations altering the settings.

    use jsonrpc_core::Error;
    use futures::BoxFuture;

    use v1::types::{Bytes, H160, H256, U256, ReleaseInfo};

    build_rpc_trait! {
    	/// Parity-specific rpc interface for operations altering the settings.
    	pub trait ParitySet {
    		/// Sets new minimal gas price for mined blocks.
    		#[rpc(name = "parity_setMinGasPrice")]
    		fn set_min_gas_price(&self, U256) -> Result<bool, Error>;

    		/// Sets new gas floor target for mined blocks.
    		#[rpc(name = "parity_setGasFloorTarget")]
    		fn set_gas_floor_target(&self, U256) -> Result<bool, Error>;

    		/// Sets new gas ceiling target for mined blocks.
    		#[rpc(name = "parity_setGasCeilTarget")]
    		fn set_gas_ceil_target(&self, U256) -> Result<bool, Error>;

    		/// Sets new extra data for mined blocks.
    		#[rpc(name = "parity_setExtraData")]
    		fn set_extra_data(&self, Bytes) -> Result<bool, Error>;

    		/// Sets new author for mined block.
    		#[rpc(name = "parity_setAuthor")]
    		fn set_author(&self, H160) -> Result<bool, Error>;

    		/// Sets account for signing consensus messages.
    		#[rpc(name = "parity_setEngineSigner")]
    		fn set_engine_signer(&self, H160, String) -> Result<bool, Error>;

    		/// Sets the limits for transaction queue.
    		#[rpc(name = "parity_setTransactionsLimit")]
    		fn set_transactions_limit(&self, usize) -> Result<bool, Error>;

    		/// Sets the maximum amount of gas a single transaction may consume.
    		#[rpc(name = "parity_setMaxTransactionGas")]
    		fn set_tx_gas_limit(&self, U256) -> Result<bool, Error>;

    		/// Add a reserved peer.
    		#[rpc(name = "parity_addReservedPeer")]
    		fn add_reserved_peer(&self, String) -> Result<bool, Error>;

    		/// Remove a reserved peer.
    		#[rpc(name = "parity_removeReservedPeer")]
    		fn remove_reserved_peer(&self, String) -> Result<bool, Error>;

    		/// Drop all non-reserved peers.
    		#[rpc(name = "parity_dropNonReservedPeers")]
    		fn drop_non_reserved_peers(&self) -> Result<bool, Error>;

    		/// Accept non-reserved peers (default behavior)
    		#[rpc(name = "parity_acceptNonReservedPeers")]
    		fn accept_non_reserved_peers(&self) -> Result<bool, Error>;

    		/// Start the network.
    		///
    		/// Deprecated. Use `set_mode("active")` instead.
    		#[rpc(name = "parity_startNetwork")]
    		fn start_network(&self) -> Result<bool, Error>;

    		/// Stop the network.
    		///
    		/// Deprecated. Use `set_mode("offline")` instead.
    		#[rpc(name = "parity_stopNetwork")]
    		fn stop_network(&self) -> Result<bool, Error>;

    		/// Set the mode. Argument must be one of: "active", "passive", "dark", "offline".
    		#[rpc(name = "parity_setMode")]
    		fn set_mode(&self, String) -> Result<bool, Error>;

    		/// Hash a file content under given URL.
    		#[rpc(async, name = "parity_hashContent")]
    		fn hash_content(&self, String) -> BoxFuture<H256, Error>;

    		/// Is there a release ready for install?
    		#[rpc(name = "parity_upgradeReady")]
    		fn upgrade_ready(&self) -> Result<Option<ReleaseInfo>, Error>;

    		/// Execute a release which is ready according to upgrade_ready().
    		#[rpc(name = "parity_executeUpgrade")]
    		fn execute_upgrade(&self) -> Result<bool, 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`)