Skip to content

feat(dpp): token configuration presets #2561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: Update Master
merged 2 commits into from
Apr 21, 2025
Merged

feat(dpp): token configuration presets #2561

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62aded7
feat: token config presets
QuantumExplorer Apr 21, 2025
c1a628b
clippy fixes
QuantumExplorer Apr 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
281 changes: 181 additions & 100 deletions packages/rs-dpp/src/data_contract/associated_token/token_configuration/v0/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ use crate::data_contract::associated_token::token_distribution_rules::v0::TokenD
use crate::data_contract::associated_token::token_distribution_rules::TokenDistributionRules;
use crate::data_contract::associated_token::token_keeps_history_rules::v0::TokenKeepsHistoryRulesV0;
use crate::data_contract::associated_token::token_keeps_history_rules::TokenKeepsHistoryRules;
use crate::data_contract::associated_token::token_perpetual_distribution::TokenPerpetualDistribution;
use crate::data_contract::associated_token::token_pre_programmed_distribution::TokenPreProgrammedDistribution;
use crate::data_contract::change_control_rules::authorized_action_takers::AuthorizedActionTakers;
use crate::data_contract::change_control_rules::v0::ChangeControlRulesV0;
use crate::data_contract::change_control_rules::ChangeControlRules;
Expand All @@ -31,7 +33,7 @@ pub struct TokenConfigurationV0 {
/// The rules for keeping history.
#[serde(default = "default_token_keeps_history_rules")]
pub keeps_history: TokenKeepsHistoryRules,
/// Do we start off as paused, meaning that we can not transfer till we unpause.
/// True if we start off as paused, meaning that we can not transfer till we unpause.
#[serde(default = "default_starts_as_paused")]
pub start_as_paused: bool,
/// Allow to transfer and mint tokens to frozen identity token balances
Expand Down Expand Up @@ -173,133 +175,212 @@ impl fmt::Display for TokenConfigurationV0 {
}
}

