Crate pchain_types
source ·Expand description
ParallelChain F Protocol Types (pchain-types) defines data structures prescribed by the ParallelChain F Blockchain Protocol. These definitions help Web Applications, clients, and differing implementations of ‘Node’ software developed by different groups communicate with each other and exhibit correct, protocol-specified semantics and behavior.
run cargo doc --open to view rich documentation on the available types.
Re-exports
pub use base64url::*;pub use blanket_impls::*;pub use block::*;pub use consensus::*;pub use constants::*;pub use crypto::*;pub use exit_status::*;pub use keypair::*;pub use proofs::*;pub use stake::*;pub use transaction::*;
Modules
- Implementation of the encode and decode operations (as defined in IETF RFC 4648) on a type Base64URL. It is the only binary-to-text encoding scheme used in ParallelChain F.
- generic types implementation of traits Serializable and Deserializable for common data structures.
- block defines block-related protocol types
- The data structure interfacing with consensus message types in hotstuff_rs for specific purpose, for example, implementing the trait Debug, Serializable and Deserializable.
- The protocol defined constants and parameters used across ParallelChain F components.
- Cryptography-related protocol types, including public addresses, secret keys, signatures, and hashes. In protocol, we uses:
- Defines ExitStatus, an enum included in every Transaction Receipt that provides a succinct way to describe what happened during the execution of the transaction command.
- Keypair Definition and its generation method as well as definition of private and public keys of an account on ParallelChain ecosystem.
- The data structures that are used for verifying a Merkle tree.
- The request-response structures for RPC.
- The data structures relevant to staking operations.
- The data structures relevant to Transactions.
Traits
- Deserializable encapsulates implementation of deserialization on data structures that are defined in pchain-types.
- Serializable encapsulates implementation of serialization on data structures that are defined in pchain-types.