Split `zcash_keys` crate out from `zcash_client_backend`
This change makes it easier for third parties to make use of the Unified key infrastructure without incurring a dependency upon the rest of the `zcash_client_backend` interfaces.
This commit is contained in:
Kris Nuttycombe
parent
75184acfdb
commit
0ca955336d
|
|
@ -3038,6 +3038,7 @@ dependencies = [
|
|||
"which",
|
||||
"zcash_address",
|
||||
"zcash_encoding",
|
||||
"zcash_keys",
|
||||
"zcash_note_encryption",
|
||||
"zcash_primitives",
|
||||
"zcash_proofs",
|
||||
|
|
@ -3114,6 +3115,33 @@ dependencies = [
|
|||
"proptest",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zcash_keys"
|
||||
version = "0.0.0"
|
||||
dependencies = [
|
||||
"bech32",
|
||||
"bls12_381",
|
||||
"bs58",
|
||||
"byteorder",
|
||||
"document-features",
|
||||
"group",
|
||||
"hdwallet",
|
||||
"hex",
|
||||
"jubjub",
|
||||
"memuse",
|
||||
"nonempty",
|
||||
"orchard",
|
||||
"proptest",
|
||||
"rand_core",
|
||||
"sapling-crypto",
|
||||
"subtle",
|
||||
"tracing",
|
||||
"zcash_address",
|
||||
"zcash_encoding",
|
||||
"zcash_primitives",
|
||||
"zip32",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zcash_note_encryption"
|
||||
version = "0.4.0"
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ members = [
|
|||
"zcash_client_sqlite",
|
||||
"zcash_extensions",
|
||||
"zcash_history",
|
||||
"zcash_keys",
|
||||
"zcash_primitives",
|
||||
"zcash_proofs",
|
||||
]
|
||||
|
|
@ -30,6 +31,7 @@ equihash = { version = "0.2", path = "components/equihash" }
|
|||
zcash_address = { version = "0.3", path = "components/zcash_address" }
|
||||
zcash_client_backend = { version = "0.10", path = "zcash_client_backend" }
|
||||
zcash_encoding = { version = "0.2", path = "components/zcash_encoding" }
|
||||
zcash_keys = { version = "0.0", path = "zcash_keys" }
|
||||
zcash_note_encryption = "0.4"
|
||||
zcash_primitives = { version = "0.13", path = "zcash_primitives", default-features = false }
|
||||
zcash_proofs = { version = "0.13", path = "zcash_proofs", default-features = false }
|
||||
|
|
|
|||
|
|
@ -29,9 +29,6 @@ and this library adheres to Rust's notion of
|
|||
functionality and move it behind the `transparent-inputs` feature flag.
|
||||
- `zcash_client_backend::fees::{standard, orchard, sapling}`
|
||||
- `zcash_client_backend::fees::ChangeValue::{new, orchard}`
|
||||
- `zcash_client_backend::keys`:
|
||||
- `AddressGenerationError`
|
||||
- `UnifiedAddressRequest`
|
||||
- `zcash_client_backend::wallet`:
|
||||
- `Note`
|
||||
- `ReceivedNote`
|
||||
|
|
@ -194,29 +191,6 @@ and this library adheres to Rust's notion of
|
|||
- `ReceivedSaplingNote::value`
|
||||
- `WalletTransparentOutput::value`
|
||||
|
||||
- `zcash_client_backend::address`:
|
||||
- `RecipientAddress` has been renamed to `Address`
|
||||
- `Address::Shielded` has been renamed to `Address::Sapling`
|
||||
- `UnifiedAddress::from_receivers` no longer takes an Orchard receiver
|
||||
argument unless the `orchard` feature is enabled.
|
||||
- `UnifiedAddress::orchard` is now only available when the `orchard` feature
|
||||
is enabled.
|
||||
|
||||
- `zcash_client_backend::keys`:
|
||||
- `DerivationError::Orchard` is now only available when the `orchard` feature
|
||||
is enabled.
|
||||
- `UnifiedSpendingKey::address` now takes an argument that specifies the
|
||||
receivers to be generated in the resulting address. Also, it now returns
|
||||
`Result<UnifiedAddress, AddressGenerationError>` instead of
|
||||
`Option<UnifiedAddress>` so that we may better report to the user how
|
||||
address generation has failed.
|
||||
- `UnifiedSpendingKey::orchard` is now only available when the `orchard`
|
||||
feature is enabled.
|
||||
- `UnifiedSpendingKey::transparent` is now only available when the
|
||||
`transparent-inputs` feature is enabled.
|
||||
- `UnifiedFullViewingKey::new` no longer takes an Orchard full viewing key
|
||||
argument unless the `orchard` feature is enabled.
|
||||
|
||||
### Removed
|
||||
- `zcash_client_backend::wallet::ReceivedSaplingNote` has been replaced by
|
||||
`zcash_client_backend::ReceivedNote`.
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ rustdoc-args = ["--cfg", "docsrs"]
|
|||
[dependencies]
|
||||
zcash_address.workspace = true
|
||||
zcash_encoding.workspace = true
|
||||
zcash_keys.workspace = true
|
||||
zcash_note_encryption.workspace = true
|
||||
zcash_primitives.workspace = true
|
||||
zip32.workspace = true
|
||||
|
|
|
|||
|
|
@ -14,12 +14,12 @@
|
|||
// Temporary until we have addressed all Result<T, ()> cases.
|
||||
#![allow(clippy::result_unit_err)]
|
||||
|
||||
pub mod address;
|
||||
pub use zcash_keys::address;
|
||||
pub mod data_api;
|
||||
mod decrypt;
|
||||
pub mod encoding;
|
||||
pub use zcash_keys::encoding;
|
||||
pub mod fees;
|
||||
pub mod keys;
|
||||
pub use zcash_keys::keys;
|
||||
pub mod proto;
|
||||
pub mod scan;
|
||||
pub mod scanning;
|
||||
|
|
|
|||
|
|
@ -0,0 +1,45 @@
|
|||
All notable changes to this library will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this library adheres to Rust's notion of
|
||||
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
The entries below are relative to the `zcash_client_backend` crate as of
|
||||
`zcash_client_backend 0.10.0`.
|
||||
|
||||
### Added
|
||||
- The following modules have been extracted from `zcash_client_backend` and
|
||||
moved to this crate:
|
||||
- `address`
|
||||
- `encoding`
|
||||
- `keys`
|
||||
- `zcash_keys::keys`:
|
||||
- `AddressGenerationError`
|
||||
- `UnifiedAddressRequest`
|
||||
- A new `orchard` feature flag has been added to make it possible to
|
||||
build client code without `orchard` dependendencies.
|
||||
|
||||
### Changed
|
||||
- `zcash_keys::address`:
|
||||
- `RecipientAddress` has been renamed to `Address`
|
||||
- `Address::Shielded` has been renamed to `Address::Sapling`
|
||||
- `UnifiedAddress::from_receivers` no longer takes an Orchard receiver
|
||||
argument unless the `orchard` feature is enabled.
|
||||
- `UnifiedAddress::orchard` is now only available when the `orchard` feature
|
||||
is enabled.
|
||||
|
||||
- `zcash_keys::keys`:
|
||||
- `DerivationError::Orchard` is now only available when the `orchard` feature
|
||||
is enabled.
|
||||
- `UnifiedSpendingKey::address` now takes an argument that specifies the
|
||||
receivers to be generated in the resulting address. Also, it now returns
|
||||
`Result<UnifiedAddress, AddressGenerationError>` instead of
|
||||
`Option<UnifiedAddress>` so that we may better report to the user how
|
||||
address generation has failed.
|
||||
- `UnifiedSpendingKey::orchard` is now only available when the `orchard`
|
||||
feature is enabled.
|
||||
- `UnifiedSpendingKey::transparent` is now only available when the
|
||||
`transparent-inputs` feature is enabled.
|
||||
- `UnifiedFullViewingKey::new` no longer takes an Orchard full viewing key
|
||||
argument unless the `orchard` feature is enabled.
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
[package]
|
||||
name = "zcash_keys"
|
||||
description = "Zcash key and address management"
|
||||
version = "0.0.0"
|
||||
authors = [
|
||||
"Jack Grigg <jack@z.cash>",
|
||||
"Kris Nuttycombe <kris@electriccoin.co>"
|
||||
]
|
||||
homepage = "https://github.com/zcash/librustzcash"
|
||||
repository.workspace = true
|
||||
readme = "README.md"
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
rust-version.workspace = true
|
||||
categories.workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
|
||||
[dependencies]
|
||||
zcash_address.workspace = true
|
||||
zcash_encoding.workspace = true
|
||||
zcash_primitives.workspace = true
|
||||
zip32.workspace = true
|
||||
|
||||
# Dependencies exposed in a public API:
|
||||
nonempty.workspace = true
|
||||
|
||||
# - CSPRNG
|
||||
rand_core.workspace = true
|
||||
|
||||
# - Encodings
|
||||
bech32.workspace = true
|
||||
bs58.workspace = true
|
||||
|
||||
# - Transparent protocols
|
||||
hdwallet = { workspace = true, optional = true }
|
||||
|
||||
# - Logging and metrics
|
||||
memuse.workspace = true
|
||||
tracing.workspace = true
|
||||
|
||||
# - Secret management
|
||||
subtle.workspace = true
|
||||
|
||||
# - Shielded protocols
|
||||
bls12_381.workspace = true
|
||||
group.workspace = true
|
||||
orchard = { workspace = true, optional = true }
|
||||
sapling.workspace = true
|
||||
|
||||
# - Test dependencies
|
||||
proptest = { workspace = true, optional = true }
|
||||
|
||||
# Dependencies used internally:
|
||||
# (Breaking upgrades to these are usually backwards-compatible, but check MSRVs.)
|
||||
# - Documentation
|
||||
document-features.workspace = true
|
||||
|
||||
# - Encodings
|
||||
byteorder = { workspace = true, optional = true }
|
||||
|
||||
[dev-dependencies]
|
||||
hex.workspace = true
|
||||
jubjub.workspace = true
|
||||
proptest.workspace = true
|
||||
rand_core.workspace = true
|
||||
zcash_address = { workspace = true, features = ["test-dependencies"] }
|
||||
|
||||
[features]
|
||||
## Enables use of transparent key parts and addresses
|
||||
transparent-inputs = ["dep:hdwallet", "zcash_primitives/transparent-inputs"]
|
||||
|
||||
## Enables use of Orchard key parts and addresses
|
||||
orchard = ["dep:orchard"]
|
||||
|
||||
## Exposes APIs that are useful for testing, such as `proptest` strategies.
|
||||
test-dependencies = [
|
||||
"dep:proptest",
|
||||
"orchard?/test-dependencies",
|
||||
"zcash_primitives/test-dependencies",
|
||||
]
|
||||
|
||||
#! ### Experimental features
|
||||
|
||||
## Exposes unstable APIs. Their behaviour may change at any time.
|
||||
unstable = ["dep:byteorder"]
|
||||
|
||||
[badges]
|
||||
maintenance = { status = "actively-developed" }
|
||||
|
|
@ -0,0 +1,202 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2017-2019 Electric Coin Company
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# zcash_keys
|
||||
|
||||
This library contains Rust structs and traits for Zcash key and address parsing
|
||||
and encoding.
|
||||
|
||||
## License
|
||||
|
||||
Licensed under either of
|
||||
|
||||
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
||||
http://www.apache.org/licenses/LICENSE-2.0)
|
||||
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
||||
|
||||
at your option.
|
||||
|
||||
### Contribution
|
||||
|
||||
Unless you explicitly state otherwise, any contribution intentionally
|
||||
submitted for inclusion in the work by you, as defined in the Apache-2.0
|
||||
license, shall be dual licensed as above, without any additional terms or
|
||||
conditions.
|
||||
|
||||
|
|
@ -175,7 +175,7 @@ impl<P: consensus::Parameters> AddressCodec<P> for UnifiedAddress {
|
|||
/// constants::testnet::{COIN_TYPE, HRP_SAPLING_EXTENDED_SPENDING_KEY},
|
||||
/// zip32::AccountId,
|
||||
/// };
|
||||
/// use zcash_client_backend::{
|
||||
/// use zcash_keys::{
|
||||
/// encoding::encode_extended_spending_key,
|
||||
/// keys::sapling,
|
||||
/// };
|
||||
|
|
@ -208,7 +208,7 @@ pub fn decode_extended_spending_key(
|
|||
/// constants::testnet::{COIN_TYPE, HRP_SAPLING_EXTENDED_FULL_VIEWING_KEY},
|
||||
/// zip32::AccountId,
|
||||
/// };
|
||||
/// use zcash_client_backend::{
|
||||
/// use zcash_keys::{
|
||||
/// encoding::encode_extended_full_viewing_key,
|
||||
/// keys::sapling,
|
||||
/// };
|
||||
|
|
@ -239,7 +239,7 @@ pub fn decode_extended_full_viewing_key(
|
|||
/// ```
|
||||
/// use group::Group;
|
||||
/// use sapling::{Diversifier, PaymentAddress};
|
||||
/// use zcash_client_backend::{
|
||||
/// use zcash_keys::{
|
||||
/// encoding::encode_payment_address,
|
||||
/// };
|
||||
/// use zcash_primitives::{
|
||||
|
|
@ -283,7 +283,7 @@ pub fn encode_payment_address_p<P: consensus::Parameters>(
|
|||
/// ```
|
||||
/// use group::Group;
|
||||
/// use sapling::{Diversifier, PaymentAddress};
|
||||
/// use zcash_client_backend::{
|
||||
/// use zcash_keys::{
|
||||
/// encoding::decode_payment_address,
|
||||
/// };
|
||||
/// use zcash_primitives::{
|
||||
|
|
@ -327,7 +327,7 @@ pub fn decode_payment_address(
|
|||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use zcash_client_backend::{
|
||||
/// use zcash_keys::{
|
||||
/// encoding::encode_transparent_address,
|
||||
/// };
|
||||
/// use zcash_primitives::{
|
||||
|
|
@ -398,7 +398,7 @@ pub fn encode_transparent_address_p<P: consensus::Parameters>(
|
|||
/// use zcash_primitives::{
|
||||
/// consensus::{TEST_NETWORK, Parameters},
|
||||
/// };
|
||||
/// use zcash_client_backend::{
|
||||
/// use zcash_keys::{
|
||||
/// encoding::decode_transparent_address,
|
||||
/// };
|
||||
/// use zcash_primitives::legacy::TransparentAddress;
|
||||
|
|
@ -44,12 +44,8 @@ pub mod sapling {
|
|||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use zcash_primitives::{
|
||||
/// constants::testnet::COIN_TYPE,
|
||||
/// };
|
||||
/// use zcash_client_backend::{
|
||||
/// keys::sapling,
|
||||
/// };
|
||||
/// use zcash_primitives::constants::testnet::COIN_TYPE;
|
||||
/// use zcash_keys::keys::sapling;
|
||||
/// use zip32::AccountId;
|
||||
///
|
||||
/// let extsk = sapling::spending_key(&[0; 32][..], COIN_TYPE, AccountId::ZERO);
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
//! *A crate for Zcash key and address management.*
|
||||
//!
|
||||
//! `zcash_keys` contains Rust structs, traits and functions for creating Zcash spending
|
||||
//! and viewing keys and addresses.
|
||||
//!
|
||||
//! ## Feature flags
|
||||
#![doc = document_features::document_features!()]
|
||||
//!
|
||||
|
||||
#![cfg_attr(docsrs, feature(doc_cfg))]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
// Catch documentation errors caused by code changes.
|
||||
#![deny(rustdoc::broken_intra_doc_links)]
|
||||
// Temporary until we have addressed all Result<T, ()> cases.
|
||||
#![allow(clippy::result_unit_err)]
|
||||
|
||||
pub mod address;
|
||||
pub mod encoding;
|
||||
pub mod keys;
|
||||
Loading…
Reference in New Issue