Move Budget EDSL into its own module
This commit is contained in:
parent
aa7e3df8d6
commit
f82cbf3a27
|
@ -5,11 +5,12 @@
|
||||||
|
|
||||||
extern crate libc;
|
extern crate libc;
|
||||||
|
|
||||||
|
use budget::Budget;
|
||||||
use chrono::prelude::*;
|
use chrono::prelude::*;
|
||||||
use entry::Entry;
|
use entry::Entry;
|
||||||
use hash::Hash;
|
use hash::Hash;
|
||||||
use mint::Mint;
|
use mint::Mint;
|
||||||
use plan::{Budget, Payment, PaymentPlan, Witness};
|
use plan::{Payment, PaymentPlan, Witness};
|
||||||
use rayon::prelude::*;
|
use rayon::prelude::*;
|
||||||
use signature::{KeyPair, PublicKey, Signature};
|
use signature::{KeyPair, PublicKey, Signature};
|
||||||
use std::collections::hash_map::Entry::Occupied;
|
use std::collections::hash_map::Entry::Occupied;
|
||||||
|
|
|
@ -0,0 +1,168 @@
|
||||||
|
//! The `budget` module provides a domain-specific language for payment plans. Users create Budget objects that
|
||||||
|
//! are given to an interpreter. The interpreter listens for `Witness` transactions,
|
||||||
|
//! which it uses to reduce the payment plan. When the budget is reduced to a
|
||||||
|
//! `Payment`, the payment is executed.
|
||||||
|
|
||||||
|
use chrono::prelude::*;
|
||||||
|
use payment_plan::{Payment, PaymentPlan, Witness};
|
||||||
|
use signature::PublicKey;
|
||||||
|
use std::mem;
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)]
|
||||||
|
pub enum Condition {
|
||||||
|
Timestamp(DateTime<Utc>),
|
||||||
|
Signature(PublicKey),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Condition {
|
||||||
|
/// Return true if the given Witness satisfies this Condition.
|
||||||
|
pub fn is_satisfied(&self, witness: &Witness) -> bool {
|
||||||
|
match (self, witness) {
|
||||||
|
(&Condition::Signature(ref pubkey), &Witness::Signature(ref from)) => pubkey == from,
|
||||||
|
(&Condition::Timestamp(ref dt), &Witness::Timestamp(ref last_time)) => dt <= last_time,
|
||||||
|
_ => false,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[repr(C)]
|
||||||
|
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)]
|
||||||
|
pub enum Budget {
|
||||||
|
Pay(Payment),
|
||||||
|
After(Condition, Payment),
|
||||||
|
Race((Condition, Payment), (Condition, Payment)),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Budget {
|
||||||
|
/// Create the simplest spending plan - one that pays `tokens` to PublicKey.
|
||||||
|
pub fn new_payment(tokens: i64, to: PublicKey) -> Self {
|
||||||
|
Budget::Pay(Payment { tokens, to })
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a spending plan that pays `tokens` to `to` after being witnessed by `from`.
|
||||||
|
pub fn new_authorized_payment(from: PublicKey, tokens: i64, to: PublicKey) -> Self {
|
||||||
|
Budget::After(Condition::Signature(from), Payment { tokens, to })
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a spending plan that pays `tokens` to `to` after the given DateTime.
|
||||||
|
pub fn new_future_payment(dt: DateTime<Utc>, tokens: i64, to: PublicKey) -> Self {
|
||||||
|
Budget::After(Condition::Timestamp(dt), Payment { tokens, to })
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a spending plan that pays `tokens` to `to` after the given DateTime
|
||||||
|
/// unless cancelled by `from`.
|
||||||
|
pub fn new_cancelable_future_payment(
|
||||||
|
dt: DateTime<Utc>,
|
||||||
|
from: PublicKey,
|
||||||
|
tokens: i64,
|
||||||
|
to: PublicKey,
|
||||||
|
) -> Self {
|
||||||
|
Budget::Race(
|
||||||
|
(Condition::Timestamp(dt), Payment { tokens, to }),
|
||||||
|
(Condition::Signature(from), Payment { tokens, to: from }),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl PaymentPlan for Budget {
|
||||||
|
/// Return Payment if the spending plan requires no additional Witnesses.
|
||||||
|
fn final_payment(&self) -> Option<Payment> {
|
||||||
|
match *self {
|
||||||
|
Budget::Pay(ref payment) => Some(payment.clone()),
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return true if the plan spends exactly `spendable_tokens`.
|
||||||
|
fn verify(&self, spendable_tokens: i64) -> bool {
|
||||||
|
match *self {
|
||||||
|
Budget::Pay(ref payment) | Budget::After(_, ref payment) => {
|
||||||
|
payment.tokens == spendable_tokens
|
||||||
|
}
|
||||||
|
Budget::Race(ref a, ref b) => {
|
||||||
|
a.1.tokens == spendable_tokens && b.1.tokens == spendable_tokens
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Apply a witness to the spending plan to see if the plan can be reduced.
|
||||||
|
/// If so, modify the plan in-place.
|
||||||
|
fn apply_witness(&mut self, witness: &Witness) {
|
||||||
|
let new_payment = match *self {
|
||||||
|
Budget::After(ref cond, ref payment) if cond.is_satisfied(witness) => Some(payment),
|
||||||
|
Budget::Race((ref cond, ref payment), _) if cond.is_satisfied(witness) => Some(payment),
|
||||||
|
Budget::Race(_, (ref cond, ref payment)) if cond.is_satisfied(witness) => Some(payment),
|
||||||
|
_ => None,
|
||||||
|
}.cloned();
|
||||||
|
|
||||||
|
if let Some(payment) = new_payment {
|
||||||
|
mem::replace(self, Budget::Pay(payment));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_signature_satisfied() {
|
||||||
|
let sig = PublicKey::default();
|
||||||
|
assert!(Condition::Signature(sig).is_satisfied(&Witness::Signature(sig)));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_timestamp_satisfied() {
|
||||||
|
let dt1 = Utc.ymd(2014, 11, 14).and_hms(8, 9, 10);
|
||||||
|
let dt2 = Utc.ymd(2014, 11, 14).and_hms(10, 9, 8);
|
||||||
|
assert!(Condition::Timestamp(dt1).is_satisfied(&Witness::Timestamp(dt1)));
|
||||||
|
assert!(Condition::Timestamp(dt1).is_satisfied(&Witness::Timestamp(dt2)));
|
||||||
|
assert!(!Condition::Timestamp(dt2).is_satisfied(&Witness::Timestamp(dt1)));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_verify_plan() {
|
||||||
|
let dt = Utc.ymd(2014, 11, 14).and_hms(8, 9, 10);
|
||||||
|
let from = PublicKey::default();
|
||||||
|
let to = PublicKey::default();
|
||||||
|
assert!(Budget::new_payment(42, to).verify(42));
|
||||||
|
assert!(Budget::new_authorized_payment(from, 42, to).verify(42));
|
||||||
|
assert!(Budget::new_future_payment(dt, 42, to).verify(42));
|
||||||
|
assert!(Budget::new_cancelable_future_payment(dt, from, 42, to).verify(42));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_authorized_payment() {
|
||||||
|
let from = PublicKey::default();
|
||||||
|
let to = PublicKey::default();
|
||||||
|
|
||||||
|
let mut plan = Budget::new_authorized_payment(from, 42, to);
|
||||||
|
plan.apply_witness(&Witness::Signature(from));
|
||||||
|
assert_eq!(plan, Budget::new_payment(42, to));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_future_payment() {
|
||||||
|
let dt = Utc.ymd(2014, 11, 14).and_hms(8, 9, 10);
|
||||||
|
let to = PublicKey::default();
|
||||||
|
|
||||||
|
let mut plan = Budget::new_future_payment(dt, 42, to);
|
||||||
|
plan.apply_witness(&Witness::Timestamp(dt));
|
||||||
|
assert_eq!(plan, Budget::new_payment(42, to));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_cancelable_future_payment() {
|
||||||
|
let dt = Utc.ymd(2014, 11, 14).and_hms(8, 9, 10);
|
||||||
|
let from = PublicKey::default();
|
||||||
|
let to = PublicKey::default();
|
||||||
|
|
||||||
|
let mut plan = Budget::new_cancelable_future_payment(dt, from, 42, to);
|
||||||
|
plan.apply_witness(&Witness::Timestamp(dt));
|
||||||
|
assert_eq!(plan, Budget::new_payment(42, to));
|
||||||
|
|
||||||
|
let mut plan = Budget::new_cancelable_future_payment(dt, from, 42, to);
|
||||||
|
plan.apply_witness(&Witness::Signature(from));
|
||||||
|
assert_eq!(plan, Budget::new_payment(42, from));
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,6 +1,7 @@
|
||||||
#![cfg_attr(feature = "unstable", feature(test))]
|
#![cfg_attr(feature = "unstable", feature(test))]
|
||||||
pub mod bank;
|
pub mod bank;
|
||||||
pub mod banking_stage;
|
pub mod banking_stage;
|
||||||
|
pub mod budget;
|
||||||
pub mod crdt;
|
pub mod crdt;
|
||||||
pub mod entry;
|
pub mod entry;
|
||||||
pub mod entry_writer;
|
pub mod entry_writer;
|
||||||
|
|
|
@ -68,8 +68,8 @@ pub struct MintDemo {
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
use budget::Budget;
|
||||||
use ledger::Block;
|
use ledger::Block;
|
||||||
use plan::Budget;
|
|
||||||
use transaction::Instruction;
|
use transaction::Instruction;
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
|
143
src/plan.rs
143
src/plan.rs
|
@ -5,7 +5,6 @@
|
||||||
|
|
||||||
use chrono::prelude::*;
|
use chrono::prelude::*;
|
||||||
use signature::PublicKey;
|
use signature::PublicKey;
|
||||||
use std::mem;
|
|
||||||
|
|
||||||
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)]
|
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)]
|
||||||
pub enum Witness {
|
pub enum Witness {
|
||||||
|
@ -47,145 +46,3 @@ pub trait PaymentPlan {
|
||||||
/// If so, modify the plan in-place.
|
/// If so, modify the plan in-place.
|
||||||
fn apply_witness(&mut self, witness: &Witness);
|
fn apply_witness(&mut self, witness: &Witness);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[repr(C)]
|
|
||||||
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)]
|
|
||||||
pub enum Budget {
|
|
||||||
Pay(Payment),
|
|
||||||
After(Condition, Payment),
|
|
||||||
Race((Condition, Payment), (Condition, Payment)),
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Budget {
|
|
||||||
/// Create the simplest spending plan - one that pays `tokens` to PublicKey.
|
|
||||||
pub fn new_payment(tokens: i64, to: PublicKey) -> Self {
|
|
||||||
Budget::Pay(Payment { tokens, to })
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Create a spending plan that pays `tokens` to `to` after being witnessed by `from`.
|
|
||||||
pub fn new_authorized_payment(from: PublicKey, tokens: i64, to: PublicKey) -> Self {
|
|
||||||
Budget::After(Condition::Signature(from), Payment { tokens, to })
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Create a spending plan that pays `tokens` to `to` after the given DateTime.
|
|
||||||
pub fn new_future_payment(dt: DateTime<Utc>, tokens: i64, to: PublicKey) -> Self {
|
|
||||||
Budget::After(Condition::Timestamp(dt), Payment { tokens, to })
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Create a spending plan that pays `tokens` to `to` after the given DateTime
|
|
||||||
/// unless cancelled by `from`.
|
|
||||||
pub fn new_cancelable_future_payment(
|
|
||||||
dt: DateTime<Utc>,
|
|
||||||
from: PublicKey,
|
|
||||||
tokens: i64,
|
|
||||||
to: PublicKey,
|
|
||||||
) -> Self {
|
|
||||||
Budget::Race(
|
|
||||||
(Condition::Timestamp(dt), Payment { tokens, to }),
|
|
||||||
(Condition::Signature(from), Payment { tokens, to: from }),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PaymentPlan for Budget {
|
|
||||||
/// Return Payment if the spending plan requires no additional Witnesses.
|
|
||||||
fn final_payment(&self) -> Option<Payment> {
|
|
||||||
match *self {
|
|
||||||
Budget::Pay(ref payment) => Some(payment.clone()),
|
|
||||||
_ => None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Return true if the plan spends exactly `spendable_tokens`.
|
|
||||||
fn verify(&self, spendable_tokens: i64) -> bool {
|
|
||||||
match *self {
|
|
||||||
Budget::Pay(ref payment) | Budget::After(_, ref payment) => {
|
|
||||||
payment.tokens == spendable_tokens
|
|
||||||
}
|
|
||||||
Budget::Race(ref a, ref b) => {
|
|
||||||
a.1.tokens == spendable_tokens && b.1.tokens == spendable_tokens
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Apply a witness to the spending plan to see if the plan can be reduced.
|
|
||||||
/// If so, modify the plan in-place.
|
|
||||||
fn apply_witness(&mut self, witness: &Witness) {
|
|
||||||
let new_payment = match *self {
|
|
||||||
Budget::After(ref cond, ref payment) if cond.is_satisfied(witness) => Some(payment),
|
|
||||||
Budget::Race((ref cond, ref payment), _) if cond.is_satisfied(witness) => Some(payment),
|
|
||||||
Budget::Race(_, (ref cond, ref payment)) if cond.is_satisfied(witness) => Some(payment),
|
|
||||||
_ => None,
|
|
||||||
}.cloned();
|
|
||||||
|
|
||||||
if let Some(payment) = new_payment {
|
|
||||||
mem::replace(self, Budget::Pay(payment));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_signature_satisfied() {
|
|
||||||
let sig = PublicKey::default();
|
|
||||||
assert!(Condition::Signature(sig).is_satisfied(&Witness::Signature(sig)));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_timestamp_satisfied() {
|
|
||||||
let dt1 = Utc.ymd(2014, 11, 14).and_hms(8, 9, 10);
|
|
||||||
let dt2 = Utc.ymd(2014, 11, 14).and_hms(10, 9, 8);
|
|
||||||
assert!(Condition::Timestamp(dt1).is_satisfied(&Witness::Timestamp(dt1)));
|
|
||||||
assert!(Condition::Timestamp(dt1).is_satisfied(&Witness::Timestamp(dt2)));
|
|
||||||
assert!(!Condition::Timestamp(dt2).is_satisfied(&Witness::Timestamp(dt1)));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_verify_plan() {
|
|
||||||
let dt = Utc.ymd(2014, 11, 14).and_hms(8, 9, 10);
|
|
||||||
let from = PublicKey::default();
|
|
||||||
let to = PublicKey::default();
|
|
||||||
assert!(Budget::new_payment(42, to).verify(42));
|
|
||||||
assert!(Budget::new_authorized_payment(from, 42, to).verify(42));
|
|
||||||
assert!(Budget::new_future_payment(dt, 42, to).verify(42));
|
|
||||||
assert!(Budget::new_cancelable_future_payment(dt, from, 42, to).verify(42));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_authorized_payment() {
|
|
||||||
let from = PublicKey::default();
|
|
||||||
let to = PublicKey::default();
|
|
||||||
|
|
||||||
let mut plan = Budget::new_authorized_payment(from, 42, to);
|
|
||||||
plan.apply_witness(&Witness::Signature(from));
|
|
||||||
assert_eq!(plan, Budget::new_payment(42, to));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_future_payment() {
|
|
||||||
let dt = Utc.ymd(2014, 11, 14).and_hms(8, 9, 10);
|
|
||||||
let to = PublicKey::default();
|
|
||||||
|
|
||||||
let mut plan = Budget::new_future_payment(dt, 42, to);
|
|
||||||
plan.apply_witness(&Witness::Timestamp(dt));
|
|
||||||
assert_eq!(plan, Budget::new_payment(42, to));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_cancelable_future_payment() {
|
|
||||||
let dt = Utc.ymd(2014, 11, 14).and_hms(8, 9, 10);
|
|
||||||
let from = PublicKey::default();
|
|
||||||
let to = PublicKey::default();
|
|
||||||
|
|
||||||
let mut plan = Budget::new_cancelable_future_payment(dt, from, 42, to);
|
|
||||||
plan.apply_witness(&Witness::Timestamp(dt));
|
|
||||||
assert_eq!(plan, Budget::new_payment(42, to));
|
|
||||||
|
|
||||||
let mut plan = Budget::new_cancelable_future_payment(dt, from, 42, to);
|
|
||||||
plan.apply_witness(&Witness::Signature(from));
|
|
||||||
assert_eq!(plan, Budget::new_payment(42, from));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
|
@ -176,10 +176,10 @@ impl ThinClient {
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
use bank::Bank;
|
use bank::Bank;
|
||||||
|
use budget::Budget;
|
||||||
use futures::Future;
|
use futures::Future;
|
||||||
use logger;
|
use logger;
|
||||||
use mint::Mint;
|
use mint::Mint;
|
||||||
use plan::Budget;
|
|
||||||
use server::Server;
|
use server::Server;
|
||||||
use signature::{KeyPair, KeyPairUtil};
|
use signature::{KeyPair, KeyPairUtil};
|
||||||
use std::io::sink;
|
use std::io::sink;
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
//! The `transaction` module provides functionality for creating log transactions.
|
//! The `transaction` module provides functionality for creating log transactions.
|
||||||
|
|
||||||
use bincode::serialize;
|
use bincode::serialize;
|
||||||
|
use budget::{Budget, Condition};
|
||||||
use chrono::prelude::*;
|
use chrono::prelude::*;
|
||||||
use hash::Hash;
|
use hash::Hash;
|
||||||
use plan::{Budget, Condition, Payment, PaymentPlan};
|
use plan::{Payment, PaymentPlan};
|
||||||
use signature::{KeyPair, KeyPairUtil, PublicKey, Signature, SignatureUtil};
|
use signature::{KeyPair, KeyPairUtil, PublicKey, Signature, SignatureUtil};
|
||||||
|
|
||||||
pub const SIGNED_DATA_OFFSET: usize = 112;
|
pub const SIGNED_DATA_OFFSET: usize = 112;
|
||||||
|
|
Loading…
Reference in New Issue