zec
/
librustzcash
mirror of https://github.com/zcash/librustzcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #1228 from Oscar-Pepper/fix_cargo_doc_build_failure 

Fixed cargo doc build failure
This commit is contained in:
Kris Nuttycombe 2024-03-08 15:44:09 -07:00 committed by GitHub
parent 50b4c497ae ab701118f3
commit e24d93ccfd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
zcash_client_backend/src/data_api/wallet.rs
View File

@ -7,16 +7,12 @@
//! shielded internal address belonging to their wallet. //! shielded internal address belonging to their wallet.
//! //!
//! The important high-level operations provided by this module are [`propose_transfer`], //! The important high-level operations provided by this module are [`propose_transfer`],
//! [`propose_shielding`], and [`create_proposed_transactions`]. //! and [`create_proposed_transactions`].
//! //!
//! [`propose_transfer`] takes a [`TransactionRequest`] object, selects inputs notes and //! [`propose_transfer`] takes a [`TransactionRequest`] object, selects inputs notes and
//! computes the fees required to satisfy that request, and returns a [`Proposal`] object that //! computes the fees required to satisfy that request, and returns a [`Proposal`] object that
//! describes the transaction to be made. //! describes the transaction to be made.
//! //!
//! [`propose_shielding`] takes a set of transparent source addresses, and constructs a
//! [`Proposal`] to send those funds to a wallet-internal shielded address, as described in
//! [ZIP 316](https://zips.z.cash/zip-0316).
//!
//! [`create_proposed_transactions`] constructs one or more Zcash [`Transaction`]s based upon a //! [`create_proposed_transactions`] constructs one or more Zcash [`Transaction`]s based upon a
//! provided [`Proposal`], stores them to the wallet database, and returns the [`TxId`] for each //! provided [`Proposal`], stores them to the wallet database, and returns the [`TxId`] for each
//! constructed transaction to the caller. The caller can then use the //! constructed transaction to the caller. The caller can then use the
@ -24,9 +20,18 @@
//! the responsibility of the caller to retrieve and serialize the transactions and submit them for //! the responsibility of the caller to retrieve and serialize the transactions and submit them for
//! inclusion into the Zcash blockchain. //! inclusion into the Zcash blockchain.
//! //!
#![cfg_attr(
feature = "transparent-inputs",
doc = "
Another important high-level operation provided by this module is [`propose_shielding`], which
takes a set of transparent source addresses, and constructs a [`Proposal`] to send those funds
to a wallet-internal shielded address, as described in [ZIP 316](https://zips.z.cash/zip-0316).
[`propose_shielding`]: crate::data_api::wallet::propose_shielding
"
)]
//! [`TransactionRequest`]: crate::zip321::TransactionRequest //! [`TransactionRequest`]: crate::zip321::TransactionRequest
//! [`propose_transfer`]: crate::data_api::wallet::propose_transfer //! [`propose_transfer`]: crate::data_api::wallet::propose_transfer
//! [`propose_shielding`]: crate::data_api::wallet::propose_shielding
use nonempty::NonEmpty; use nonempty::NonEmpty;
use rand_core::OsRng; use rand_core::OsRng;