zecfoundation
/
libbolt
mirror of https://github.com/ZcashFoundation/libbolt.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

more docs

This commit is contained in:
J. Ayo Akinyele 2018-08-24 03:31:46 -04:00
parent c297ef8c50
commit 5dabcf5e04
2 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -71,11 +71,11 @@ The libbolt library provides APIs for three types of payment channels:
## Unidirectional Payment Channels
**TODO**
A unidirectional payment channel enables payments from a customer to a merchant and only supports transfer of fixed-sized values in one direction.
### Channel Setup and Key Generation
The first part of setting up uni-directional payment channels involve generating initial setup parameters, channel state and key generation for both parties.
The first part of setting up unidirectional payment channels involve generating initial setup parameters, channel state and key generation for both parties.
use libbolt::unidirectional;

13
src/lib.rs
View File

@ -550,6 +550,7 @@ pub mod unidirectional {
unimplemented!();
}
// TODO: add pay protocol api, channel disput algs, etc
}
/////////////////////////////// Unidirectional ////////////////////////////////
@ -903,8 +904,7 @@ pub mod bidirectional {
///
pub fn pay_by_customer_phase1_precompute(pp: &PublicParams, t: &ChannelToken, pk_m: &clsigs::PublicKeyD, old_w: &mut CustomerWallet) {
// generate proof of knowledge of valid signature on previous wallet
let old_wallet_sig = &old_w.signature;
// get channel id, balance, commitment randomness and wallet sig
let cid = old_w.cid.clone();
let old_r = &old_w.r;
let old_wallet_sig = &old_w.signature;
@ -952,7 +952,6 @@ pub mod bidirectional {
///
pub fn pay_by_customer_phase1(pp: &PublicParams, channel: &ChannelState, t: &ChannelToken, pk_m: &clsigs::PublicKeyD,
old_w: &CustomerWallet, balance_increment: i32) -> (ChannelToken, CustomerWallet, PaymentProof) {
// get balance, keypair, commitment randomness and wallet sig
let mut rng = &mut rand::thread_rng();
if old_w.proof.is_none() {
@ -1488,7 +1487,7 @@ mod tests {
let b0_merch = init_merch_bal;
// generate long-lived keypair for merchant -- used to identify
// it to all customers
// merchant to all customers
let merch_keys = bidirectional::keygen(&pp);
// customer generates an ephemeral keypair for use on a single channel
@ -1620,7 +1619,7 @@ mod tests {
let pp = bidirectional::setup(true);
// just bidirectional case (w/o third party)
let mut channel = bidirectional::ChannelState::new(String::from("Channel A -> B"), false);
let mut channel = bidirectional::ChannelState::new(String::from("Channel A <-> B"), false);
let total_owed = -20;
let b0_customer = 90;
let b0_merchant = 30;
@ -1711,8 +1710,8 @@ mod tests {
let pp = bidirectional::setup(true);
// third party -- so indicate so in the channel state
let mut channel_a = bidirectional::ChannelState::new(String::from("Channel A -> I"), true);
let mut channel_b = bidirectional::ChannelState::new(String::from("Channel B -> I"), true);
let mut channel_a = bidirectional::ChannelState::new(String::from("Channel A <-> I"), true);
let mut channel_b = bidirectional::ChannelState::new(String::from("Channel B <-> I"), true);
let fee = 2;
channel_a.set_channel_fee(fee);