origin_conversion.rs 8.75 KB
Newer Older
Shawn Tabrizi's avatar
Shawn Tabrizi committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Copyright 2020 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.

// Polkadot 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.

// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.

Alexander Popiak's avatar
Alexander Popiak committed
17
18
//! Various implementations for `ConvertOrigin`.

Gavin Wood's avatar
Gavin Wood committed
19
20
use sp_std::{marker::PhantomData, convert::TryInto};
use xcm::v0::{MultiLocation, OriginKind, NetworkId, Junction, BodyId, BodyPart};
Gavin Wood's avatar
Gavin Wood committed
21
use xcm_executor::traits::{Convert, ConvertOrigin};
Gavin Wood's avatar
Gavin Wood committed
22
23
use frame_support::traits::{EnsureOrigin, Get, OriginTrait, GetBacking};
use frame_system::RawOrigin as SystemRawOrigin;
Shawn Tabrizi's avatar
Shawn Tabrizi committed
24
25
use polkadot_parachain::primitives::IsSystem;

Alexander Popiak's avatar
Alexander Popiak committed
26
/// Sovereign accounts use the system's `Signed` origin with an account ID derived from the `LocationConverter`.
Shawn Tabrizi's avatar
Shawn Tabrizi committed
27
28
29
30
pub struct SovereignSignedViaLocation<LocationConverter, Origin>(
	PhantomData<(LocationConverter, Origin)>
);
impl<
Gavin Wood's avatar
Gavin Wood committed
31
	LocationConverter: Convert<MultiLocation, Origin::AccountId>,
Shawn Tabrizi's avatar
Shawn Tabrizi committed
32
	Origin: OriginTrait,
Gavin Wood's avatar
Gavin Wood committed
33
> ConvertOrigin<Origin> for SovereignSignedViaLocation<LocationConverter, Origin> where Origin::AccountId: Clone {
Shawn Tabrizi's avatar
Shawn Tabrizi committed
34
35
	fn convert_origin(origin: MultiLocation, kind: OriginKind) -> Result<Origin, MultiLocation> {
		if let OriginKind::SovereignAccount = kind {
Gavin Wood's avatar
Gavin Wood committed
36
			let location = LocationConverter::convert(origin)?;
Shawn Tabrizi's avatar
Shawn Tabrizi committed
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
			Ok(Origin::signed(location).into())
		} else {
			Err(origin)
		}
	}
}

pub struct ParentAsSuperuser<Origin>(PhantomData<Origin>);
impl<
	Origin: OriginTrait,
> ConvertOrigin<Origin> for ParentAsSuperuser<Origin> {
	fn convert_origin(origin: MultiLocation, kind: OriginKind) -> Result<Origin, MultiLocation> {
		match (kind, origin) {
			(OriginKind::Superuser, MultiLocation::X1(Junction::Parent)) =>
				Ok(Origin::root()),
			(_, origin) => Err(origin),
		}
	}
}

pub struct ChildSystemParachainAsSuperuser<ParaId, Origin>(PhantomData<(ParaId, Origin)>);
impl<
	ParaId: IsSystem + From<u32>,
	Origin: OriginTrait,
> ConvertOrigin<Origin> for ChildSystemParachainAsSuperuser<ParaId, Origin> {
	fn convert_origin(origin: MultiLocation, kind: OriginKind) -> Result<Origin, MultiLocation> {
		match (kind, origin) {
64
			(OriginKind::Superuser, MultiLocation::X1(Junction::Parachain(id)))
Shawn Tabrizi's avatar
Shawn Tabrizi committed
65
66
67
68
69
70
71
72
73
74
75
76
77
78
			if ParaId::from(id).is_system() =>
				Ok(Origin::root()),
			(_, origin) => Err(origin),
		}
	}
}

pub struct SiblingSystemParachainAsSuperuser<ParaId, Origin>(PhantomData<(ParaId, Origin)>);
impl<
	ParaId: IsSystem + From<u32>,
	Origin: OriginTrait
