V0/V1 Slate Removal + Grin Header Version Bump (#140)

* Remove V0 and V1 Slates from Wallet * rustfmt
mimblewimble · Jun 7, 2019 · 25d3ccf · 25d3ccf
1 parent 5d001a0
commit 25d3ccf
Show file tree

Hide file tree

Showing 13 changed files with 177 additions and 3,031 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/api/src/foreign_rpc.rs b/api/src/foreign_rpc.rs
@@ -52,8 +52,6 @@ pub trait ForeignRpc {
 			"Ok": {
 				"foreign_api_version": 2,
 				"supported_slate_versions": [
-					"V0",
-					"V1",
 					"V2"
 				]
 			}
@@ -174,7 +172,7 @@ pub trait ForeignRpc {
 				"version_info": {
 					"orig_version": 2,
 					"version": 2,
-					"block_header_version": 1
+					"block_header_version": 2
 				}
 			}
 		]
@@ -212,7 +210,7 @@ pub trait ForeignRpc {
 			"version_info": {
 				"version": 2,
 				"orig_version": 2,
-				"block_header_version": 1
+				"block_header_version": 2
 			},
 			"num_participants": 2,
 			"id": "0436430c-2b02-624c-2032-570501212b00",
@@ -337,7 +335,7 @@ pub trait ForeignRpc {
 				"version_info": {
 					"orig_version": 2,
 					"version": 2,
-					"block_header_version": 1
+					"block_header_version": 2
 				}
 			}
 		}
@@ -370,7 +368,7 @@ pub trait ForeignRpc {
 			"version_info": {
 				"version": 2,
 				"orig_version": 2,
-				"block_header_version": 1
+				"block_header_version": 2
 			},
 			"num_participants": 2,
 			"id": "0436430c-2b02-624c-2032-570501212b00",
@@ -505,7 +503,7 @@ pub trait ForeignRpc {
 				"version_info": {
 					"orig_version": 2,
 					"version": 2,
-					"block_header_version": 1
+					"block_header_version": 2
 				}
 			}
 		}

diff --git a/api/src/owner_rpc.rs b/api/src/owner_rpc.rs
@@ -391,7 +391,7 @@ pub trait OwnerRpc {
 		  "version_info": {
 				"orig_version": 2,
 				"version": 2,
-				"block_header_version": 1
+				"block_header_version": 2
 		  }
 		}
 	  }
@@ -471,7 +471,7 @@ pub trait OwnerRpc {
 					"version_info": {
 						"orig_version": 2,
 						"version": 2,
-						"block_header_version": 1
+						"block_header_version": 2
 					}
 				}
 			}
@@ -535,7 +535,7 @@ pub trait OwnerRpc {
 					"version_info": {
 						"orig_version": 2,
 						"version": 2,
-						"block_header_version": 1
+						"block_header_version": 2
 					}
 				},
 				{
@@ -619,7 +619,7 @@ pub trait OwnerRpc {
 				"version_info": {
 					"orig_version": 2,
 					"version": 2,
-					"block_header_version": 1
+					"block_header_version": 2
 				}
 			}
 		}
@@ -688,7 +688,7 @@ pub trait OwnerRpc {
 				"version_info": {
 					"orig_version": 2,
 					"version": 2,
-					"block_header_version": 1
+					"block_header_version": 2
 				}
 			},
 			0
@@ -726,7 +726,7 @@ pub trait OwnerRpc {
 			"version_info": {
 				"version": 2,
 				"orig_version": 2,
-				"block_header_version": 1
+				"block_header_version": 2
 			},
 			"num_participants": 2,
 			"id": "0436430c-2b02-624c-2032-570501212b00",
@@ -862,7 +862,7 @@ pub trait OwnerRpc {
 				"version_info": {
 					"orig_version": 2,
 					"version": 2,
-					"block_header_version": 1
+					"block_header_version": 2
 				}
 			}
 		}
