-
Notifications
You must be signed in to change notification settings - Fork 11.3k
/
Copy pathindex.html
6 lines (6 loc) · 7.93 KB
/
index.html
1
2
3
4
5
6
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `consensus_config` crate."><title>consensus_config - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="consensus_config" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../consensus_config/index.html">consensus_config</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">consensus_config</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/consensus_config/lib.rs.html#4-12">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AnemoParameters.html" title="struct consensus_config::AnemoParameters">AnemoParameters</a></div></li><li><div class="item-name"><a class="struct" href="struct.Authority.html" title="struct consensus_config::Authority">Authority</a></div><div class="desc docblock-short">Represents one authority in the committee.</div></li><li><div class="item-name"><a class="struct" href="struct.AuthorityIndex.html" title="struct consensus_config::AuthorityIndex">AuthorityIndex</a></div><div class="desc docblock-short">Each authority is uniquely identified by its AuthorityIndex in the Committee.
AuthorityIndex is between 0 (inclusive) and the total number of authorities (exclusive).</div></li><li><div class="item-name"><a class="struct" href="struct.AuthorityKeyPair.html" title="struct consensus_config::AuthorityKeyPair">AuthorityKeyPair</a></div></li><li><div class="item-name"><a class="struct" href="struct.AuthorityPublicKey.html" title="struct consensus_config::AuthorityPublicKey">AuthorityPublicKey</a></div><div class="desc docblock-short">Authority key represents the identity of an authority. It is only used for identity sanity
checks and not used for verification.</div></li><li><div class="item-name"><a class="struct" href="struct.Committee.html" title="struct consensus_config::Committee">Committee</a></div><div class="desc docblock-short">Committee is the set of authorities that participate in the consensus protocol for this epoch.
Its configuration is stored and computed on chain.</div></li><li><div class="item-name"><a class="struct" href="struct.NetworkKeyPair.html" title="struct consensus_config::NetworkKeyPair">NetworkKeyPair</a></div></li><li><div class="item-name"><a class="struct" href="struct.NetworkPrivateKey.html" title="struct consensus_config::NetworkPrivateKey">NetworkPrivateKey</a></div></li><li><div class="item-name"><a class="struct" href="struct.NetworkPublicKey.html" title="struct consensus_config::NetworkPublicKey">NetworkPublicKey</a></div><div class="desc docblock-short">Network key is used for TLS and as the network identity of the authority.</div></li><li><div class="item-name"><a class="struct" href="struct.Parameters.html" title="struct consensus_config::Parameters">Parameters</a></div><div class="desc docblock-short">Operational configurations of a consensus authority.</div></li><li><div class="item-name"><a class="struct" href="struct.ProtocolKeyPair.html" title="struct consensus_config::ProtocolKeyPair">ProtocolKeyPair</a></div></li><li><div class="item-name"><a class="struct" href="struct.ProtocolKeySignature.html" title="struct consensus_config::ProtocolKeySignature">ProtocolKeySignature</a></div></li><li><div class="item-name"><a class="struct" href="struct.ProtocolPublicKey.html" title="struct consensus_config::ProtocolPublicKey">ProtocolPublicKey</a></div><div class="desc docblock-short">Protocol key is used for signing blocks and verifying block signatures.</div></li><li><div class="item-name"><a class="struct" href="struct.TonicParameters.html" title="struct consensus_config::TonicParameters">TonicParameters</a></div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.DIGEST_LENGTH.html" title="constant consensus_config::DIGEST_LENGTH">DIGEST_LENGTH</a></div></li><li><div class="item-name"><a class="constant" href="constant.INTENT_MESSAGE_LENGTH.html" title="constant consensus_config::INTENT_MESSAGE_LENGTH">INTENT_MESSAGE_LENGTH</a></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.local_committee_and_keys.html" title="fn consensus_config::local_committee_and_keys">local_committee_and_keys</a></div><div class="desc docblock-short">Creates a committee for local testing, and the corresponding key pairs for the authorities.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.DefaultHashFunction.html" title="type consensus_config::DefaultHashFunction">DefaultHashFunction</a></div><div class="desc docblock-short">Defines algorithm and format of block and commit digests.</div></li><li><div class="item-name"><a class="type" href="type.Epoch.html" title="type consensus_config::Epoch">Epoch</a></div><div class="desc docblock-short">Committee of the consensus protocol is updated each epoch.</div></li><li><div class="item-name"><a class="type" href="type.Stake.html" title="type consensus_config::Stake">Stake</a></div><div class="desc docblock-short">Voting power of an authority, roughly proportional to the actual amount of Sui staked
by the authority.
Total stake / voting power of all authorities should sum to 10,000.</div></li></ul></section></div></main></body></html>