CCF
Loading...
Searching...
No Matches
kv_types.h
Go to the documentation of this file.
1// Copyright (c) Microsoft Corporation. All rights reserved.
2// Licensed under the Apache 2.0 License.
3#pragma once
4
5#include "ccf/claims_digest.h"
7#include "ccf/crypto/pem.h"
8#include "ccf/ds/nonstd.h"
9#include "ccf/entity_id.h"
10#include "ccf/kv/get_name.h"
11#include "ccf/kv/hooks.h"
12#include "ccf/kv/version.h"
16#include "ccf/tx_id.h"
19#include "serialiser_declare.h"
20
21#include <array>
22#include <chrono>
23#include <functional>
24#include <limits>
25#include <list>
26#include <memory>
27#include <set>
28#include <string>
29#include <unordered_set>
30#include <vector>
31
32namespace ccf
33{
34 struct PrimarySignature;
35}
36
37namespace ccf::kv
38{
39 // Term describes an epoch of Versions. It is incremented when global kv's
40 // writer(s) changes. Term and Version combined give a unique identifier for
41 // all accepted kv modifications. Terms are handled by Consensus via the
42 // TermHistory
43 using Term = uint64_t;
45
46 using ReconfigurationId = uint64_t;
47
49 {
50 struct NodeInfo
51 {
52 std::string hostname;
53 std::string port;
54
55 NodeInfo() = default;
56
57 NodeInfo(std::string hostname_, std::string port_) :
58 hostname(std::move(hostname_)),
59 port(std::move(port_))
60 {}
61
62 bool operator==(const NodeInfo& other) const
63 {
64 return hostname == other.hostname && port == other.port;
65 }
66 };
67
68 using Nodes = std::map<NodeId, NodeInfo>;
69
73 };
74
75 inline void to_json(nlohmann::json& j, const Configuration::NodeInfo& ni)
76 {
77 j["address"] = fmt::format("{}:{}", ni.hostname, ni.port);
78 }
79
80 inline void from_json(const nlohmann::json& j, Configuration::NodeInfo& ni)
81 {
82 const std::string addr(j["address"]);
83 const auto& [h, p] = ccf::nonstd::split_1(addr, ":");
84 ni.hostname = h;
85 ni.port = p;
86 }
87
88 inline std::string schema_name(const Configuration::NodeInfo* /*unused*/)
89 {
90 return "Configuration__NodeInfo";
91 }
92
93 inline void fill_json_schema(
94 nlohmann::json& schema, const Configuration::NodeInfo* /*unused*/)
95 {
96 schema["type"] = "object";
97 schema["required"] = nlohmann::json::array();
98 schema["required"].push_back("address");
99 schema["properties"] = nlohmann::json::object();
100 schema["properties"]["address"] = nlohmann::json::object();
101 schema["properties"]["address"]["$ref"] = "#/components/schemas/string";
102 }
103
104 enum class LeadershipState : uint8_t
105 {
106 None,
107 Leader,
108 Follower,
110 Candidate,
111 };
112
115 {{LeadershipState::None, "None"},
116 {LeadershipState::Leader, "Leader"},
117 {LeadershipState::Follower, "Follower"},
118 {LeadershipState::PreVoteCandidate, "PreVoteCandidate"},
119 {LeadershipState::Candidate, "Candidate"}});
120
121 enum class MembershipState : uint8_t
122 {
123 Active,
124 Retired
125 };
126
129 {{MembershipState::Active, "Active"},
130 {MembershipState::Retired, "Retired"}});
131
132 enum class RetirementPhase : uint8_t
133 {
134 Ordered = 1,
135 Signed = 2,
136 Completed = 3,
138 };
139
142 {{RetirementPhase::Ordered, "Ordered"},
143 {RetirementPhase::Signed, "Signed"},
144 {RetirementPhase::Completed, "Completed"},
145 {RetirementPhase::RetiredCommitted, "RetiredCommitted"}});
146
149
151 {
152 struct Ack
153 {
156 };
157
158 std::vector<Configuration> configs;
159 std::unordered_map<ccf::NodeId, Ack> acks;
161 std::optional<LeadershipState> leadership_state = std::nullopt;
162 std::optional<RetirementPhase> retirement_phase = std::nullopt;
163 std::optional<std::unordered_map<ccf::NodeId, ccf::SeqNo>> learners =
164 std::nullopt;
165 std::optional<ccf::ReconfigurationType> reconfiguration_type = std::nullopt;
166 std::optional<ccf::NodeId> primary_id = std::nullopt;
168 bool ticking = false;
169 };
170
173
177 configs,
178 acks,
179 membership_state,
180 primary_id,
181 current_view,
182 ticking);
185 reconfiguration_type,
186 learners,
187 leadership_state,
188 retirement_phase);
189
191 {
192 public:
193 virtual ~ConfigurableConsensus() = default;
194 virtual void add_configuration(
195 ccf::SeqNo seqno, const Configuration::Nodes& conf) = 0;
198 const = 0;
200 };
201
202 using BatchVector = std::vector<std::tuple<
203 Version,
204 std::shared_ptr<std::vector<uint8_t>>,
205 bool,
206 std::shared_ptr<ConsensusHookPtrs>>>;
207
208 enum CommitResult : uint8_t
209 {
213 };
214
215 enum SecurityDomain : uint8_t
216 {
217 PUBLIC, // Public domain indicates the version and always appears first
220 };
221
228
238
239 static bool has_claims(const EntryType& et)
240 {
241 return et == EntryType::WriteSetWithClaims ||
243 }
244
245 static bool has_commit_evidence(const EntryType& et)
246 {
249 }
250
251 // EntryType must be backwards compatible with the older
252 // bool is_snapshot field
253 static_assert(sizeof(EntryType) == sizeof(bool));
254
255 constexpr auto public_domain_prefix = "public:";
256
257 static inline SecurityDomain get_security_domain(const std::string& name)
258 {
259 if (name.starts_with(public_domain_prefix))
260 {
262 }
263
265 }
266
267 static inline std::pair<SecurityDomain, AccessCategory> parse_map_name(
268 std::string_view name)
269 {
270 constexpr auto internal_category_prefix = "ccf.internal.";
271 constexpr auto governance_category_prefix = "ccf.gov.";
272 constexpr auto reserved_category_prefix = "ccf.";
273
274 auto security_domain = SecurityDomain::PRIVATE;
275 if (name.starts_with(public_domain_prefix))
276 {
277 name.remove_prefix(strlen(public_domain_prefix));
278 security_domain = SecurityDomain::PUBLIC;
279 }
280
281 auto access_category = AccessCategory::APPLICATION;
282 if (name.starts_with(internal_category_prefix))
283 {
284 access_category = AccessCategory::INTERNAL;
285 }
286 else if (name.starts_with(governance_category_prefix))
287 {
288 access_category = AccessCategory::GOVERNANCE;
289 }
290 else if (name.starts_with(reserved_category_prefix))
291 {
292 throw std::logic_error(fmt::format(
293 "Map name '{}' includes disallowed reserved prefix '{}'",
294 name,
295 reserved_category_prefix));
296 }
297
298 return {security_domain, access_category};
299 }
300
313
314 class KvSerialiserException : public std::exception
315 {
316 private:
317 std::string msg;
318
319 public:
320 KvSerialiserException(std::string msg_) : msg(std::move(msg_)) {}
321
322 [[nodiscard]] const char* what() const noexcept override
323 {
324 return msg.c_str();
325 }
326 };
327
329 {
330 public:
331 virtual ~TxHistory() = default;
332 virtual bool verify_root_signatures(ccf::kv::Version version) = 0;
333 virtual void try_emit_signature() = 0;
334 virtual void emit_signature() = 0;
336 virtual std::tuple<
337 ccf::TxID /* TxID of last transaction seen by history */,
338 ccf::crypto::Sha256Hash /* root as of TxID */,
339 ccf::kv::Term /* term_of_next_version */>
341 virtual std::vector<uint8_t> get_proof(Version v) = 0;
342 virtual bool verify_proof(const std::vector<uint8_t>& proof) = 0;
343 virtual bool init_from_snapshot(
344 const std::vector<uint8_t>& hash_at_snapshot) = 0;
345 virtual std::vector<uint8_t> get_raw_leaf(uint64_t index) = 0;
346 virtual void append(const std::vector<uint8_t>& data) = 0;
347 virtual void append_entry(
348 const ccf::crypto::Sha256Hash& digest,
349 std::optional<ccf::kv::Term> expected_term = std::nullopt) = 0;
350 virtual void rollback(
351 const ccf::TxID& tx_id, ccf::kv::Term term_of_next_version_) = 0;
352 virtual void compact(Version v) = 0;
353 virtual void set_term(ccf::kv::Term) = 0;
354 virtual std::vector<uint8_t> serialise_tree(size_t to) = 0;
355 virtual void set_endorsed_certificate(const ccf::crypto::Pem& cert) = 0;
356 virtual void start_signature_emit_timer() = 0;
358 std::shared_ptr<ccf::crypto::ECKeyPair_OpenSSL> keypair,
359 const COSESignaturesConfig& cose_signatures) = 0;
361 };
362
364 {
365 public:
366 ~Consensus() override = default;
367
368 virtual NodeId id() = 0;
369 virtual bool is_primary() = 0;
370 virtual bool is_backup() = 0;
371 virtual bool is_candidate() = 0;
372 virtual bool can_replicate() = 0;
373 virtual bool is_at_max_capacity() = 0;
374
375 enum class SignatureDisposition : uint8_t
376 {
378 CAN_SIGN,
380 };
382
383 virtual void force_become_primary() = 0;
385 ccf::SeqNo, ccf::View, const std::vector<ccf::SeqNo>&, ccf::SeqNo) = 0;
386 virtual void init_as_backup(
387 ccf::SeqNo, ccf::View, const std::vector<ccf::SeqNo>&, ccf::SeqNo) = 0;
388
389 virtual bool replicate(const BatchVector& entries, ccf::View view) = 0;
390 virtual std::pair<ccf::View, ccf::SeqNo> get_committed_txid() = 0;
391
393 virtual ccf::View get_view() = 0;
394 virtual std::vector<ccf::SeqNo> get_view_history(
395 ccf::SeqNo seqno = std::numeric_limits<ccf::SeqNo>::max()) = 0;
396 virtual std::vector<ccf::SeqNo> get_view_history_since(
397 ccf::SeqNo seqno) = 0;
399 virtual std::optional<NodeId> primary() = 0;
400
401 virtual void recv_message(
402 const NodeId& from, const uint8_t* data, size_t size) = 0;
403
404 virtual void periodic(std::chrono::milliseconds /*elapsed*/) {}
405 virtual void periodic_end() {}
406
407 virtual void enable_all_domains() {}
408
410 ccf::SeqNo /*seqno*/, const std::vector<NodeId>& node_ids)
411 {}
412
413 virtual void nominate_successor() {};
414 };
415
417 {
419 std::vector<uint8_t> data;
422 std::vector<ConsensusHookPtr> hooks;
423
425 CommitResult success_,
426 std::vector<uint8_t>&& data_,
427 ccf::ClaimsDigest&& claims_digest_,
428 ccf::crypto::Sha256Hash&& commit_evidence_digest_,
429 std::vector<ConsensusHookPtr>&& hooks_) :
430 success(success_),
431 data(std::move(data_)),
432 claims_digest(claims_digest_),
433 commit_evidence_digest(commit_evidence_digest_),
434 hooks(std::move(hooks_))
435 {}
436 };
437
439 {
440 public:
441 virtual PendingTxInfo call() = 0;
442 virtual ~PendingTx() = default;
443 };
444
446 {
447 private:
448 std::vector<uint8_t> data;
449 ccf::ClaimsDigest claims_digest;
450 ccf::crypto::Sha256Hash commit_evidence_digest;
451 ConsensusHookPtrs hooks;
452
453 public:
455 std::vector<uint8_t>&& data_,
456 ccf::ClaimsDigest&& claims_digest_,
457 ccf::crypto::Sha256Hash&& commit_evidence_digest_,
458 ConsensusHookPtrs&& hooks_) :
459 data(std::move(data_)),
460 claims_digest(std::move(claims_digest_)),
461 commit_evidence_digest(std::move(commit_evidence_digest_)),
462 hooks(std::move(hooks_))
463 {}
464
466 {
467 return {
469 std::move(data),
470 std::move(claims_digest),
471 std::move(commit_evidence_digest),
472 std::move(hooks)};
473 }
474 };
475
477 {
478 public:
479 virtual ~AbstractTxEncryptor() = default;
480
481 virtual bool encrypt(
482 const std::vector<uint8_t>& plain,
483 const std::vector<uint8_t>& additional_data,
484 std::vector<uint8_t>& serialised_header,
485 std::vector<uint8_t>& cipher,
486 const ccf::TxID& tx_id,
487 EntryType entry_type = EntryType::WriteSet,
488 bool historical_hint = false) = 0;
489 virtual bool decrypt(
490 const std::vector<uint8_t>& cipher,
491 const std::vector<uint8_t>& additional_data,
492 const std::vector<uint8_t>& serialised_header,
493 std::vector<uint8_t>& plain,
494 Version version,
495 Term& term,
496 bool historical_hint = false) = 0;
497
498 virtual void rollback(Version version) = 0;
499
500 virtual size_t get_header_length() = 0;
501 virtual uint64_t get_term(const uint8_t* data, size_t size) = 0;
502
504 const ccf::TxID& tx_id, bool historical_hint = false) = 0;
505 };
506 using EncryptorPtr = std::shared_ptr<AbstractTxEncryptor>;
507
509 {
510 public:
511 virtual ~AbstractSnapshotter() = default;
512
514 virtual void commit(ccf::kv::Version v, bool generate_snapshot) = 0;
515 virtual void rollback(ccf::kv::Version v) = 0;
516 };
517 using SnapshotterPtr = std::shared_ptr<AbstractSnapshotter>;
518
520 {
521 public:
522 virtual ~AbstractChangeSet() = default;
523
524 [[nodiscard]] virtual bool has_writes() const = 0;
525 };
526
528 {
529 public:
530 virtual ~AbstractCommitter() = default;
531
532 virtual bool has_writes() = 0;
533 virtual bool prepare() = 0;
534 virtual void commit(Version v, bool track_deletes_on_missing_keys) = 0;
536 };
537
538 class AbstractStore;
539 class AbstractMap : public std::enable_shared_from_this<AbstractMap>,
540 public GetName
541 {
542 public:
544 {
545 public:
546 virtual ~Snapshot() = default;
547 virtual void serialise(KvStoreSerialiser& s) = 0;
548 [[nodiscard]] virtual SecurityDomain get_security_domain() const = 0;
549 };
550
551 using GetName::GetName;
552 ~AbstractMap() override = default;
553
554 virtual std::unique_ptr<AbstractCommitter> create_committer(
555 AbstractChangeSet* changes) = 0;
556
557 virtual AbstractStore* get_store() = 0;
558 virtual void serialise_changes(
559 const AbstractChangeSet* changes,
561 bool include_reads) = 0;
562 virtual void compact(Version v) = 0;
563 virtual std::unique_ptr<Snapshot> snapshot(Version v) = 0;
564 virtual void post_compact() = 0;
565 virtual void rollback(Version v) = 0;
566 virtual void lock() = 0;
567 virtual void unlock() = 0;
569 virtual void clear() = 0;
570
571 virtual AbstractMap* clone(AbstractStore* store) = 0;
572 virtual void swap(AbstractMap* map) = 0;
573 };
574
575 class Tx;
576
578 {
579 public:
580 virtual ~AbstractExecutionWrapper() = default;
582 bool track_deletes_on_missing_keys = false) = 0;
584 virtual const std::vector<uint8_t>& get_entry() = 0;
585 virtual ccf::kv::Term get_term() = 0;
587 virtual bool support_async_execution() = 0;
588 virtual bool is_public_only() = 0;
590 virtual std::optional<ccf::crypto::Sha256Hash>&&
592
593 // Setting a short rollback is a work around that should be fixed
594 // shortly. In BFT mode when we deserialize and realize we need to
595 // create a new map we remember this. If we need to create the same
596 // map multiple times (for tx in the same group of append entries) the
597 // first create successes but the second fails because the map is
598 // already there. This works around the problem by stopping just
599 // before the 2nd create (which failed at this point) and when the
600 // primary resends the append entries we will succeed as the map is
601 // already there. This will only occur on BFT startup so not a perf
602 // problem but still need to be resolved.
603 //
604 // Thus, a large rollback is one which did not result from the map creating
605 // issue. https://github.com/microsoft/CCF/issues/2799
607 };
608
610 {
611 public:
613 {
614 public:
615 virtual ~AbstractSnapshot() = default;
616 [[nodiscard]] virtual Version get_version() const = 0;
617 virtual std::vector<uint8_t> serialise(
618 const std::shared_ptr<AbstractTxEncryptor>& encryptor) = 0;
619 };
620
621 virtual ~AbstractStore() = default;
622
623 virtual void lock_map_set() = 0;
624 virtual void unlock_map_set() = 0;
625
626 virtual Version next_version() = 0;
627 virtual std::tuple<Version, Version> next_version(bool commit_new_map) = 0;
628 virtual ccf::TxID next_txid() = 0;
629
631 virtual ccf::TxID current_txid() = 0;
632 virtual std::pair<ccf::TxID, Term> current_txid_and_commit_term() = 0;
633
635 virtual Term commit_view() = 0;
636
637 virtual std::shared_ptr<AbstractMap> get_map(
638 Version v, const std::string& map_name) = 0;
639 virtual std::shared_ptr<AbstractMap> get_map_unsafe(
640 Version v, const std::string& map_name) = 0;
641 virtual void add_dynamic_map(
642 Version v, const std::shared_ptr<AbstractMap>& map) = 0;
643
644 virtual std::shared_ptr<Consensus> get_consensus() = 0;
645 virtual std::shared_ptr<TxHistory> get_history() = 0;
646 virtual std::shared_ptr<ILedgerChunker> get_chunker() = 0;
648 virtual std::unique_ptr<AbstractExecutionWrapper> deserialize(
649 const std::vector<uint8_t>& data,
650 bool public_only = false,
651 const std::optional<ccf::TxID>& expected_txid = std::nullopt) = 0;
652 virtual void compact(Version v) = 0;
653 virtual void rollback(const ccf::TxID& tx_id, Term write_term_) = 0;
654 virtual void initialise_term(Term t) = 0;
656 const ccf::TxID& txid,
657 std::unique_ptr<PendingTx> pending_tx,
658 bool globally_committable) = 0;
659 virtual bool check_rollback_count(Version count) = 0;
660
661 virtual std::unique_ptr<AbstractSnapshot> snapshot_unsafe_maps(
662 Version v) = 0;
663 virtual void lock_maps() = 0;
664 virtual void unlock_maps() = 0;
665 virtual std::vector<uint8_t> serialise_snapshot(
666 std::unique_ptr<AbstractSnapshot> snapshot) = 0;
668 const uint8_t* data,
669 size_t size,
670 ConsensusHookPtrs& hooks,
671 std::vector<Version>* view_history = nullptr,
672 bool public_only = false) = 0;
673 virtual bool should_create_ledger_chunk(Version version) = 0;
675
676 virtual size_t committable_gap() = 0;
677
678 enum class StoreFlag : uint8_t
679 {
681 };
682
683 virtual void set_flag(StoreFlag f) = 0;
684 virtual void unset_flag(StoreFlag f) = 0;
685 virtual bool flag_enabled(StoreFlag f) = 0;
686 virtual void set_flag_unsafe(StoreFlag f) = 0;
687 virtual void unset_flag_unsafe(StoreFlag f) = 0;
688 [[nodiscard]] virtual bool flag_enabled_unsafe(StoreFlag f) const = 0;
689 };
690
691 template <class StorePointer>
693 {
694 public:
696 ScopedStoreMapsLock(StorePointer _store) : store(std::move(_store))
697 {
698 store->lock_maps();
699 }
701 {
702 store->unlock_maps();
703 }
704
705 private:
706 StorePointer store;
707 };
708
709}
710
711FMT_BEGIN_NAMESPACE
712
713template <>
714struct formatter<ccf::kv::Configuration::Nodes>
715{
716 template <typename ParseContext>
717 constexpr auto parse(ParseContext& ctx)
718 {
719 return ctx.begin();
720 }
721
722 template <typename FormatContext>
723 auto format(const ccf::kv::Configuration::Nodes& nodes, FormatContext& ctx)
724 const -> decltype(ctx.out())
725 {
726 std::set<ccf::NodeId> node_ids;
727 for (const auto& [nid, _] : nodes)
728 {
729 node_ids.insert(nid);
730 }
731 return fmt::format_to(ctx.out(), "{{{}}}", fmt::join(node_ids, " "));
732 }
733};
734
735template <>
736struct formatter<ccf::kv::MembershipState>
737{
738 template <typename ParseContext>
739 constexpr auto parse(ParseContext& ctx)
740 {
741 return ctx.begin();
742 }
743
744 template <typename FormatContext>
745 auto format(const ccf::kv::MembershipState& state, FormatContext& ctx) const
746 -> decltype(ctx.out())
747 {
748 const auto s = nlohmann::json(state).get<std::string>();
749 return format_to(ctx.out(), "{}", s);
750 }
751};
752
753template <>
754struct formatter<ccf::kv::LeadershipState>
755{
756 template <typename ParseContext>
757 constexpr auto parse(ParseContext& ctx)
758 {
759 return ctx.begin();
760 }
761
762 template <typename FormatContext>
763 auto format(const ccf::kv::LeadershipState& state, FormatContext& ctx) const
764 -> decltype(ctx.out())
765 {
766 const auto s = nlohmann::json(state).get<std::string>();
767 return format_to(ctx.out(), "{}", s);
768 }
769};
770
771FMT_END_NAMESPACE
Definition claims_digest.h:10
Definition pem.h:18
Definition sha256_hash.h:16
Definition kv_types.h:520
virtual bool has_writes() const =0
virtual ~AbstractChangeSet()=default
Definition kv_types.h:528
virtual bool prepare()=0
virtual void commit(Version v, bool track_deletes_on_missing_keys)=0
virtual ConsensusHookPtr post_commit()=0
virtual ~AbstractCommitter()=default
virtual bool has_writes()=0
Definition kv_types.h:578
virtual ccf::kv::ConsensusHookPtrs & get_hooks()=0
virtual ccf::kv::ApplyResult apply(bool track_deletes_on_missing_keys=false)=0
virtual ~AbstractExecutionWrapper()=default
virtual bool should_rollback_to_last_committed()=0
virtual std::optional< ccf::crypto::Sha256Hash > && consume_commit_evidence_digest()=0
virtual const std::vector< uint8_t > & get_entry()=0
virtual ccf::kv::Term get_term()=0
virtual bool support_async_execution()=0
virtual ccf::ClaimsDigest && consume_claims_digest()=0
virtual ccf::kv::Version get_index()=0
Definition kv_types.h:544
virtual void serialise(KvStoreSerialiser &s)=0
virtual SecurityDomain get_security_domain() const =0
Definition kv_types.h:541
virtual void clear()=0
virtual std::unique_ptr< Snapshot > snapshot(Version v)=0
virtual SecurityDomain get_security_domain()=0
virtual AbstractStore * get_store()=0
~AbstractMap() override=default
virtual std::unique_ptr< AbstractCommitter > create_committer(AbstractChangeSet *changes)=0
virtual AbstractMap * clone(AbstractStore *store)=0
virtual void post_compact()=0
virtual void lock()=0
virtual void serialise_changes(const AbstractChangeSet *changes, KvStoreSerialiser &s, bool include_reads)=0
virtual void compact(Version v)=0
virtual void rollback(Version v)=0
virtual void swap(AbstractMap *map)=0
virtual void unlock()=0
Definition kv_types.h:509
virtual void rollback(ccf::kv::Version v)=0
virtual bool record_committable(ccf::kv::Version v)=0
virtual void commit(ccf::kv::Version v, bool generate_snapshot)=0
virtual ~AbstractSnapshotter()=default
virtual std::vector< uint8_t > serialise(const std::shared_ptr< AbstractTxEncryptor > &encryptor)=0
virtual Version get_version() const =0
Definition kv_types.h:610
virtual std::unique_ptr< AbstractSnapshot > snapshot_unsafe_maps(Version v)=0
virtual CommitResult commit(const ccf::TxID &txid, std::unique_ptr< PendingTx > pending_tx, bool globally_committable)=0
virtual bool flag_enabled_unsafe(StoreFlag f) const =0
virtual ccf::TxID next_txid()=0
StoreFlag
Definition kv_types.h:679
virtual std::shared_ptr< TxHistory > get_history()=0
virtual std::shared_ptr< AbstractMap > get_map(Version v, const std::string &map_name)=0
virtual EncryptorPtr get_encryptor()=0
virtual void add_dynamic_map(Version v, const std::shared_ptr< AbstractMap > &map)=0
virtual bool should_create_ledger_chunk_unsafe(Version version)=0
virtual void set_flag_unsafe(StoreFlag f)=0
virtual void compact(Version v)=0
virtual std::pair< ccf::TxID, Term > current_txid_and_commit_term()=0
virtual bool should_create_ledger_chunk(Version version)=0
virtual std::shared_ptr< Consensus > get_consensus()=0
virtual void lock_map_set()=0
virtual std::shared_ptr< AbstractMap > get_map_unsafe(Version v, const std::string &map_name)=0
virtual bool flag_enabled(StoreFlag f)=0
virtual void unlock_map_set()=0
virtual std::unique_ptr< AbstractExecutionWrapper > deserialize(const std::vector< uint8_t > &data, bool public_only=false, const std::optional< ccf::TxID > &expected_txid=std::nullopt)=0
virtual size_t committable_gap()=0
virtual void unset_flag(StoreFlag f)=0
virtual void lock_maps()=0
virtual Version current_version()=0
virtual Term commit_view()=0
virtual Version next_version()=0
virtual void set_flag(StoreFlag f)=0
virtual bool check_rollback_count(Version count)=0
virtual std::shared_ptr< ILedgerChunker > get_chunker()=0
virtual std::vector< uint8_t > serialise_snapshot(std::unique_ptr< AbstractSnapshot > snapshot)=0
virtual Version compacted_version()=0
virtual void rollback(const ccf::TxID &tx_id, Term write_term_)=0
virtual void unlock_maps()=0
virtual ~AbstractStore()=default
virtual ApplyResult deserialise_snapshot(const uint8_t *data, size_t size, ConsensusHookPtrs &hooks, std::vector< Version > *view_history=nullptr, bool public_only=false)=0
virtual void initialise_term(Term t)=0
virtual void unset_flag_unsafe(StoreFlag f)=0
virtual std::tuple< Version, Version > next_version(bool commit_new_map)=0
virtual ccf::TxID current_txid()=0
Definition kv_types.h:477
virtual ~AbstractTxEncryptor()=default
virtual bool decrypt(const std::vector< uint8_t > &cipher, const std::vector< uint8_t > &additional_data, const std::vector< uint8_t > &serialised_header, std::vector< uint8_t > &plain, Version version, Term &term, bool historical_hint=false)=0
virtual size_t get_header_length()=0
virtual bool encrypt(const std::vector< uint8_t > &plain, const std::vector< uint8_t > &additional_data, std::vector< uint8_t > &serialised_header, std::vector< uint8_t > &cipher, const ccf::TxID &tx_id, EntryType entry_type=EntryType::WriteSet, bool historical_hint=false)=0
virtual void rollback(Version version)=0
virtual uint64_t get_term(const uint8_t *data, size_t size)=0
virtual ccf::crypto::HashBytes get_commit_nonce(const ccf::TxID &tx_id, bool historical_hint=false)=0
Definition kv_types.h:191
virtual void add_configuration(ccf::SeqNo seqno, const Configuration::Nodes &conf)=0
virtual ~ConfigurableConsensus()=default
virtual ConsensusDetails get_details()=0
virtual Configuration::Nodes get_latest_configuration()=0
virtual Configuration::Nodes get_latest_configuration_unsafe() const =0
Definition kv_types.h:364
virtual void enable_all_domains()
Definition kv_types.h:407
virtual void nominate_successor()
Definition kv_types.h:413
virtual std::pair< ccf::View, ccf::SeqNo > get_committed_txid()=0
virtual bool is_candidate()=0
virtual ccf::SeqNo get_committed_seqno()=0
virtual bool can_replicate()=0
virtual void periodic_end()
Definition kv_types.h:405
~Consensus() override=default
virtual void init_as_backup(ccf::SeqNo, ccf::View, const std::vector< ccf::SeqNo > &, ccf::SeqNo)=0
virtual std::vector< ccf::SeqNo > get_view_history(ccf::SeqNo seqno=std::numeric_limits< ccf::SeqNo >::max())=0
virtual void recv_message(const NodeId &from, const uint8_t *data, size_t size)=0
virtual bool is_primary()=0
virtual NodeId id()=0
virtual std::optional< NodeId > primary()=0
virtual void force_become_primary(ccf::SeqNo, ccf::View, const std::vector< ccf::SeqNo > &, ccf::SeqNo)=0
virtual bool replicate(const BatchVector &entries, ccf::View view)=0
virtual void set_retired_committed(ccf::SeqNo, const std::vector< NodeId > &node_ids)
Definition kv_types.h:409
virtual void force_become_primary()=0
virtual bool is_at_max_capacity()=0
virtual SignatureDisposition get_signature_disposition()=0
virtual void periodic(std::chrono::milliseconds)
Definition kv_types.h:404
SignatureDisposition
Definition kv_types.h:376
virtual ccf::View get_view(ccf::SeqNo seqno)=0
virtual std::vector< ccf::SeqNo > get_view_history_since(ccf::SeqNo seqno)=0
virtual ccf::View get_view()=0
virtual bool is_backup()=0
Definition generic_serialise_wrapper.h:20
Definition kv_types.h:315
KvSerialiserException(std::string msg_)
Definition kv_types.h:320
const char * what() const noexcept override
Definition kv_types.h:322
Definition kv_types.h:446
MovePendingTx(std::vector< uint8_t > &&data_, ccf::ClaimsDigest &&claims_digest_, ccf::crypto::Sha256Hash &&commit_evidence_digest_, ConsensusHookPtrs &&hooks_)
Definition kv_types.h:454
PendingTxInfo call() override
Definition kv_types.h:465
Definition kv_types.h:439
virtual ~PendingTx()=default
virtual PendingTxInfo call()=0
Definition kv_types.h:693
ScopedStoreMapsLock(StorePointer _store)
Definition kv_types.h:696
~ScopedStoreMapsLock()
Definition kv_types.h:700
Definition kv_types.h:329
virtual void compact(Version v)=0
virtual void set_term(ccf::kv::Term)=0
virtual std::vector< uint8_t > get_proof(Version v)=0
virtual void emit_signature()=0
virtual const ccf::COSESignaturesConfig & get_cose_signatures_config()=0
virtual bool verify_root_signatures(ccf::kv::Version version)=0
virtual bool init_from_snapshot(const std::vector< uint8_t > &hash_at_snapshot)=0
virtual std::vector< uint8_t > serialise_tree(size_t to)=0
virtual std::vector< uint8_t > get_raw_leaf(uint64_t index)=0
virtual void set_service_signing_identity(std::shared_ptr< ccf::crypto::ECKeyPair_OpenSSL > keypair, const COSESignaturesConfig &cose_signatures)=0
virtual void try_emit_signature()=0
virtual ccf::crypto::Sha256Hash get_replicated_state_root()=0
virtual void append_entry(const ccf::crypto::Sha256Hash &digest, std::optional< ccf::kv::Term > expected_term=std::nullopt)=0
virtual void append(const std::vector< uint8_t > &data)=0
virtual void start_signature_emit_timer()=0
virtual bool verify_proof(const std::vector< uint8_t > &proof)=0
virtual void rollback(const ccf::TxID &tx_id, ccf::kv::Term term_of_next_version_)=0
virtual std::tuple< ccf::TxID, ccf::crypto::Sha256Hash, ccf::kv::Term > get_replicated_state_txid_and_root()=0
virtual ~TxHistory()=default
virtual void set_endorsed_certificate(const ccf::crypto::Pem &cert)=0
Definition tx.h:200
#define DECLARE_JSON_REQUIRED_FIELDS(TYPE,...)
Definition json.h:718
#define DECLARE_JSON_TYPE(TYPE)
Definition json.h:667
#define DECLARE_JSON_TYPE_WITH_OPTIONAL_FIELDS(TYPE)
Definition json.h:694
#define DECLARE_JSON_OPTIONAL_FIELDS(TYPE,...)
Definition json.h:790
#define DECLARE_JSON_ENUM(TYPE,...)
Definition json.h:841
std::vector< uint8_t > HashBytes
Definition hash_bytes.h:10
Definition app_interface.h:19
std::shared_ptr< AbstractTxEncryptor > EncryptorPtr
Definition kv_types.h:506
std::string schema_name(const Configuration::NodeInfo *)
Definition kv_types.h:88
AccessCategory
Definition kv_types.h:223
@ INTERNAL
Definition kv_types.h:224
@ APPLICATION
Definition kv_types.h:226
@ GOVERNANCE
Definition kv_types.h:225
uint64_t Term
Definition kv_types.h:43
std::unique_ptr< ConsensusHook > ConsensusHookPtr
Definition hooks.h:21
EntryType
Definition kv_types.h:230
@ WriteSetWithCommitEvidenceAndClaims
std::vector< std::tuple< Version, std::shared_ptr< std::vector< uint8_t > >, bool, std::shared_ptr< ConsensusHookPtrs > > > BatchVector
Definition kv_types.h:206
CommitResult
Definition kv_types.h:209
@ FAIL_NO_REPLICATE
Definition kv_types.h:212
@ SUCCESS
Definition kv_types.h:210
@ FAIL_CONFLICT
Definition kv_types.h:211
SecurityDomain
Definition kv_types.h:216
@ SECURITY_DOMAIN_MAX
Definition kv_types.h:219
@ PRIVATE
Definition kv_types.h:218
@ PUBLIC
Definition kv_types.h:217
uint64_t Version
Definition version.h:8
MembershipState
Definition kv_types.h:122
std::shared_ptr< AbstractSnapshotter > SnapshotterPtr
Definition kv_types.h:517
RetirementPhase
Definition kv_types.h:133
void fill_json_schema(nlohmann::json &schema, const Configuration::NodeInfo *)
Definition kv_types.h:93
uint64_t ReconfigurationId
Definition kv_types.h:46
LeadershipState
Definition kv_types.h:105
constexpr auto public_domain_prefix
Definition kv_types.h:255
void to_json(nlohmann::json &j, const Configuration::NodeInfo &ni)
Definition kv_types.h:75
ApplyResult
Definition kv_types.h:302
@ PASS_NONCES
Definition kv_types.h:307
@ PASS_SIGNATURE
Definition kv_types.h:304
@ PASS_BACKUP_SIGNATURE
Definition kv_types.h:305
@ PASS_BACKUP_SIGNATURE_SEND_ACK
Definition kv_types.h:306
@ FAIL
Definition kv_types.h:311
@ PASS
Definition kv_types.h:303
@ PASS_APPLY
Definition kv_types.h:310
@ PASS_ENCRYPTED_PAST_LEDGER_SECRET
Definition kv_types.h:309
@ PASS_NEW_VIEW
Definition kv_types.h:308
std::vector< ConsensusHookPtr > ConsensusHookPtrs
Definition hooks.h:22
void from_json(const nlohmann::json &j, Configuration::NodeInfo &ni)
Definition kv_types.h:80
Definition app_interface.h:14
EntityId< NodeIdFormatter > NodeId
Definition entity_id.h:164
view
Definition signatures.h:54
seqno
Definition signatures.h:54
uint64_t View
Definition tx_id.h:23
uint64_t SeqNo
Definition tx_id.h:36
Definition map_serializers.h:11
STL namespace.
Definition cose_signatures_config.h:12
Definition tx_id.h:44
Definition kv_types.h:51
std::string hostname
Definition kv_types.h:52
bool operator==(const NodeInfo &other) const
Definition kv_types.h:62
NodeInfo(std::string hostname_, std::string port_)
Definition kv_types.h:57
std::string port
Definition kv_types.h:53
Definition kv_types.h:49
ccf::SeqNo idx
Definition kv_types.h:70
std::map< NodeId, NodeInfo > Nodes
Definition kv_types.h:68
ReconfigurationId rid
Definition kv_types.h:72
Nodes nodes
Definition kv_types.h:71
Definition kv_types.h:153
size_t last_received_ms
Definition kv_types.h:155
ccf::SeqNo seqno
Definition kv_types.h:154
Definition kv_types.h:151
bool ticking
Definition kv_types.h:168
std::optional< std::unordered_map< ccf::NodeId, ccf::SeqNo > > learners
Definition kv_types.h:163
std::optional< ccf::ReconfigurationType > reconfiguration_type
Definition kv_types.h:165
std::optional< RetirementPhase > retirement_phase
Definition kv_types.h:162
ccf::View current_view
Definition kv_types.h:167
std::optional< LeadershipState > leadership_state
Definition kv_types.h:161
MembershipState membership_state
Definition kv_types.h:160
std::unordered_map< ccf::NodeId, Ack > acks
Definition kv_types.h:159
std::optional< ccf::NodeId > primary_id
Definition kv_types.h:166
std::vector< Configuration > configs
Definition kv_types.h:158
Definition get_name.h:10
GetName(std::string s)
Definition get_name.h:15
Definition kv_types.h:417
ccf::crypto::Sha256Hash commit_evidence_digest
Definition kv_types.h:421
PendingTxInfo(CommitResult success_, std::vector< uint8_t > &&data_, ccf::ClaimsDigest &&claims_digest_, ccf::crypto::Sha256Hash &&commit_evidence_digest_, std::vector< ConsensusHookPtr > &&hooks_)
Definition kv_types.h:424
std::vector< ConsensusHookPtr > hooks
Definition kv_types.h:422
ccf::ClaimsDigest claims_digest
Definition kv_types.h:420
std::vector< uint8_t > data
Definition kv_types.h:419
CommitResult success
Definition kv_types.h:418
constexpr auto parse(ParseContext &ctx)
Definition kv_types.h:717
auto format(const ccf::kv::Configuration::Nodes &nodes, FormatContext &ctx) const -> decltype(ctx.out())
Definition kv_types.h:723
constexpr auto parse(ParseContext &ctx)
Definition kv_types.h:757
auto format(const ccf::kv::LeadershipState &state, FormatContext &ctx) const -> decltype(ctx.out())
Definition kv_types.h:763
auto format(const ccf::kv::MembershipState &state, FormatContext &ctx) const -> decltype(ctx.out())
Definition kv_types.h:745
constexpr auto parse(ParseContext &ctx)
Definition kv_types.h:739