@@ -1121,7 +1121,7 @@ pub trait OwnerRpc {
 				"version_info": {
 					"orig_version": 2,
 					"version": 2,
-					"block_header_version": 1
+					"block_header_version": 2
 				}
 			}
 		]

diff --git a/api/tests/slate_versioning.rs b/api/tests/slate_versioning.rs
@@ -12,18 +12,18 @@
 // limitations under the License.
 
 //! core::libtx specific tests
-use grin_wallet_api::foreign_rpc_client;
+//use grin_wallet_api::foreign_rpc_client;
 use grin_wallet_api::run_doctest_foreign;
-use grin_wallet_libwallet::{Slate, SlateVersion, VersionedSlate};
+//use grin_wallet_libwallet::VersionedSlate;
 use serde_json;
 use serde_json::Value;
 use tempfile::tempdir;
 //use grin_wallet_libwallet::slate_versions::v1::SlateV1;
 //use grin_wallet_libwallet::slate_versions::v2::SlateV2;
 
 // test all slate conversions
-#[test]
-fn receive_versioned_slate() {
+//#[test]
+fn _receive_versioned_slate() {
 	// as in doctests, except exercising versioning functionality
 	// by accepting and responding with a V1 slate
 
@@ -65,6 +65,9 @@ fn receive_versioned_slate() {
 	}
 }
 
+// TODO: Re-introduce on a new slate version
+
+/*
 /// call ForeignRpc::receive_tx on vs and return the result
 fn receive_tx(vs: VersionedSlate) -> VersionedSlate {
 	let dir = tempdir().map_err(|e| format!("{:#?}", e)).unwrap();
@@ -128,4 +131,4 @@ fn version_unchanged() {
 			VersionedSlate::V2(_) => (),
 		}
 	}
-}
+}*/
diff --git a/libwallet/src/slate.rs b/libwallet/src/slate.rs
@@ -39,8 +39,6 @@ use std::fmt;
 use std::sync::Arc;
 use uuid::Uuid;
 
-use crate::slate_versions::v0::SlateV0;
-use crate::slate_versions::v1::SlateV1;
 use crate::slate_versions::v2::{
 	InputV2, OutputV2, ParticipantDataV2, SlateV2, TransactionBodyV2, TransactionV2, TxKernelV2,
 	VersionCompatInfoV2,
@@ -207,20 +205,15 @@ impl Slate {
 	/// Recieve a slate, upgrade it to the latest version internally
 	pub fn deserialize_upgrade(slate_json: &str) -> Result<Slate, Error> {
 		let version = Slate::parse_slate_version(slate_json)?;
-		let v2 = match version {
+		let v2: SlateV2 = match version {
 			2 => serde_json::from_str(slate_json).context(ErrorKind::SlateDeser)?,
-			1 => {
-				let mut v1: SlateV1 =
-					serde_json::from_str(slate_json).context(ErrorKind::SlateDeser)?;
-				v1.orig_version = 1;
-				SlateV2::from(v1)
-			}
-			0 => {
+			// left as a reminder
+			/*0 => {
 				let v0: SlateV0 =
 					serde_json::from_str(slate_json).context(ErrorKind::SlateDeser)?;
 				let v1 = SlateV1::from(v0);
 				SlateV2::from(v1)
-			}
+			}*/
 			_ => return Err(ErrorKind::SlateVersion(version).into()),
 		};
 		Ok(v2.into())
@@ -681,15 +674,12 @@ impl Serialize for Slate {
 		let v2 = SlateV2::from(self);
 		match self.version_info.orig_version {
 			2 => v2.serialize(serializer),
-			1 => {
-				let v1 = SlateV1::from(v2);
-				v1.serialize(serializer)
-			}
-			0 => {
+			// left as a reminder
+			/*0 => {
 				let v1 = SlateV1::from(v2);
 				let v0 = SlateV0::from(v1);
 				v0.serialize(serializer)
-			}
+			}*/
 			v => Err(S::Error::custom(format!("Unknown slate version {}", v))),
 		}
 	}

diff --git a/libwallet/src/slate_versions/mod.rs b/libwallet/src/slate_versions/mod.rs
@@ -14,31 +14,24 @@
 
 //! This module contains old slate versions and conversions to the newest slate version
 //! Used for serialization and deserialization of slates in a backwards compatible way.
+//! Versions earlier than V2 are removed for the 2.0.0 release, but versioning code
+//! remains for future needs
+
 use crate::slate::Slate;
-use crate::slate_versions::v0::SlateV0;
-use crate::slate_versions::v1::SlateV1;
 use crate::slate_versions::v2::SlateV2;
 
-#[allow(missing_docs)]
-pub mod v0;
-#[allow(missing_docs)]
-pub mod v1;
 #[allow(missing_docs)]
 pub mod v2;
 
 /// The most recent version of the slate
 pub const CURRENT_SLATE_VERSION: u16 = 2;
 
 /// The grin block header this slate is intended to be compatible with
-pub const GRIN_BLOCK_HEADER_VERSION: u16 = 1;
+pub const GRIN_BLOCK_HEADER_VERSION: u16 = 2;
 
 /// Existing versions of the slate
 #[derive(EnumIter, Serialize, Deserialize, Clone, Debug, PartialEq, PartialOrd, Eq, Ord)]
 pub enum SlateVersion {
-	/// V0
-	V0,
-	/// V1
-	V1,
 	/// V2 (most current)
 	V2,
 }
@@ -48,39 +41,30 @@ pub enum SlateVersion {
 /// Versions are ordered newest to oldest so serde attempts to
 /// deserialize newer versions first, then falls back to older versions.
 pub enum VersionedSlate {
-	/// Current
+	/// Current (Grin 1.1.0 - 2.x (current))
 	V2(SlateV2),
-	/// V1 - Grin 1.0.1 - 1.0.3)
-	V1(SlateV1),
-	/// V0 - Grin 1.0.0
-	V0(SlateV0),
 }
 
 impl VersionedSlate {
 	/// Return slate version
 	pub fn version(&self) -> SlateVersion {
 		match *self {
 			VersionedSlate::V2(_) => SlateVersion::V2,
-			VersionedSlate::V1(_) => SlateVersion::V1,
-			VersionedSlate::V0(_) => SlateVersion::V0,
 		}
 	}
 
 	/// convert this slate type to a specified older version
 	pub fn into_version(slate: Slate, version: SlateVersion) -> VersionedSlate {
 		match version {
 			SlateVersion::V2 => VersionedSlate::V2(slate.into()),
-			SlateVersion::V1 => {
-				let s = SlateV2::from(slate);
-				let s = SlateV1::from(s);
-				VersionedSlate::V1(s)
-			}
-			SlateVersion::V0 => {
+			// Left here as a reminder of what needs to be inserted on
+			// the release of a new slate
+			/*SlateVersion::V0 => {
 				let s = SlateV2::from(slate);
 				let s = SlateV1::from(s);
 				let s = SlateV0::from(s);
 				VersionedSlate::V0(s)
-			}
+			}*/
 		}
 	}
 }
@@ -91,18 +75,13 @@ impl From<VersionedSlate> for Slate {
 			VersionedSlate::V2(s) => {
 				let s = SlateV2::from(s);
 				Slate::from(s)
-			}
-			VersionedSlate::V1(s) => {
-				let s = SlateV1::from(s);
-				let s = SlateV2::from(s);
-				Slate::from(s)
-			}
-			VersionedSlate::V0(s) => {
-				let s = SlateV0::from(s);
-				let s = SlateV1::from(s);
-				let s = SlateV2::from(s);
-				Slate::from(s)
-			}
+			} // Again, left in as a reminder
+			  /*VersionedSlate::V0(s) => {
+				  let s = SlateV0::from(s);
+				  let s = SlateV1::from(s);
+				  let s = SlateV2::from(s);
+				  Slate::from(s)
+			  }*/
 		}
 	}
 }