penumbra_transaction/lib.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
//! Data modeling for Penumbra transactions.
//!
//! This crate defines data structures that provide modeling of shielded
//! transactions through their entire lifecycle:
//!
//! * the [`TransactionPlan`](TransactionPlan) type completely describes a
//! planned transaction before it is created;
//!
//! * the [`Transaction`] type represents the shielded transaction itself;
//!
//! * the [`TransactionView`] type represents a view from a particular
//! [`TransactionPerspective`] (e.g., the sender or receiver) of the cleartext
//! contents of a shielded transaction after it has been created.
#![deny(clippy::unwrap_used)]
#![allow(clippy::clone_on_copy)]
// Requires nightly.
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
mod auth_data;
mod detection_data;
mod error;
mod is_action;
mod parameters;
mod transaction;
mod witness_data;
pub mod action;
pub mod action_list;
pub mod gas;
pub mod memo;
pub mod plan;
pub mod view;
pub use action::Action;
pub use action_list::ActionList;
pub use auth_data::AuthorizationData;
pub use detection_data::DetectionData;
pub use error::Error;
pub use is_action::IsAction;
pub use parameters::TransactionParameters;
pub use penumbra_txhash as txhash;
pub use plan::{ActionPlan, TransactionPlan};
pub use transaction::{Transaction, TransactionBody};
pub use view::{ActionView, MemoPlaintextView, MemoView, TransactionPerspective, TransactionView};
pub use witness_data::WitnessData;
/// A compatibility wrapper for trait implementations that are temporarily duplicated
/// in multiple crates as an orphan rule work around until we finish splitting crates (#2288).
pub struct Compat<'a, T>(pub &'a T);