tari_engine 0.33.0

Tari template runtime engine
Documentation
//  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 tari_engine_types::{confidential::MinotariBurnClaimProof, instruction_result::InstructionResult};
use tari_ootle_common_types::Epoch;
use tari_template_abi::FunctionDef;
use tari_template_lib::types::crypto::RistrettoPublicKeyBytes;

pub trait Invokable<S> {
    type Error;

    fn invoke(
        &mut self,
        store: &mut S,
        def: &FunctionDef,
        args: &[tari_bor::Value],
    ) -> Result<InstructionResult, Self::Error>;
}

/// Verifier for claim proofs (MinotariBurnClaimProof).
///
/// Implementors of this trait should provide the logic to verify the authenticity and validity of the claim proof.
/// If the claim proof is invalid, the failure reason should be returned.
///
/// NOTE: This trait must be deterministic, as it is used in consensus-critical code paths.
pub trait ClaimProofVerifier {
    fn verify_claim_proof(
        &self,
        epoch: Epoch,
        claimant: &RistrettoPublicKeyBytes,
        claim: &MinotariBurnClaimProof,
    ) -> Result<(), String>;
}