orml-traits 1.5.0

Shared traits including `BasicCurrency`, `MultiCurrency`, `Auction` and more.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

use frame_support::pallet_prelude::*;
use sp_runtime::DispatchResult;
use sp_std::fmt::Debug;
use xcm::v5::prelude::*;
use xcm::VersionedLocation;

pub trait WeightToFeeConverter {
	fn convert_weight_to_fee(location: &Location, weight: Weight) -> Option<u128>;
}

pub trait FixedConversionRateProvider {
	fn get_fee_per_second(location: &Location) -> Option<u128>;
}

pub trait AssetProcessor<AssetId, Metadata> {
	fn pre_register(id: Option<AssetId>, asset_metadata: Metadata) -> Result<(AssetId, Metadata), DispatchError>;
	fn post_register(_id: AssetId, _asset_metadata: Metadata) -> Result<(), DispatchError> {
		Ok(())
	}
}

/// Data describing the asset properties.
#[derive(
	TypeInfo,
	Encode,
	Decode,
	CloneNoBound,
	EqNoBound,
	PartialEqNoBound,
	RuntimeDebugNoBound,
	MaxEncodedLen,
	DecodeWithMemTracking,
)]
#[codec(mel_bound(skip_type_params(StringLimit)))]
#[scale_info(skip_type_params(StringLimit))]
pub struct AssetMetadata<Balance, CustomMetadata, StringLimit: Get<u32>>
where
	Balance: Clone + Debug + Eq + PartialEq,
	CustomMetadata: Parameter + Member + TypeInfo,
{
	pub decimals: u32,
	pub name: BoundedVec<u8, StringLimit>,
	pub symbol: BoundedVec<u8, StringLimit>,
	pub existential_deposit: Balance,
	pub location: Option<VersionedLocation>,
	pub additional: CustomMetadata,
}

pub trait Inspect {
	/// AssetId type
	type AssetId;
	/// Balance type
	type Balance: Clone + Debug + Eq + PartialEq;
	/// Custom metadata type
	type CustomMetadata: Parameter + Member + TypeInfo;
	/// Name and symbol string limit
	type StringLimit: Get<u32>;

	fn asset_id(location: &Location) -> Option<Self::AssetId>;
	fn metadata(
		asset_id: &Self::AssetId,
	) -> Option<AssetMetadata<Self::Balance, Self::CustomMetadata, Self::StringLimit>>;
	fn metadata_by_location(
		location: &Location,
	) -> Option<AssetMetadata<Self::Balance, Self::CustomMetadata, Self::StringLimit>>;
	fn location(asset_id: &Self::AssetId) -> Result<Option<Location>, DispatchError>;
}

pub trait Mutate: Inspect {
	fn register_asset(
		asset_id: Option<Self::AssetId>,
		metadata: AssetMetadata<Self::Balance, Self::CustomMetadata, Self::StringLimit>,
	) -> DispatchResult;

	fn update_asset(
		asset_id: Self::AssetId,
		decimals: Option<u32>,
		name: Option<BoundedVec<u8, Self::StringLimit>>,
		symbol: Option<BoundedVec<u8, Self::StringLimit>>,
		existential_deposit: Option<Self::Balance>,
		location: Option<Option<VersionedLocation>>,
		additional: Option<Self::CustomMetadata>,
	) -> DispatchResult;
}