Merge pull request #88 from str4d/address-encodings

Sapling address encodings
zkcrypto · Jul 10, 2019 · 91c6b0b · 91c6b0b
2 parents 3b6f5e3 + a3a9ee2
commit 91c6b0b
Show file tree

Hide file tree

Showing 25 changed files with 397 additions and 334 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -6,10 +6,9 @@ members = [
     "librustzcash",
     "pairing",
     "sapling-crypto",
+    "zcash_client_backend",
     "zcash_primitives",
     "zcash_proofs",
-    "zcash_wallet",
-    "zip32",
 ]
 
 [profile.release]

diff --git a/librustzcash/Cargo.toml b/librustzcash/Cargo.toml
@@ -24,7 +24,6 @@ rand = "0.4"
 sapling-crypto = { path = "../sapling-crypto" }
 zcash_primitives = { path = "../zcash_primitives" }
 zcash_proofs = { path = "../zcash_proofs" }
-zip32 = { path = "../zip32" }
 
 [dependencies.blake2-rfc]
 git = "https://github.com/gtank/blake2-rfc"

diff --git a/librustzcash/src/rustzcash.rs b/librustzcash/src/rustzcash.rs
@@ -8,7 +8,6 @@ extern crate rand;
 extern crate sapling_crypto;
 extern crate zcash_primitives;
 extern crate zcash_proofs;
-extern crate zip32;
 
 extern crate lazy_static;
 
@@ -58,7 +57,7 @@ use std::ffi::OsString;
 use std::os::windows::ffi::OsStringExt;
 
 use sapling_crypto::primitives::{ProofGenerationKey, ViewingKey};
-use zcash_primitives::{note_encryption::sapling_ka_agree, sapling::spend_sig, JUBJUB};
+use zcash_primitives::{note_encryption::sapling_ka_agree, sapling::spend_sig, zip32, JUBJUB};
 use zcash_proofs::{
     load_parameters,
     sapling::{CommitmentTreeWitness, SaplingProvingContext, SaplingVerificationContext},

diff --git a/zcash_client_backend/Cargo.toml b/zcash_client_backend/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "zcash_client_backend"
+version = "0.0.0"
+authors = [
+    "Jack Grigg <jack@z.cash>",
+]
+edition = "2018"
+
+[dependencies]
+bech32 = "0.6"
+pairing = { path = "../pairing" }
+sapling-crypto = { path = "../sapling-crypto" }
+zcash_primitives = { path = "../zcash_primitives" }
+
+[dev-dependencies]
+rand = "0.4"
diff --git a/zcash_wallet/LICENSE-APACHE → zcash_client_backend/LICENSE-APACHE b/zcash_wallet/LICENSE-APACHE → zcash_client_backend/LICENSE-APACHE
diff --git a/zcash_wallet/LICENSE-MIT → zcash_client_backend/LICENSE-MIT b/zcash_wallet/LICENSE-MIT → zcash_client_backend/LICENSE-MIT
diff --git a/zcash_wallet/README.md → zcash_client_backend/README.md b/zcash_wallet/README.md → zcash_client_backend/README.md
@@ -1,6 +1,6 @@
-# zcash_wallet
+# zcash_client_backend
 
-This library contains Rust structs and traits for creating shielded Zcash wallets.
+This library contains Rust structs and traits for creating shielded Zcash light clients.
 
 ## License
 

diff --git a/zcash_client_backend/src/constants.rs b/zcash_client_backend/src/constants.rs
@@ -0,0 +1,4 @@
+//! Zcash global and per-network constants.
+
+pub mod mainnet;
+pub mod testnet;
diff --git a/zcash_client_backend/src/constants/mainnet.rs b/zcash_client_backend/src/constants/mainnet.rs
@@ -0,0 +1,28 @@
+/// The mainnet coin type for ZEC, as defined by [SLIP 44].
+///
+/// [SLIP 44]: https://github.com/satoshilabs/slips/blob/master/slip-0044.md
+pub const COIN_TYPE: u32 = 133;
+
+/// The HRP for a Bech32-encoded mainnet [`ExtendedSpendingKey`].
+///
+/// Defined in [ZIP 32].
+///
+/// [`ExtendedSpendingKey`]: zcash_primitives::zip32::ExtendedSpendingKey
+/// [ZIP 32]: https://github.com/zcash/zips/blob/master/zip-0032.rst
+pub const HRP_SAPLING_EXTENDED_SPENDING_KEY: &str = "secret-extended-key-main";
+
+/// The HRP for a Bech32-encoded mainnet [`ExtendedFullViewingKey`].
+///
+/// Defined in [ZIP 32].
+///
+/// [`ExtendedFullViewingKey`]: zcash_primitives::zip32::ExtendedFullViewingKey
+/// [ZIP 32]: https://github.com/zcash/zips/blob/master/zip-0032.rst
+pub const HRP_SAPLING_EXTENDED_FULL_VIEWING_KEY: &str = "zxviews";
+
+/// The HRP for a Bech32-encoded mainnet [`PaymentAddress`].
+///
+/// Defined in section 5.6.4 of the [Zcash Protocol Specification].
+///
+/// [`PaymentAddress`]: sapling_crypto::primitives::PaymentAddress
+/// [Zcash Protocol Specification]: https://github.com/zcash/zips/blob/master/protocol/protocol.pdf
+pub const HRP_SAPLING_PAYMENT_ADDRESS: &str = "zs";
diff --git a/zcash_client_backend/src/constants/testnet.rs b/zcash_client_backend/src/constants/testnet.rs
@@ -0,0 +1,28 @@
+/// The testnet coin type for ZEC, as defined by [SLIP 44].
+///
+/// [SLIP 44]: https://github.com/satoshilabs/slips/blob/master/slip-0044.md
+pub const COIN_TYPE: u32 = 1;
+
+/// The HRP for a Bech32-encoded testnet [`ExtendedSpendingKey`].
+///
+/// Defined in [ZIP 32].
+///
+/// [`ExtendedSpendingKey`]: zcash_primitives::zip32::ExtendedSpendingKey
+/// [ZIP 32]: https://github.com/zcash/zips/blob/master/zip-0032.rst
+pub const HRP_SAPLING_EXTENDED_SPENDING_KEY: &str = "secret-extended-key-test";
+
+/// The HRP for a Bech32-encoded testnet [`ExtendedFullViewingKey`].
+///
+/// Defined in [ZIP 32].
+///
+/// [`ExtendedFullViewingKey`]: zcash_primitives::zip32::ExtendedFullViewingKey
+/// [ZIP 32]: https://github.com/zcash/zips/blob/master/zip-0032.rst
+pub const HRP_SAPLING_EXTENDED_FULL_VIEWING_KEY: &str = "zxviewtestsapling";
+
+/// The HRP for a Bech32-encoded testnet [`PaymentAddress`].
+///
+/// Defined in section 5.6.4 of the [Zcash Protocol Specification].
+///
+/// [`PaymentAddress`]: sapling_crypto::primitives::PaymentAddress
+/// [Zcash Protocol Specification]: https://github.com/zcash/zips/blob/master/protocol/protocol.pdf
+pub const HRP_SAPLING_PAYMENT_ADDRESS: &str = "ztestsapling";