Struct TokenConfigurationV1 

pub struct TokenConfigurationV1 {
    pub base: TokenConfigurationV0,
    pub has_shielded_pool: bool,
    pub minimum_pool_notes_for_outgoing: Option<u64>,
    pub minimum_pool_notes_for_outgoing_change_rules: ChangeControlRules,
}

Version 1 of the token configuration: everything TokenConfigurationV0 carries, plus the per-token shielded pool opt-in and the pool’s outgoing notes threshold.

The V0 fields are nested as base and flattened on the JSON / Value wire, so a V1 configuration reads exactly like a V0 one with $formatVersion: "1" and the extra hasShieldedPool, minimumPoolNotesForOutgoing and minimumPoolNotesForOutgoingChangeRules keys. On the bincode wire it is the V0 bytes followed by the flag, the threshold and its rules, under the enum’s variant index 1, so stored V0 configurations decode unchanged.

has_shielded_pool is decided at token creation and is immutable afterwards: the pool subtree (an Orchard note commitment tree, nullifier set, anchors and a balance) is created together with the token’s other trees, and a pool holding notes can never be removed. Enabling a pool on an existing token is not supported by this version.

Fields

base: TokenConfigurationV0

The V0 configuration this version extends.

has_shielded_pool: bool

Whether this token has its own shielded pool. When true, holders may move balance into the pool (TokenShield), transfer privately inside it (TokenShieldedTransfer) and move balance back out to an identity (TokenUnshield).

minimum_pool_notes_for_outgoing: Option<u64>

The fewest notes the token’s shielded pool must hold before tokens may leave it for a visible destination (unshielding to an identity, burning from the pool, paying a document’s token cost from the pool). Transfers inside the pool are not limited. None reads as 0, no threshold.

The count is of note commitments, not of holders: one bundle carries several actions, so a single depositor can reach a threshold alone. It tells holders how busy the pool should be before they leave it and guarantees no anonymity set. A threshold above 0 also traps a new pool’s first depositors until enough notes accumulate, so the default is none. At most max_token_pool_notes_for_outgoing, so an issuer cannot set one no pool reaches and strand every shielded balance. Changed through TokenConfigUpdate under minimum_pool_notes_for_outgoing_change_rules.

minimum_pool_notes_for_outgoing_change_rules: ChangeControlRules

Change control rules governing who can modify minimum_pool_notes_for_outgoing. No one when absent.

Implementations

impl TokenConfigurationV1

pub fn apply_token_configuration_item( &mut self, change_item: TokenConfigurationChangeItem, )

Applies a TokenConfigurationChangeItem: the shielded pool’s threshold items to this configuration, every other item to the nested V0 configuration.

impl TokenConfigurationV1

pub fn controlling_action_takers_for_configuration_item( &self, change_item: &TokenConfigurationChangeItem, ) -> AuthorizedActionTakers

Returns the current authority that controls a configuration item: the shielded pool’s threshold items are controlled like any other rule-governed item, every other item as the nested V0 configuration says.

pub fn authorized_action_takers_for_configuration_item( &self, change_item: &TokenConfigurationChangeItem, ) -> AuthorizedActionTakers

Returns the authorized action takers for a specific TokenConfigurationChangeItem: the shielded pool’s threshold items from minimum_pool_notes_for_outgoing_change_rules, every other item from the nested V0 configuration.

impl TokenConfigurationV1

pub fn can_apply_token_configuration_item( &self, change_item: &TokenConfigurationChangeItem, contract_owner_id: &Identifier, main_group: Option<GroupContractPosition>, groups: &BTreeMap<GroupContractPosition, Group>, action_taker: &ActionTaker, goal: ActionGoal, ) -> bool

Determines whether a TokenConfigurationChangeItem can be applied: the shielded pool’s threshold items under minimum_pool_notes_for_outgoing_change_rules, every other item under the nested V0 configuration’s rules.

impl TokenConfigurationV1

pub fn from_v0(base: TokenConfigurationV0, has_shielded_pool: bool) -> Self

Wraps a V0 configuration, opting the token into a shielded pool when has_shielded_pool.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for TokenConfigurationV1

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<'__de, __Context> BorrowDecodeUntrusted<'__de, __Context> for TokenConfigurationV1

fn borrow_decode_untrusted<__D: BorrowUntrustedDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Borrow-decode with explicit untrusted field dispatch and resource handling.

impl Clone for TokenConfigurationV1

fn clone(&self) -> TokenConfigurationV1

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TokenConfigurationV1

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for TokenConfigurationV1

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<__Context> DecodeUntrusted<__Context> for TokenConfigurationV1

fn decode_untrusted<__D: UntrustedDecoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Decode with explicit untrusted field dispatch and resource handling.

impl<'de> Deserialize<'de> for TokenConfigurationV1

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TokenConfigurationV1

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for TokenConfigurationV1

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl Eq for TokenConfigurationV1

impl From<TokenConfigurationV1> for TokenConfiguration

fn from(value: TokenConfigurationV1) -> Self

Converts to this type from the input type.

impl JsonSafeFields for TokenConfigurationV1

