ss58_registry/
token.rs

1// Copyright (C) 2021-2022 Parity Technologies (UK) Ltd.
2// SPDX-License-Identifier: Apache-2.0
3
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// 	http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16#[cfg(feature = "std")]
17use num_format::{Locale, ToFormattedString};
18
19/// Name and decimals of a given token.
20#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
21pub struct Token {
22	/// The short name (ticker) of the token
23	pub name: &'static str,
24	/// The number of decimals the token has (smallest granularity of the token)
25	pub decimals: u8,
26}
27
28impl core::fmt::Debug for Token {
29	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
30		f.debug_struct("Token")
31			.field("name", &self.name)
32			.field("decimals", &self.decimals)
33			.finish()
34	}
35}
36
37impl Token {
38	/// Creates the specified amount of [`Token`] with its name and decimals filled from the
39	/// [`TokenRegistry`] variant.
40	///
41	/// ```
42	/// # use ss58_registry::{Token, TokenRegistry};
43	/// # #[cfg(feature = "std")]
44	/// # fn x() {
45	/// let token: Token = TokenRegistry::Dot.into();
46	/// let my_amount = token.amount(100_000_000);
47	/// assert_eq!(format!("{}", my_amount), "0.010 DOT");
48	/// assert_eq!(format!("{:?}", my_amount), "0.010 DOT (100,000,000)");
49	/// # }
50	/// # #[cfg(not(feature = "std"))]
51	/// # fn x() {}
52	/// # x();
53	/// ```
54	pub fn amount(&self, amount: u128) -> TokenAmount {
55		TokenAmount { token: self.clone(), amount }
56	}
57}
58
59/// A given amount of token. Can be used for nicely formatted output and token-aware comparison of
60/// different amounts.
61///
62/// ```
63/// # use ss58_registry::{Token, TokenAmount};
64/// # #[cfg(feature = "std")]
65/// # fn x() {
66/// let token = Token { name: "I❤U", decimals: 8 };
67/// let my_amount = token.amount(100_000_000_000);
68/// assert_eq!(format!("{}", my_amount), "1,000.000 I❤U");
69/// assert_eq!(format!("{:?}", my_amount), "1000.000 I❤U (100,000,000,000)");
70/// # }
71/// # #[cfg(not(feature = "std"))]
72/// # fn x() {}
73/// # x();
74/// ```
75#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
76pub struct TokenAmount {
77	/// The token this amount is from.
78	pub token: Token,
79	/// The amount in the smallest granularity of the token.
80	pub amount: u128,
81}
82
83#[cfg(feature = "std")]
84impl std::fmt::Display for TokenAmount {
85	fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
86		let multiplier = u128::pow(10, self.token.decimals as u32);
87		write!(
88			f,
89			"{}.{:0>3} {}",
90			(self.amount / multiplier).to_formatted_string(&Locale::en),
91			self.amount % multiplier / (multiplier / 1000),
92			self.token.name
93		)
94	}
95}
96
97#[cfg(feature = "std")]
98impl std::fmt::Debug for TokenAmount {
99	fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
100		let multiplier = u128::pow(10, self.token.decimals as u32);
101		write!(
102			f,
103			"{}.{:0>3} {} ({})",
104			self.amount / multiplier,
105			self.amount % multiplier / (multiplier / 1000),
106			self.token.name,
107			self.amount.to_formatted_string(&Locale::en),
108		)
109	}
110}
ss58_registry/token.rs

ss58_registry/
token.rs
