Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Commit

Permalink
WIP: Add current_relay_block to ValidationParams, resolve circular dep
Browse files Browse the repository at this point in the history 
Resolving the circular dependency was relatively simple: just move
a bunch of parachain-specific stuff from the parachain package into
the primitives package, then fix up the Cargo manifests. Then,
publicly import all the stuff which was moved so that we don't break
any external packages which depend on parachain.

We have a deprecation notice on that `pub use` statement because
downstream consumers should depend on items in the right place.
Unfortunately, it doesn't actually do anything due to
rust-lang/rust#47236. Still, we'll
leave it in against the day that bug gets fixed.

Adding current_relay_block to ValidationParams is only part of the
work, of course: we now need to go back to where that struct is
instantiated, and insert it there, tracing it back until we get to
some kind of relay chain instance from which we can get the actual
current value and insert it appropriately.
  • Loading branch information
@coriolinus
coriolinus committed Mar 5, 2020
1 parent b1f88ed commit b4fb14b
Show file tree
Hide file tree
Showing 4 changed files with 171 additions and 161 deletions.
2 changes: 2 additions & 0 deletions parachain/Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ sp-io = { git = "https://github.com/paritytech/substrate", branch = "cumulus-bra
lazy_static = { version = "1.4.0", optional = true }
parking_lot = { version = "0.10.0", optional = true }
log = { version = "0.4.8", optional = true }
polkadot-primitives = { path = "../primitives", default-features = false }

[target.'cfg(not(target_os = "unknown"))'.dependencies]
shared_memory = { version = "0.10.0", optional = true }
Expand All @@ -44,4 +45,5 @@ std = [
"sp-externalities",
"sc-executor",
"sp-io",
"polkadot-primitives/std",
]
164 changes: 13 additions & 151 deletions parachain/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,21 @@ mod wasm_api;

use rstd::vec::Vec;

use codec::{Encode, Decode, CompactAs};
use sp_core::{RuntimeDebug, TypeId};
use codec::{Encode, Decode};

#[cfg(all(not(feature = "std"), feature = "wasm-api"))]
pub use wasm_api::*;

#[deprecated(note="moved to primitives package")]
pub use polkadot_primitives::{BlockNumber, parachain::{
AccountIdConversion,
Id,
IncomingMessage,
LOWEST_USER_ID,
ParachainDispatchOrigin,
UpwardMessage,
}};

/// Validation parameters for evaluating the parachain validity function.
// TODO: balance downloads (https://github.com/paritytech/polkadot/issues/220)
#[derive(PartialEq, Eq, Decode)]
Expand All @@ -65,6 +74,8 @@ pub struct ValidationParams {
pub block_data: Vec<u8>,
/// Previous head-data.
pub parent_head: Vec<u8>,
/// Number of the current relay chain block.
pub current_relay_block: BlockNumber,
}

/// The result of parachain validation.
Expand All @@ -75,152 +86,3 @@ pub struct ValidationResult {
/// New head data that should be included in the relay chain state.
pub head_data: Vec<u8>,
}

/// Unique identifier of a parachain.
#[derive(
Clone, CompactAs, Copy, Decode, Default, Encode, Eq,
Hash, Ord, PartialEq, PartialOrd, RuntimeDebug,
)]
#[cfg_attr(feature = "std", derive(serde::Serialize, serde::Deserialize, derive_more::Display))]
pub struct Id(u32);

impl TypeId for Id {
const TYPE_ID: [u8; 4] = *b"para";
}

/// Type for determining the active set of parachains.
pub trait ActiveThreads {
/// Return the current ordered set of `Id`s of active parathreads.
fn active_threads() -> Vec<Id>;
}

impl From<Id> for u32 {
fn from(x: Id) -> Self { x.0 }
}

impl From<u32> for Id {
fn from(x: u32) -> Self { Id(x) }
}

const USER_INDEX_START: u32 = 1000;

/// The ID of the first user (non-system) parachain.
pub const LOWEST_USER_ID: Id = Id(USER_INDEX_START);

impl Id {
/// Create an `Id`.
pub const fn new(id: u32) -> Self {
Self(id)
}

/// Returns `true` if this parachain runs with system-level privileges.
pub fn is_system(&self) -> bool { self.0 < USER_INDEX_START }
}

impl rstd::ops::Add<u32> for Id {
type Output = Self;

fn add(self, other: u32) -> Self {
Self(self.0 + other)
}
}

// TODO: Remove all of this, move sp-runtime::AccountIdConversion to own crate and and use that.
// #360
struct TrailingZeroInput<'a>(&'a [u8]);
impl<'a> codec::Input for TrailingZeroInput<'a> {
fn remaining_len(&mut self) -> Result<Option<usize>, codec::Error> {
Ok(None)
}

fn read(&mut self, into: &mut [u8]) -> Result<(), codec::Error> {
let len = into.len().min(self.0.len());
into[..len].copy_from_slice(&self.0[..len]);
for i in &mut into[len..] {
*i = 0;
}
self.0 = &self.0[len..];
Ok(())
}
}