impl TokenConfigurationV0 {
pub fn default_most_restrictive() -> Self {
Self {
conventions: TokenConfigurationConvention::V0(TokenConfigurationConventionV0 {
localizations: Default::default(),
decimals: 8,
}),
conventions_change_rules: ChangeControlRulesV0 {
#[derive(Serialize, Deserialize, Decode, Encode, Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
pub enum TokenConfigurationPresetFeatures {
/// Nothing can be changed once it is set
MostRestrictive,
/// The action taker can not mint or burn tokens, or any advanced action.
/// They can pause the token if needed.
WithOnlyEmergencyAction,
WithMintingAndBurningActions,
/// The action taker can do advanced actions like freezing
WithAllAdvancedActions,
/// The action taker is a god, he can do everything, even taking away his own power.
WithExtremeActions,
}

#[derive(Serialize, Deserialize, Decode, Encode, Debug, Clone, PartialEq, Eq, PartialOrd)]
pub struct TokenConfigurationPreset {
features: TokenConfigurationPresetFeatures,
action_taker: AuthorizedActionTakers,
}

impl TokenConfigurationPreset {
pub fn default_main_control_group_can_be_modified(&self) -> AuthorizedActionTakers {
match self.features {
TokenConfigurationPresetFeatures::MostRestrictive
| TokenConfigurationPresetFeatures::WithOnlyEmergencyAction
| TokenConfigurationPresetFeatures::WithMintingAndBurningActions
| TokenConfigurationPresetFeatures::WithAllAdvancedActions => {
AuthorizedActionTakers::NoOne
}
TokenConfigurationPresetFeatures::WithExtremeActions => self.action_taker,
}
}
pub fn default_basic_change_control_rules_v0(&self) -> ChangeControlRulesV0 {
match self.features {
TokenConfigurationPresetFeatures::MostRestrictive
| TokenConfigurationPresetFeatures::WithOnlyEmergencyAction => ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
base_supply: 100000,
max_supply: None,
keeps_history: TokenKeepsHistoryRules::V0(TokenKeepsHistoryRulesV0 {
keeps_transfer_history: true,
keeps_freezing_history: true,
keeps_minting_history: true,
keeps_burning_history: true,
keeps_direct_pricing_history: true,
keeps_direct_purchase_history: true,
}),
start_as_paused: false,
allow_transfer_to_frozen_balance: true,
max_supply_change_rules: ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
},
TokenConfigurationPresetFeatures::WithMintingAndBurningActions
| TokenConfigurationPresetFeatures::WithAllAdvancedActions => ChangeControlRulesV0 {
authorized_to_make_change: self.action_taker,
admin_action_takers: self.action_taker,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
distribution_rules: TokenDistributionRules::V0(TokenDistributionRulesV0 {
perpetual_distribution: None,
perpetual_distribution_rules: ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
pre_programmed_distribution: None,
new_tokens_destination_identity: None,
new_tokens_destination_identity_rules: ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
minting_allow_choosing_destination: true,
minting_allow_choosing_destination_rules: ChangeControlRulesV0 {
self_changing_admin_action_takers_allowed: true,
},
TokenConfigurationPresetFeatures::WithExtremeActions => ChangeControlRulesV0 {
authorized_to_make_change: self.action_taker,
admin_action_takers: self.action_taker,
changing_authorized_action_takers_to_no_one_allowed: true,
changing_admin_action_takers_to_no_one_allowed: true,
self_changing_admin_action_takers_allowed: true,
},
}
}

pub fn default_advanced_change_control_rules_v0(&self) -> ChangeControlRulesV0 {
match self.features {
TokenConfigurationPresetFeatures::MostRestrictive
| TokenConfigurationPresetFeatures::WithOnlyEmergencyAction
| TokenConfigurationPresetFeatures::WithMintingAndBurningActions => {
ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
change_direct_purchase_pricing_rules: ChangeControlRules::V0(
ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
},
),
}),
manual_minting_rules: ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
manual_burning_rules: ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
TokenConfigurationPresetFeatures::WithAllAdvancedActions => ChangeControlRulesV0 {
authorized_to_make_change: self.action_taker,
admin_action_takers: self.action_taker,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
freeze_rules: ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
unfreeze_rules: ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
destroy_frozen_funds_rules: ChangeControlRulesV0 {
self_changing_admin_action_takers_allowed: true,
},
TokenConfigurationPresetFeatures::WithExtremeActions => ChangeControlRulesV0 {
authorized_to_make_change: self.action_taker,
admin_action_takers: self.action_taker,
changing_authorized_action_takers_to_no_one_allowed: true,
changing_admin_action_takers_to_no_one_allowed: true,
self_changing_admin_action_takers_allowed: true,
},
}
}

pub fn default_emergency_action_change_control_rules_v0(&self) -> ChangeControlRulesV0 {
match self.features {
TokenConfigurationPresetFeatures::MostRestrictive => ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into(),
emergency_action_rules: ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
},
TokenConfigurationPresetFeatures::WithAllAdvancedActions
| TokenConfigurationPresetFeatures::WithMintingAndBurningActions
| TokenConfigurationPresetFeatures::WithOnlyEmergencyAction => ChangeControlRulesV0 {
authorized_to_make_change: self.action_taker,
admin_action_takers: self.action_taker,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
self_changing_admin_action_takers_allowed: true,
},
TokenConfigurationPresetFeatures::WithExtremeActions => ChangeControlRulesV0 {
authorized_to_make_change: self.action_taker,
admin_action_takers: self.action_taker,
changing_authorized_action_takers_to_no_one_allowed: true,
changing_admin_action_takers_to_no_one_allowed: true,
self_changing_admin_action_takers_allowed: true,
},
}
}

pub fn default_distribution_rules_v0(
&self,
perpetual_distribution: Option<TokenPerpetualDistribution>,
pre_programmed_distribution: Option<TokenPreProgrammedDistribution>,
with_direct_pricing: bool,
) -> TokenDistributionRulesV0 {
TokenDistributionRulesV0 {
perpetual_distribution,
perpetual_distribution_rules: self.default_advanced_change_control_rules_v0().into(),
pre_programmed_distribution,
new_tokens_destination_identity: None,
new_tokens_destination_identity_rules: self
.default_basic_change_control_rules_v0()
.into(),
minting_allow_choosing_destination: true,
minting_allow_choosing_destination_rules: self
.default_basic_change_control_rules_v0()
.into(),
change_direct_purchase_pricing_rules: if with_direct_pricing {
self.default_basic_change_control_rules_v0().into()
} else {
ChangeControlRulesV0 {
authorized_to_make_change: AuthorizedActionTakers::NoOne,
admin_action_takers: AuthorizedActionTakers::NoOne,
changing_authorized_action_takers_to_no_one_allowed: false,
changing_admin_action_takers_to_no_one_allowed: false,
self_changing_admin_action_takers_allowed: false,
}
.into()
},
}
}

pub fn token_configuration_v0(
&self,
conventions: TokenConfigurationConvention,
base_supply: TokenAmount,
max_supply: Option<TokenAmount>,
keeps_all_history: bool,
with_direct_pricing: bool,
) -> TokenConfigurationV0 {
TokenConfigurationV0 {
conventions,
conventions_change_rules: self.default_basic_change_control_rules_v0().into(),
base_supply,
max_supply,
keeps_history: TokenKeepsHistoryRulesV0::default_for_keeping_all_history(
keeps_all_history,
)
.into(),
start_as_paused: false,
allow_transfer_to_frozen_balance: true,
max_supply_change_rules: self.default_advanced_change_control_rules_v0().into(),
distribution_rules: self
.default_distribution_rules_v0(None, None, with_direct_pricing)
.into(),
manual_minting_rules: self.default_basic_change_control_rules_v0().into(),
manual_burning_rules: self.default_basic_change_control_rules_v0().into(),
freeze_rules: self.default_advanced_change_control_rules_v0().into(),
unfreeze_rules: self.default_advanced_change_control_rules_v0().into(),
destroy_frozen_funds_rules: self.default_advanced_change_control_rules_v0().into(),
emergency_action_rules: self
.default_emergency_action_change_control_rules_v0()
.into(),
main_control_group: None,
main_control_group_can_be_modified: AuthorizedActionTakers::NoOne,
main_control_group_can_be_modified: self.default_main_control_group_can_be_modified(),
description: None,
}
}
}

impl TokenConfigurationV0 {
pub fn default_most_restrictive() -> Self {
TokenConfigurationPreset {
features: TokenConfigurationPresetFeatures::MostRestrictive,
action_taker: AuthorizedActionTakers::NoOne,
}
.token_configuration_v0(
TokenConfigurationConvention::V0(TokenConfigurationConventionV0 {
localizations: Default::default(),
decimals: 8,
}),
100000,
None,
true,
false,
)
}

pub fn with_base_supply(mut self, base_supply: TokenAmount) -> Self {
self.base_supply = base_supply;
Expand Down
13 changes: 13 additions & 0 deletions packages/rs-dpp/src/data_contract/associated_token/token_keeps_history_rules/v0/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,19 @@ pub struct TokenKeepsHistoryRulesV0 {
pub keeps_direct_purchase_history: bool,
}

impl TokenKeepsHistoryRulesV0 {
pub fn default_for_keeping_all_history(keeps_all_history: bool) -> TokenKeepsHistoryRulesV0 {
TokenKeepsHistoryRulesV0 {
keeps_transfer_history: keeps_all_history,
keeps_freezing_history: keeps_all_history,
keeps_minting_history: keeps_all_history,
keeps_burning_history: keeps_all_history,
keeps_direct_pricing_history: keeps_all_history,
keeps_direct_purchase_history: keeps_all_history,
}
}
}

impl Default for TokenKeepsHistoryRulesV0 {
fn default() -> Self {
TokenKeepsHistoryRulesV0 {
Expand Down
2 changes: 1 addition & 1 deletion packages/rs-dpp/src/data_contract/change_control_rules/authorized_action_takers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use std::collections::BTreeMap;
use std::fmt;

#[derive(
Serialize, Deserialize, Decode, Encode, Debug, Clone, PartialEq, Eq, PartialOrd, Default,
Serialize, Deserialize, Decode, Encode, Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Default,
)]
pub enum AuthorizedActionTakers {
#[default]
Expand Down
Loading