xcm_docs/cookbook/relay_token_transactor/relay_chain/
xcm_config.rs

1// Copyright (C) Parity Technologies (UK) Ltd.
2// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
3// This file is part of Polkadot.
4
5// Polkadot is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9
10// Polkadot is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13// GNU General Public License for more details.
14
15// You should have received a copy of the GNU General Public License
16// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
17
18//! Relay chain XCM configuration
19
20use frame::{
21	deps::frame_system,
22	runtime::prelude::*,
23	traits::{Disabled, Everything, Nothing},
24};
25use xcm::latest::prelude::*;
26use xcm_builder::{
27	AccountId32Aliases, DescribeAllTerminal, DescribeFamily, EnsureXcmOrigin,
28	FrameTransactionalProcessor, FungibleAdapter, HashedDescription, IsConcrete,
29	SignedToAccountId32,
30};
31use xcm_executor::XcmExecutor;
32
33use super::{AccountId, Balances, Runtime, RuntimeCall, RuntimeEvent, RuntimeOrigin};
34
35parameter_types! {
36	pub HereLocation: Location = Location::here();
37	pub ThisNetwork: NetworkId = NetworkId::Polkadot;
38}
39
40/// Converter from XCM Locations to accounts.
41/// This generates sovereign accounts for Locations and converts
42/// local AccountId32 junctions to local accounts.
43pub type LocationToAccountId = (
44	HashedDescription<AccountId, DescribeFamily<DescribeAllTerminal>>,
45	AccountId32Aliases<ThisNetwork, AccountId>,
46);
47
48mod asset_transactor {
49	use super::*;
50
51	/// AssetTransactor for handling the Relay Chain token.
52	pub type FungibleTransactor = FungibleAdapter<
53		// Use this `fungible` implementation.
54		Balances,
55		// This transactor handles the native token.
56		IsConcrete<HereLocation>,
57		// How to convert an XCM Location into a local account id.
58		// Whenever assets are handled, the location is turned into an account.
59		// This account is the one where balances are withdrawn/deposited.
60		LocationToAccountId,
61		// The account id type, needed because `fungible` is generic over it.
62		AccountId,
63		// Not tracking teleports.
64		(),
65	>;
66
67	/// All asset transactors, in this case only one
68	pub type AssetTransactor = FungibleTransactor;
69}
70
71mod weigher {
72	use super::*;
73	use xcm_builder::FixedWeightBounds;
74
75	parameter_types! {
76		pub const WeightPerInstruction: Weight = Weight::from_parts(1, 1);
77		pub const MaxInstructions: u32 = 100;
78	}
79
80	pub type Weigher = FixedWeightBounds<WeightPerInstruction, RuntimeCall, MaxInstructions>;
81}
82
83parameter_types! {
84	pub UniversalLocation: InteriorLocation = [GlobalConsensus(NetworkId::Polkadot)].into();
85}
86
87pub struct XcmConfig;
88impl xcm_executor::Config for XcmConfig {
89	type RuntimeCall = RuntimeCall;
90	type XcmSender = ();
91	type XcmEventEmitter = ();
92	type AssetTransactor = asset_transactor::AssetTransactor;
93	type OriginConverter = ();
94	// We don't need to recognize anyone as a reserve
95	type IsReserve = ();
96	type IsTeleporter = ();
97	type UniversalLocation = UniversalLocation;
98	// This is not safe, you should use `xcm_builder::AllowTopLevelPaidExecutionFrom<T>` in a
99	// production chain
100	type Barrier = xcm_builder::AllowUnpaidExecutionFrom<Everything>;
101	type Weigher = weigher::Weigher;
102	type Trader = ();
103	type ResponseHandler = ();
104	type AssetTrap = ();
105	type AssetLocker = ();
106	type AssetExchanger = ();
107	type SubscriptionService = ();
108	type PalletInstancesInfo = ();
109	type FeeManager = ();
110	type MaxAssetsIntoHolding = frame::traits::ConstU32<1>;
111	type MessageExporter = ();
112	type UniversalAliases = Nothing;
113	type CallDispatcher = RuntimeCall;
114	type SafeCallFilter = Everything;
115	type Aliasers = Nothing;
116	type TransactionalProcessor = FrameTransactionalProcessor;
117	type HrmpNewChannelOpenRequestHandler = ();
118	type HrmpChannelAcceptedHandler = ();
119	type HrmpChannelClosingHandler = ();
120	type XcmRecorder = ();
121}
122
123/// Converts a local signed origin into an XCM location. Forms the basis for local origins
124/// sending/executing XCMs.
125pub type LocalOriginToLocation = SignedToAccountId32<RuntimeOrigin, AccountId, ThisNetwork>;
126
127impl pallet_xcm::Config for Runtime {
128	// No one can call `send`
129	type SendXcmOrigin = EnsureXcmOrigin<RuntimeOrigin, ()>;
130	type XcmRouter = super::super::network::RelayChainXcmRouter; // Provided by xcm-simulator
131															  // Anyone can execute XCM programs
132	type ExecuteXcmOrigin = EnsureXcmOrigin<RuntimeOrigin, LocalOriginToLocation>;
133	// We execute any type of program
134	type XcmExecuteFilter = Everything;
135	// How we execute programs
136	type XcmExecutor = XcmExecutor<XcmConfig>;
137	// We don't allow teleports
138	type XcmTeleportFilter = Nothing;
139	// We allow all reserve transfers.
140	// This is so it can act as a reserve for its native token.
141	type XcmReserveTransferFilter = Everything;
142	// Same weigher executor uses to weigh XCM programs
143	type Weigher = weigher::Weigher;
144	// Same universal location
145	type UniversalLocation = UniversalLocation;
146	// No version discovery needed
147	const VERSION_DISCOVERY_QUEUE_SIZE: u32 = 0;
148	type AdvertisedXcmVersion = pallet_xcm::CurrentXcmVersion;
149	type AdminOrigin = frame_system::EnsureRoot<AccountId>;
150	// No locking
151	type TrustedLockers = ();
152	type MaxLockers = frame::traits::ConstU32<0>;
153	type MaxRemoteLockConsumers = frame::traits::ConstU32<0>;
154	type RemoteLockConsumerIdentifier = ();
155	// How to turn locations into accounts
156	type SovereignAccountOf = LocationToAccountId;
157	// A currency to pay for things and its matcher, we are using the relay token
158	type Currency = Balances;
159	type CurrencyMatcher = IsConcrete<HereLocation>;
160	// Pallet benchmarks, no need for this example
161	type WeightInfo = pallet_xcm::TestWeightInfo;
162	// Runtime types
163	type RuntimeOrigin = RuntimeOrigin;
164	type RuntimeCall = RuntimeCall;
165	type RuntimeEvent = RuntimeEvent;
166	// Aliasing is disabled: xcm_executor::Config::Aliasers is set to `Nothing`.
167	type AuthorizedAliasConsideration = Disabled;
168}
xcm_docs/cookbook/relay_token_transactor/relay_chain/xcm_config.rs

xcm_docs/cookbook/relay_token_transactor/relay_chain/
xcm_config.rs
