frame_support/traits/tokens/fungibles/metadata.rs
1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: Apache-2.0
5
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18//! Inspect and Mutate traits for Asset metadata
19//!
20//! See the [`crate::traits::fungibles`] doc for more information about fungibles traits.
21
22use crate::dispatch::DispatchResult;
23use alloc::vec::Vec;
24
25pub trait Inspect<AccountId>: super::Inspect<AccountId> {
26 // Get name for an AssetId.
27 fn name(asset: Self::AssetId) -> Vec<u8>;
28 // Get symbol for an AssetId.
29 fn symbol(asset: Self::AssetId) -> Vec<u8>;
30 // Get decimals for an AssetId.
31 fn decimals(asset: Self::AssetId) -> u8;
32}
33
34pub trait Mutate<AccountId>: Inspect<AccountId> {
35 // Set name, symbol and decimals for a given assetId.
36 fn set(
37 asset: Self::AssetId,
38 from: &AccountId,
39 name: Vec<u8>,
40 symbol: Vec<u8>,
41 decimals: u8,
42 ) -> DispatchResult;
43}
44
45pub trait MetadataDeposit<DepositBalance> {
46 // Returns the required deposit amount for a given metadata.
47 fn calc_metadata_deposit(name: &[u8], symbol: &[u8]) -> DepositBalance;
48}