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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
use crate::estimate_transaction_size::estimate_virtual_size;
use crate::input::Input;
use anyhow::{anyhow, bail, Context, Result};
use bitcoin_hashes::hex::ToHex;
use conquer_once::Lazy;
use elements::bitcoin::{Amount, Network, PrivateKey, PublicKey};
use elements::confidential::{self, Asset, AssetBlindingFactor, ValueBlindingFactor};
use elements::encode::serialize;
use elements::pset::serialize::Serialize;
use elements::script::Builder;
use elements::secp256k1_zkp::{self, Secp256k1, SecretKey, Signing, Verification, SECP256K1};
use elements::sighash::SigHashCache;
use elements::{
Address, AddressParams, AssetId, OutPoint, Script, SigHashType, Transaction, TxIn, TxInWitness,
TxOut, TxOutSecrets,
};
use elements_miniscript::descriptor::CovSatisfier;
use elements_miniscript::miniscript::satisfy::After;
use elements_miniscript::{Descriptor, DescriptorTrait, Satisfier};
use rand::{CryptoRng, RngCore};
use secp256k1_zkp::{Signature, SurjectionProof, Tag};
use std::collections::HashMap;
use std::future::Future;
use std::str::FromStr;
use std::time::SystemTime;
#[cfg(test)]
mod protocol_tests;
static COVENANT_SK: Lazy<SecretKey> = Lazy::new(|| {
SecretKey::from_str("cc5417e929f7756df9a599715ad0780cea75659279cd4e2c0a19adb6339d7011")
.expect("is a valid key")
});
static COVENANT_PK: &str = "03b9b6059008e3576aad58e05a3a3e37133b05f68cda8535ec097ef4bae564a6af";
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct CollateralContract {
descriptor: Descriptor<PublicKey>,
raw_script: Script,
borrower_pk: PublicKey,
lender_pk: PublicKey,
repayment_principal_output: TxOut,
repayment_principal_output_blinder: SecretKey,
timelock: u32,
oracle_pk: PublicKey,
min_price_btc: u64,
min_timestamp: u64,
}
impl CollateralContract {
const COV_SCRIPT_BYTES: [u8; 3] = [0xad, 0xc1, 0x68];
fn new(
borrower_pk: PublicKey,
lender_pk: PublicKey,
timelock: u32,
(repayment_principal_output, repayment_principal_output_blinder): (TxOut, SecretKey),
oracle_pk: PublicKey,
min_price_btc: u64,
min_timestamp: u64,
) -> Result<Self> {
use elements::opcodes::all::*;
let repayment_principal_output_as_hex = serialize(&repayment_principal_output).to_hex();
let descriptor: Descriptor<elements::bitcoin::PublicKey> = format!(
"elcovwsh({},or_i(and_v(v:pk({}),after({})),and_v(v:pk({}),outputs_pref({}))))",
COVENANT_PK, lender_pk, timelock, borrower_pk, repayment_principal_output_as_hex,
)
.parse()
.expect("valid collateral output descriptor");
let dynamic_liquidation_branch = Builder::new()
.push_slice(lender_pk.serialize().as_slice())
.push_opcode(OP_CHECKSIGVERIFY)
.push_int(2)
.push_opcode(OP_PICK)
.push_int(2)
.push_opcode(OP_PICK)
.push_opcode(OP_CAT)
.push_slice(oracle_pk.serialize().as_slice())
.push_opcode(OP_CHECKSIGFROMSTACKVERIFY)
.push_int(min_timestamp as i64)
.push_opcode(OP_GREATERTHANOREQUAL)
.push_opcode(OP_VERIFY)
.push_int(min_price_btc as i64)
.push_opcode(OP_LESSTHANOREQUAL)
.into_script();
let raw_script = {
let mut script = vec![OP_IF.into_u8()];
script.append(&mut dynamic_liquidation_branch.to_bytes());
script.push(OP_ELSE.into_u8());
let mut desc_script = descriptor.explicit_script().to_bytes();
script.append(&mut desc_script);
script.push(OP_ENDIF.into_u8());
script
};
let raw_script = {
let mut script = raw_script;
let pos = script
.windows(3)
.position(|window| window == [0x82u8, 0x53u8, 0x88u8])
.expect("OP_SIZE OP_PUSHNUM_3 OP_EQUALVERIFY section to exist");
let _ = script.drain(pos..pos + 3);
Script::from(script)
};
Ok(Self {
descriptor,
raw_script,
borrower_pk,
lender_pk,
repayment_principal_output,
repayment_principal_output_blinder,
timelock,
oracle_pk,
min_price_btc,
min_timestamp,
})
}
async fn satisfy_loan_repayment<S, SF>(
&self,
transaction: &mut Transaction,
input_value: confidential::Value,
input_index: u32,
identity_signer: S,
) -> Result<()>
where
S: FnOnce(secp256k1::Message) -> SF,
SF: Future<Output = Result<Signature>>,
{
let transaction_cloned = transaction.clone();
let cov_script = Script::from(Self::COV_SCRIPT_BYTES.to_vec());
let satisfiers = self
.descriptor_satisfiers(
identity_signer,
&transaction_cloned,
input_value,
input_index,
self.borrower_pk,
&cov_script,
)
.await?;
self.satisfy(
satisfiers,
&mut transaction.input[input_index as usize].witness,
)?;
Ok(())
}
async fn satisfy_liquidation<S, SF>(
&self,
transaction: &mut Transaction,
input_value: confidential::Value,
input_index: u32,
identity_signer: S,
) -> Result<()>
where
S: FnOnce(secp256k1::Message) -> SF,
SF: Future<Output = Result<Signature>>,
{
let transaction_cloned = transaction.clone();
let cov_script = Script::from(Self::COV_SCRIPT_BYTES.to_vec());
let satisfiers = self
.descriptor_satisfiers(
identity_signer,
&transaction_cloned,
input_value,
input_index,
self.lender_pk,
&cov_script,
)
.await?;
let after_sat = After(self.timelock);
self.satisfy(
(satisfiers, after_sat),
&mut transaction.input[input_index as usize].witness,
)?;
Ok(())
}
async fn satisfy_dynamic_liquidation<S, SF>(
&self,
identity_signer: S,
transaction: &mut Transaction,
input_value: confidential::Value,
input_index: u32,
oracle_msg: oracle::Message,
oracle_sig: Signature,
) -> Result<()>
where
S: FnOnce(secp256k1::Message) -> SF,
SF: Future<Output = Result<Signature>>,
{
let btc_price = oracle_msg.price_to_bytes();
let timestamp = oracle_msg.timestamp_to_bytes();
let oracle_sig = oracle_sig.serialize_der().to_vec();
let script = &self.raw_script;
let sighash = SigHashCache::new(&*transaction).segwitv0_sighash(
input_index as usize,
script,
input_value,
SigHashType::All,
);
let sighash = secp256k1_zkp::Message::from(sighash);
let identity_sig = identity_signer(sighash)
.await
.context("could not sign on behalf of lender")?;
let mut identity_sig = identity_sig.serialize_der().to_vec();
identity_sig.push(SigHashType::All as u8);
let if_flag = vec![0x01];
let script = self.raw_script.to_bytes();
transaction.input[input_index as usize]
.witness
.script_witness = vec![
btc_price,
timestamp,
oracle_sig,
identity_sig,
if_flag,
script,
];
Ok(())
}
async fn descriptor_satisfiers<'a, S, SF>(
&'a self,
identity_signer: S,
transaction: &'a Transaction,
input_value: confidential::Value,
input_index: u32,
identity_pk: PublicKey,
cov_script: &'a Script,
) -> Result<impl Satisfier<PublicKey> + 'a>
where
S: FnOnce(secp256k1::Message) -> SF,
SF: Future<Output = Result<Signature>>,
{
let descriptor_cov = &self.descriptor.as_cov().expect("covenant descriptor");
let cov_sat = CovSatisfier::new_segwitv0(
transaction,
input_index,
input_value,
cov_script,
SigHashType::All,
);
let cov_pk_sat = {
let mut hash_map = HashMap::new();
let sighash = cov_sat.segwit_sighash()?;
let sighash = secp256k1_zkp::Message::from(sighash);
let sig = SECP256K1.sign(&sighash, &COVENANT_SK);
hash_map.insert(*descriptor_cov.pk(), (sig, SigHashType::All));
hash_map
};
let ident_pk_sat = {
let mut hash_map = HashMap::new();
let script = &self.raw_script;
let sighash = SigHashCache::new(&*transaction).segwitv0_sighash(
input_index as usize,
script,
input_value,
SigHashType::All,
);
let sighash = secp256k1_zkp::Message::from(sighash);
let sig = identity_signer(sighash)
.await
.context("could not sign on behalf of lender")?;
hash_map.insert(identity_pk, (sig, SigHashType::All));
hash_map
};
Ok((cov_sat, cov_pk_sat, ident_pk_sat))
}
fn satisfy<S>(&self, satisfier: S, input_witness: &mut TxInWitness) -> Result<()>
where
S: Satisfier<PublicKey>,
{
let (mut script_witness, _) = self.descriptor.get_satisfaction(satisfier)?;
{
script_witness.pop();
let if_flag = vec![];
script_witness.push(if_flag);
script_witness.push(self.raw_script.to_bytes())
};
input_witness.script_witness = script_witness;
Ok(())
}
fn address(&self) -> Address {
Address::p2wsh(&self.raw_script, None, &AddressParams::ELEMENTS)
}
fn blinded_address(&self, blinder: secp256k1_zkp::PublicKey) -> Address {
Address::p2wsh(&self.raw_script, Some(blinder), &AddressParams::ELEMENTS)
}
fn repayment_amount<C>(&self, secp: &Secp256k1<C>) -> Result<Amount>
where
C: Verification,
{
let TxOutSecrets { value, .. } = self
.repayment_principal_output
.unblind(secp, self.repayment_principal_output_blinder)?;
Ok(Amount::from_sat(value))
}
pub fn timelock(&self) -> &u32 {
&self.timelock
}
}
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct LoanRequest {
#[serde(with = "::elements::bitcoin::util::amount::serde::as_sat")]
collateral_amount: Amount,
collateral_inputs: Vec<Input>,
#[serde(with = "::elements::bitcoin::util::amount::serde::as_sat")]
fee_sats_per_vbyte: Amount,
borrower_pk: PublicKey,
timelock: u32,
borrower_address: Address,
}
impl LoanRequest {
pub fn collateral_amount(&self) -> Amount {
self.collateral_amount
}
}
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct LoanResponse {
#[serde(with = "transaction_as_string")]
transaction: Transaction,
collateral_contract: CollateralContract,
repayment_collateral_input: Input,
repayment_collateral_abf: AssetBlindingFactor,
repayment_collateral_vbf: ValueBlindingFactor,
}
impl LoanResponse {
pub fn transaction(&self) -> &Transaction {
&self.transaction
}
}
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct Borrower0 {
keypair: (SecretKey, PublicKey),
address: Address,
address_blinding_sk: SecretKey,
#[serde(with = "::elements::bitcoin::util::amount::serde::as_sat")]
collateral_amount: Amount,
collateral_inputs: Vec<Input>,
#[serde(with = "::elements::bitcoin::util::amount::serde::as_sat")]
fee_sats_per_vbyte: Amount,
timelock: u32,
bitcoin_asset_id: AssetId,
usdt_asset_id: AssetId,
}
impl Borrower0 {
#[allow(clippy::too_many_arguments)]
pub async fn new<R, CS, CF>(
rng: &mut R,
coin_selector: CS,
address: Address,
address_blinding_sk: SecretKey,
collateral_amount: Amount,
fee_sats_per_vbyte: Amount,
timelock: u32,
bitcoin_asset_id: AssetId,
usdt_asset_id: AssetId,
) -> Result<Self>
where
R: RngCore + CryptoRng,
CS: FnOnce(Amount, AssetId) -> CF,
CF: Future<Output = Result<Vec<Input>>>,
{
let keypair = make_keypair(rng);
let collateral_inputs = coin_selector(collateral_amount, bitcoin_asset_id).await?;
Ok(Self {
keypair,
address,
address_blinding_sk,
collateral_amount,
collateral_inputs,
fee_sats_per_vbyte,
timelock,
bitcoin_asset_id,
usdt_asset_id,
})
}
pub fn loan_request(&self) -> LoanRequest {
LoanRequest {
collateral_amount: self.collateral_amount,
collateral_inputs: self.collateral_inputs.clone(),
fee_sats_per_vbyte: self.fee_sats_per_vbyte,
borrower_pk: self.keypair.1,
timelock: self.timelock,
borrower_address: self.address.clone(),
}
}
pub fn interpret<C>(self, secp: &Secp256k1<C>, loan_response: LoanResponse) -> Result<Borrower1>
where
C: Signing + Verification,
{
let transaction = loan_response.transaction;
let principal_amount = transaction
.output
.iter()
.find_map(|out| {
let unblinded_out = out.unblind(secp, self.address_blinding_sk).ok()?;
let is_principal_out = unblinded_out.asset == self.usdt_asset_id
&& out.script_pubkey == self.address.script_pubkey();
is_principal_out.then(|| Amount::from_sat(unblinded_out.value))
})
.context("no principal txout")?;
let collateral_contract = loan_response.collateral_contract;
let collateral_address = collateral_contract.address();
let collateral_blinding_sk = loan_response.repayment_collateral_input.blinding_key;
let collateral_script_pubkey = collateral_address.script_pubkey();
transaction
.output
.iter()
.find_map(|out| {
let unblinded_out = out.unblind(secp, collateral_blinding_sk).ok()?;
let is_collateral_out = unblinded_out.asset == self.bitcoin_asset_id
&& unblinded_out.value == self.collateral_amount.as_sat()
&& out.script_pubkey == collateral_script_pubkey;
is_collateral_out.then(|| out)
})
.context("no collateral txout")?;
let collateral_input_amount = self
.collateral_inputs
.iter()
.map(|input| input.clone().into_unblinded_input(secp))
.try_fold(0, |sum, input| {
input.map(|input| sum + input.secrets.value).ok()
})
.context("could not sum collateral inputs")?;
let tx_fee = Amount::from_sat(
estimate_virtual_size(transaction.input.len() as u64, 4)
* self.fee_sats_per_vbyte.as_sat(),
);
let collateral_change_amount = Amount::from_sat(collateral_input_amount)
.checked_sub(self.collateral_amount)
.map(|a| a.checked_sub(tx_fee))
.flatten()
.with_context(|| {
format!(
"cannot pay for output {} and fee {} with input {}",
self.collateral_amount, tx_fee, collateral_input_amount,
)
})?;
transaction
.output
.iter()
.find_map(|out| {
let unblinded_out = out.unblind(secp, self.address_blinding_sk).ok()?;
let is_collateral_change_out = unblinded_out.asset == self.bitcoin_asset_id
&& unblinded_out.value == collateral_change_amount.as_sat()
&& out.script_pubkey == self.address.script_pubkey();
is_collateral_change_out.then(|| out)
})
.context("no collateral change txout")?;
Ok(Borrower1 {
keypair: self.keypair,
loan_transaction: transaction,
collateral_amount: self.collateral_amount,
collateral_contract,
principal_amount,
address: self.address.clone(),
repayment_collateral_input: loan_response.repayment_collateral_input,
repayment_collateral_abf: loan_response.repayment_collateral_abf,
repayment_collateral_vbf: loan_response.repayment_collateral_vbf,
bitcoin_asset_id: self.bitcoin_asset_id,
usdt_asset_id: self.usdt_asset_id,
})
}
}
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct Borrower1 {
keypair: (SecretKey, PublicKey),
loan_transaction: Transaction,
#[serde(with = "::elements::bitcoin::util::amount::serde::as_sat")]
collateral_amount: Amount,
collateral_contract: CollateralContract,
#[serde(with = "::elements::bitcoin::util::amount::serde::as_sat")]
principal_amount: Amount,
address: Address,
repayment_collateral_input: Input,
repayment_collateral_abf: AssetBlindingFactor,
repayment_collateral_vbf: ValueBlindingFactor,
bitcoin_asset_id: AssetId,
usdt_asset_id: AssetId,
}
impl Borrower1 {
pub async fn sign<S, F>(&self, signer: S) -> Result<Transaction>
where
S: FnOnce(Transaction) -> F,
F: Future<Output = Result<Transaction>>,
{
signer(self.loan_transaction.clone()).await
}
pub async fn loan_repayment_transaction<R, C, CS, CF, SI, SF>(
&self,
rng: &mut R,
secp: &Secp256k1<C>,
coin_selector: CS,
signer: SI,
fee_sats_per_vbyte: Amount,
) -> Result<Transaction>
where
R: RngCore + CryptoRng,
C: Verification + Signing,
CS: FnOnce(Amount, AssetId) -> CF,
CF: Future<Output = Result<Vec<Input>>>,
SI: FnOnce(Transaction) -> SF,
SF: Future<Output = Result<Transaction>>,
{
let collateral_input = self
.repayment_collateral_input
.clone()
.into_unblinded_input(secp)
.context("could not unblind repayment collateral input")?;
let principal_inputs = coin_selector(
self.collateral_contract.repayment_amount(secp)?,
self.usdt_asset_id,
)
.await?;
let unblinded_principal_inputs = principal_inputs
.clone()
.into_iter()
.map(|input| input.into_unblinded_input(secp))
.collect::<Result<Vec<_>>>()?;
let inputs = {
let mut borrower_inputs = unblinded_principal_inputs
.iter()
.map(|input| (input.txout.asset, &input.secrets))
.collect::<Vec<_>>();
borrower_inputs.push((collateral_input.txout.asset, &collateral_input.secrets));
borrower_inputs
};
let repayment_amount = self.collateral_contract.repayment_amount(secp)?;
let mut repayment_principal_output =
self.collateral_contract.repayment_principal_output.clone();
let domain = inputs
.iter()
.map(|(asset, secrets)| {
Ok((
asset
.into_asset_gen(secp)
.ok_or_else(|| anyhow!("unexpected explicit or null asset"))?,
Tag::from(secrets.asset.into_inner().0),
secrets.asset_bf.into_inner(),
))
})
.collect::<Result<Vec<_>>>()?;
repayment_principal_output.witness.surjection_proof = Some(SurjectionProof::new(
secp,
rng,
Tag::from(self.usdt_asset_id.into_inner().0),
self.repayment_collateral_abf.into_inner(),
domain.as_slice(),
)?);
let principal_input_amount = unblinded_principal_inputs
.iter()
.fold(0, |acc, input| acc + input.secrets.value);
let change_amount = Amount::from_sat(principal_input_amount)
.checked_sub(repayment_amount)
.with_context(|| {
format!(
"cannot pay for output {} with input {}",
repayment_amount, principal_input_amount,
)
})?;
let repayment_principal_output_secrets = TxOutSecrets::new(
self.usdt_asset_id,
self.repayment_collateral_abf,
repayment_amount.as_sat(),
self.repayment_collateral_vbf,
);
let mut outputs = vec![repayment_principal_output_secrets];
let mut tx_ins: Vec<OutPoint> = unblinded_principal_inputs
.clone()
.into_iter()
.map(|input| input.txin)
.collect();
tx_ins.push(collateral_input.txin);
let tx_ins = tx_ins
.into_iter()
.map(|previous_output| TxIn {
previous_output,
is_pegin: false,
has_issuance: false,
script_sig: Default::default(),
sequence: 0,
asset_issuance: Default::default(),
witness: Default::default(),
})
.collect::<Vec<_>>();
let inputs_not_last_confidential = inputs
.iter()
.copied()
.map(|(asset, secrets)| (asset, Some(secrets)))
.collect::<Vec<_>>();
let change_output = match change_amount {
Amount::ZERO => None,
_ => {
let (output, abf, vbf) = TxOut::new_not_last_confidential(
rng,
secp,
change_amount.as_sat(),
self.address.clone(),
self.usdt_asset_id,
&inputs_not_last_confidential,
)
.context("Change output creation failed")?;
let principal_change_output =
TxOutSecrets::new(self.usdt_asset_id, abf, change_amount.as_sat(), vbf);
outputs.push(principal_change_output);
Some(output)
}
};
let tx_fee = Amount::from_sat(
estimate_virtual_size(tx_ins.len() as u64, 4) * fee_sats_per_vbyte.as_sat(),
);
let (collateral_output, _, _) = TxOut::new_last_confidential(
rng,
secp,
(self.collateral_amount - tx_fee).as_sat(),
self.address.clone(),
self.bitcoin_asset_id,
&inputs,
outputs.iter().collect::<Vec<_>>().as_ref(),
)
.context("Creation of collateral output failed")?;
let tx_fee_output = TxOut::new_fee(tx_fee.as_sat(), self.bitcoin_asset_id);
let mut tx_outs = vec![repayment_principal_output.clone()];
if let Some(change_output) = change_output {
tx_outs.push(change_output)
}
tx_outs.push(collateral_output);
tx_outs.push(tx_fee_output);
let mut tx = Transaction {
version: 2,
lock_time: 0,
input: tx_ins,
output: tx_outs,
};
self.collateral_contract
.satisfy_loan_repayment(
&mut tx,
self.repayment_collateral_input.original_txout.value,
1,
|message| async move { Ok(SECP256K1.sign(&message, &self.keypair.0)) },
)
.await
.context("could not satisfy collateral input")?;
let tx = signer(tx).await?;
Ok(tx)
}
pub fn collateral_amount(&self) -> Amount {
self.collateral_amount
}
pub fn principal_amount(&self) -> Amount {
self.principal_amount
}
pub fn collateral_contract(&self) -> &CollateralContract {
&self.collateral_contract
}
pub fn loan_transaction(&self) -> &Transaction {
&self.loan_transaction
}
}
pub struct Lender0 {
keypair: (SecretKey, PublicKey),
address: Address,
address_blinder: SecretKey,
oracle_pk: PublicKey,
bitcoin_asset_id: AssetId,
usdt_asset_id: AssetId,
}
impl Lender0 {
pub fn new<R>(
rng: &mut R,
bitcoin_asset_id: AssetId,
usdt_asset_id: AssetId,
address: Address,
address_blinder: SecretKey,
oracle_pk: PublicKey,
) -> Result<Self>
where
R: RngCore + CryptoRng,
{
let keypair = make_keypair(rng);
Ok(Self {
keypair,
address,
address_blinder,
oracle_pk,
bitcoin_asset_id,
usdt_asset_id,
})
}
pub async fn interpret<R, C, CS, CF>(
self,
rng: &mut R,
secp: &Secp256k1<C>,
coin_selector: CS,
loan_request: LoanRequest,
rate: u64,
) -> Result<Lender1>
where
R: RngCore + CryptoRng,
C: Verification + Signing,
CS: FnOnce(Amount, AssetId) -> CF,
CF: Future<Output = Result<Vec<Input>>>,
{
let LoanAmounts {
principal: principal_amount,
repayment: repayment_amount,
min_price_btc,
} = Lender0::calculate_loan_amounts(&loan_request, rate, 20, 10)?;
let collateral_inputs = loan_request
.collateral_inputs
.into_iter()
.map(|input| input.into_unblinded_input(secp))
.collect::<Result<Vec<_>>>()?;
let borrower_inputs = collateral_inputs
.iter()
.map(|input| (input.txout.asset, &input.secrets));
let principal_inputs = coin_selector(principal_amount, self.usdt_asset_id).await?;
let unblinded_principal_inputs = principal_inputs
.clone()
.into_iter()
.map(|input| input.into_unblinded_input(secp))
.collect::<Result<Vec<_>>>()?;
let lender_inputs = unblinded_principal_inputs
.iter()
.map(|input| (input.txout.asset, &input.secrets))
.collect::<Vec<_>>();
let inputs = borrower_inputs.chain(lender_inputs).collect::<Vec<_>>();
let collateral_input_amount = collateral_inputs
.iter()
.fold(0, |sum, input| sum + input.secrets.value);
let collateral_amount = loan_request.collateral_amount;
let (repayment_principal_output, repayment_collateral_abf, repayment_collateral_vbf) = {
let dummy_asset_id = self.usdt_asset_id;
let dummy_abf = AssetBlindingFactor::new(rng);
let dummy_asset = Asset::new_confidential(secp, dummy_asset_id, dummy_abf);
let dummy_amount = principal_amount.as_sat();
let dummy_vbf = ValueBlindingFactor::new(rng);
let dummy_secrets =
TxOutSecrets::new(dummy_asset_id, dummy_abf, dummy_amount, dummy_vbf);
let dummy_inputs = [(dummy_asset, Some(&dummy_secrets))];
TxOut::new_not_last_confidential(
rng,
secp,
repayment_amount.as_sat(),
self.address.clone(),
self.usdt_asset_id,
&dummy_inputs,
)?
};
let (_, lender_pk) = self.keypair;
let (collateral_blinding_sk, collateral_blinding_pk) = make_keypair(rng);
let now = std::time::SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)?;
let contract_creation_timestamp = now.as_secs() + 300;
let collateral_contract = CollateralContract::new(
loan_request.borrower_pk,
lender_pk,
loan_request.timelock,
(repayment_principal_output, self.address_blinder),
self.oracle_pk,
min_price_btc,
contract_creation_timestamp,
)
.context("could not build collateral contract")?;
let collateral_address = collateral_contract.blinded_address(collateral_blinding_pk.key);
let inputs_not_last_confidential = inputs
.iter()
.map(|(asset, secrets)| (*asset, Some(*secrets)))
.collect::<Vec<_>>();
let (collateral_tx_out, abf_collateral, vbf_collateral) = TxOut::new_not_last_confidential(
rng,
secp,
collateral_amount.as_sat(),
collateral_address.clone(),
self.bitcoin_asset_id,
inputs_not_last_confidential.as_slice(),
)
.context("could not construct collateral txout")?;
let (principal_tx_out, abf_principal, vbf_principal) = TxOut::new_not_last_confidential(
rng,
secp,
principal_amount.as_sat(),
loan_request.borrower_address.clone(),
self.usdt_asset_id,
inputs_not_last_confidential.as_slice(),
)
.context("could not construct principal txout")?;
let principal_input_amount = unblinded_principal_inputs
.iter()
.fold(0, |sum, input| sum + input.secrets.value);
let principal_change_amount = Amount::from_sat(principal_input_amount) - principal_amount;
let (principal_change_tx_out, abf_principal_change, vbf_principal_change) =
TxOut::new_not_last_confidential(
rng,
secp,
principal_change_amount.as_sat(),
self.address.clone(),
self.usdt_asset_id,
&inputs_not_last_confidential,
)
.context("could not construct principal change txout")?;
let not_last_confidential_outputs = [
&TxOutSecrets::new(
self.bitcoin_asset_id,
abf_collateral,
collateral_amount.as_sat(),
vbf_collateral,
),
&TxOutSecrets::new(
self.usdt_asset_id,
abf_principal,
principal_amount.as_sat(),
vbf_principal,
),
&TxOutSecrets::new(
self.usdt_asset_id,
abf_principal_change,
principal_change_amount.as_sat(),
vbf_principal_change,
),
];
let tx_fee = Amount::from_sat(
estimate_virtual_size(inputs.len() as u64, 4)
* loan_request.fee_sats_per_vbyte.as_sat(),
);
let collateral_change_amount = Amount::from_sat(collateral_input_amount)
.checked_sub(collateral_amount)
.map(|a| a.checked_sub(tx_fee))
.flatten()
.with_context(|| {
format!(
"cannot pay for output {} and fee {} with input {}",
collateral_amount, tx_fee, collateral_input_amount,
)
})?;
let (collateral_change_tx_out, _, _) = TxOut::new_last_confidential(
rng,
secp,
collateral_change_amount.as_sat(),
loan_request.borrower_address,
self.bitcoin_asset_id,
inputs
.iter()
.map(|(asset, secrets)| (*asset, *secrets))
.collect::<Vec<_>>()
.as_slice(),
¬_last_confidential_outputs,
)
.context("Creation of collateral change output failed")?;
let tx_ins = {
let borrower_inputs = collateral_inputs.iter().map(|input| input.txin);
let lender_inputs = principal_inputs.iter().map(|input| input.txin);
borrower_inputs
.chain(lender_inputs)
.map(|previous_output| TxIn {
previous_output,
is_pegin: false,
has_issuance: false,
script_sig: Default::default(),
sequence: 0,
asset_issuance: Default::default(),
witness: Default::default(),
})
.collect::<Vec<_>>()
};
let tx_fee_tx_out = TxOut::new_fee(tx_fee.as_sat(), self.bitcoin_asset_id);
let loan_transaction = Transaction {
version: 2,
lock_time: 0,
input: tx_ins,
output: vec![
collateral_tx_out.clone(),
principal_tx_out,
principal_change_tx_out,
collateral_change_tx_out,
tx_fee_tx_out,
],
};
let repayment_collateral_input = {
let vout = loan_transaction
.output
.iter()
.position(|out| out.script_pubkey == collateral_address.script_pubkey())
.expect("loan transaction contains collateral output");
Input {
txin: OutPoint {
txid: loan_transaction.txid(),
vout: vout as u32,
},
original_txout: collateral_tx_out,
blinding_key: collateral_blinding_sk,
}
};
Ok(Lender1 {
keypair: self.keypair,
address: self.address,
timelock: loan_request.timelock,
loan_transaction,
collateral_contract,
collateral_amount: loan_request.collateral_amount,
repayment_collateral_input,
repayment_collateral_abf,
repayment_collateral_vbf,
bitcoin_asset_id: self.bitcoin_asset_id,
})
}
fn calculate_loan_amounts(
loan_request: &LoanRequest,
rate: u64,
overcollateralization_percentage: u8,
interest_percentage: u8,
) -> Result<LoanAmounts> {
use rust_decimal::prelude::ToPrimitive;
use rust_decimal::Decimal;
let sats = loan_request.collateral_amount.as_sat();
let btc = Decimal::from(sats)
.checked_div(Decimal::from(Amount::ONE_BTC.as_sat()))
.context("division overflow")?;
let satodollars_per_btc = Decimal::from(rate);
let overcollateralization_factor = Decimal::from(overcollateralization_percentage + 100)
.checked_div(Decimal::from(100))
.context("division overflow")?;
let satodollars_per_btc_adjusted = satodollars_per_btc
.checked_div(overcollateralization_factor)
.context("division overflow")?;
let principal = satodollars_per_btc_adjusted * btc;
let principal = principal
.to_u64()
.context("decimal cannot be represented as u64")?;
let principal = Amount::from_sat(principal);
let interest_factor = Decimal::from(interest_percentage + 100)
.checked_div(Decimal::from(100))
.context("division overflow")?;
let repayment = Decimal::from(principal.as_sat()) * interest_factor;
let min_price_btc = repayment.checked_div(btc).context("division overflow")?;
let min_price_btc = min_price_btc
.to_u64()
.context("decimal cannot be represented as u64")?;
let repayment = repayment
.to_u64()
.context("decimal cannot be represented as u64")?;
let repayment = Amount::from_sat(repayment);
Ok(LoanAmounts {
principal,
repayment,
min_price_btc,
})
}
}
struct LoanAmounts {
principal: Amount,
repayment: Amount,
min_price_btc: u64,
}
pub struct Lender1 {
keypair: (SecretKey, PublicKey),
address: Address,
timelock: u32,
loan_transaction: Transaction,
collateral_contract: CollateralContract,
collateral_amount: Amount,
repayment_collateral_input: Input,
repayment_collateral_abf: AssetBlindingFactor,
repayment_collateral_vbf: ValueBlindingFactor,
bitcoin_asset_id: AssetId,
}
impl Lender1 {
pub fn loan_response(&self) -> LoanResponse {
LoanResponse {
transaction: self.loan_transaction.clone(),
collateral_contract: self.collateral_contract.clone(),
repayment_collateral_input: self.repayment_collateral_input.clone(),
repayment_collateral_abf: self.repayment_collateral_abf,
repayment_collateral_vbf: self.repayment_collateral_vbf,
}
}
pub async fn finalise_loan<S, F>(
&self,
loan_transaction: Transaction,
signer: S,
) -> Result<Transaction>
where
S: FnOnce(Transaction) -> F,
F: Future<Output = Result<Transaction>>,
{
if self.loan_transaction.txid() != loan_transaction.txid() {
bail!("wrong loan transaction")
}
signer(loan_transaction).await
}
pub async fn liquidation_transaction<R, C>(
&self,
rng: &mut R,
secp: &Secp256k1<C>,
fee_sats_per_vbyte: Amount,
) -> Result<Transaction>
where
R: RngCore + CryptoRng,
C: Verification + Signing,
{
let collateral_input = self
.repayment_collateral_input
.clone()
.into_unblinded_input(secp)
.context("could not unblind repayment collateral input")?;
let inputs = [(collateral_input.txout.asset, &collateral_input.secrets)];
let tx_fee = Amount::from_sat(
estimate_virtual_size(inputs.len() as u64, 4) * fee_sats_per_vbyte.as_sat(),
);
let (collateral_output, _, _) = TxOut::new_last_confidential(
rng,
secp,
(self.collateral_amount - tx_fee).as_sat(),
self.address.clone(),
self.bitcoin_asset_id,
&inputs,
&[],
)
.context("Creation of collateral output failed")?;
let tx_fee_output = TxOut::new_fee(tx_fee.as_sat(), self.bitcoin_asset_id);
let tx_ins = vec![TxIn {
previous_output: collateral_input.txin,
is_pegin: false,
has_issuance: false,
script_sig: Default::default(),
sequence: 0,
asset_issuance: Default::default(),
witness: Default::default(),
}];
let tx_outs = vec![collateral_output, tx_fee_output];
let mut liquidation_transaction = Transaction {
version: 2,
lock_time: self.timelock,
input: tx_ins,
output: tx_outs,
};
self.collateral_contract
.satisfy_liquidation(
&mut liquidation_transaction,
self.repayment_collateral_input.original_txout.value,
0,
|message| async move { Ok(SECP256K1.sign(&message, &self.keypair.0)) },
)
.await
.context("could not satisfy collateral input")?;
Ok(liquidation_transaction)
}
pub async fn dynamic_liquidation_transaction<R, C>(
&self,
rng: &mut R,
secp: &Secp256k1<C>,
oracle_msg: oracle::Message,
oracle_sig: Signature,
fee_sats_per_vbyte: Amount,
) -> Result<Transaction>
where
R: RngCore + CryptoRng,
C: Verification + Signing,
{
let collateral_input = self
.repayment_collateral_input
.clone()
.into_unblinded_input(secp)
.context("could not unblind repayment collateral input")?;
let inputs = [(collateral_input.txout.asset, &collateral_input.secrets)];
let tx_fee = Amount::from_sat(
estimate_virtual_size(inputs.len() as u64, 4) * fee_sats_per_vbyte.as_sat(),
);
let (collateral_output, _, _) = TxOut::new_last_confidential(
rng,
secp,
(self.collateral_amount - tx_fee).as_sat(),
self.address.clone(),
self.bitcoin_asset_id,
&inputs,
&[],
)
.context("Creation of collateral output failed")?;
let tx_fee_output = TxOut::new_fee(tx_fee.as_sat(), self.bitcoin_asset_id);
let tx_ins = vec![TxIn {
previous_output: collateral_input.txin,
is_pegin: false,
has_issuance: false,
script_sig: Default::default(),
sequence: 0,
asset_issuance: Default::default(),
witness: Default::default(),
}];
let tx_outs = vec![collateral_output, tx_fee_output];
let mut liquidation_transaction = Transaction {
version: 2,
lock_time: 0,
input: tx_ins,
output: tx_outs,
};
self.collateral_contract
.satisfy_dynamic_liquidation(
|message| async move { Ok(SECP256K1.sign(&message, &self.keypair.0)) },
&mut liquidation_transaction,
self.repayment_collateral_input.original_txout.value,
0,
oracle_msg,
oracle_sig,
)
.await?;
Ok(liquidation_transaction)
}
pub fn collateral_contract(&self) -> &CollateralContract {
&self.collateral_contract
}
}
pub(crate) mod oracle {
pub struct Message {
btc_price: WitnessStackInteger,
timestamp: WitnessStackInteger,
}
impl Message {
pub fn new(btc_price: u64, timestamp: u64) -> Self {
Self {
btc_price: WitnessStackInteger(btc_price),
timestamp: WitnessStackInteger(timestamp),
}
}
pub fn price_to_bytes(&self) -> Vec<u8> {
self.btc_price.serialize()
}
pub fn timestamp_to_bytes(&self) -> Vec<u8> {
self.timestamp.serialize()
}
#[cfg(test)]
pub fn message_hash(&self) -> secp256k1::Message {
use bitcoin_hashes::{sha256, Hash, HashEngine};
let mut sha256d = sha256::Hash::engine();
sha256d.input(&self.price_to_bytes());
sha256d.input(&self.timestamp_to_bytes());
let message_hash = sha256::Hash::from_engine(sha256d);
secp256k1::Message::from_slice(&message_hash).unwrap()
}
}
struct WitnessStackInteger(u64);
impl WitnessStackInteger {
fn serialize(&self) -> Vec<u8> {
let bytes = self.0.to_be_bytes().to_vec();
let mut bytes = bytes
.into_iter()
.skip_while(|byte| *byte == 0)
.collect::<Vec<_>>();
bytes.reverse();
bytes
}
}
}
fn make_keypair<R>(rng: &mut R) -> (SecretKey, PublicKey)
where
R: RngCore + CryptoRng,
{
let sk = SecretKey::new(rng);
let pk = PublicKey::from_private_key(
SECP256K1,
&PrivateKey {
compressed: true,
network: Network::Regtest,
key: sk,
},
);
(sk, pk)
}
pub mod transaction_as_string {
use elements::encode::serialize_hex;
use elements::Transaction;
use serde::de::Error;
use serde::{Deserialize, Deserializer, Serializer};
pub fn serialize<S: Serializer>(a: &Transaction, s: S) -> Result<S::Ok, S::Error> {
s.serialize_str(&serialize_hex(a))
}
pub fn deserialize<'d, D: Deserializer<'d>>(d: D) -> Result<Transaction, D::Error> {
let string = String::deserialize(d)?;
let bytes = hex::decode(string).map_err(D::Error::custom)?;
let tx = elements::encode::deserialize(&bytes).map_err(D::Error::custom)?;
Ok(tx)
}
}
#[cfg(test)]
mod constant_tests {
use super::*;
#[test]
fn covenant_pk_is_the_public_key_of_covenant_sk() {
let pk = PublicKey::from_private_key(
SECP256K1,
&PrivateKey::new(*COVENANT_SK, elements::bitcoin::Network::Regtest),
);
assert_eq!(format!("{}", pk), COVENANT_PK)
}
#[test]
fn cov_script_bytes_represents_correct_script() {
use elements::opcodes::all::*;
let expected = Builder::new()
.push_opcode(OP_CHECKSIGVERIFY)
.push_opcode(OP_CHECKSIGFROMSTACK)
.push_opcode(OP_ENDIF)
.into_script();
let actual = Script::from(CollateralContract::COV_SCRIPT_BYTES.to_vec());
assert_eq!(actual, expected);
}
}