ccf::kv::TxHistory Class Reference

#include <kv_types.h>

Inherited by ccf::HashedTxHistory< T >, and ccf::NullTxHistory.

Classes
struct	RequestCallbackArgs
struct	ResponseCallbackArgs
struct	ResultCallbackArgs

Public Types
enum class	Result { FAIL = 0 , OK , SEND_SIG_RECEIPT_ACK , SEND_REPLY_AND_NONCE }
using	RequestID = std::tuple< size_t, size_t >

Public Member Functions
virtual	~TxHistory ()
virtual bool	verify_root_signatures (ccf::kv::Version version)=0
virtual void	try_emit_signature ()=0
virtual void	emit_signature ()=0
virtual ccf::crypto::Sha256Hash	get_replicated_state_root ()=0
virtual std::tuple< ccf::kv::TxID, ccf::crypto::Sha256Hash, ccf::kv::Term >	get_replicated_state_txid_and_root ()=0
virtual std::vector< uint8_t >	get_proof (Version v)=0
virtual bool	verify_proof (const std::vector< uint8_t > &proof)=0
virtual bool	init_from_snapshot (const std::vector< uint8_t > &hash_at_snapshot)=0
virtual std::vector< uint8_t >	get_raw_leaf (uint64_t index)=0
virtual void	append (const std::vector< uint8_t > &data)=0
virtual void	append_entry (const ccf::crypto::Sha256Hash &digest, std::optional< ccf::kv::Term > expected_term=std::nullopt)=0
virtual void	rollback (const ccf::kv::TxID &tx_id, ccf::kv::Term term_of_next_version_)=0
virtual void	compact (Version v)=0
virtual void	set_term (ccf::kv::Term)=0
virtual std::vector< uint8_t >	serialise_tree (size_t to)=0
virtual void	set_endorsed_certificate (const ccf::crypto::Pem &cert)=0
virtual void	start_signature_emit_timer ()=0
virtual void	set_service_signing_identity (std::shared_ptr< ccf::crypto::KeyPair_OpenSSL > keypair, const COSESignaturesConfig &cose_signatures)=0
virtual const ccf::COSESignaturesConfig &	get_cose_signatures_config ()=0

Member Typedef Documentation

RequestID

using ccf::kv::TxHistory::RequestID = std::tuple< size_t , size_t >

Member Enumeration Documentation

Result

enum class ccf::kv::TxHistory::Result

strong

Enumerator
FAIL
OK
SEND_SIG_RECEIPT_ACK
SEND_REPLY_AND_NONCE

Constructor & Destructor Documentation

~TxHistory()

virtual ccf::kv::TxHistory::~TxHistory ( )

inlinevirtual

Member Function Documentation

append()

virtual void ccf::kv::TxHistory::append ( const std::vector< uint8_t > &  data )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

append_entry()

virtual void ccf::kv::TxHistory::append_entry ( const ccf::crypto::Sha256Hash &  digest, std::optional< ccf::kv::Term >  expected_term = std::nullopt  )

pure virtual

compact()

virtual void ccf::kv::TxHistory::compact ( Version  v )

pure virtual

Implemented in ccf::HashedTxHistory< T >, and ccf::NullTxHistory.

emit_signature()

virtual void ccf::kv::TxHistory::emit_signature ( )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

get_cose_signatures_config()

virtual const ccf::COSESignaturesConfig & ccf::kv::TxHistory::get_cose_signatures_config ( )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

get_proof()

virtual std::vector< uint8_t > ccf::kv::TxHistory::get_proof ( Version  v )

pure virtual

Implemented in ccf::HashedTxHistory< T >, and ccf::NullTxHistory.

get_raw_leaf()

virtual std::vector< uint8_t > ccf::kv::TxHistory::get_raw_leaf ( uint64_t  index )

pure virtual

Implemented in ccf::HashedTxHistory< T >, and ccf::NullTxHistory.

get_replicated_state_root()

virtual ccf::crypto::Sha256Hash ccf::kv::TxHistory::get_replicated_state_root ( )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

get_replicated_state_txid_and_root()

virtual std::tuple< ccf::kv::TxID, ccf::crypto::Sha256Hash, ccf::kv::Term > ccf::kv::TxHistory::get_replicated_state_txid_and_root ( )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

init_from_snapshot()

virtual bool ccf::kv::TxHistory::init_from_snapshot ( const std::vector< uint8_t > &  hash_at_snapshot )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

rollback()

virtual void ccf::kv::TxHistory::rollback ( const ccf::kv::TxID &  tx_id, ccf::kv::Term  term_of_next_version_  )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

serialise_tree()

virtual std::vector< uint8_t > ccf::kv::TxHistory::serialise_tree ( size_t  to )

pure virtual

Implemented in ccf::HashedTxHistory< T >, and ccf::NullTxHistory.

set_endorsed_certificate()

virtual void ccf::kv::TxHistory::set_endorsed_certificate ( const ccf::crypto::Pem &  cert )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

set_service_signing_identity()

virtual void ccf::kv::TxHistory::set_service_signing_identity ( std::shared_ptr< ccf::crypto::KeyPair_OpenSSL >  keypair, const COSESignaturesConfig &  cose_signatures  )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

set_term()

virtual void ccf::kv::TxHistory::set_term ( ccf::kv::Term  )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

start_signature_emit_timer()

virtual void ccf::kv::TxHistory::start_signature_emit_timer ( )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

try_emit_signature()

virtual void ccf::kv::TxHistory::try_emit_signature ( )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

verify_proof()

virtual bool ccf::kv::TxHistory::verify_proof ( const std::vector< uint8_t > &  proof )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

verify_root_signatures()

virtual bool ccf::kv::TxHistory::verify_root_signatures ( ccf::kv::Version  version )

pure virtual

Implemented in ccf::NullTxHistory, and ccf::HashedTxHistory< T >.

---

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

• src/kv/kv_types.h