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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

//! # sqlx-ledger
//!
//! This crate builds on the sqlx crate to provide a set of primitives for
//! implementing an SQL-compatible double-entry accounting system. This system
//! is engineered specifically for dealing with money and building financial
//! products.
//!
//! ## Quick Start
//! Here is how to initialize a ledger create a primitive template and post a transaction.
//! This is a toy example that brings all pieces together end-to-end.
//! Not recommended for real use.
//! ```rust
//! use uuid::uuid;
//! use rust_decimal::Decimal;
//! use sqlx_ledger::{*, journal::*, account::*, tx_template::*};
//!
//! async fn init_ledger(journal_id: JournalId) -> SqlxLedger {
//!     let pg_con = std::env::var("PG_CON").unwrap_or(format!("postgres://user:password@localhost:5432/pg"));
//!     let pool = sqlx::PgPool::connect(&pg_con).await.unwrap();
//!     let ledger = SqlxLedger::new(&pool);
//!
//!     // Initialize the journal - all entities are constructed via builders
//!     let new_journal = NewJournal::builder()
//!         .id(journal_id)
//!         .description("General ledger".to_string())
//!         .name("Ledger")
//!         .build()
//!         .expect("Couldn't build NewJournal");
//!
//!     let _ = ledger.journals().create(new_journal).await; // Ignore error for repeated run
//!
//!     // Initialize an income omnibus account
//!     let main_account_id = uuid!("00000000-0000-0000-0000-000000000001");
//!     let new_account = NewAccount::builder()
//!         .id(main_account_id)
//!         .name("Income")
//!         .code("Income")
//!         .build()
//!         .unwrap();
//!
//!     let _ = ledger.accounts().create(new_account).await; // Ignore error for repeated run
//!
//!     // Create the trivial 'income' template
//!     let params = vec![
//!         ParamDefinition::builder()
//!             .name("sender_account_id")
//!             .r#type(ParamDataType::UUID)
//!             .build()
//!             .unwrap(),
//!         ParamDefinition::builder()
//!             .name("units")
//!             .r#type(ParamDataType::DECIMAL)
//!             .build()
//!             .unwrap()
//!     ];
//!      let entries = vec![
//!          EntryInput::builder()
//!              .entry_type("'INCOME_DR'")
//!              .account_id("params.sender_account_id")
//!              .layer("SETTLED")
//!              .direction("DEBIT")
//!              .units("params.units")
//!              .currency("'BTC'")
//!              .build()
//!              .unwrap(),
//!          EntryInput::builder()
//!              .entry_type("'INCOME_CR'")
//!              .account_id("uuid('00000000-0000-0000-0000-000000000001')")
//!              .layer("SETTLED")
//!              .direction("CREDIT")
//!              .units("params.units")
//!              .currency("'BTC'")
//!              .build()
//!              .unwrap(),
//!      ];
//!      let tx_code = "GENERAL_INCOME";
//!      let new_template = NewTxTemplate::builder()
//!          .id(uuid::Uuid::new_v4())
//!          .code(tx_code)
//!          .params(params)
//!          .tx_input(
//!              TxInput::builder()
//!                  .effective("date()")
//!                  .journal_id(format!("uuid('{journal_id}')"))
//!                  .build()
//!                  .unwrap(),
//!          )
//!          .entries(entries)
//!          .build()
//!          .unwrap();
//!
//!     let _ = ledger.tx_templates().create(new_template).await; // Ignore error for repeated run
//!
//!     ledger
//! }
//!
//! tokio_test::block_on(async {
//!     let journal_id = JournalId::from(uuid!("00000000-0000-0000-0000-000000000001"));
//!     let ledger = init_ledger(journal_id).await;
//!
//!     // The account that is sending to the general income account
//!     let sender_account_id = AccountId::new();
//!     let sender_account = NewAccount::builder()
//!         .id(sender_account_id)
//!         .name(format!("Sender-{sender_account_id}"))
//!         .code(format!("Sender-{sender_account_id}"))
//!         .build()
//!         .unwrap();
//!     ledger.accounts().create(sender_account).await.unwrap();
//!
//!     // Prepare the input parameters that the template requires
//!     let mut params = TxParams::new();
//!     params.insert("sender_account_id", sender_account_id);
//!     params.insert("units", Decimal::ONE);
//!
//!     // Create the transaction via the template
//!     ledger
//!         .post_transaction(TransactionId::new(), "GENERAL_INCOME", Some(params))
//!         .await
//!         .unwrap();
//!
//!     // Check the resulting balance
//!     let account_balance = ledger
//!         .balances()
//!         .find(journal_id, sender_account_id, "BTC".parse().unwrap())
//!         .await
//!         .unwrap();
//!
//!     assert_eq!(account_balance.unwrap().settled(), Decimal::NEGATIVE_ONE);
//! });
//! ```

#![cfg_attr(feature = "fail-on-warnings", deny(warnings))]
#![cfg_attr(feature = "fail-on-warnings", deny(clippy::all))]

pub mod account;
pub mod balance;
pub mod entry;
pub mod event;
pub mod journal;
pub mod transaction;
pub mod tx_template;

mod error;
mod ledger;
mod macros;
mod primitives;

pub use error::*;
pub use ledger::*;
pub use primitives::*;