tari_engine 0.31.0

Tari template runtime engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//  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.

mod bootstrap;
pub use bootstrap::*;
pub mod memory;

use std::fmt::Debug;

use tari_engine_types::substate::{Substate, SubstateId};
use tari_ootle_common_types::optional::IsNotFoundError;

pub trait StateReader {
    fn get_state(&self, key: &SubstateId) -> Result<&Substate, StateStoreError>;
    fn exists(&self, key: &SubstateId) -> Result<bool, StateStoreError>;
}

pub trait StateWriter: StateReader {
    fn set_state(&mut self, key: SubstateId, value: Substate) -> Result<(), StateStoreError>;
}

#[derive(Debug, thiserror::Error)]
pub enum StateStoreError {
    #[error("Non existent shard: {shard:?}")]
    NonExistentShard { shard: Vec<u8> },
    #[error("Error: {0}")]
    CustomStr(String),
    #[error("{kind} not found with key {key}")]
    NotFound { kind: &'static str, key: String },
    #[error("Substate has already been destroyed")]
    SubstateDestroyed,
}

impl StateStoreError {
    pub fn custom_str(e: &str) -> Self {
        StateStoreError::CustomStr(e.to_string())
    }
}

impl IsNotFoundError for StateStoreError {
    fn is_not_found_error(&self) -> bool {
        matches!(self, StateStoreError::NotFound { .. })
    }
}