use alloc::vec::Vec;
use core::cmp::Ordering;
use packable::{
error::{UnpackError, UnpackErrorExt},
packer::Packer,
unpacker::Unpacker,
Packable,
};
use crate::{
address::{Address, AliasAddress},
output::{
feature::{verify_allowed_features, Feature, FeatureFlags, Features},
unlock_condition::{verify_allowed_unlock_conditions, UnlockCondition, UnlockConditionFlags, UnlockConditions},
verify_output_amount, ChainId, FoundryId, NativeToken, NativeTokens, Output, OutputBuilderAmount, OutputId,
Rent, RentStructure, StateTransitionError, StateTransitionVerifier, TokenId, TokenScheme,
},
protocol::ProtocolParameters,
semantic::{ConflictReason, ValidationContext},
unlock::Unlock,
Error,
};
#[derive(Clone)]
#[must_use]
pub struct FoundryOutputBuilder {
amount: OutputBuilderAmount,
native_tokens: Vec<NativeToken>,
serial_number: u32,
token_scheme: TokenScheme,
unlock_conditions: Vec<UnlockCondition>,
features: Vec<Feature>,
immutable_features: Vec<Feature>,
}
impl FoundryOutputBuilder {
pub fn new_with_amount(
amount: u64,
serial_number: u32,
token_scheme: TokenScheme,
) -> Result<FoundryOutputBuilder, Error> {
Self::new(OutputBuilderAmount::Amount(amount), serial_number, token_scheme)
}
pub fn new_with_minimum_storage_deposit(
rent_structure: RentStructure,
serial_number: u32,
token_scheme: TokenScheme,
) -> Result<FoundryOutputBuilder, Error> {
Self::new(
OutputBuilderAmount::MinimumStorageDeposit(rent_structure),
serial_number,
token_scheme,
)
}
fn new(
amount: OutputBuilderAmount,
serial_number: u32,
token_scheme: TokenScheme,
) -> Result<FoundryOutputBuilder, Error> {
Ok(Self {
amount,
native_tokens: Vec::new(),
serial_number,
token_scheme,
unlock_conditions: Vec::new(),
features: Vec::new(),
immutable_features: Vec::new(),
})
}
#[inline(always)]
pub fn with_amount(mut self, amount: u64) -> Result<Self, Error> {
self.amount = OutputBuilderAmount::Amount(amount);
Ok(self)
}
#[inline(always)]
pub fn with_minimum_storage_deposit(mut self, rent_structure: RentStructure) -> Self {
self.amount = OutputBuilderAmount::MinimumStorageDeposit(rent_structure);
self
}
#[inline(always)]
pub fn add_native_token(mut self, native_token: NativeToken) -> Self {
self.native_tokens.push(native_token);
self
}
#[inline(always)]
pub fn with_native_tokens(mut self, native_tokens: impl IntoIterator<Item = NativeToken>) -> Self {
self.native_tokens = native_tokens.into_iter().collect();
self
}
#[inline(always)]
pub fn with_serial_number(mut self, serial_number: u32) -> Self {
self.serial_number = serial_number;
self
}
#[inline(always)]
pub fn with_token_scheme(mut self, token_scheme: TokenScheme) -> Self {
self.token_scheme = token_scheme;
self
}
#[inline(always)]
pub fn add_unlock_condition(mut self, unlock_condition: UnlockCondition) -> Self {
self.unlock_conditions.push(unlock_condition);
self
}
#[inline(always)]
pub fn with_unlock_conditions(mut self, unlock_conditions: impl IntoIterator<Item = UnlockCondition>) -> Self {
self.unlock_conditions = unlock_conditions.into_iter().collect();
self
}
pub fn replace_unlock_condition(mut self, unlock_condition: UnlockCondition) -> Result<Self, Error> {
match self
.unlock_conditions
.iter_mut()
.find(|u| u.kind() == unlock_condition.kind())
{
Some(u) => *u = unlock_condition,
None => return Err(Error::CannotReplaceMissingField),
}
Ok(self)
}
#[inline(always)]
pub fn add_feature(mut self, feature: Feature) -> Self {
self.features.push(feature);
self
}
#[inline(always)]
pub fn with_features(mut self, features: impl IntoIterator<Item = Feature>) -> Self {
self.features = features.into_iter().collect();
self
}
pub fn replace_feature(mut self, feature: Feature) -> Result<Self, Error> {
match self.features.iter_mut().find(|f| f.kind() == feature.kind()) {
Some(f) => *f = feature,
None => return Err(Error::CannotReplaceMissingField),
}
Ok(self)
}
#[inline(always)]
pub fn add_immutable_feature(mut self, immutable_feature: Feature) -> Self {
self.immutable_features.push(immutable_feature);
self
}
#[inline(always)]
pub fn with_immutable_features(mut self, immutable_features: impl IntoIterator<Item = Feature>) -> Self {
self.immutable_features = immutable_features.into_iter().collect();
self
}
pub fn replace_immutable_feature(mut self, immutable_feature: Feature) -> Result<Self, Error> {
match self
.immutable_features
.iter_mut()
.find(|f| f.kind() == immutable_feature.kind())
{
Some(f) => *f = immutable_feature,
None => return Err(Error::CannotReplaceMissingField),
}
Ok(self)
}
pub fn finish(self, token_supply: u64) -> Result<FoundryOutput, Error> {
let unlock_conditions = UnlockConditions::new(self.unlock_conditions)?;
verify_unlock_conditions(&unlock_conditions)?;
let features = Features::new(self.features)?;
verify_allowed_features(&features, FoundryOutput::ALLOWED_FEATURES)?;
let immutable_features = Features::new(self.immutable_features)?;
verify_allowed_features(&immutable_features, FoundryOutput::ALLOWED_IMMUTABLE_FEATURES)?;
let mut output = FoundryOutput {
amount: 1u64,
native_tokens: NativeTokens::new(self.native_tokens)?,
serial_number: self.serial_number,
token_scheme: self.token_scheme,
unlock_conditions,
features,
immutable_features,
};
output.amount = match self.amount {
OutputBuilderAmount::Amount(amount) => amount,
OutputBuilderAmount::MinimumStorageDeposit(rent_structure) => {
Output::Foundry(output.clone()).rent_cost(&rent_structure)
}
};
verify_output_amount::<true>(&output.amount, &token_supply)?;
Ok(output)
}
pub fn finish_output(self, token_supply: u64) -> Result<Output, Error> {
Ok(Output::Foundry(self.finish(token_supply)?))
}
}
impl From<&FoundryOutput> for FoundryOutputBuilder {
fn from(output: &FoundryOutput) -> Self {
FoundryOutputBuilder {
amount: OutputBuilderAmount::Amount(output.amount),
native_tokens: output.native_tokens.to_vec(),
serial_number: output.serial_number,
token_scheme: output.token_scheme.clone(),
unlock_conditions: output.unlock_conditions.to_vec(),
features: output.features.to_vec(),
immutable_features: output.immutable_features.to_vec(),
}
}
}
#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct FoundryOutput {
amount: u64,
native_tokens: NativeTokens,
serial_number: u32,
token_scheme: TokenScheme,
unlock_conditions: UnlockConditions,
features: Features,
immutable_features: Features,
}
impl FoundryOutput {
pub const KIND: u8 = 5;
pub const ALLOWED_UNLOCK_CONDITIONS: UnlockConditionFlags = UnlockConditionFlags::IMMUTABLE_ALIAS_ADDRESS;
pub const ALLOWED_FEATURES: FeatureFlags = FeatureFlags::METADATA;
pub const ALLOWED_IMMUTABLE_FEATURES: FeatureFlags = FeatureFlags::METADATA;
#[inline(always)]
pub fn new_with_amount(
amount: u64,
serial_number: u32,
token_scheme: TokenScheme,
token_supply: u64,
) -> Result<Self, Error> {
FoundryOutputBuilder::new_with_amount(amount, serial_number, token_scheme)?.finish(token_supply)
}
#[inline(always)]
pub fn new_with_minimum_storage_deposit(
serial_number: u32,
token_scheme: TokenScheme,
rent_structure: RentStructure,
token_supply: u64,
) -> Result<Self, Error> {
FoundryOutputBuilder::new_with_minimum_storage_deposit(rent_structure, serial_number, token_scheme)?
.finish(token_supply)
}
#[inline(always)]
pub fn build_with_amount(
amount: u64,
serial_number: u32,
token_scheme: TokenScheme,
) -> Result<FoundryOutputBuilder, Error> {
FoundryOutputBuilder::new_with_amount(amount, serial_number, token_scheme)
}
#[inline(always)]
pub fn build_with_minimum_storage_deposit(
rent_structure: RentStructure,
serial_number: u32,
token_scheme: TokenScheme,
) -> Result<FoundryOutputBuilder, Error> {
FoundryOutputBuilder::new_with_minimum_storage_deposit(rent_structure, serial_number, token_scheme)
}
#[inline(always)]
pub fn amount(&self) -> u64 {
self.amount
}
#[inline(always)]
pub fn native_tokens(&self) -> &NativeTokens {
&self.native_tokens
}
#[inline(always)]
pub fn serial_number(&self) -> u32 {
self.serial_number
}
#[inline(always)]
pub fn token_scheme(&self) -> &TokenScheme {
&self.token_scheme
}
#[inline(always)]
pub fn unlock_conditions(&self) -> &UnlockConditions {
&self.unlock_conditions
}
#[inline(always)]
pub fn features(&self) -> &Features {
&self.features
}
#[inline(always)]
pub fn immutable_features(&self) -> &Features {
&self.immutable_features
}
#[inline(always)]
pub fn alias_address(&self) -> &AliasAddress {
self.unlock_conditions
.immutable_alias_address()
.map(|unlock_condition| unlock_condition.alias_address())
.unwrap()
}
pub fn id(&self) -> FoundryId {
FoundryId::build(self.alias_address(), self.serial_number, self.token_scheme.kind())
}
pub fn token_id(&self) -> TokenId {
TokenId::from(self.id())
}
#[inline(always)]
pub fn chain_id(&self) -> ChainId {
ChainId::Foundry(self.id())
}
pub fn unlock(
&self,
_output_id: &OutputId,
unlock: &Unlock,
inputs: &[(OutputId, &Output)],
context: &mut ValidationContext,
) -> Result<(), ConflictReason> {
Address::from(*self.alias_address()).unlock(unlock, inputs, context)
}
}
impl StateTransitionVerifier for FoundryOutput {
fn creation(next_state: &Self, context: &ValidationContext) -> Result<(), StateTransitionError> {
let alias_chain_id = ChainId::from(*next_state.alias_address().alias_id());
if let (Some(Output::Alias(input_alias)), Some(Output::Alias(output_alias))) = (
context.input_chains.get(&alias_chain_id),
context.output_chains.get(&alias_chain_id),
) {
if input_alias.foundry_counter() >= next_state.serial_number()
|| next_state.serial_number() > output_alias.foundry_counter()
{
return Err(StateTransitionError::InconsistentFoundrySerialNumber);
}
} else {
return Err(StateTransitionError::MissingAliasForFoundry);
}
let token_id = next_state.token_id();
let output_tokens = context.output_native_tokens.get(&token_id).copied().unwrap_or_default();
let TokenScheme::Simple(ref next_token_scheme) = next_state.token_scheme;
if context.input_native_tokens.contains_key(&token_id) {
return Err(StateTransitionError::InconsistentNativeTokensFoundryCreation);
}
if output_tokens != next_token_scheme.minted_tokens() || !next_token_scheme.melted_tokens().is_zero() {
return Err(StateTransitionError::InconsistentNativeTokensFoundryCreation);
}
Ok(())
}
fn transition(
current_state: &Self,
next_state: &Self,
context: &ValidationContext,
) -> Result<(), StateTransitionError> {
if current_state.alias_address() != next_state.alias_address()
|| current_state.serial_number != next_state.serial_number
|| current_state.immutable_features != next_state.immutable_features
{
return Err(StateTransitionError::MutatedImmutableField);
}
let token_id = next_state.token_id();
let input_tokens = context.input_native_tokens.get(&token_id).copied().unwrap_or_default();
let output_tokens = context.output_native_tokens.get(&token_id).copied().unwrap_or_default();
let TokenScheme::Simple(ref current_token_scheme) = current_state.token_scheme;
let TokenScheme::Simple(ref next_token_scheme) = next_state.token_scheme;
if current_token_scheme.maximum_supply() != next_token_scheme.maximum_supply() {
return Err(StateTransitionError::MutatedImmutableField);
}
if current_token_scheme.minted_tokens() > next_token_scheme.minted_tokens()
|| current_token_scheme.melted_tokens() > next_token_scheme.melted_tokens()
{
return Err(StateTransitionError::NonMonotonicallyIncreasingNativeTokens);
}
match input_tokens.cmp(&output_tokens) {
Ordering::Less => {
let minted_diff = next_token_scheme.minted_tokens() - current_token_scheme.minted_tokens();
let token_diff = output_tokens - input_tokens;
if minted_diff != token_diff {
return Err(StateTransitionError::InconsistentNativeTokensMint);
}
if current_token_scheme.melted_tokens() != next_token_scheme.melted_tokens() {
return Err(StateTransitionError::InconsistentNativeTokensMint);
}
}
Ordering::Equal => {
if current_token_scheme.minted_tokens() != next_token_scheme.minted_tokens()
|| current_token_scheme.melted_tokens() != next_token_scheme.melted_tokens()
{
return Err(StateTransitionError::InconsistentNativeTokensTransition);
}
}
Ordering::Greater => {
if current_token_scheme.melted_tokens() != next_token_scheme.melted_tokens()
&& current_token_scheme.minted_tokens() != next_token_scheme.minted_tokens()
{
return Err(StateTransitionError::InconsistentNativeTokensMeltBurn);
}
let melted_diff = next_token_scheme.melted_tokens() - current_token_scheme.melted_tokens();
let token_diff = input_tokens - output_tokens;
if melted_diff > token_diff {
return Err(StateTransitionError::InconsistentNativeTokensMeltBurn);
}
}
}
Ok(())
}
fn destruction(current_state: &Self, context: &ValidationContext) -> Result<(), StateTransitionError> {
let token_id = current_state.token_id();
let input_tokens = context.input_native_tokens.get(&token_id).copied().unwrap_or_default();
let TokenScheme::Simple(ref current_token_scheme) = current_state.token_scheme;
if context.output_native_tokens.contains_key(&token_id) {
return Err(StateTransitionError::InconsistentNativeTokensFoundryDestruction);
}
let minted_melted_diff = current_token_scheme.minted_tokens() - current_token_scheme.melted_tokens();
if minted_melted_diff != input_tokens {
return Err(StateTransitionError::InconsistentNativeTokensFoundryDestruction);
}
Ok(())
}
}
impl Packable for FoundryOutput {
type UnpackError = Error;
type UnpackVisitor = ProtocolParameters;
fn pack<P: Packer>(&self, packer: &mut P) -> Result<(), P::Error> {
self.amount.pack(packer)?;
self.native_tokens.pack(packer)?;
self.serial_number.pack(packer)?;
self.token_scheme.pack(packer)?;
self.unlock_conditions.pack(packer)?;
self.features.pack(packer)?;
self.immutable_features.pack(packer)?;
Ok(())
}
fn unpack<U: Unpacker, const VERIFY: bool>(
unpacker: &mut U,
visitor: &Self::UnpackVisitor,
) -> Result<Self, UnpackError<Self::UnpackError, U::Error>> {
let amount = u64::unpack::<_, VERIFY>(unpacker, &()).coerce()?;
verify_output_amount::<VERIFY>(&amount, &visitor.token_supply()).map_err(UnpackError::Packable)?;
let native_tokens = NativeTokens::unpack::<_, VERIFY>(unpacker, &())?;
let serial_number = u32::unpack::<_, VERIFY>(unpacker, &()).coerce()?;
let token_scheme = TokenScheme::unpack::<_, VERIFY>(unpacker, &())?;
let unlock_conditions = UnlockConditions::unpack::<_, VERIFY>(unpacker, visitor)?;
if VERIFY {
verify_unlock_conditions(&unlock_conditions).map_err(UnpackError::Packable)?;
}
let features = Features::unpack::<_, VERIFY>(unpacker, &())?;
if VERIFY {
verify_allowed_features(&features, FoundryOutput::ALLOWED_FEATURES).map_err(UnpackError::Packable)?;
}
let immutable_features = Features::unpack::<_, VERIFY>(unpacker, &())?;
if VERIFY {
verify_allowed_features(&immutable_features, FoundryOutput::ALLOWED_IMMUTABLE_FEATURES)
.map_err(UnpackError::Packable)?;
}
Ok(Self {
amount,
native_tokens,
serial_number,
token_scheme,
unlock_conditions,
features,
immutable_features,
})
}
}
fn verify_unlock_conditions(unlock_conditions: &UnlockConditions) -> Result<(), Error> {
if unlock_conditions.immutable_alias_address().is_none() {
Err(Error::MissingAddressUnlockCondition)
} else {
verify_allowed_unlock_conditions(unlock_conditions, FoundryOutput::ALLOWED_UNLOCK_CONDITIONS)
}
}
#[cfg(feature = "dto")]
#[allow(missing_docs)]
pub mod dto {
use serde::{Deserialize, Serialize};
use super::*;
use crate::{
error::dto::DtoError,
output::{
dto::OutputBuilderAmountDto, feature::dto::FeatureDto, native_token::dto::NativeTokenDto,
token_scheme::dto::TokenSchemeDto, unlock_condition::dto::UnlockConditionDto,
},
};
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct FoundryOutputDto {
#[serde(rename = "type")]
pub kind: u8,
pub amount: String,
#[serde(rename = "nativeTokens", skip_serializing_if = "Vec::is_empty", default)]
pub native_tokens: Vec<NativeTokenDto>,
#[serde(rename = "serialNumber")]
pub serial_number: u32,
#[serde(rename = "tokenScheme")]
pub token_scheme: TokenSchemeDto,
#[serde(rename = "unlockConditions")]
pub unlock_conditions: Vec<UnlockConditionDto>,
#[serde(skip_serializing_if = "Vec::is_empty", default)]
pub features: Vec<FeatureDto>,
#[serde(rename = "immutableFeatures", skip_serializing_if = "Vec::is_empty", default)]
pub immutable_features: Vec<FeatureDto>,
}
impl From<&FoundryOutput> for FoundryOutputDto {
fn from(value: &FoundryOutput) -> Self {
Self {
kind: FoundryOutput::KIND,
amount: value.amount().to_string(),
native_tokens: value.native_tokens().iter().map(Into::into).collect::<_>(),
serial_number: value.serial_number(),
token_scheme: value.token_scheme().into(),
unlock_conditions: value.unlock_conditions().iter().map(Into::into).collect::<_>(),
features: value.features().iter().map(Into::into).collect::<_>(),
immutable_features: value.immutable_features().iter().map(Into::into).collect::<_>(),
}
}
}
impl FoundryOutput {
pub fn try_from_dto(value: &FoundryOutputDto, token_supply: u64) -> Result<FoundryOutput, DtoError> {
let mut builder = FoundryOutputBuilder::new_with_amount(
value
.amount
.parse::<u64>()
.map_err(|_| DtoError::InvalidField("amount"))?,
value.serial_number,
(&value.token_scheme).try_into()?,
)?;
for t in &value.native_tokens {
builder = builder.add_native_token(t.try_into()?);
}
for u in &value.unlock_conditions {
builder = builder.add_unlock_condition(UnlockCondition::try_from_dto(u, token_supply)?);
}
for b in &value.features {
builder = builder.add_feature(b.try_into()?);
}
for b in &value.immutable_features {
builder = builder.add_immutable_feature(b.try_into()?);
}
Ok(builder.finish(token_supply)?)
}
#[allow(clippy::too_many_arguments)]
pub fn try_from_dtos(
amount: OutputBuilderAmountDto,
native_tokens: Option<Vec<NativeTokenDto>>,
serial_number: u32,
token_scheme: &TokenSchemeDto,
unlock_conditions: Vec<UnlockConditionDto>,
features: Option<Vec<FeatureDto>>,
immutable_features: Option<Vec<FeatureDto>>,
token_supply: u64,
) -> Result<FoundryOutput, DtoError> {
let token_scheme = TokenScheme::try_from(token_scheme)?;
let mut builder = match amount {
OutputBuilderAmountDto::Amount(amount) => FoundryOutputBuilder::new_with_amount(
amount.parse().map_err(|_| DtoError::InvalidField("amount"))?,
serial_number,
token_scheme,
)?,
OutputBuilderAmountDto::MinimumStorageDeposit(rent_structure) => {
FoundryOutputBuilder::new_with_minimum_storage_deposit(rent_structure, serial_number, token_scheme)?
}
};
if let Some(native_tokens) = native_tokens {
let native_tokens = native_tokens
.iter()
.map(NativeToken::try_from)
.collect::<Result<Vec<NativeToken>, DtoError>>()?;
builder = builder.with_native_tokens(native_tokens);
}
let unlock_conditions = unlock_conditions
.iter()
.map(|u| UnlockCondition::try_from_dto(u, token_supply))
.collect::<Result<Vec<UnlockCondition>, DtoError>>()?;
builder = builder.with_unlock_conditions(unlock_conditions);
if let Some(features) = features {
let features = features
.iter()
.map(Feature::try_from)
.collect::<Result<Vec<Feature>, DtoError>>()?;
builder = builder.with_features(features);
}
if let Some(immutable_features) = immutable_features {
let immutable_features = immutable_features
.iter()
.map(Feature::try_from)
.collect::<Result<Vec<Feature>, DtoError>>()?;
builder = builder.with_immutable_features(immutable_features);
}
Ok(builder.finish(token_supply)?)
}
}
}