CCF
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ccf::LedgerSecrets Class Reference

#include <ledger_secrets.h>

Public Member Functions

 LedgerSecrets ()=default
 
void init (ccf::kv::Version initial_version=1)
 
void init_from_map (LedgerSecretsMap &&ledger_secrets_)
 
void adjust_previous_secret_stored_version (ccf::kv::Version version)
 
bool is_empty ()
 
VersionedLedgerSecret get_first ()
 
VersionedLedgerSecret get_latest (ccf::kv::ReadOnlyTx &tx)
 
std::pair< VersionedLedgerSecret, std::optional< VersionedLedgerSecret > > get_latest_and_penultimate (ccf::kv::ReadOnlyTx &tx)
 
LedgerSecretsMap get (ccf::kv::ReadOnlyTx &tx, std::optional< ccf::kv::Version > up_to=std::nullopt)
 
void restore_historical (LedgerSecretsMap &&restored_ledger_secrets)
 
std::shared_ptr< ccf::crypto::KeyAesGcmget_encryption_key_for (ccf::kv::Version version, bool historical_hint=false)
 
LedgerSecretPtr get_secret_for (ccf::kv::Version version, bool historical_hint=false)
 
void set_secret (ccf::kv::Version version, LedgerSecretPtr &&secret)
 
void rollback (ccf::kv::Version version)
 

Constructor & Destructor Documentation

◆ LedgerSecrets()

ccf::LedgerSecrets::LedgerSecrets ( )
default

Member Function Documentation

◆ adjust_previous_secret_stored_version()

void ccf::LedgerSecrets::adjust_previous_secret_stored_version ( ccf::kv::Version  version)
inline

◆ get()

LedgerSecretsMap ccf::LedgerSecrets::get ( ccf::kv::ReadOnlyTx tx,
std::optional< ccf::kv::Version up_to = std::nullopt 
)
inline

◆ get_encryption_key_for()

std::shared_ptr< ccf::crypto::KeyAesGcm > ccf::LedgerSecrets::get_encryption_key_for ( ccf::kv::Version  version,
bool  historical_hint = false 
)
inline

◆ get_first()

VersionedLedgerSecret ccf::LedgerSecrets::get_first ( )
inline

◆ get_latest()

VersionedLedgerSecret ccf::LedgerSecrets::get_latest ( ccf::kv::ReadOnlyTx tx)
inline

◆ get_latest_and_penultimate()

std::pair< VersionedLedgerSecret, std::optional< VersionedLedgerSecret > > ccf::LedgerSecrets::get_latest_and_penultimate ( ccf::kv::ReadOnlyTx tx)
inline

◆ get_secret_for()

LedgerSecretPtr ccf::LedgerSecrets::get_secret_for ( ccf::kv::Version  version,
bool  historical_hint = false 
)
inline

◆ init()

void ccf::LedgerSecrets::init ( ccf::kv::Version  initial_version = 1)
inline

◆ init_from_map()

void ccf::LedgerSecrets::init_from_map ( LedgerSecretsMap &&  ledger_secrets_)
inline

◆ is_empty()

bool ccf::LedgerSecrets::is_empty ( )
inline

◆ restore_historical()

void ccf::LedgerSecrets::restore_historical ( LedgerSecretsMap &&  restored_ledger_secrets)
inline

◆ rollback()

void ccf::LedgerSecrets::rollback ( ccf::kv::Version  version)
inline

◆ set_secret()

void ccf::LedgerSecrets::set_secret ( ccf::kv::Version  version,
LedgerSecretPtr &&  secret 
)
inline

The documentation for this class was generated from the following file: