Enum Token Configuration &nbsp; Copy item path

V0(TokenConfigurationV0)

Implementations§

impl TokenConfiguration

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

Applies a TokenConfigurationChangeItem to this token configuration.

§Parameters

change_item: The change item to be applied.

This method modifies the current TokenConfigurationV0 instance in place.

impl TokenConfiguration

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

Returns the authorized action takers for a specific TokenConfigurationChangeItem.

§Parameters

change_item: The change item for which to retrieve the authorized action takers.

§Returns

AuthorizedActionTakers: The authorized action takers for the given change item.

impl TokenConfiguration

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

Applies a TokenConfigurationChangeItem to this token configuration.

§Parameters

change_item: The change item to be applied.

This method modifies the current TokenConfigurationV0 instance in place.

impl TokenConfiguration

pub fn validate_token_config_groups_exist( &self, groups: &BTreeMap<GroupContractPosition, Group>, platform_version: &PlatformVersion, ) -> Result<SimpleConsensusValidationResult, ProtocolError>

Validates that all group positions referenced in the token configuration exist in the provided groups map.

§Parameters

groups: A reference to a BTreeMap containing group positions as keys and their associated Group objects as values. These represent the groups defined in the data contract.
platform_version: A reference to the PlatformVersion object specifying the version of the function to call.

§Returns

Ok(SimpleConsensusValidationResult): If the validation is successful, returns a result containing a validation result object, which will be empty if no errors are found.
Err(ProtocolError): If an unknown or unsupported platform version is specified, an error indicating a version mismatch is returned.

§Errors

If a group position referenced in the token configuration does not exist in the provided groups map, the method will invoke the version-specific validation logic, which will include any corresponding validation errors.

§Versioning

This function dispatches to version-specific validation logic based on the platform_version.
Currently supports validate_token_config_groups_exist_v0 for version 0.

impl TokenConfiguration

pub fn validate_token_config_update( &self, new_config: &TokenConfiguration, contract_owner_id: &Identifier, groups: &BTreeMap<GroupContractPosition, Group>, action_taker: &ActionTaker, goal: ActionGoal, platform_version: &PlatformVersion, ) -> Result<SimpleConsensusValidationResult, ProtocolError>

impl TokenConfiguration

pub fn as_cow_v0(&self) -> Cow<'_, TokenConfigurationV0>

Trait Implementations§

impl<'de, Context> BorrowDecode<'de, Context> for TokenConfiguration

fn borrow_decode<D: BorrowDecoder<'de, Context = Context>>( decoder: &mut D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for TokenConfiguration

fn clone(&self) -> TokenConfiguration

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for TokenConfiguration

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

Formats the value using the given formatter. Read more

impl<Context> Decode<Context> for TokenConfiguration

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

Attempt to decode this type with the given Decode.

impl<'de> Deserialize<'de> for TokenConfiguration

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for TokenConfiguration

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

Formats the value using the given formatter. Read more

impl Encode for TokenConfiguration

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

Encode a given type.

impl From<TokenConfigurationV0> for TokenConfiguration

fn from(value: TokenConfigurationV0) -> Self

Converts to this type from the input type.

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TokenConfiguration

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl TokenConfigurationV0Getters for TokenConfiguration

Implementing TokenConfigurationV0Getters for TokenConfiguration

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 base_supply(&self) -> TokenAmount

Returns the base supply.

fn keeps_history(&self) -> &TokenKeepsHistoryRules

Returns if we keep history.

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 max_supply(&self) -> Option<TokenAmount>

Returns the maximum supply.

fn max_supply_change_rules(&self) -> &ChangeControlRules

Returns the max supply change 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 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.

fn conventions_change_rules(&self) -> &ChangeControlRules

Returns the new tokens destination identity rules.

fn is_allowed_transfer_to_frozen_balance(&self) -> bool

Allow to transfer and mint tokens to frozen identity token balances

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 destroy_frozen_funds_rules(&self) -> &ChangeControlRules

Returns the destroy frozen funds rules.

fn emergency_action_rules(&self) -> &ChangeControlRules

Returns the emergency action rules.

impl TokenConfigurationV0Setters for TokenConfiguration

Implementing TokenConfigurationV0Setters for TokenConfiguration

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: u64)

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<u64>)

Sets the maximum supply.

fn set_max_supply_change_rules(&mut self, rules: ChangeControlRules)

Sets the max supply change 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_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.

fn set_distribution_rules(&mut self, rules: TokenDistributionRules)

Sets the distribution 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.

impl ValueConvertible for TokenConfiguration

fn to_object(&self) -> Result<Value, ProtocolError>
where Self: Sized,

fn into_object(self) -> Result<Value, ProtocolError>
where Self: Sized,

fn from_object(value: Value) -> Result<Self, ProtocolError>
where Self: Sized,

fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>
where Self: Sized,

impl Eq for TokenConfiguration

impl JsonSafeFields for TokenConfiguration

impl StructuralPartialEq for TokenConfiguration

Auto Trait Implementations§

impl Freeze for TokenConfiguration

impl RefUnwindSafe for TokenConfiguration

impl Send for TokenConfiguration

impl Sync for TokenConfiguration

impl Unpin for TokenConfiguration

impl UnwindSafe for TokenConfiguration

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> CostsExt for T

fn wrap_with_cost(self, cost: OperationCost) -> CostContext<Self>
where Self: Sized,

Wraps any value into a CostContext object with provided costs.

fn wrap_fn_cost( self, f: impl FnOnce(&Self) -> OperationCost, ) -> CostContext<Self>
where Self: Sized,

Wraps any value into CostContext object with costs computed using the value getting wrapped.

impl<'de, T> DefaultBorrowDecode<'de> for T
where T: BorrowDecode<'de, ()>,

fn borrow_decode<D>(decoder: &mut D) -> Result<Self, DecodeError>
where D: BorrowDecoder<'de, Context = ()>, Self: Sized,

impl<T> DefaultDecode for T
where T: Decode<()>,

fn decode<D>(decoder: &mut D) -> Result<Self, DecodeError>
where D: Decoder<Context = ()>, Self: Sized,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T, U> IntoOnNetwork for T
where U: FromOnNetwork<T>,

fn into_on_network(self, network: Network) -> U

Calls U::from_on_network(self).

impl<T, U> IntoPlatformVersioned for T
where U: FromPlatformVersioned<T>,

fn into_platform_versioned(self, platform_version: &PlatformVersion) -> U

Performs the conversion.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryFromVersioned for T
where T: TryFrom,

type Error = <T as TryFrom>::Error

The type returned in the event of a conversion error.

fn try_from_versioned( value: U, _grove_version: &GroveVersion, ) -> Result<T, <T as TryFromVersioned>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T, U> TryIntoPlatformVersioned for T
where U: TryFromPlatformVersioned<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into_platform_versioned( self, platform_version: &PlatformVersion, ) -> Result<U, >::Error>

Performs the conversion.

impl<T, U> TryIntoVersioned for T
where U: TryFromVersioned<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into_versioned( self, grove_version: &GroveVersion, ) -> Result<U, >::Error>

Performs the conversion.

impl<T, U> TryIntoWithBlockHashLookup for T
where U: TryFromWithBlockHashLookup<T>,

type Error = >::Error

fn try_into_with_block_hash_lookup<F>( self, block_hash_lookup: F, network: Network, ) -> Result<U, <T as TryIntoWithBlockHashLookup>::Error>
where F: Fn(&BlockHash) -> Option<u32>,

Converts self into T, using a block hash lookup function.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more