mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-13 05:51:02 +00:00
Custom RPC implementation for node. (#3109)
* Allow RPCs to be customized. * Implement node-rpc extensions. * Working on a test. * Add node-testing crate. * Fix genesis test config * Fix nonce lookups. * Clean up. * Fix expected block type. * Make the RPC extension function optional. * Fix service doc test. * Bump jsonrpc. * Bump client version. * Update Cargo.lock * Update jsonrpc. * Fix build. * Remove unused imports. * Fix signed extra. * Post merge clean up. * Fix tests. * Patch hashmap-core. * Fix build. * Fix build. * Remove hashmap_core patches.
This commit is contained in:
Tomasz Drwięga
committed by
Gavin Wood
Gavin Wood
parent
95abffc8e4
commit
56296386ab
@@ -0,0 +1,25 @@
|
||||
[package]
|
||||
name = "node-rpc"
|
||||
version = "2.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>"]
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
client = { package = "substrate-client", path = "../../core/client" }
|
||||
jsonrpc-core = "13.0.0"
|
||||
jsonrpc-core-client = "13.0.0"
|
||||
jsonrpc-derive = "13.0.0"
|
||||
jsonrpc-pubsub = "13.0.0"
|
||||
keyring = { package = "substrate-keyring", path = "../../core/keyring" }
|
||||
log = "0.4"
|
||||
node-primitives = { path = "../primitives" }
|
||||
codec = { package = "parity-scale-codec", version = "1.0.0" }
|
||||
serde = { version = "1.0", features = ["derive"] }
|
||||
sr-primitives = { path = "../../core/sr-primitives" }
|
||||
substrate-primitives = { path = "../../core/primitives" }
|
||||
transaction_pool = { package = "substrate-transaction-pool", path = "../../core/transaction-pool" }
|
||||
|
||||
[dev-dependencies]
|
||||
node-testing = { path = "../testing" }
|
||||
node-runtime = { path = "../runtime" }
|
||||
env_logger = "0.6"
|
||||
@@ -0,0 +1,156 @@
|
||||
// Copyright 2019 Parity Technologies (UK) Ltd.
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Substrate 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.
|
||||
|
||||
// Substrate 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 Substrate. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
//! Node-specific RPC methods for Accounts.
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
use client::blockchain::HeaderBackend;
|
||||
use jsonrpc_core::{Result, Error, ErrorCode};
|
||||
use jsonrpc_derive::rpc;
|
||||
use node_primitives::{
|
||||
AccountId, Index, AccountNonceApi, Block, BlockId,
|
||||
};
|
||||
use codec::Encode;
|
||||
use sr_primitives::traits;
|
||||
use substrate_primitives::hexdisplay::HexDisplay;
|
||||
use transaction_pool::txpool::{self, Pool};
|
||||
|
||||
pub use self::gen_client::Client as AccountsClient;
|
||||
|
||||
const RUNTIME_ERROR: i64 = 1;
|
||||
|
||||
/// Accounts RPC methods.
|
||||
#[rpc]
|
||||
pub trait AccountsApi {
|
||||
/// Returns the next valid index (aka nonce) for given account.
|
||||
///
|
||||
/// This method takes into consideration all pending transactions
|
||||
/// currently in the pool and if no transactions are found in the pool
|
||||
/// it fallbacks to query the index from the runtime (aka. state nonce).
|
||||
#[rpc(name = "account_nextIndex")]
|
||||
fn nonce(&self, account: AccountId) -> Result<Index>;
|
||||
}
|
||||
|
||||
/// An implementation of Accounts specific RPC methods.
|
||||
pub struct Accounts<P: txpool::ChainApi, C> {
|
||||
client: Arc<C>,
|
||||
pool: Arc<Pool<P>>,
|
||||
}
|
||||
|
||||
impl<P: txpool::ChainApi, C> Accounts<P, C> {
|
||||
/// Create new `Accounts` given client and transaction pool.
|
||||
pub fn new(client: Arc<C>, pool: Arc<Pool<P>>) -> Self {
|
||||
Accounts {
|
||||
client,
|
||||
pool
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<P, C> AccountsApi for Accounts<P, C>
|
||||
where
|
||||
C: traits::ProvideRuntimeApi,
|
||||
C: HeaderBackend<Block>,
|
||||
C: Send + Sync + 'static,
|
||||
C::Api: AccountNonceApi<Block>,
|
||||
P: txpool::ChainApi + Sync + Send + 'static,
|
||||
{
|
||||
fn nonce(&self, account: AccountId) -> Result<Index> {
|
||||
let api = self.client.runtime_api();
|
||||
let best = self.client.info().best_hash;
|
||||
let at = BlockId::hash(best);
|
||||
|
||||
let nonce = api.account_nonce(&at, account.clone()).map_err(|e| Error {
|
||||
code: ErrorCode::ServerError(RUNTIME_ERROR),
|
||||
message: "Unable to query nonce.".into(),
|
||||
data: Some(format!("{:?}", e).into()),
|
||||
})?;
|
||||
|
||||
log::debug!(target: "rpc", "State nonce for {}: {}", account, nonce);
|
||||
// Now we need to query the transaction pool
|
||||
// and find transactions originating from the same sender.
|
||||
//
|
||||
// Since extrinsics are opaque to us, we look for them using
|
||||
// `provides` tag. And increment the nonce if we find a transaction
|
||||
// that matches the current one.
|
||||
let mut current_nonce = nonce;
|
||||
let mut current_tag = (account.clone(), nonce).encode();
|
||||
for tx in self.pool.ready() {
|
||||
log::debug!(
|
||||
target: "rpc",
|
||||
"Current nonce to {:?}, checking {} vs {:?}",
|
||||
current_nonce,
|
||||
HexDisplay::from(¤t_tag),
|
||||
tx.provides.iter().map(|x| format!("{}", HexDisplay::from(x))).collect::<Vec<_>>(),
|
||||
);
|
||||
// since transactions in `ready()` need to be ordered by nonce
|
||||
// it's fine to continue with current iterator.
|
||||
if tx.provides.get(0) == Some(¤t_tag) {
|
||||
current_nonce += 1;
|
||||
current_tag = (account.clone(), current_nonce).encode();
|
||||
}
|
||||
}
|
||||
|
||||
Ok(current_nonce)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
use node_runtime::{CheckedExtrinsic, Call, TimestampCall};
|
||||
use codec::Decode;
|
||||
use node_testing::{
|
||||
client::{ClientExt, TestClientBuilder, TestClientBuilderExt},
|
||||
keyring::{self, alice, signed_extra},
|
||||
};
|
||||
|
||||
const VERSION: u32 = node_runtime::VERSION.spec_version;
|
||||
|
||||
#[test]
|
||||
fn should_return_next_nonce_for_some_account() {
|
||||
// given
|
||||
let _ = env_logger::try_init();
|
||||
let client = Arc::new(TestClientBuilder::new().build());
|
||||
let pool = Arc::new(Pool::new(Default::default(), transaction_pool::ChainApi::new(client.clone())));
|
||||
|
||||
let new_transaction = |extra| {
|
||||
let ex = CheckedExtrinsic {
|
||||
signed: Some((alice().into(), extra)),
|
||||
function: Call::Timestamp(TimestampCall::set(5)),
|
||||
};
|
||||
let xt = keyring::sign(ex, VERSION, client.genesis_hash().into());
|
||||
// Convert to OpaqueExtrinsic
|
||||
let encoded = xt.encode();
|
||||
node_primitives::UncheckedExtrinsic::decode(&mut &*encoded).unwrap()
|
||||
};
|
||||
// Populate the pool
|
||||
let ext0 = new_transaction(signed_extra(0, 0));
|
||||
pool.submit_one(&BlockId::number(0), ext0).unwrap();
|
||||
let ext1 = new_transaction(signed_extra(1, 0));
|
||||
pool.submit_one(&BlockId::number(0), ext1).unwrap();
|
||||
|
||||
let accounts = Accounts::new(client, pool);
|
||||
|
||||
// when
|
||||
let nonce = accounts.nonce(alice().into());
|
||||
|
||||
// then
|
||||
assert_eq!(nonce.unwrap(), 2);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
// Copyright 2019 Parity Technologies (UK) Ltd.
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Substrate 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.
|
||||
|
||||
// Substrate 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 Substrate. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
//! A collection of node-specific RPC methods.
|
||||
//!
|
||||
//! Since `substrate` core functionality makes no assumptions
|
||||
//! about the modules used inside the runtime, so do
|
||||
//! RPC methods defined in `substrate-rpc` crate.
|
||||
//! It means that `core/rpc` can't have any methods that
|
||||
//! need some strong assumptions about the particular runtime.
|
||||
//!
|
||||
//! The RPCs available in this crate however can make some assumptions
|
||||
//! about how the runtime is constructed and what `SRML` modules
|
||||
//! are part of it. Therefore all node-runtime-specific RPCs can
|
||||
//! be placed here.
|
||||
|
||||
#![warn(missing_docs)]
|
||||
|
||||
pub mod accounts;
|
||||
Reference in New Issue
Block a user