impl PartialEq for TokenConfigurationV1

fn eq(&self, other: &TokenConfigurationV1) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TokenConfigurationV1

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TokenConfigurationV1

impl TokenConfigurationV0Getters for TokenConfigurationV1

Every V0 getter reads through to the nested base configuration.

fn conventions(&self) -> &TokenConfigurationConvention

Returns a reference to the conventions.

fn conventions_mut(&mut self) -> &mut TokenConfigurationConvention

Returns a mutable reference to the conventions.

fn conventions_change_rules(&self) -> &ChangeControlRules

Returns the new tokens destination identity rules.

fn base_supply(&self) -> TokenAmount

Returns the base supply.

fn keeps_history(&self) -> &TokenKeepsHistoryRules

Returns the KeepsHistory rules.

fn keeps_history_mut(&mut self) -> &mut TokenKeepsHistoryRules

Returns if we keep history.

fn start_as_paused(&self) -> bool

Returns if we start as paused.

fn is_allowed_transfer_to_frozen_balance(&self) -> bool

Allow to transfer and mint tokens to frozen identity token balances

fn max_supply(&self) -> Option<TokenAmount>

Returns the maximum supply.

fn max_supply_change_rules(&self) -> &ChangeControlRules

Returns the max supply change rules.

fn distribution_rules(&self) -> &TokenDistributionRules

Returns the distribution rules.

fn distribution_rules_mut(&mut self) -> &mut TokenDistributionRules

Returns a mutable reference to the distribution rules.

fn manual_minting_rules(&self) -> &ChangeControlRules

Returns the manual minting rules.

fn manual_burning_rules(&self) -> &ChangeControlRules

Returns the manual burning rules.

fn freeze_rules(&self) -> &ChangeControlRules

Returns the freeze rules.

fn unfreeze_rules(&self) -> &ChangeControlRules

Returns the unfreeze rules.

fn destroy_frozen_funds_rules(&self) -> &ChangeControlRules

Returns the destroy frozen funds rules.

fn emergency_action_rules(&self) -> &ChangeControlRules

Returns the emergency action rules.

fn main_control_group(&self) -> Option<GroupContractPosition>

Returns the main control group.

fn main_control_group_can_be_modified(&self) -> &AuthorizedActionTakers

Returns the main control group can be modified.

fn all_used_group_positions(&self) -> (BTreeSet<GroupContractPosition>, bool)

Returns all group positions used in the token configuration

fn all_change_control_rules(&self) -> Vec<(&str, &ChangeControlRules)>

Returns all the change contract rules, including those from the distribution rules

fn description(&self) -> &Option<String>

Returns the token description.

impl TokenConfigurationV0Setters for TokenConfigurationV1

Every V0 setter writes through to the nested base configuration.

fn set_conventions(&mut self, conventions: TokenConfigurationConvention)

Sets the conventions.

fn set_conventions_change_rules(&mut self, rules: ChangeControlRules)

Sets the conventions change rules.

fn allow_transfer_to_frozen_balance(&mut self, allow: bool)

Allow or not a transfer and mint tokens to frozen identity token balances

fn set_base_supply(&mut self, base_supply: TokenAmount)

Sets the base supply.

fn set_start_as_paused(&mut self, start_as_paused: bool)

Sets if we should start as paused. Meaning transfers will not work till unpaused

fn set_max_supply(&mut self, max_supply: Option<TokenAmount>)

Sets the maximum supply.

fn set_max_supply_change_rules(&mut self, rules: ChangeControlRules)

Sets the max supply change rules.

fn set_distribution_rules(&mut self, rules: TokenDistributionRules)

Sets the distribution rules.

fn set_manual_minting_rules(&mut self, rules: ChangeControlRules)

Sets the manual minting rules.

fn set_manual_burning_rules(&mut self, rules: ChangeControlRules)

Sets the manual burning rules.

fn set_freeze_rules(&mut self, rules: ChangeControlRules)

Sets the freeze rules.

fn set_unfreeze_rules(&mut self, rules: ChangeControlRules)

Sets the unfreeze rules.

fn set_destroy_frozen_funds_rules(&mut self, rules: ChangeControlRules)

Sets the destroy frozen funds rules.

fn set_emergency_action_rules(&mut self, rules: ChangeControlRules)

Sets the emergency action rules.

fn set_main_control_group(&mut self, group: Option<GroupContractPosition>)

Sets the main control group.

fn set_main_control_group_can_be_modified( &mut self, action_takers: AuthorizedActionTakers, )

Sets the main control group can be modified.

fn set_description(&mut self, description: Option<String>)

Sets the token description.

impl TokenConfigurationV1Getters for TokenConfigurationV1

fn has_shielded_pool(&self) -> bool

Whether the token has its own shielded pool.

fn minimum_pool_notes_for_outgoing(&self) -> u64

The fewest notes the token’s shielded pool must hold before tokens may leave it for a visible destination; 0 when the configuration sets none.

impl TokenConfigurationV1Setters for TokenConfigurationV1

fn set_has_shielded_pool(&mut self, has_shielded_pool: bool)

Sets whether the token has its own shielded pool.