Enum fedimint_ln_common::db::LightningAuditItemKey

pub enum LightningAuditItemKey {
    Incoming(ContractId),
    Outgoing(ContractId),
}

We keep a separate mapping of incoming and outgoing ContractIds to Amounts, which allows us to quickly audit the total liabilities in the Lightning module.

This differs from MintAuditItemKeys, since it doesn’t include an aggregate *Total key. The motivation for not including the aggregate key is how the Amount associated to the contract mutates in the LN module. When a contract reaches a terminal state, the associated amount updates to 0. The additional complexity to update both the individual incoming/outgoing contract audit keys along with the aggregate audit key is not necessary.

In contrast to the mint module, the total number of LN audit keys with a non-zero amount will not grow linearly, so querying the LN audit keys with a non-zero amount should remain quick.

Variants

Incoming(ContractId)

Outgoing(ContractId)

Implementations

impl LightningAuditItemKey

pub fn from_funded_contract(contract: &FundedContract) -> Self

Trait Implementations

impl Clone for LightningAuditItemKey

fn clone(&self) -> LightningAuditItemKey

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DatabaseRecord for LightningAuditItemKey

const DB_PREFIX: u8 = 72u8

type Key = LightningAuditItemKey

type Value = Amount

const NOTIFY_ON_MODIFY: bool = false

impl Debug for LightningAuditItemKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decodable for LightningAuditItemKey

fn consensus_decode<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry ) -> Result<Self, DecodeError>

Decode an object with a well-defined format

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode> ) -> Result<Self, DecodeError>

Decode an object from hex

impl Encodable for LightningAuditItemKey

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Result<Vec<u8>, Error>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> Result<String, Error>

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl PartialEq for LightningAuditItemKey

fn eq(&self, other: &LightningAuditItemKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LightningAuditItemKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LightningAuditItemKey