> ConvertOrigin<Origin> for SiblingSystemParachainAsSuperuser<ParaId, Origin> {
	fn convert_origin(origin: MultiLocation, kind: OriginKind) -> Result<Origin, MultiLocation> {
		match (kind, origin) {
79
			(OriginKind::Superuser, MultiLocation::X2(Junction::Parent, Junction::Parachain(id)))
Shawn Tabrizi's avatar
Shawn Tabrizi committed
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
			if ParaId::from(id).is_system() =>
				Ok(Origin::root()),
			(_, origin) => Err(origin),
		}
	}
}

pub struct ChildParachainAsNative<ParachainOrigin, Origin>(
	PhantomData<(ParachainOrigin, Origin)>
);
impl<
	ParachainOrigin: From<u32>,
	Origin: From<ParachainOrigin>,
> ConvertOrigin<Origin> for ChildParachainAsNative<ParachainOrigin, Origin> {
	fn convert_origin(origin: MultiLocation, kind: OriginKind) -> Result<Origin, MultiLocation> {
		match (kind, origin) {
96
			(OriginKind::Native, MultiLocation::X1(Junction::Parachain(id)))
Shawn Tabrizi's avatar
Shawn Tabrizi committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
			=> Ok(Origin::from(ParachainOrigin::from(id))),
			(_, origin) => Err(origin),
		}
	}
}

pub struct SiblingParachainAsNative<ParachainOrigin, Origin>(
	PhantomData<(ParachainOrigin, Origin)>
);
impl<
	ParachainOrigin: From<u32>,
	Origin: From<ParachainOrigin>,
> ConvertOrigin<Origin> for SiblingParachainAsNative<ParachainOrigin, Origin> {
	fn convert_origin(origin: MultiLocation, kind: OriginKind) -> Result<Origin, MultiLocation> {
		match (kind, origin) {
112
			(OriginKind::Native, MultiLocation::X2(Junction::Parent, Junction::Parachain(id)))
Shawn Tabrizi's avatar
Shawn Tabrizi committed
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
			=> Ok(Origin::from(ParachainOrigin::from(id))),
			(_, origin) => Err(origin),
		}
	}
}

// Our Relay-chain has a native origin given by the `Get`ter.
pub struct RelayChainAsNative<RelayOrigin, Origin>(
	PhantomData<(RelayOrigin, Origin)>
);
impl<
	RelayOrigin: Get<Origin>,
	Origin,
> ConvertOrigin<Origin> for RelayChainAsNative<RelayOrigin, Origin> {
	fn convert_origin(origin: MultiLocation, kind: OriginKind) -> Result<Origin, MultiLocation> {
		match (kind, origin) {
			(OriginKind::Native, MultiLocation::X1(Junction::Parent)) => Ok(RelayOrigin::get()),
			(_, origin) => Err(origin),
		}
	}
}

pub struct SignedAccountId32AsNative<Network, Origin>(
	PhantomData<(Network, Origin)>
);
impl<
	Network: Get<NetworkId>,
	Origin: OriginTrait,
> ConvertOrigin<Origin> for SignedAccountId32AsNative<Network, Origin> where
	Origin::AccountId: From<[u8; 32]>,
{
	fn convert_origin(origin: MultiLocation, kind: OriginKind) -> Result<Origin, MultiLocation> {
		match (kind, origin) {
			(OriginKind::Native, MultiLocation::X1(Junction::AccountId32 { id, network }))
			if matches!(network, NetworkId::Any) || network == Network::get()
			=> Ok(Origin::signed(id.into())),
			(_, origin) => Err(origin),
		}
	}
}
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

pub struct SignedAccountKey20AsNative<Network, Origin>(
	PhantomData<(Network, Origin)>
);
impl<
	Network: Get<NetworkId>,
	Origin: OriginTrait
