tari_engine_types 0.32.0

//   Copyright 2022. The Tari Project
//
//   Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
//   following conditions are met:
//
//   1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
//   disclaimer.
//
//   2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//   following disclaimer in the documentation and/or other materials provided with the distribution.
//
//   3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
//   products derived from this software without specific prior written permission.
//
//   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
//   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
//   USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use std::collections::BTreeSet;

use serde::{Deserialize, Serialize};
use tari_crypto::ristretto::RistrettoPublicKey;
use tari_template_lib::{
    models::BucketId,
    types::{Amount, NonFungibleId, ResourceAddress, ResourceType, confidential::ConfidentialWithdrawProof},
};

use crate::{
    proof::{ContainerRef, LockedResource, Proof},
    resource_container::{ResourceContainer, ResourceError},
};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Bucket {
    bucket_id: BucketId,
    resource_container: ResourceContainer,
}

impl Bucket {
    pub fn new(bucket_id: BucketId, resource: ResourceContainer) -> Self {
        Self {
            bucket_id,
            resource_container: resource,
        }
    }

    pub fn is_empty(&self) -> bool {
        self.resource_container.is_empty()
    }

    pub fn unlocked_amount(&self) -> Amount {
        self.resource_container.unlocked_amount()
    }

    pub fn number_of_confidential_commitments(&self) -> usize {
        self.resource_container.number_of_confidential_commitments()
    }

    pub fn locked_amount(&self) -> Amount {
        self.resource_container.locked_amount()
    }

    pub fn resource_address(&self) -> &ResourceAddress {
        self.resource_container.resource_address()
    }

    pub fn resource_type(&self) -> ResourceType {
        self.resource_container.resource_type()
    }

    pub(crate) fn into_resource_container(self) -> ResourceContainer {
        self.resource_container
    }

    pub fn take_all(self) -> ResourceContainer {
        self.into_resource_container()
    }

    pub fn into_non_fungible_ids(self) -> Option<BTreeSet<NonFungibleId>> {
        self.resource_container.into_non_fungible_ids()
    }

    pub fn non_fungible_ids(&self) -> &BTreeSet<NonFungibleId> {
        self.resource_container.non_fungible_token_ids()
    }

    pub fn contains_non_fungible_id(&self, id: &NonFungibleId) -> bool {
        self.resource_container.non_fungible_token_ids().contains(id)
    }

    pub fn take(&mut self, amount: Amount) -> Result<ResourceContainer, ResourceError> {
        self.resource_container.withdraw(amount)
    }

    pub fn take_confidential(
        &mut self,
        proof: ConfidentialWithdrawProof,
        view_key: Option<&RistrettoPublicKey>,
    ) -> Result<ResourceContainer, ResourceError> {
        self.resource_container.withdraw_confidential(proof, view_key)
    }

    pub fn join(&mut self, other: Bucket) -> Result<(), ResourceError> {
        self.resource_container.deposit(other.resource_container)
    }

    pub fn lock_all(&mut self) -> Result<LockedResource, ResourceError> {
        let locked_resource = self.resource_container.lock_all()?;
        Ok(LockedResource::new(
            ContainerRef::Bucket(self.bucket_id),
            locked_resource,
        ))
    }

    pub fn lock_by_non_fungible_ids(&mut self, ids: BTreeSet<NonFungibleId>) -> Result<LockedResource, ResourceError> {
        let locked_resource = self.resource_container.lock_by_non_fungible_ids(ids)?;
        Ok(LockedResource::new(
            ContainerRef::Bucket(self.bucket_id),
            locked_resource,
        ))
    }

    pub fn lock_by_amount(&mut self, amount: Amount) -> Result<LockedResource, ResourceError> {
        let locked_resource = self.resource_container.lock_by_amount(amount)?;
        Ok(LockedResource::new(
            ContainerRef::Bucket(self.bucket_id),
            locked_resource,
        ))
    }

    pub fn unlock(&mut self, proof: Proof) -> Result<(), ResourceError> {
        self.resource_container.unlock(proof.into_resource_container())
    }
}