mhinprotocol 0.2.3

Reference Rust implementation of the MY HASH IS NICE (MHIN) protocol.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

use crate::types::{Amount, UtxoKey};

/// Abstraction over the persistence layer used by `MhinProtocol`.
///
/// Any backend that can read and write MHIN balances using the provided key can
/// be used. Higher-level lifecycle management (transactions, staging, etc.) is
/// left to concrete implementations.
pub trait MhinStore {
    /// Fetches the MHIN balance attached to a given UTXO key.
    fn get(&mut self, key: &UtxoKey) -> Amount;

    /// Removes the entry for the UTXO key, returning its current MHIN balance.
    /// Implementations should return `0` if the key is not present.
    fn pop(&mut self, key: &UtxoKey) -> Amount;

    /// Sets the MHIN balance assigned to a UTXO key.
    fn set(&mut self, key: UtxoKey, value: Amount);
}