Write top-level Readme.

Author: lyulka

Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "pchain-types"
-version = "0.4.1"
+version = "0.4.2"
 authors = ["ParallelChain Lab <[email protected]>"]
 edition = "2018"
-description = "Types prescribed in the ParallelChain F Blockchain Protocol"
+description = "Data types defined in the ParallelChain Protocol"
 license = "Apache-2.0"
-repository = "https://github.com/parallelchain-io/parallelchain-protocol-types"
+repository = "https://github.com/parallelchain-io/pchain-types-rust"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -17,12 +17,8 @@ hex = "0.4.3"
 rand = "0.7"
 
 [dependencies]
-base64 = "0.13"
 borsh = "=0.10.2"
 ed25519-dalek = "1.0.1"
-hotstuff_rs = { git = "https://github.com/parallelchain-io/hotstuff_rs" }
+hotstuff_rs = { version = "0.2", git = "https://github.com/parallelchain-io/hotstuff_rs" }
 rs_merkle = "1.1"
 sha2 = "0.10"
-
-[features]
-default = []

README.md

@@ -1,6 +1,6 @@
 # ParallelChain Types (Rust)
 
-Rust implementations of the data types defined in the [ParallelChain Protocol](https://github.com/parallelchain-io/parallelchain-protocol), including transactions, blocks, cryptographic primitives, and RPC requests and responses.
+Rust implementation of the data types defined in the [ParallelChain Protocol](https://github.com/parallelchain-io/parallelchain-protocol), including transactions, blocks, cryptographic primitives, and RPC requests and responses.
 
 Read the docs at: [docs.rs](https://docs.rs/pchain-types/0.4.2/pchain_types/)
 
@@ -14,9 +14,9 @@ Read the docs at: [docs.rs](https://docs.rs/pchain-types/0.4.2/pchain_types/)
 
 ## Common use cases
 
-- Generating a keypair.
-- Creating and signing a transaction.
-- Creating RPC requests, and interpreting responses.
+- Generating a keypair: (https://docs.rs/pchain-types/0.4.2/pchain_types/cryptography/index.html#generating-a-keypair)
+- Creating and signing a transaction: (https://docs.rs/pchain-types/0.4.2/pchain-types/blockchain/struct.Transaction.html#creating-a-transaction).
+- Creating RPC requests: [RPC](https://docs.rs/pchain-types/0.4.2/pchain_types/rpc).
 
 ## Versioning
 

src/blockchain.rs

@@ -77,8 +77,15 @@ pub struct BlockHeader {
 impl Serializable for BlockHeader {}
 impl Deserializable for BlockHeader {}
 
-/// Transactions are digitally signed instructions that tell 
-/// the Mainnet state machine to execute a sequence of ‘commands’. 
+/// Digitally signed instructions that tell the ParallelChain state machine to execute a sequence of [commands](Command). 
+/// 
+/// ## Creating a Transaction
+/// 
+/// There are two ways of creating an instance of transaction:
+/// 1. Using the [constructor function](Transaction::new): this takes in the user-provided fields of a transaction and
+///    computes its signature and hash automatically.
+/// 2. Using a struct expression (i.e., `Transaction { signer: ..., }`): this does not check the signature and hash 
+///    fields.
 #[derive(Debug, Clone, PartialEq, Eq, BorshSerialize, BorshDeserialize)]
 pub struct Transaction {
     /// The public address of the external account which signed this transaction
@@ -248,25 +255,3 @@ pub enum ExitStatus {
 
 impl Serializable for ExitStatus {}
 impl Deserializable for ExitStatus {}
-
-/// SignedTx is a data structure utlized in generating 
-/// signed [Transaction] for submission to ParallelChain.
-#[derive(Debug, Clone, PartialEq, Eq, BorshSerialize, BorshDeserialize)]
-pub struct SignedTransaction(Transaction);
-
-impl Serializable for SignedTransaction {}
-impl Deserializable for SignedTransaction {}
-
-impl Deref for SignedTransaction {
-    type Target = Transaction;
-
-    fn deref(&self) -> &Self::Target {
-        &self.0
-    }
-}
-
-impl From<SignedTransaction> for Transaction {
-    fn from(signed_tx: SignedTransaction) -> Self {
-        signed_tx.0
-    }
-}