/// This type can be converted into and possibly from an AccountId (which itself is generic).
pub trait AccountIdConversion<AccountId>: Sized {
/// Convert into an account ID. This is infallible.
fn into_account(&self) -> AccountId;

/// Try to convert an account ID into this type. Might not succeed.
fn try_from_account(a: &AccountId) -> Option<Self>;
}

/// Format is b"para" ++ encode(parachain ID) ++ 00.... where 00... is indefinite trailing
/// zeroes to fill AccountId.
impl<T: Encode + Decode + Default> AccountIdConversion<T> for Id {
fn into_account(&self) -> T {
(b"para", self).using_encoded(|b|
T::decode(&mut TrailingZeroInput(b))
).unwrap_or_default()
}

fn try_from_account(x: &T) -> Option<Self> {
x.using_encoded(|d| {
if &d[0..4] != b"para" { return None }
let mut cursor = &d[4..];
let result = Decode::decode(&mut cursor).ok()?;
if cursor.iter().all(|x| *x == 0) {
Some(result)
} else {
None
}
})
}
}

/// Which origin a parachain's message to the relay chain should be dispatched from.
#[derive(Clone, PartialEq, Eq, Encode, Decode)]
#[cfg_attr(feature = "std", derive(Debug))]
#[repr(u8)]
pub enum ParachainDispatchOrigin {
/// As a simple `Origin::Signed`, using `ParaId::account_id` as its value. This is good when
/// interacting with standard modules such as `balances`.
Signed,
/// As the special `Origin::Parachain(ParaId)`. This is good when interacting with parachain-
/// aware modules which need to succinctly verify that the origin is a parachain.
Parachain,
/// As the simple, superuser `Origin::Root`. This can only be done on specially permissioned
/// parachains.
Root,
}

impl rstd::convert::TryFrom<u8> for ParachainDispatchOrigin {
type Error = ();
fn try_from(x: u8) -> core::result::Result<ParachainDispatchOrigin, ()> {
const SIGNED: u8 = ParachainDispatchOrigin::Signed as u8;
const PARACHAIN: u8 = ParachainDispatchOrigin::Parachain as u8;
Ok(match x {
SIGNED => ParachainDispatchOrigin::Signed,
PARACHAIN => ParachainDispatchOrigin::Parachain,
_ => return Err(()),
})
}
}

/// A message from a parachain to its Relay Chain.
#[derive(Clone, PartialEq, Eq, Encode, Decode, sp_runtime_interface::pass_by::PassByCodec)]
#[cfg_attr(feature = "std", derive(Debug))]
pub struct UpwardMessage {
/// The origin for the message to be sent from.
pub origin: ParachainDispatchOrigin,
/// The message data.
pub data: Vec<u8>,
}

/// An incoming message.
#[derive(PartialEq, Eq, Decode)]
#[cfg_attr(feature = "std", derive(Debug, Encode))]
pub struct IncomingMessage {
/// The source parachain.
pub source: Id,
/// The data of the message.
pub data: Vec<u8>,
}
7 changes: 3 additions & 4 deletions primitives/Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ primitives = { package = "sp-core", git = "https://github.com/paritytech/substra
inherents = { package = "sp-inherents", git = "https://github.com/paritytech/substrate", branch = "cumulus-branch", default-features = false }
application-crypto = { package = "sp-application-crypto", git = "https://github.com/paritytech/substrate", branch = "cumulus-branch", default-features = false }
sp-api = { git = "https://github.com/paritytech/substrate", branch = "cumulus-branch", default-features = false }
sp-runtime-interface = { git = "https://github.com/paritytech/substrate", branch = "cumulus-branch", default-features = false }
sp-version = { git = "https://github.com/paritytech/substrate", branch = "cumulus-branch", default-features = false }
rstd = { package = "sp-std", git = "https://github.com/paritytech/substrate", branch = "cumulus-branch", default-features = false }
runtime_primitives = { package = "sp-runtime", git = "https://github.com/paritytech/substrate", branch = "cumulus-branch", default-features = false }
polkadot-parachain = { path = "../parachain", default-features = false }
trie = { package = "sp-trie", git = "https://github.com/paritytech/substrate", branch = "cumulus-branch", default-features = false }
bitvec = { version = "0.15.2", default-features = false, features = ["alloc"] }
babe = { package = "pallet-babe", git = "https://github.com/paritytech/substrate", branch = "cumulus-branch", default-features = false }
derive_more = { version = "0.99.2" }

[dev-dependencies]
sp-serializer = { git = "https://github.com/paritytech/substrate", branch = "cumulus-branch" }
Expand All @@ -31,11 +31,10 @@ std = [
"inherents/std",
"trie/std",
"sp-api/std",
"sp-runtime-interface/std",
"rstd/std",
"sp-version/std",
"runtime_primitives/std",
"serde",
"polkadot-parachain/std",
"bitvec/std",
"babe/std"
]
Loading

0 comments on commit b4fb14b

Please sign in to comment.