-
Notifications
You must be signed in to change notification settings - Fork 989
/
transaction.rs
2561 lines (2238 loc) · 72.7 KB
/
transaction.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
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
// Copyright 2021 The Grin Developers
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Transactions
use crate::core::hash::{DefaultHashable, Hashed};
use crate::core::{committed, Committed};
use crate::libtx::{aggsig, secp_ser};
use crate::ser::{
self, read_multi, PMMRable, ProtocolVersion, Readable, Reader, VerifySortedAndUnique,
Writeable, Writer,
};
use crate::{consensus, global};
use enum_primitive::FromPrimitive;
use keychain::{self, BlindingFactor};
use serde::de;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use std::cmp::Ordering;
use std::cmp::{max, min};
use std::convert::{TryFrom, TryInto};
use std::fmt::Display;
use std::{error, fmt};
use util::secp;
use util::secp::pedersen::{Commitment, RangeProof};
use util::static_secp_instance;
use util::ToHex;
/// Fee fields as in fix-fees RFC: { future_use: 20, fee_shift: 4, fee: 40 }
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct FeeFields(u64);
impl DefaultHashable for FeeFields {}
impl Writeable for FeeFields {
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ser::Error> {
writer.write_u64(self.0)
}
}
impl Readable for FeeFields {
fn read<R: Reader>(reader: &mut R) -> Result<Self, ser::Error> {
let fee_fields = reader.read_u64()?;
Ok(Self(fee_fields))
}
}
impl Display for FeeFields {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.0)
}
}
impl Serialize for FeeFields {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.collect_str(&self.0)
}
}
impl<'de> Deserialize<'de> for FeeFields {
fn deserialize<D>(deserializer: D) -> Result<FeeFields, D::Error>
where
D: Deserializer<'de>,
{
struct FeeFieldsVisitor;
impl<'de> de::Visitor<'de> for FeeFieldsVisitor {
type Value = FeeFields;
fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
formatter.write_str("an 64-bit integer")
}
fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
where
E: de::Error,
{
let value = value
.parse()
.map_err(|_| E::custom(format!("invalid fee field")))?;
self.visit_u64(value)
}
fn visit_u64<E>(self, value: u64) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(FeeFields(value))
}
}
deserializer.deserialize_any(FeeFieldsVisitor)
}
}
/// Conversion from a valid fee to a FeeFields with 0 fee_shift
/// The valid fee range is 1..FEE_MASK
impl TryFrom<u64> for FeeFields {
type Error = Error;
fn try_from(fee: u64) -> Result<Self, Self::Error> {
if fee == 0 || fee > FeeFields::FEE_MASK {
Err(Error::InvalidFeeFields)
} else {
Ok(Self(fee))
}
}
}
/// Conversion from a 32-bit fee to a FeeFields with 0 fee_shift
/// For use exclusively in tests with constant fees
impl From<u32> for FeeFields {
fn from(fee: u32) -> Self {
Self(fee as u64)
}
}
impl From<FeeFields> for u64 {
fn from(fee_fields: FeeFields) -> Self {
fee_fields.0 as u64
}
}
impl FeeFields {
/// Fees are limited to 40 bits
const FEE_BITS: u32 = 40;
/// Used to extract fee field
const FEE_MASK: u64 = (1u64 << FeeFields::FEE_BITS) - 1;
/// Fee shifts are limited to 4 bits
pub const FEE_SHIFT_BITS: u32 = 4;
/// Used to extract fee_shift field
pub const FEE_SHIFT_MASK: u64 = (1u64 << FeeFields::FEE_SHIFT_BITS) - 1;
/// Create a zero FeeFields with 0 fee and 0 fee_shift
pub fn zero() -> Self {
Self(0)
}
/// Create a new FeeFields from the provided shift and fee
/// Checks both are valid (in range)
pub fn new(fee_shift: u64, fee: u64) -> Result<Self, Error> {
if fee == 0 || fee > FeeFields::FEE_MASK || fee_shift > FeeFields::FEE_SHIFT_MASK {
Err(Error::InvalidFeeFields)
} else {
Ok(Self((fee_shift << FeeFields::FEE_BITS) | fee))
}
}
/// Extract fee_shift field
pub fn fee_shift(&self) -> u8 {
((self.0 >> FeeFields::FEE_BITS) & FeeFields::FEE_SHIFT_MASK) as u8
}
/// Extract fee field
pub fn fee(&self) -> u64 {
self.0 & FeeFields::FEE_MASK
}
/// Turn a zero `FeeField` into a `None`, any other value into a `Some`.
/// We need this because a zero `FeeField` cannot be deserialized.
pub fn as_opt(&self) -> Option<Self> {
if self.is_zero() {
None
} else {
Some(*self)
}
}
/// Check if the `FeeFields` is set to zero
pub fn is_zero(&self) -> bool {
self.0 == 0
}
}
fn fee_fields_as_int<S>(fee_fields: &FeeFields, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.serialize_u64(fee_fields.0)
}
/// Relative height field on NRD kernel variant.
/// u16 representing a height between 1 and MAX (consensus::WEEK_HEIGHT).
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
pub struct NRDRelativeHeight(u16);
impl DefaultHashable for NRDRelativeHeight {}
impl Writeable for NRDRelativeHeight {
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ser::Error> {
writer.write_u16(self.0)
}
}
impl Readable for NRDRelativeHeight {
fn read<R: Reader>(reader: &mut R) -> Result<Self, ser::Error> {
let x = reader.read_u16()?;
NRDRelativeHeight::try_from(x).map_err(|_| ser::Error::CorruptedData)
}
}
/// Conversion from a u16 to a valid NRDRelativeHeight.
/// Valid height is between 1 and WEEK_HEIGHT inclusive.
impl TryFrom<u16> for NRDRelativeHeight {
type Error = Error;
fn try_from(height: u16) -> Result<Self, Self::Error> {
if height == 0
|| height
> NRDRelativeHeight::MAX
.try_into()
.expect("WEEK_HEIGHT const should fit in u16")
{
Err(Error::InvalidNRDRelativeHeight)
} else {
Ok(Self(height))
}
}
}
impl TryFrom<u64> for NRDRelativeHeight {
type Error = Error;
fn try_from(height: u64) -> Result<Self, Self::Error> {
Self::try_from(u16::try_from(height).map_err(|_| Error::InvalidNRDRelativeHeight)?)
}
}
impl From<NRDRelativeHeight> for u64 {
fn from(height: NRDRelativeHeight) -> Self {
height.0 as u64
}
}
impl NRDRelativeHeight {
const MAX: u64 = consensus::WEEK_HEIGHT;
/// Create a new NRDRelativeHeight from the provided height.
/// Checks height is valid (between 1 and WEEK_HEIGHT inclusive).
pub fn new(height: u64) -> Result<Self, Error> {
NRDRelativeHeight::try_from(height)
}
}
/// Various tx kernel variants.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
pub enum KernelFeatures {
/// Plain kernel (the default for Grin txs).
Plain {
/// Plain kernels have fees.
#[serde(serialize_with = "fee_fields_as_int")]
fee: FeeFields,
},
/// A coinbase kernel.
Coinbase,
/// A kernel with an explicit lock height (and fee).
HeightLocked {
/// Height locked kernels have fees.
#[serde(serialize_with = "fee_fields_as_int")]
fee: FeeFields,
/// Height locked kernels have lock heights.
lock_height: u64,
},
/// "No Recent Duplicate" (NRD) kernels enforcing relative lock height between instances.
NoRecentDuplicate {
/// These have fees.
#[serde(serialize_with = "fee_fields_as_int")]
fee: FeeFields,
/// Relative lock height.
relative_height: NRDRelativeHeight,
},
}
impl KernelFeatures {
const PLAIN_U8: u8 = 0;
const COINBASE_U8: u8 = 1;
const HEIGHT_LOCKED_U8: u8 = 2;
const NO_RECENT_DUPLICATE_U8: u8 = 3;
/// Underlying (u8) value representing this kernel variant.
/// This is the first byte when we serialize/deserialize the kernel features.
pub fn as_u8(&self) -> u8 {
match self {
KernelFeatures::Plain { .. } => KernelFeatures::PLAIN_U8,
KernelFeatures::Coinbase => KernelFeatures::COINBASE_U8,
KernelFeatures::HeightLocked { .. } => KernelFeatures::HEIGHT_LOCKED_U8,
KernelFeatures::NoRecentDuplicate { .. } => KernelFeatures::NO_RECENT_DUPLICATE_U8,
}
}
/// Conversion for backward compatibility.
pub fn as_string(&self) -> String {
match self {
KernelFeatures::Plain { .. } => String::from("Plain"),
KernelFeatures::Coinbase => String::from("Coinbase"),
KernelFeatures::HeightLocked { .. } => String::from("HeightLocked"),
KernelFeatures::NoRecentDuplicate { .. } => String::from("NoRecentDuplicate"),
}
}
/// msg = hash(features) for coinbase kernels
/// hash(features || fee_fields) for plain kernels
/// hash(features || fee_fields || lock_height) for height locked kernels
/// hash(features || fee_fields || relative_height) for NRD kernels
pub fn kernel_sig_msg(&self) -> Result<secp::Message, Error> {
let x = self.as_u8();
let hash = match self {
KernelFeatures::Plain { fee } => (x, fee).hash(),
KernelFeatures::Coinbase => x.hash(),
KernelFeatures::HeightLocked { fee, lock_height } => (x, fee, lock_height).hash(),
KernelFeatures::NoRecentDuplicate {
fee,
relative_height,
} => (x, fee, relative_height).hash(),
};
let msg = secp::Message::from_slice(&hash.as_bytes())?;
Ok(msg)
}
/// Write tx kernel features out in v1 protocol format.
/// Always include the fee_fields and lock_height, writing 0 value if unused.
fn write_v1<W: Writer>(&self, writer: &mut W) -> Result<(), ser::Error> {
writer.write_u8(self.as_u8())?;
match self {
KernelFeatures::Plain { fee } => {
fee.write(writer)?;
// Write "empty" bytes for feature specific data (8 bytes).
writer.write_empty_bytes(8)?;
}
KernelFeatures::Coinbase => {
// Write "empty" bytes for fee_fields (8 bytes) and feature specific data (8 bytes).
writer.write_empty_bytes(16)?;
}
KernelFeatures::HeightLocked { fee, lock_height } => {
fee.write(writer)?;
// 8 bytes of feature specific data containing the lock height as big-endian u64.
writer.write_u64(*lock_height)?;
}
KernelFeatures::NoRecentDuplicate {
fee,
relative_height,
} => {
fee.write(writer)?;
// 8 bytes of feature specific data. First 6 bytes are empty.
// Last 2 bytes contain the relative lock height as big-endian u16.
// Note: This is effectively the same as big-endian u64.
// We write "empty" bytes explicitly rather than quietly casting the u16 -> u64.
writer.write_empty_bytes(6)?;
relative_height.write(writer)?;
}
};
Ok(())
}
/// Write tx kernel features out in v2 protocol format.
/// These are variable sized based on feature variant.
/// Only write fee_fields out for feature variants that support it.
/// Only write lock_height out for feature variants that support it.
fn write_v2<W: Writer>(&self, writer: &mut W) -> Result<(), ser::Error> {
writer.write_u8(self.as_u8())?;
match self {
KernelFeatures::Plain { fee } => {
// Fee only, no additional data on plain kernels.
fee.write(writer)?;
}
KernelFeatures::Coinbase => {
// No additional data.
}
KernelFeatures::HeightLocked { fee, lock_height } => {
fee.write(writer)?;
// V2 height locked kernels use 8 bytes for the lock height.
writer.write_u64(*lock_height)?;
}
KernelFeatures::NoRecentDuplicate {
fee,
relative_height,
} => {
fee.write(writer)?;
// V2 NRD kernels use 2 bytes for the relative lock height.
relative_height.write(writer)?;
}
}
Ok(())
}
// Always read feature byte, 8 bytes for fee_fields and 8 bytes for additional data
// representing lock height or relative height.
// Fee and additional data may be unused for some kernel variants but we need
// to read these bytes and verify they are 0 if unused.
fn read_v1<R: Reader>(reader: &mut R) -> Result<KernelFeatures, ser::Error> {
let feature_byte = reader.read_u8()?;
let features = match feature_byte {
KernelFeatures::PLAIN_U8 => {
let fee = FeeFields::read(reader)?;
// 8 "empty" bytes as additional data is not used.
reader.read_empty_bytes(8)?;
KernelFeatures::Plain { fee }
}
KernelFeatures::COINBASE_U8 => {
// 8 "empty" bytes as fee_fields is not used.
// 8 "empty" bytes as additional data is not used.
reader.read_empty_bytes(16)?;
KernelFeatures::Coinbase
}
KernelFeatures::HEIGHT_LOCKED_U8 => {
let fee = FeeFields::read(reader)?;
// 8 bytes of feature specific data, lock height as big-endian u64.
let lock_height = reader.read_u64()?;
KernelFeatures::HeightLocked { fee, lock_height }
}
KernelFeatures::NO_RECENT_DUPLICATE_U8 => {
// NRD kernels are invalid if NRD feature flag is not enabled.
if !global::is_nrd_enabled() {
return Err(ser::Error::CorruptedData);
}
let fee = FeeFields::read(reader)?;
// 8 bytes of feature specific data.
// The first 6 bytes must be "empty".
// The last 2 bytes is the relative height as big-endian u16.
reader.read_empty_bytes(6)?;
let relative_height = NRDRelativeHeight::read(reader)?;
KernelFeatures::NoRecentDuplicate {
fee,
relative_height,
}
}
_ => {
return Err(ser::Error::CorruptedData);
}
};
Ok(features)
}
// V2 kernels only expect bytes specific to each variant.
// Coinbase kernels have no associated fee and we do not serialize a fee for these.
fn read_v2<R: Reader>(reader: &mut R) -> Result<KernelFeatures, ser::Error> {
let features = match reader.read_u8()? {
KernelFeatures::PLAIN_U8 => {
let fee = FeeFields::read(reader)?;
KernelFeatures::Plain { fee }
}
KernelFeatures::COINBASE_U8 => KernelFeatures::Coinbase,
KernelFeatures::HEIGHT_LOCKED_U8 => {
let fee = FeeFields::read(reader)?;
let lock_height = reader.read_u64()?;
KernelFeatures::HeightLocked { fee, lock_height }
}
KernelFeatures::NO_RECENT_DUPLICATE_U8 => {
// NRD kernels are invalid if NRD feature flag is not enabled.
if !global::is_nrd_enabled() {
return Err(ser::Error::CorruptedData);
}
let fee = FeeFields::read(reader)?;
let relative_height = NRDRelativeHeight::read(reader)?;
KernelFeatures::NoRecentDuplicate {
fee,
relative_height,
}
}
_ => {
return Err(ser::Error::CorruptedData);
}
};
Ok(features)
}
}
impl Writeable for KernelFeatures {
/// Protocol version may increment rapidly for other unrelated changes.
/// So we match on ranges here and not specific version values.
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ser::Error> {
// Care must be exercised when writing for hashing purposes.
// All kernels are hashed using original v1 serialization strategy.
if writer.serialization_mode().is_hash_mode() {
return self.write_v1(writer);
}
match writer.protocol_version().value() {
0..=1 => self.write_v1(writer),
2..=ProtocolVersion::MAX => self.write_v2(writer),
}
}
}
impl Readable for KernelFeatures {
fn read<R: Reader>(reader: &mut R) -> Result<KernelFeatures, ser::Error> {
match reader.protocol_version().value() {
0..=1 => KernelFeatures::read_v1(reader),
2..=ProtocolVersion::MAX => KernelFeatures::read_v2(reader),
}
}
}
/// Errors thrown by Transaction validation
#[derive(Clone, Eq, Debug, PartialEq, Serialize, Deserialize)]
pub enum Error {
/// Underlying Secp256k1 error (signature validation or invalid public key
/// typically)
Secp(secp::Error),
/// Underlying keychain related error
Keychain(keychain::Error),
/// The sum of output minus input commitments does not
/// match the sum of kernel commitments
KernelSumMismatch,
/// Restrict tx total weight.
TooHeavy,
/// Error originating from an invalid lock-height
LockHeight(u64),
/// Range proof validation error
RangeProof,
/// Error originating from an invalid Merkle proof
MerkleProof,
/// Returns if the value hidden within the a RangeProof message isn't
/// repeated 3 times, indicating it's incorrect
InvalidProofMessage,
/// Error when verifying kernel sums via committed trait.
Committed(committed::Error),
/// Validation error relating to cut-through (tx is spending its own
/// output).
CutThrough,
/// Validation error relating to output features.
/// It is invalid for a transaction to contain a coinbase output, for example.
InvalidOutputFeatures,
/// Validation error relating to kernel features.
/// It is invalid for a transaction to contain a coinbase kernel, for example.
InvalidKernelFeatures,
/// feeshift is limited to 4 bits and fee must be positive and fit in 40 bits.
InvalidFeeFields,
/// NRD kernel relative height is limited to 1 week duration and must be greater than 0.
InvalidNRDRelativeHeight,
/// Signature verification error.
IncorrectSignature,
/// Underlying serialization error.
Serialization(ser::Error),
}
impl error::Error for Error {
fn description(&self) -> &str {
match *self {
_ => "some kind of keychain error",
}
}
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self {
_ => write!(f, "some kind of keychain error"),
}
}
}
impl From<ser::Error> for Error {
fn from(e: ser::Error) -> Error {
Error::Serialization(e)
}
}
impl From<secp::Error> for Error {
fn from(e: secp::Error) -> Error {
Error::Secp(e)
}
}
impl From<keychain::Error> for Error {
fn from(e: keychain::Error) -> Error {
Error::Keychain(e)
}
}
impl From<committed::Error> for Error {
fn from(e: committed::Error) -> Error {
Error::Committed(e)
}
}
/// A proof that a transaction sums to zero. Includes both the transaction's
/// Pedersen commitment and the signature, that guarantees that the commitments
/// amount to zero.
/// The signature signs the fee_fields and the lock_height, which are retained for
/// signature validation.
#[derive(Serialize, Deserialize, Debug, Clone, Copy)]
pub struct TxKernel {
/// Options for a kernel's structure or use
pub features: KernelFeatures,
/// Remainder of the sum of all transaction commitments. If the transaction
/// is well formed, amounts components should sum to zero and the excess
/// is hence a valid public key (sum of the commitment public keys).
#[serde(
serialize_with = "secp_ser::as_hex",
deserialize_with = "secp_ser::commitment_from_hex"
)]
pub excess: Commitment,
/// The signature proving the excess is a valid public key, which signs
/// the transaction fee_fields.
#[serde(with = "secp_ser::sig_serde")]
pub excess_sig: secp::Signature,
}
impl DefaultHashable for TxKernel {}
hashable_ord!(TxKernel);
/// We want to be able to put kernels in a hashset in the pool.
/// So we need to be able to hash them.
impl ::std::hash::Hash for TxKernel {
fn hash<H: ::std::hash::Hasher>(&self, state: &mut H) {
let mut vec = Vec::new();
ser::serialize_default(&mut vec, &self).expect("serialization failed");
::std::hash::Hash::hash(&vec, state);
}
}
impl Writeable for TxKernel {
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ser::Error> {
self.features.write(writer)?;
self.excess.write(writer)?;
self.excess_sig.write(writer)?;
Ok(())
}
}
impl Readable for TxKernel {
fn read<R: Reader>(reader: &mut R) -> Result<TxKernel, ser::Error> {
Ok(TxKernel {
features: KernelFeatures::read(reader)?,
excess: Commitment::read(reader)?,
excess_sig: secp::Signature::read(reader)?,
})
}
}
/// We store kernels in the kernel MMR.
/// Note: These are "variable size" to support different kernel feature variants.
impl PMMRable for TxKernel {
type E = Self;
fn as_elmt(&self) -> Self::E {
self.clone()
}
fn elmt_size() -> Option<u16> {
None
}
}
impl KernelFeatures {
/// Is this a coinbase kernel?
pub fn is_coinbase(&self) -> bool {
match self {
KernelFeatures::Coinbase => true,
_ => false,
}
}
/// Is this a plain kernel?
pub fn is_plain(&self) -> bool {
match self {
KernelFeatures::Plain { .. } => true,
_ => false,
}
}
/// Is this a height locked kernel?
pub fn is_height_locked(&self) -> bool {
match self {
KernelFeatures::HeightLocked { .. } => true,
_ => false,
}
}
/// Is this an NRD kernel?
pub fn is_nrd(&self) -> bool {
match self {
KernelFeatures::NoRecentDuplicate { .. } => true,
_ => false,
}
}
}
impl TxKernel {
/// Is this a coinbase kernel?
pub fn is_coinbase(&self) -> bool {
self.features.is_coinbase()
}
/// Is this a plain kernel?
pub fn is_plain(&self) -> bool {
self.features.is_plain()
}
/// Is this a height locked kernel?
pub fn is_height_locked(&self) -> bool {
self.features.is_height_locked()
}
/// Is this an NRD kernel?
pub fn is_nrd(&self) -> bool {
self.features.is_nrd()
}
/// Return the excess commitment for this tx_kernel.
pub fn excess(&self) -> Commitment {
self.excess
}
/// The msg signed as part of the tx kernel.
/// Based on kernel features and associated fields (fee_fields and lock_height).
pub fn msg_to_sign(&self) -> Result<secp::Message, Error> {
let msg = self.features.kernel_sig_msg()?;
Ok(msg)
}
/// Verify the transaction proof validity. Entails handling the commitment
/// as a public key and checking the signature verifies with the fee_fields as
/// message.
pub fn verify(&self) -> Result<(), Error> {
let secp = static_secp_instance();
let secp = secp.lock();
let sig = &self.excess_sig;
// Verify aggsig directly in libsecp
let pubkey = &self.excess.to_pubkey(&secp)?;
if !aggsig::verify_single(
&secp,
&sig,
&self.msg_to_sign()?,
None,
&pubkey,
Some(&pubkey),
false,
) {
return Err(Error::IncorrectSignature);
}
Ok(())
}
/// Batch signature verification.
pub fn batch_sig_verify(tx_kernels: &[TxKernel]) -> Result<(), Error> {
let len = tx_kernels.len();
let mut sigs = Vec::with_capacity(len);
let mut pubkeys = Vec::with_capacity(len);
let mut msgs = Vec::with_capacity(len);
let secp = static_secp_instance();
let secp = secp.lock();
for tx_kernel in tx_kernels {
sigs.push(tx_kernel.excess_sig);
pubkeys.push(tx_kernel.excess.to_pubkey(&secp)?);
msgs.push(tx_kernel.msg_to_sign()?);
}
if !aggsig::verify_batch(&secp, &sigs, &msgs, &pubkeys) {
return Err(Error::IncorrectSignature);
}
Ok(())
}
/// Build an empty tx kernel with zero values.
pub fn empty() -> TxKernel {
TxKernel::with_features(KernelFeatures::Plain {
fee: FeeFields::zero(),
})
}
/// Build an empty tx kernel with the provided kernel features.
pub fn with_features(features: KernelFeatures) -> TxKernel {
TxKernel {
features,
excess: Commitment::from_vec(vec![0; 33]),
excess_sig: secp::Signature::from_raw_data(&[0; 64]).unwrap(),
}
}
}
/// Enum of possible tx weight verification options -
///
/// * As "transaction" checks tx (as block) weight does not exceed max_block_weight.
/// * As "block" same as above but allow for additional coinbase reward (1 output, 1 kernel).
/// * With "no limit" to skip the weight check.
///
#[derive(Clone, Copy)]
pub enum Weighting {
/// Tx represents a tx (max block weight, accounting for additional coinbase reward).
AsTransaction,
/// Tx representing a tx with artificially limited max_weight.
/// This is used when selecting mineable txs from the pool.
AsLimitedTransaction(u64),
/// Tx represents a block (max block weight).
AsBlock,
/// No max weight limit (skip the weight check).
NoLimit,
}
/// TransactionBody is a common abstraction for transaction and block
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct TransactionBody {
/// List of inputs spent by the transaction.
pub inputs: Inputs,
/// List of outputs the transaction produces.
pub outputs: Vec<Output>,
/// List of kernels that make up this transaction (usually a single kernel).
pub kernels: Vec<TxKernel>,
}
/// Implementation of Writeable for a body, defines how to
/// write the body as binary.
impl Writeable for TransactionBody {
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ser::Error> {
ser_multiwrite!(
writer,
[write_u64, self.inputs.len() as u64],
[write_u64, self.outputs.len() as u64],
[write_u64, self.kernels.len() as u64]
);
self.inputs.write(writer)?;
self.outputs.write(writer)?;
self.kernels.write(writer)?;
Ok(())
}
}
/// Implementation of Readable for a body, defines how to read a
/// body from a binary stream.
impl Readable for TransactionBody {
fn read<R: Reader>(reader: &mut R) -> Result<TransactionBody, ser::Error> {
let (num_inputs, num_outputs, num_kernels) =
ser_multiread!(reader, read_u64, read_u64, read_u64);
// Quick block weight check before proceeding.
// Note: We use weight_as_block here (inputs have weight).
let tx_block_weight = TransactionBody::weight_by_iok(num_inputs, num_outputs, num_kernels);
if tx_block_weight > global::max_block_weight() {
return Err(ser::Error::TooLargeReadErr);
}
// Read protocol version specific inputs.
let inputs = match reader.protocol_version().value() {
0..=2 => {
let inputs: Vec<Input> = read_multi(reader, num_inputs)?;
Inputs::from(inputs.as_slice())
}
3..=ser::ProtocolVersion::MAX => {
let inputs: Vec<CommitWrapper> = read_multi(reader, num_inputs)?;
Inputs::from(inputs.as_slice())
}
};
let outputs = read_multi(reader, num_outputs)?;
let kernels = read_multi(reader, num_kernels)?;
// Initialize tx body and verify everything is sorted.
let body = TransactionBody::init(inputs, &outputs, &kernels, true)
.map_err(|_| ser::Error::CorruptedData)?;
Ok(body)
}
}
impl Committed for TransactionBody {
fn inputs_committed(&self) -> Vec<Commitment> {
let inputs: Vec<_> = self.inputs().into();
inputs.iter().map(|x| x.commitment()).collect()
}
fn outputs_committed(&self) -> Vec<Commitment> {
self.outputs().iter().map(|x| x.commitment()).collect()
}
fn kernels_committed(&self) -> Vec<Commitment> {
self.kernels().iter().map(|x| x.excess()).collect()
}
}
impl Default for TransactionBody {
fn default() -> TransactionBody {
TransactionBody::empty()
}
}
impl From<Transaction> for TransactionBody {
fn from(tx: Transaction) -> Self {
tx.body
}
}
impl TransactionBody {
/// Creates a new empty transaction (no inputs or outputs, zero fee).
pub fn empty() -> TransactionBody {
TransactionBody {
inputs: Inputs::default(),
outputs: vec![],
kernels: vec![],
}
}
/// Sort the inputs|outputs|kernels.
pub fn sort(&mut self) {
self.inputs.sort_unstable();
self.outputs.sort_unstable();
self.kernels.sort_unstable();
}
/// Creates a new transaction body initialized with
/// the provided inputs, outputs and kernels.
/// Guarantees inputs, outputs, kernels are sorted lexicographically.
pub fn init(
inputs: Inputs,
outputs: &[Output],
kernels: &[TxKernel],
verify_sorted: bool,
) -> Result<TransactionBody, Error> {
let mut body = TransactionBody {
inputs,
outputs: outputs.to_vec(),
kernels: kernels.to_vec(),
};
if verify_sorted {
// If we are verifying sort order then verify and
// return an error if not sorted lexicographically.
body.verify_sorted()?;
} else {
// If we are not verifying sort order then sort in place and return.
body.sort();
}
Ok(body)
}
/// Transaction inputs.
pub fn inputs(&self) -> Inputs {
self.inputs.clone()
}
/// Transaction outputs.
pub fn outputs(&self) -> &[Output] {
&self.outputs
}
/// Transaction kernels.
pub fn kernels(&self) -> &[TxKernel] {
&self.kernels
}
/// Builds a new body with the provided inputs added. Existing
/// inputs, if any, are kept intact.
/// Sort order is maintained.
pub fn with_input(mut self, input: Input) -> TransactionBody {
match &mut self.inputs {
Inputs::CommitOnly(inputs) => {
let commit = input.into();
if let Err(e) = inputs.binary_search(&commit) {
inputs.insert(e, commit)
};
}
Inputs::FeaturesAndCommit(inputs) => {
if let Err(e) = inputs.binary_search(&input) {
inputs.insert(e, input)
};
}
};
self
}
/// Fully replace inputs.
pub fn replace_inputs(mut self, inputs: Inputs) -> TransactionBody {
self.inputs = inputs;
self
}
/// Builds a new TransactionBody with the provided output added. Existing
/// outputs, if any, are kept intact.
/// Sort order is maintained.
pub fn with_output(mut self, output: Output) -> TransactionBody {
if let Err(e) = self.outputs.binary_search(&output) {
self.outputs.insert(e, output)
};
self
}