mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-14 08:41:07 +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
@@ -0,0 +1,17 @@
|
||||
[package]
|
||||
name = "srml-contracts-rpc"
|
||||
version = "2.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>"]
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
client = { package = "substrate-client", path = "../../../core/client" }
|
||||
codec = { package = "parity-scale-codec", version = "1.0.0" }
|
||||
jsonrpc-core = "13.2.0"
|
||||
jsonrpc-core-client = "13.2.0"
|
||||
jsonrpc-derive = "13.2.0"
|
||||
rpc-primitives = { package = "substrate-rpc-primitives", path = "../../../core/rpc/primitives" }
|
||||
serde = { version = "1.0.101", features = ["derive"] }
|
||||
sr-primitives = { path = "../../../core/sr-primitives" }
|
||||
srml-contracts-rpc-runtime-api = { path = "./runtime-api" }
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
[package]
|
||||
name = "srml-contracts-rpc-runtime-api"
|
||||
version = "2.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>"]
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
client = { package = "substrate-client", path = "../../../../core/client", default-features = false }
|
||||
codec = { package = "parity-scale-codec", version = "1.0.0", default-features = false, features = ["derive"] }
|
||||
rstd = { package = "sr-std", path = "../../../../core/sr-std", default-features = false }
|
||||
serde = { version = "1.0.101", optional = true, features = ["derive"] }
|
||||
|
||||
[features]
|
||||
default = ["std"]
|
||||
std = [
|
||||
"client/std",
|
||||
"codec/std",
|
||||
"rstd/std",
|
||||
"serde",
|
||||
]
|
||||
@@ -0,0 +1,64 @@
|
||||
// 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/>.
|
||||
|
||||
//! Runtime API definition required by Contracts RPC extensions.
|
||||
//!
|
||||
//! This API should be imported and implemented by the runtime,
|
||||
//! of a node that wants to use the custom RPC extension
|
||||
//! adding Contracts access methods.
|
||||
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
use rstd::vec::Vec;
|
||||
use codec::{Encode, Decode, Codec};
|
||||
|
||||
/// A result of execution of a contract.
|
||||
#[derive(Eq, PartialEq, Encode, Decode)]
|
||||
#[cfg_attr(feature = "std", derive(Debug, serde::Serialize, serde::Deserialize))]
|
||||
pub enum ContractExecResult {
|
||||
/// The contract returned successfully.
|
||||
///
|
||||
/// There is a status code and, optionally, some data returned by the contract.
|
||||
Success {
|
||||
/// Status code returned by the contract.
|
||||
status: u8,
|
||||
/// Output data returned by the contract.
|
||||
///
|
||||
/// Can be empty.
|
||||
data: Vec<u8>,
|
||||
},
|
||||
/// The contract execution either trapped or returned an error.
|
||||
Error,
|
||||
}
|
||||
|
||||
client::decl_runtime_apis! {
|
||||
/// The API to interact with contracts without using executive.
|
||||
pub trait ContractsApi<AccountId, Balance> where
|
||||
AccountId: Codec,
|
||||
Balance: Codec,
|
||||
{
|
||||
/// Perform a call from a specified account to a given contract.
|
||||
///
|
||||
/// See the contracts' `call` dispatchable function for more details.
|
||||
fn call(
|
||||
origin: AccountId,
|
||||
dest: AccountId,
|
||||
value: Balance,
|
||||
gas_limit: u64,
|
||||
input_data: Vec<u8>,
|
||||
) -> ContractExecResult;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,123 @@
|
||||
// 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 codec::Codec;
|
||||
use jsonrpc_core::{Error, ErrorCode, Result};
|
||||
use jsonrpc_derive::rpc;
|
||||
use sr_primitives::{
|
||||
generic::BlockId,
|
||||
traits::{Block as BlockT, ProvideRuntimeApi},
|
||||
};
|
||||
use rpc_primitives::number;
|
||||
|
||||
pub use srml_contracts_rpc_runtime_api::{ContractExecResult, ContractsApi as ContractsRuntimeApi};
|
||||
pub use self::gen_client::Client as ContractsClient;
|
||||
|
||||
/// 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<AccountId, Balance> {
|
||||
origin: AccountId,
|
||||
dest: AccountId,
|
||||
value: Balance,
|
||||
gas_limit: number::NumberOrHex<u64>,
|
||||
input_data: Vec<u8>,
|
||||
}
|
||||
|
||||
/// Contracts RPC methods.
|
||||
#[rpc]
|
||||
pub trait ContractsApi<BlockHash, AccountId, Balance> {
|
||||
/// 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<AccountId, Balance>,
|
||||
at: Option<BlockHash>,
|
||||
) -> Result<ContractExecResult>;
|
||||
}
|
||||
|
||||
/// An implementation of contract specific RPC methods.
|
||||
pub struct Contracts<C, B> {
|
||||
client: Arc<C>,
|
||||
_marker: std::marker::PhantomData<B>,
|
||||
}
|
||||
|
||||
impl<C, B> Contracts<C, B> {
|
||||
/// Create new `Contracts` with the given reference to the client.
|
||||
pub fn new(client: Arc<C>) -> Self {
|
||||
Contracts { client, _marker: Default::default() }
|
||||
}
|
||||
}
|
||||
|
||||
const RUNTIME_ERROR: i64 = 1;
|
||||
|
||||
impl<C, Block, AccountId, Balance> ContractsApi<<Block as BlockT>::Hash, AccountId, Balance> for Contracts<C, Block>
|
||||
where
|
||||
Block: BlockT,
|
||||
C: Send + Sync + 'static,
|
||||
C: ProvideRuntimeApi,
|
||||
C: HeaderBackend<Block>,
|
||||
C::Api: ContractsRuntimeApi<Block, AccountId, Balance>,
|
||||
AccountId: Codec,
|
||||
Balance: Codec,
|
||||
{
|
||||
fn call(
|
||||
&self,
|
||||
call_request: CallRequest<AccountId, Balance>,
|
||||
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(RUNTIME_ERROR),
|
||||
message: "Runtime trapped while executing a contract.".into(),
|
||||
data: Some(format!("{:?}", e).into()),
|
||||
})?;
|
||||
|
||||
Ok(exec_result)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
[package]
|
||||
name = "srml-system-rpc"
|
||||
version = "2.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>"]
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
client = { package = "substrate-client", path = "../../../core/client" }
|
||||
codec = { package = "parity-scale-codec", version = "1.0.0" }
|
||||
jsonrpc-core = "13.2.0"
|
||||
jsonrpc-core-client = "13.2.0"
|
||||
jsonrpc-derive = "13.2.0"
|
||||
log = "0.4.8"
|
||||
serde = { version = "1.0.101", features = ["derive"] }
|
||||
sr-primitives = { path = "../../../core/sr-primitives" }
|
||||
srml-system-rpc-runtime-api = { path = "./runtime-api" }
|
||||
substrate-primitives = { path = "../../../core/primitives" }
|
||||
transaction_pool = { package = "substrate-transaction-pool", path = "../../../core/transaction-pool" }
|
||||
|
||||
[dev-dependencies]
|
||||
test-client = { package = "substrate-test-runtime-client", path = "../../../core/test-runtime/client" }
|
||||
env_logger = "0.7.0"
|
||||
futures03 = { package = "futures-preview", version = "=0.3.0-alpha.19" }
|
||||
@@ -0,0 +1,16 @@
|
||||
[package]
|
||||
name = "srml-system-rpc-runtime-api"
|
||||
version = "2.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>"]
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
client = { package = "substrate-client", path = "../../../../core/client", default-features = false }
|
||||
codec = { package = "parity-scale-codec", version = "1.0.0", default-features = false }
|
||||
|
||||
[features]
|
||||
default = ["std"]
|
||||
std = [
|
||||
"client/std",
|
||||
"codec/std",
|
||||
]
|
||||
@@ -0,0 +1,34 @@
|
||||
// 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/>.
|
||||
|
||||
//! Runtime API definition required by System RPC extensions.
|
||||
//!
|
||||
//! This API should be imported and implemented by the runtime,
|
||||
//! of a node that wants to use the custom RPC extension
|
||||
//! adding System access methods.
|
||||
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
client::decl_runtime_apis! {
|
||||
/// The API to query account nonce (aka transaction index).
|
||||
pub trait AccountNonceApi<AccountId, Index> where
|
||||
AccountId: codec::Codec,
|
||||
Index: codec::Codec,
|
||||
{
|
||||
/// Get current account nonce of given `AccountId`.
|
||||
fn account_nonce(account: AccountId) -> Index;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,158 @@
|
||||
// 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/>.
|
||||
|
||||
//! System SRML specific RPC methods.
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
use codec::{self, Codec, Encode};
|
||||
use client::blockchain::HeaderBackend;
|
||||
use jsonrpc_core::{Result, Error, ErrorCode};
|
||||
use jsonrpc_derive::rpc;
|
||||
use sr_primitives::{
|
||||
generic::BlockId,
|
||||
traits,
|
||||
};
|
||||
use substrate_primitives::hexdisplay::HexDisplay;
|
||||
use transaction_pool::txpool::{self, Pool};
|
||||
|
||||
pub use srml_system_rpc_runtime_api::AccountNonceApi;
|
||||
pub use self::gen_client::Client as SystemClient;
|
||||
|
||||
/// System RPC methods.
|
||||
#[rpc]
|
||||
pub trait SystemApi<AccountId, Index> {
|
||||
/// 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 = "system_accountNextIndex", alias("account_nextIndex"))]
|
||||
fn nonce(&self, account: AccountId) -> Result<Index>;
|
||||
}
|
||||
|
||||
const RUNTIME_ERROR: i64 = 1;
|
||||
|
||||
/// An implementation of System-specific RPC methods.
|
||||
pub struct System<P: txpool::ChainApi, C, B> {
|
||||
client: Arc<C>,
|
||||
pool: Arc<Pool<P>>,
|
||||
_marker: std::marker::PhantomData<B>,
|
||||
}
|
||||
|
||||
impl<P: txpool::ChainApi, C, B> System<P, C, B> {
|
||||
/// Create new `System` given client and transaction pool.
|
||||
pub fn new(client: Arc<C>, pool: Arc<Pool<P>>) -> Self {
|
||||
System {
|
||||
client,
|
||||
pool,
|
||||
_marker: Default::default(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<P, C, Block, AccountId, Index> SystemApi<AccountId, Index> for System<P, C, Block>
|
||||
where
|
||||
C: traits::ProvideRuntimeApi,
|
||||
C: HeaderBackend<Block>,
|
||||
C: Send + Sync + 'static,
|
||||
C::Api: AccountNonceApi<Block, AccountId, Index>,
|
||||
P: txpool::ChainApi + Sync + Send + 'static,
|
||||
Block: traits::Block,
|
||||
AccountId: Clone + std::fmt::Display + Codec,
|
||||
Index: Clone + std::fmt::Display + Codec + traits::SimpleArithmetic,
|
||||
{
|
||||
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.clone();
|
||||
let mut current_tag = (account.clone(), nonce.clone()).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 += traits::One::one();
|
||||
current_tag = (account.clone(), current_nonce.clone()).encode();
|
||||
}
|
||||
}
|
||||
|
||||
Ok(current_nonce)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
use futures03::executor::block_on;
|
||||
use test_client::{
|
||||
runtime::Transfer,
|
||||
AccountKeyring,
|
||||
};
|
||||
|
||||
#[test]
|
||||
fn should_return_next_nonce_for_some_account() {
|
||||
// given
|
||||
let _ = env_logger::try_init();
|
||||
let client = Arc::new(test_client::new());
|
||||
let pool = Arc::new(Pool::new(Default::default(), transaction_pool::FullChainApi::new(client.clone())));
|
||||
|
||||
let new_transaction = |nonce: u64| {
|
||||
let t = Transfer {
|
||||
from: AccountKeyring::Alice.into(),
|
||||
to: AccountKeyring::Bob.into(),
|
||||
amount: 5,
|
||||
nonce,
|
||||
};
|
||||
t.into_signed_tx()
|
||||
};
|
||||
// Populate the pool
|
||||
let ext0 = new_transaction(0);
|
||||
block_on(pool.submit_one(&BlockId::number(0), ext0)).unwrap();
|
||||
let ext1 = new_transaction(1);
|
||||
block_on(pool.submit_one(&BlockId::number(0), ext1)).unwrap();
|
||||
|
||||
let accounts = System::new(client, pool);
|
||||
|
||||
// when
|
||||
let nonce = accounts.nonce(AccountKeyring::Alice.into());
|
||||
|
||||
// then
|
||||
assert_eq!(nonce.unwrap(), 2);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user