iota_grpc_types/proto/generated/

iota.grpc.v1.coin.rs

// Copyright (c) Mysten Labs, Inc.
// Modifications Copyright (c) 2025 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

// This file is @generated by prost-build.
/// Metadata for a coin type
#[non_exhaustive]
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct CoinMetadata {
    /// ObjectId of the `0x2::coin::CoinMetadata` object or
    /// 0x2::iota::coin_registry::Currency object (when registered with CoinRegistry).
    #[prost(message, optional, tag = "1")]
    pub id: ::core::option::Option<super::types::ObjectId>,
    /// Number of decimal places the coin uses.
    #[prost(uint32, optional, tag = "2")]
    pub decimals: ::core::option::Option<u32>,
    /// Name for the token
    #[prost(string, optional, tag = "3")]
    pub name: ::core::option::Option<::prost::alloc::string::String>,
    /// Symbol for the token
    #[prost(string, optional, tag = "4")]
    pub symbol: ::core::option::Option<::prost::alloc::string::String>,
    /// Description of the token
    #[prost(string, optional, tag = "5")]
    pub description: ::core::option::Option<::prost::alloc::string::String>,
    /// URL for the token logo
    #[prost(string, optional, tag = "6")]
    pub icon_url: ::core::option::Option<::prost::alloc::string::String>,
    /// The MetadataCap ID if it has been claimed for this coin type.
    /// This capability allows updating the coin's metadata fields.
    /// Only populated when metadata is from CoinRegistry.
    #[prost(message, optional, tag = "7")]
    pub metadata_cap_id: ::core::option::Option<super::types::ObjectId>,
    /// State of the MetadataCap for this coin type.
    #[prost(enumeration = "coin_metadata::MetadataCapState", optional, tag = "8")]
    pub metadata_cap_state: ::core::option::Option<i32>,
}
/// Nested message and enum types in `CoinMetadata`.
pub mod coin_metadata {
    /// Information about the state of the coin's MetadataCap
    #[non_exhaustive]
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum MetadataCapState {
        /// Indicates the state of the MetadataCap is unknown.
        /// Set when the coin has not been migrated to the CoinRegistry.
        Unknown = 0,
        /// Indicates the MetadataCap has been claimed.
        Claimed = 1,
        /// Indicates the MetadataCap has not been claimed.
        Unclaimed = 2,
        /// Indicates the MetadataCap has been deleted.
        Deleted = 3,
    }
    impl MetadataCapState {
        /// String value of the enum field names used in the ProtoBuf definition.
        ///
        /// The values are not transformed in any way and thus are considered stable
        /// (if the ProtoBuf definition does not change) and safe for programmatic use.
        pub fn as_str_name(&self) -> &'static str {
            match self {
                Self::Unknown => "METADATA_CAP_STATE_UNKNOWN",
                Self::Claimed => "CLAIMED",
                Self::Unclaimed => "UNCLAIMED",
                Self::Deleted => "DELETED",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "METADATA_CAP_STATE_UNKNOWN" => Some(Self::Unknown),
                "CLAIMED" => Some(Self::Claimed),
                "UNCLAIMED" => Some(Self::Unclaimed),
                "DELETED" => Some(Self::Deleted),
                _ => None,
            }
        }
    }
}
/// Information about a coin type's `0x2::coin::TreasuryCap` and its total available supply
#[non_exhaustive]
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct CoinTreasury {
    /// ObjectId of the `0x2::coin::TreasuryCap` object.
    #[prost(message, optional, tag = "1")]
    pub id: ::core::option::Option<super::types::ObjectId>,
    /// Total available supply for this coin type.
    #[prost(uint64, optional, tag = "2")]
    pub total_supply: ::core::option::Option<u64>,
    /// Supply state indicating if the supply is fixed or can still be minted
    #[prost(enumeration = "coin_treasury::SupplyState", optional, tag = "3")]
    pub supply_state: ::core::option::Option<i32>,
}
/// Nested message and enum types in `CoinTreasury`.
pub mod coin_treasury {
    /// Supply state of a coin, matching the Move SupplyState enum
    #[non_exhaustive]
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum SupplyState {
        /// Supply is unknown or TreasuryCap still exists (minting still possible)
        Unknown = 0,
        /// Supply is fixed (TreasuryCap consumed, no more minting possible)
        Fixed = 1,
        /// Supply can only decrease (burning allowed, minting not allowed)
        BurnOnly = 2,
    }
    impl SupplyState {
        /// String value of the enum field names used in the ProtoBuf definition.
        ///
        /// The values are not transformed in any way and thus are considered stable
        /// (if the ProtoBuf definition does not change) and safe for programmatic use.
        pub fn as_str_name(&self) -> &'static str {
            match self {
                Self::Unknown => "SUPPLY_STATE_UNKNOWN",
                Self::Fixed => "FIXED",
                Self::BurnOnly => "BURN_ONLY",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "SUPPLY_STATE_UNKNOWN" => Some(Self::Unknown),
                "FIXED" => Some(Self::Fixed),
                "BURN_ONLY" => Some(Self::BurnOnly),
                _ => None,
            }
        }
    }
}
/// Information about a regulated coin, which indicates that it makes use of the transfer deny list.
#[non_exhaustive]
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct RegulatedCoinMetadata {
    /// ObjectId of the `0x2::coin::RegulatedCoinMetadata` object.
    /// Only present for coins that have not been migrated to CoinRegistry.
    #[prost(message, optional, tag = "1")]
    pub id: ::core::option::Option<super::types::ObjectId>,
    /// The ID of the coin's `CoinMetadata` or `CoinData` object.
    #[prost(message, optional, tag = "2")]
    pub coin_metadata_object: ::core::option::Option<super::types::ObjectId>,
    /// The ID of the coin's `DenyCap` object.
    #[prost(message, optional, tag = "3")]
    pub deny_cap_object: ::core::option::Option<super::types::ObjectId>,
    /// Whether the coin can be globally paused
    #[prost(bool, optional, tag = "4")]
    pub allow_global_pause: ::core::option::Option<bool>,
    /// Variant of the regulated coin metadata
    #[prost(uint32, optional, tag = "5")]
    pub variant: ::core::option::Option<u32>,
    /// Indicates the coin's regulated state.
    #[prost(
        enumeration = "regulated_coin_metadata::CoinRegulatedState",
        optional,
        tag = "6"
    )]
    pub coin_regulated_state: ::core::option::Option<i32>,
}
/// Nested message and enum types in `RegulatedCoinMetadata`.
pub mod regulated_coin_metadata {
    /// Indicates the state of the regulation of the coin.
    #[non_exhaustive]
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum CoinRegulatedState {
        /// Indicates the regulation state of the coin is unknown.
        /// This is set when a coin has not been migrated to the
        /// coin registry and has no `0x2::coin::RegulatedCoinMetadata`
        /// object.
        Unknown = 0,
        /// Indicates a coin is regulated. RegulatedCoinMetadata will be populated.
        Regulated = 1,
        /// Indicates a coin is unregulated.
        Unregulated = 2,
    }
    impl CoinRegulatedState {
        /// String value of the enum field names used in the ProtoBuf definition.
        ///
        /// The values are not transformed in any way and thus are considered stable
        /// (if the ProtoBuf definition does not change) and safe for programmatic use.
        pub fn as_str_name(&self) -> &'static str {
            match self {
                Self::Unknown => "COIN_REGULATED_STATE_UNKNOWN",
                Self::Regulated => "REGULATED",
                Self::Unregulated => "UNREGULATED",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "COIN_REGULATED_STATE_UNKNOWN" => Some(Self::Unknown),
                "REGULATED" => Some(Self::Regulated),
                "UNREGULATED" => Some(Self::Unregulated),
                _ => None,
            }
        }
    }
}