2021-01-08 08:32:36 -08:00
|
|
|
//! # orchard
|
2021-03-08 13:39:02 -08:00
|
|
|
//!
|
|
|
|
//! ## Nomenclature
|
|
|
|
//!
|
|
|
|
//! All types in the `orchard` crate, unless otherwise specified, are Orchard-specific
|
|
|
|
//! types. For example, [`Address`] is documented as being a shielded payment address; we
|
|
|
|
//! implicitly mean it is an Orchard payment address (as opposed to e.g. a Sapling payment
|
|
|
|
//! address, which is also shielded).
|
2020-10-20 14:12:37 -07:00
|
|
|
|
2020-10-20 14:44:33 -07:00
|
|
|
#![cfg_attr(docsrs, feature(doc_cfg))]
|
2021-03-19 22:31:09 -07:00
|
|
|
// Temporary until we have more of the crate implemented.
|
|
|
|
#![allow(dead_code)]
|
2020-10-20 14:44:33 -07:00
|
|
|
// Catch documentation errors caused by code changes.
|
2022-02-23 17:29:07 -08:00
|
|
|
#![deny(rustdoc::broken_intra_doc_links)]
|
2020-10-20 14:12:37 -07:00
|
|
|
#![deny(missing_debug_implementations)]
|
|
|
|
#![deny(missing_docs)]
|
|
|
|
#![deny(unsafe_code)]
|
2021-01-20 10:54:00 -08:00
|
|
|
|
2022-04-28 14:46:24 -07:00
|
|
|
mod action;
|
2021-01-20 10:54:00 -08:00
|
|
|
mod address;
|
2021-04-27 12:56:36 -07:00
|
|
|
pub mod builder;
|
2021-01-20 12:30:35 -08:00
|
|
|
pub mod bundle;
|
2021-06-21 05:38:43 -07:00
|
|
|
pub mod circuit;
|
2021-03-05 15:25:45 -08:00
|
|
|
mod constants;
|
2021-01-20 10:54:00 -08:00
|
|
|
pub mod keys;
|
2021-05-05 13:05:17 -07:00
|
|
|
pub mod note;
|
2021-08-05 17:01:12 -07:00
|
|
|
pub mod note_encryption;
|
2021-01-20 12:35:54 -08:00
|
|
|
pub mod primitives;
|
2021-03-05 15:25:45 -08:00
|
|
|
mod spec;
|
2021-06-17 07:34:09 -07:00
|
|
|
pub mod tree;
|
2021-01-20 12:09:09 -08:00
|
|
|
pub mod value;
|
2021-07-15 00:18:01 -07:00
|
|
|
pub mod zip32;
|
2021-01-20 10:54:00 -08:00
|
|
|
|
2021-05-28 03:57:21 -07:00
|
|
|
#[cfg(test)]
|
|
|
|
mod test_vectors;
|
|
|
|
|
2022-04-28 14:46:24 -07:00
|
|
|
pub use action::Action;
|
2021-01-20 10:54:00 -08:00
|
|
|
pub use address::Address;
|
2021-05-05 10:46:24 -07:00
|
|
|
pub use bundle::Bundle;
|
2021-04-21 08:57:48 -07:00
|
|
|
pub use circuit::Proof;
|
2021-05-05 10:46:24 -07:00
|
|
|
pub use note::Note;
|
2021-04-21 08:57:48 -07:00
|
|
|
pub use tree::Anchor;
|