mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-28 03:58:04 +00:00
Move srml RPC extensions to separate crates (#3791)
* Move srml-system RPC out. * Fix tests for system-rpc module. * Contracts RPC moved. * Fix rpc test. * Clean up. * Update lockfile. * Bump runtime version. * Update srml/contracts/rpc/runtime-api/src/lib.rs Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com> * Bump impl version.
This commit is contained in:
Tomasz Drwięga
committed by
Gavin Wood
Gavin Wood
parent
642c8504c4
commit
dc92631180
@@ -1,155 +0,0 @@
|
||||
// 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;
|
||||
|
||||
/// 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(crate::constants::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 futures03::executor::block_on;
|
||||
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::FullChainApi::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));
|
||||
block_on(pool.submit_one(&BlockId::number(0), ext0)).unwrap();
|
||||
let ext1 = new_transaction(signed_extra(1, 0));
|
||||
block_on(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);
|
||||
}
|
||||
}
|
||||
@@ -1,116 +0,0 @@
|
||||
// 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 interaction with contracts.
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
use serde::{Serialize, Deserialize};
|
||||
use client::blockchain::HeaderBackend;
|
||||
use jsonrpc_core::{Error, ErrorCode, Result};
|
||||
use jsonrpc_derive::rpc;
|
||||
use node_primitives::{
|
||||
AccountId, Balance, Block, BlockId, ContractExecResult, ContractsApi as ContractsRuntimeApi,
|
||||
};
|
||||
use sr_primitives::traits::{
|
||||
self,
|
||||
Block as BlockT,
|
||||
};
|
||||
use rpc_primitives::number;
|
||||
|
||||
/// A struct that encodes RPC parameters required for a call to a smart-contract.
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(rename_all="camelCase")]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct CallRequest {
|
||||
origin: AccountId,
|
||||
dest: AccountId,
|
||||
value: Balance,
|
||||
gas_limit: number::NumberOrHex<u64>,
|
||||
input_data: Vec<u8>,
|
||||
}
|
||||
|
||||
/// Contracts RPC methods.
|
||||
#[rpc]
|
||||
pub trait ContractsApi<BlockHash> {
|
||||
/// Executes a call to a contract.
|
||||
///
|
||||
/// This call is performed locally without submitting any transactions. Thus executing this
|
||||
/// won't change any state. Nonetheless, the calling state-changing contracts is still possible.
|
||||
///
|
||||
/// This method is useful for calling getter-like methods on contracts.
|
||||
#[rpc(name = "contracts_call")]
|
||||
fn call(
|
||||
&self,
|
||||
call_request: CallRequest,
|
||||
at: Option<BlockHash>,
|
||||
) -> Result<ContractExecResult>;
|
||||
}
|
||||
|
||||
/// An implementation of contract specific RPC methods.
|
||||
pub struct Contracts<C> {
|
||||
client: Arc<C>,
|
||||
}
|
||||
|
||||
impl<C> Contracts<C> {
|
||||
/// Create new `Contracts` with the given reference to the client.
|
||||
pub fn new(client: Arc<C>) -> Self {
|
||||
Contracts { client }
|
||||
}
|
||||
}
|
||||
|
||||
impl<C> ContractsApi<<Block as BlockT>::Hash> for Contracts<C>
|
||||
where
|
||||
C: Send + Sync + 'static,
|
||||
C: traits::ProvideRuntimeApi,
|
||||
C: HeaderBackend<Block>,
|
||||
C::Api: ContractsRuntimeApi<Block>,
|
||||
{
|
||||
fn call(
|
||||
&self,
|
||||
call_request: CallRequest,
|
||||
at: Option<<Block as BlockT>::Hash>,
|
||||
) -> Result<ContractExecResult> {
|
||||
let api = self.client.runtime_api();
|
||||
let at = BlockId::hash(at.unwrap_or_else(||
|
||||
// If the block hash is not supplied assume the best block.
|
||||
self.client.info().best_hash
|
||||
));
|
||||
|
||||
let CallRequest {
|
||||
origin,
|
||||
dest,
|
||||
value,
|
||||
gas_limit,
|
||||
input_data
|
||||
} = call_request;
|
||||
let gas_limit = gas_limit.to_number().map_err(|e| Error {
|
||||
code: ErrorCode::InvalidParams,
|
||||
message: e,
|
||||
data: None,
|
||||
})?;
|
||||
|
||||
let exec_result = api
|
||||
.call(&at, origin, dest, value, gas_limit, input_data)
|
||||
.map_err(|e| Error {
|
||||
code: ErrorCode::ServerError(crate::constants::RUNTIME_ERROR),
|
||||
message: "Runtime trapped while executing a contract.".into(),
|
||||
data: Some(format!("{:?}", e).into()),
|
||||
})?;
|
||||
|
||||
Ok(exec_result)
|
||||
}
|
||||
}
|
||||
@@ -25,43 +25,32 @@
|
||||
//! 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.
|
||||
//! be placed here or imported from corresponding `SRML` RPC definitions.
|
||||
|
||||
#![warn(missing_docs)]
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
use node_primitives::{Block, AccountNonceApi, ContractsApi};
|
||||
use node_primitives::{Block, AccountId, Index, Balance};
|
||||
use sr_primitives::traits::ProvideRuntimeApi;
|
||||
use transaction_pool::txpool::{ChainApi, Pool};
|
||||
|
||||
pub mod accounts;
|
||||
pub mod contracts;
|
||||
|
||||
mod constants {
|
||||
/// A status code indicating an error happened while trying to call into the runtime.
|
||||
///
|
||||
/// This typically means that the runtime trapped.
|
||||
pub const RUNTIME_ERROR: i64 = 1;
|
||||
}
|
||||
|
||||
/// Instantiate all RPC extensions.
|
||||
pub fn create<C, P, M>(client: Arc<C>, pool: Arc<Pool<P>>) -> jsonrpc_core::IoHandler<M> where
|
||||
C: ProvideRuntimeApi,
|
||||
C: client::blockchain::HeaderBackend<Block>,
|
||||
C: Send + Sync + 'static,
|
||||
C::Api: AccountNonceApi<Block> + ContractsApi<Block>,
|
||||
C::Api: srml_system_rpc::AccountNonceApi<Block, AccountId, Index>,
|
||||
C::Api: srml_contracts_rpc::ContractsRuntimeApi<Block, AccountId, Balance>,
|
||||
P: ChainApi + Sync + Send + 'static,
|
||||
M: jsonrpc_core::Metadata + Default,
|
||||
{
|
||||
use self::{
|
||||
accounts::{Accounts, AccountsApi},
|
||||
contracts::{Contracts, ContractsApi},
|
||||
};
|
||||
use srml_system_rpc::{System, SystemApi};
|
||||
use srml_contracts_rpc::{Contracts, ContractsApi};
|
||||
|
||||
let mut io = jsonrpc_core::IoHandler::default();
|
||||
io.extend_with(
|
||||
AccountsApi::to_delegate(Accounts::new(client.clone(), pool))
|
||||
SystemApi::to_delegate(System::new(client.clone(), pool))
|
||||
);
|
||||
io.extend_with(
|
||||
ContractsApi::to_delegate(Contracts::new(client))
|
||||
|
||||
Reference in New Issue
Block a user