> ConvertOrigin<Origin> for SignedAccountKey20AsNative<Network, Origin> where
	Origin::AccountId: From<[u8; 20]>,
{
	fn convert_origin(origin: MultiLocation, kind: OriginKind) -> Result<Origin, MultiLocation> {
		match (kind, origin) {
			(OriginKind::Native, MultiLocation::X1(Junction::AccountKey20 { key, network }))
				if matches!(network, NetworkId::Any) || network == Network::get() =>
			{
				Ok(Origin::signed(key.into()))
			}
			(_, origin) => Err(origin),
		}
	}
}
Gavin Wood's avatar
Gavin Wood committed
174

Denis_P's avatar
Denis_P committed
175
/// `EnsureOrigin` barrier to convert from dispatch origin to XCM origin, if one exists.
Gavin Wood's avatar
Gavin Wood committed
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
pub struct EnsureXcmOrigin<Origin, Conversion>(PhantomData<(Origin, Conversion)>);
impl<
	Origin: OriginTrait + Clone,
	Conversion: Convert<Origin, MultiLocation>,
> EnsureOrigin<Origin> for EnsureXcmOrigin<Origin, Conversion> where
	Origin::PalletsOrigin: PartialEq,
{
	type Success = MultiLocation;
	fn try_origin(o: Origin) -> Result<Self::Success, Origin> {
		let o = match Conversion::convert(o) {
			Ok(location) => return Ok(location),
			Err(o) => o,
		};
		// We institute a root fallback so root can always represent the context. This
		// guarantees that `successful_origin` will work.
		if o.caller() == Origin::root().caller() {
			Ok(MultiLocation::Null)
		} else {
			Err(o)
		}
	}

	#[cfg(feature = "runtime-benchmarks")]
	fn successful_origin() -> Origin {
		Origin::root()
	}
}

/// `Convert` implementation to convert from some a `Signed` (system) `Origin` into an `AccountId32`.
///
/// Typically used when configuring `pallet-xcm` for allowing normal accounts to dispatch an XCM from an `AccountId32`
/// origin.
pub struct SignedToAccountId32<Origin, AccountId, Network>(
	PhantomData<(Origin, AccountId, Network)>
);
impl<
	Origin: OriginTrait + Clone,
	AccountId: Into<[u8; 32]>,
	Network: Get<NetworkId>,
> Convert<Origin, MultiLocation> for SignedToAccountId32<Origin, AccountId, Network> where
	Origin::PalletsOrigin: From<SystemRawOrigin<AccountId>> +
	TryInto<SystemRawOrigin<AccountId>, Error=Origin::PalletsOrigin>
{
	fn convert(o: Origin) -> Result<MultiLocation, Origin> {
		o.try_with_caller(|caller| match caller.try_into() {
			Ok(SystemRawOrigin::Signed(who)) =>
				Ok(Junction::AccountId32 { network: Network::get(), id: who.into() }.into()),
			Ok(other) => Err(other.into()),
			Err(other) => Err(other),
		})
	}
}

/// `Convert` implementation to convert from some an origin which implements `Backing` into a corresponding `Plurality`
Denis_P's avatar
Denis_P committed
230
/// `MultiLocation`.
Gavin Wood's avatar
Gavin Wood committed
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
///
/// Typically used when configuring `pallet-xcm` for allowing a collective's Origin to dispatch an XCM from a
/// `Plurality` origin.
pub struct BackingToPlurality<Origin, COrigin, Body>(
	PhantomData<(Origin, COrigin, Body)>
);
impl<
	Origin: OriginTrait + Clone,
	COrigin: GetBacking,
	Body: Get<BodyId>,
> Convert<Origin, MultiLocation> for BackingToPlurality<Origin, COrigin, Body> where
	Origin::PalletsOrigin: From<COrigin> +
	TryInto<COrigin, Error=Origin::PalletsOrigin>
{
	fn convert(o: Origin) -> Result<MultiLocation, Origin> {
		o.try_with_caller(|caller| match caller.try_into() {
			Ok(co) => match co.get_backing() {
				Some(backing) => Ok(Junction::Plurality {
					id: Body::get(),
					part: BodyPart::Fraction { nom: backing.approvals, denom: backing.eligible },
				}.into()),
				None => Err(co.into()),
			}
			Err(other) => Err(other),
		})
	}
}