-
Notifications
You must be signed in to change notification settings - Fork 266
/
BridgeSupport.java
2876 lines (2499 loc) · 125 KB
/
BridgeSupport.java
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
/*
* This file is part of RskJ
* Copyright (C) 2017 RSK Labs Ltd.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package co.rsk.peg;
import static co.rsk.peg.BridgeUtils.getRegularPegoutTxSize;
import static co.rsk.peg.ReleaseTransactionBuilder.BTC_TX_VERSION_2;
import static co.rsk.peg.bitcoin.UtxoUtils.extractOutpointValues;
import static co.rsk.peg.pegin.RejectedPeginReason.INVALID_AMOUNT;
import static org.ethereum.config.blockchain.upgrades.ConsensusRule.*;
import co.rsk.bitcoinj.core.*;
import co.rsk.bitcoinj.crypto.TransactionSignature;
import co.rsk.bitcoinj.script.*;
import co.rsk.bitcoinj.store.BlockStoreException;
import co.rsk.bitcoinj.wallet.SendRequest;
import co.rsk.bitcoinj.wallet.Wallet;
import co.rsk.core.types.bytes.Bytes;
import co.rsk.peg.constants.BridgeConstants;
import co.rsk.core.RskAddress;
import co.rsk.crypto.Keccak256;
import co.rsk.panic.PanicProcessor;
import co.rsk.peg.bitcoin.*;
import co.rsk.peg.btcLockSender.BtcLockSender.TxSenderAddressType;
import co.rsk.peg.btcLockSender.BtcLockSenderProvider;
import co.rsk.peg.federation.*;
import co.rsk.peg.federation.constants.FederationConstants;
import co.rsk.peg.feeperkb.FeePerKbSupport;
import co.rsk.peg.flyover.FlyoverFederationInformation;
import co.rsk.peg.flyover.FlyoverTxResponseCodes;
import co.rsk.peg.lockingcap.LockingCapIllegalArgumentException;
import co.rsk.peg.lockingcap.LockingCapSupport;
import co.rsk.peg.pegin.*;
import co.rsk.peg.pegininstructions.PeginInstructionsException;
import co.rsk.peg.pegininstructions.PeginInstructionsProvider;
import co.rsk.peg.utils.*;
import co.rsk.peg.vote.*;
import co.rsk.peg.whitelist.*;
import co.rsk.rpc.modules.trace.CallType;
import co.rsk.rpc.modules.trace.ProgramSubtrace;
import com.google.common.annotations.VisibleForTesting;
import java.io.IOException;
import java.io.InputStream;
import java.math.BigInteger;
import java.time.Instant;
import java.util.*;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import org.apache.commons.lang3.tuple.Pair;
import org.ethereum.config.blockchain.upgrades.ActivationConfig;
import org.ethereum.config.blockchain.upgrades.ConsensusRule;
import org.ethereum.core.*;
import org.ethereum.crypto.HashUtil;
import org.ethereum.util.ByteUtil;
import org.ethereum.vm.DataWord;
import org.ethereum.vm.PrecompiledContracts;
import org.ethereum.vm.exception.VMException;
import org.ethereum.vm.program.*;
import org.ethereum.vm.program.invoke.TransferInvoke;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Helper class to move funds from btc to rsk and rsk to btc
* @author Oscar Guindzberg
*/
public class BridgeSupport {
public static final RskAddress BURN_ADDRESS = new RskAddress("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF");
public static final int MAX_RELEASE_ITERATIONS = 30;
public static final Integer BTC_TRANSACTION_CONFIRMATION_INEXISTENT_BLOCK_HASH_ERROR_CODE = -1;
public static final Integer BTC_TRANSACTION_CONFIRMATION_BLOCK_NOT_IN_BEST_CHAIN_ERROR_CODE = -2;
public static final Integer BTC_TRANSACTION_CONFIRMATION_INCONSISTENT_BLOCK_ERROR_CODE = -3;
public static final Integer BTC_TRANSACTION_CONFIRMATION_BLOCK_TOO_OLD_ERROR_CODE = -4;
public static final Integer BTC_TRANSACTION_CONFIRMATION_INVALID_MERKLE_BRANCH_ERROR_CODE = -5;
public static final Integer RECEIVE_HEADER_CALLED_TOO_SOON = -1;
public static final Integer RECEIVE_HEADER_BLOCK_TOO_OLD = -2;
public static final Integer RECEIVE_HEADER_CANT_FOUND_PREVIOUS_BLOCK = -3;
public static final Integer RECEIVE_HEADER_BLOCK_PREVIOUSLY_SAVED = -4;
public static final Integer RECEIVE_HEADER_UNEXPECTED_EXCEPTION = -99;
// Enough depth to be able to search backwards one month worth of blocks
// (6 blocks/hour, 24 hours/day, 30 days/month)
public static final Integer BTC_TRANSACTION_CONFIRMATION_MAX_DEPTH = 4320;
private static final Logger logger = LoggerFactory.getLogger(BridgeSupport.class);
private static final PanicProcessor panicProcessor = new PanicProcessor();
private final BridgeConstants bridgeConstants;
private final BridgeStorageProvider provider;
private final Repository rskRepository;
private final BridgeEventLogger eventLogger;
private final List<ProgramSubtrace> subtraces = new ArrayList<>();
private final BtcLockSenderProvider btcLockSenderProvider;
private final PeginInstructionsProvider peginInstructionsProvider;
private final FeePerKbSupport feePerKbSupport;
private final WhitelistSupport whitelistSupport;
private final FederationSupport federationSupport;
private final LockingCapSupport lockingCapSupport;
private final Context btcContext;
private final BtcBlockStoreWithCache.Factory btcBlockStoreFactory;
private BtcBlockStoreWithCache btcBlockStore;
private BtcBlockChain btcBlockChain;
private final org.ethereum.core.Block rskExecutionBlock;
private final ActivationConfig.ForBlock activations;
private final SignatureCache signatureCache;
public BridgeSupport(
BridgeConstants bridgeConstants,
BridgeStorageProvider provider,
BridgeEventLogger eventLogger,
BtcLockSenderProvider btcLockSenderProvider,
PeginInstructionsProvider peginInstructionsProvider,
Repository repository,
Block executionBlock,
Context btcContext,
FeePerKbSupport feePerKbSupport,
WhitelistSupport whitelistSupport,
FederationSupport federationSupport,
LockingCapSupport lockingCapSupport,
BtcBlockStoreWithCache.Factory btcBlockStoreFactory,
ActivationConfig.ForBlock activations,
SignatureCache signatureCache) {
this.rskRepository = repository;
this.provider = provider;
this.rskExecutionBlock = executionBlock;
this.bridgeConstants = bridgeConstants;
this.eventLogger = eventLogger;
this.btcLockSenderProvider = btcLockSenderProvider;
this.peginInstructionsProvider = peginInstructionsProvider;
this.btcContext = btcContext;
this.feePerKbSupport = feePerKbSupport;
this.whitelistSupport = whitelistSupport;
this.federationSupport = federationSupport;
this.lockingCapSupport = lockingCapSupport;
this.btcBlockStoreFactory = btcBlockStoreFactory;
this.activations = activations;
this.signatureCache = signatureCache;
}
public List<ProgramSubtrace> getSubtraces() {
return Collections.unmodifiableList(this.subtraces);
}
@VisibleForTesting
InputStream getCheckPoints() {
String resourceName = "/rskbitcoincheckpoints/" + bridgeConstants.getBtcParams().getId() + ".checkpoints";
InputStream checkpoints = BridgeSupport.class.getResourceAsStream(resourceName);
logger.debug("[getCheckPoints] Looking for checkpoint {}. Found? {}", resourceName, checkpoints != null);
if (checkpoints == null) {
// If we don't have a custom checkpoints file, try to use bitcoinj's default checkpoints for that network
checkpoints = BridgeSupport.class.getResourceAsStream("/" + bridgeConstants.getBtcParams().getId() + ".checkpoints");
}
return checkpoints;
}
public void save() {
provider.save();
feePerKbSupport.save();
whitelistSupport.save();
federationSupport.save();
lockingCapSupport.save();
}
/**
* Receives an array of serialized Bitcoin block headers and adds them to the internal BlockChain structure.
* @param headers The bitcoin headers
*/
public void receiveHeaders(BtcBlock[] headers) throws IOException, BlockStoreException {
if (headers.length > 0) {
logger.debug("Received {} headers. First {}, last {}.", headers.length, headers[0].getHash(), headers[headers.length - 1].getHash());
} else {
logger.warn("Received 0 headers");
}
Context.propagate(btcContext);
this.ensureBtcBlockChain();
for (BtcBlock header : headers) {
try {
StoredBlock previousBlock = btcBlockStore.get(header.getPrevBlockHash());
if (cannotProcessNextBlock(previousBlock)) {
logger.warn("[receiveHeaders] Header {} has too much work to be processed", header.getHash());
break;
}
btcBlockChain.add(header);
} catch (Exception e) {
// If we try to add an orphan header bitcoinj throws an exception
// This catches that case and any other exception that may be thrown
logger.warn("Exception adding btc header {}", header.getHash(), e);
}
}
}
/**
* Receives only one header of serialized Bitcoin block headers and adds them to the internal BlockChain structure.
* @param header The bitcoin headers
*/
public Integer receiveHeader(BtcBlock header) throws IOException, BlockStoreException {
Context.propagate(btcContext);
this.ensureBtcBlockChain();
if (btcBlockStore.get(header.getHash()) != null) {
return RECEIVE_HEADER_BLOCK_PREVIOUSLY_SAVED;
}
long diffTimeStamp = bridgeConstants.getMinSecondsBetweenCallsToReceiveHeader();
long currentTimeStamp = rskExecutionBlock.getTimestamp(); //in seconds
Optional<Long> optionalLastTimeStamp = provider.getReceiveHeadersLastTimestamp();
if (optionalLastTimeStamp.isPresent() && (currentTimeStamp - optionalLastTimeStamp.get() < diffTimeStamp)) {
logger.warn("Receive header last TimeStamp less than {} milliseconds", diffTimeStamp);
return RECEIVE_HEADER_CALLED_TOO_SOON;
}
//Depth
StoredBlock previousBlock = btcBlockStore.get(header.getPrevBlockHash());
if (previousBlock == null) {
return RECEIVE_HEADER_CANT_FOUND_PREVIOUS_BLOCK;
}
// height of best chain - height of current header block greater than maximum depth accepted
if ((getBtcBlockchainBestChainHeight() - (previousBlock.getHeight() + 1)) > bridgeConstants.getMaxDepthBlockchainAccepted()) {
return RECEIVE_HEADER_BLOCK_TOO_OLD;
}
if (cannotProcessNextBlock(previousBlock)) {
logger.warn("[receiveHeader] Header {} has too much work to be processed", header.getHash());
return RECEIVE_HEADER_UNEXPECTED_EXCEPTION;
}
try {
btcBlockChain.add(header);
} catch (Exception e) {
// If we try to add an orphan header bitcoinj throws an exception
// This catches that case and any other exception that may be thrown
logger.warn("Exception adding btc header {}", header.getHash(), e);
return RECEIVE_HEADER_UNEXPECTED_EXCEPTION;
}
provider.setReceiveHeadersLastTimestamp(currentTimeStamp);
return 0;
}
private boolean cannotProcessNextBlock(StoredBlock previousBlock) {
int nextBlockHeight = previousBlock.getHeight() + 1;
boolean networkIsMainnet = btcContext.getParams().equals(NetworkParameters.fromID(NetworkParameters.ID_MAINNET));
return nextBlockHeight >= bridgeConstants.getBlockWithTooMuchChainWorkHeight()
&& networkIsMainnet
&& !activations.isActive(ConsensusRule.RSKIP434);
}
/**
* Get the wallet for the currently active federation
* @return A BTC wallet for the currently active federation
*
* @param shouldConsiderFlyoverUTXOs
*/
public Wallet getActiveFederationWallet(boolean shouldConsiderFlyoverUTXOs) {
Federation federation = getActiveFederation();
List<UTXO> utxos = federationSupport.getActiveFederationBtcUTXOs();
return BridgeUtils.getFederationSpendWallet(
btcContext,
federation,
utxos,
shouldConsiderFlyoverUTXOs,
provider
);
}
/**
* Get the wallet for the currently retiring federation
* or null if there's currently no retiring federation
* @return A BTC wallet for the currently active federation
*
* @param shouldConsiderFlyoverUTXOs
*/
protected Wallet getRetiringFederationWallet(boolean shouldConsiderFlyoverUTXOs) {
List<UTXO> retiringFederationBtcUTXOs = federationSupport.getRetiringFederationBtcUTXOs();
return getRetiringFederationWallet(shouldConsiderFlyoverUTXOs, retiringFederationBtcUTXOs.size());
}
private Wallet getRetiringFederationWallet(boolean shouldConsiderFlyoverUTXOs, int utxosSizeLimit) {
Federation federation = getRetiringFederation();
if (federation == null) {
logger.debug("[getRetiringFederationWallet] No retiring federation found");
return null;
}
List<UTXO> utxos = federationSupport.getRetiringFederationBtcUTXOs();
if (utxos.size() > utxosSizeLimit) {
logger.debug("[getRetiringFederationWallet] Going to limit the amount of UTXOs to {}", utxosSizeLimit);
utxos = utxos.subList(0, utxosSizeLimit);
}
logger.debug("[getRetiringFederationWallet] Fetching retiring federation spend wallet");
return BridgeUtils.getFederationSpendWallet(
btcContext,
federation,
utxos,
shouldConsiderFlyoverUTXOs,
provider
);
}
/**
* Get the wallet for the currently live federations
* but limited to a specific list of UTXOs
* @return A BTC wallet for the currently live federation(s)
* limited to the given list of UTXOs
*
*/
public Wallet getUTXOBasedWalletForLiveFederations(List<UTXO> utxos, boolean isFlyoverCompatible) {
return BridgeUtils.getFederationsSpendWallet(btcContext, getLiveFederations(), utxos, isFlyoverCompatible, provider);
}
/**
* Get a no spend wallet for the currently live federations
* @return A no spend BTC wallet for the currently live federation(s)
*
*/
public Wallet getNoSpendWalletForLiveFederations(boolean isFlyoverCompatible) {
return BridgeUtils.getFederationsNoSpendWallet(btcContext, getLiveFederations(), isFlyoverCompatible, provider);
}
/**
* In case of a peg-in tx: Transfers some RBTCs to the sender of the btc tx and keeps track of the new UTXOs available for spending.
* In case of a peg-out tx: Keeps track of the change UTXOs, now available for spending.
* @param rskTx The RSK transaction
* @param btcTxSerialized The raw BTC tx
* @param height The height of the BTC block that contains the tx
* @param pmtSerialized The raw partial Merkle tree
* @throws BlockStoreException
* @throws IOException
*/
public void registerBtcTransaction(
Transaction rskTx,
byte[] btcTxSerialized,
int height,
byte[] pmtSerialized
) throws IOException, BlockStoreException, BridgeIllegalArgumentException {
Context.propagate(btcContext);
Keccak256 rskTxHash = rskTx.getHash();
Sha256Hash btcTxHash = BtcTransactionFormatUtils.calculateBtcTxHash(btcTxSerialized);
logger.debug("[registerBtcTransaction][rsk tx {}] Processing btc tx {}", rskTxHash, btcTxHash);
try {
// Check the tx was not already processed
if (isAlreadyBtcTxHashProcessed(btcTxHash)) {
throw new RegisterBtcTransactionException("Transaction already processed");
}
// Validations for register
if (!validationsForRegisterBtcTransaction(btcTxHash, height, pmtSerialized, btcTxSerialized)) {
throw new RegisterBtcTransactionException("Could not validate transaction");
}
BtcTransaction btcTx = new BtcTransaction(bridgeConstants.getBtcParams(), btcTxSerialized);
btcTx.verify();
logger.debug("[registerBtcTransaction][rsk tx {}] Btc tx hash without witness {}", rskTxHash, btcTx.getHash(false));
// Check again that the tx was not already processed but making sure to use the txid (no witness)
if (isAlreadyBtcTxHashProcessed(btcTx.getHash(false))) {
throw new RegisterBtcTransactionException("Transaction already processed");
}
PegTxType pegTxType = PegUtils.getTransactionType(
activations,
provider,
bridgeConstants,
getActiveFederation(),
getRetiringFederation(),
getLastRetiredFederationP2SHScript(),
btcTx,
height
);
switch (pegTxType) {
case PEGIN:
logger.debug("[registerBtcTransaction] This is a peg-in tx {}", btcTx.getHash());
processPegIn(btcTx, rskTxHash, height);
break;
case PEGOUT_OR_MIGRATION:
logger.debug("[registerBtcTransaction] This is a peg-out or migration tx {}", btcTx.getHash());
processPegoutOrMigration(btcTx);
break;
default:
String message = String.format("This is not a peg-in, a peg-out nor a migration tx %s", btcTx.getHash());
logger.warn("[registerBtcTransaction][rsk tx {}] {}", rskTxHash, message);
panicProcessor.panic("btclock", message);
}
} catch (RegisterBtcTransactionException e) {
logger.warn(
"[registerBtcTransaction][rsk tx {}] Could not register transaction {}. Message: {}",
rskTxHash,
btcTxHash,
e.getMessage()
);
}
}
private Script getLastRetiredFederationP2SHScript() {
return federationSupport.getLastRetiredFederationP2SHScript().orElse(null);
}
@VisibleForTesting
BtcBlockStoreWithCache getBtcBlockStore() {
return btcBlockStore;
}
protected void processPegIn(
BtcTransaction btcTx,
Keccak256 rskTxHash,
int height
) throws IOException, RegisterBtcTransactionException {
final String METHOD_NAME = "processPegIn";
if (!activations.isActive(ConsensusRule.RSKIP379)) {
legacyProcessPegin(btcTx, rskTxHash, height);
logger.info(
"[{}] BTC Tx {} processed in RSK transaction {} using legacy function",
METHOD_NAME,
btcTx.getHash(),
rskTxHash
);
return;
}
Coin totalAmount = computeTotalAmountSent(btcTx);
logger.debug("[{}}] Total amount sent: {}", METHOD_NAME, totalAmount);
PeginInformation peginInformation = new PeginInformation(
btcLockSenderProvider,
peginInstructionsProvider,
activations
);
Coin minimumPeginTxValue = bridgeConstants.getMinimumPeginTxValue(activations);
Wallet fedWallet = getNoSpendWalletForLiveFederations(false);
PeginEvaluationResult peginEvaluationResult = PegUtils.evaluatePegin(
btcTx,
peginInformation,
minimumPeginTxValue,
fedWallet,
activations
);
PeginProcessAction peginProcessAction = peginEvaluationResult.getPeginProcessAction();
if (peginProcessAction == PeginProcessAction.CAN_BE_REGISTERED) {
logger.debug("[{}] Peg-in is valid, going to register", METHOD_NAME);
executePegIn(btcTx, peginInformation, totalAmount);
markTxAsProcessed(btcTx);
} else {
Optional<RejectedPeginReason> rejectedPeginReasonOptional = peginEvaluationResult.getRejectedPeginReason();
if (!rejectedPeginReasonOptional.isPresent()) {
// This flow should never be reached. There should always be a rejected pegin reason.
String message = "Invalid state. No rejected reason was returned from evaluatePegin method";
logger.error("[{}}] {}", METHOD_NAME, message);
throw new IllegalStateException(message);
}
RejectedPeginReason rejectedPeginReason = rejectedPeginReasonOptional.get();
logger.debug("[{}] Rejected peg-in, reason {}", METHOD_NAME, rejectedPeginReason);
eventLogger.logRejectedPegin(btcTx, rejectedPeginReason);
if (peginProcessAction == PeginProcessAction.CAN_BE_REFUNDED) {
logger.debug("[{}] Refunding to address {} ", METHOD_NAME, peginInformation.getBtcRefundAddress());
generateRejectionRelease(btcTx, peginInformation.getBtcRefundAddress(), rskTxHash, totalAmount);
markTxAsProcessed(btcTx);
} else {
logger.debug("[{}] Unprocessable transaction {}.", METHOD_NAME, btcTx.getHash());
handleUnprocessableBtcTx(btcTx, peginInformation.getProtocolVersion(), rejectedPeginReason);
}
}
}
private void handleUnprocessableBtcTx(
BtcTransaction btcTx,
int protocolVersion,
RejectedPeginReason rejectedPeginReason
) {
UnrefundablePeginReason unrefundablePeginReason;
if (rejectedPeginReason == INVALID_AMOUNT) {
unrefundablePeginReason = UnrefundablePeginReason.INVALID_AMOUNT;
} else {
unrefundablePeginReason = protocolVersion == 1 ?
UnrefundablePeginReason.PEGIN_V1_REFUND_ADDRESS_NOT_SET :
UnrefundablePeginReason.LEGACY_PEGIN_UNDETERMINED_SENDER;
}
logger.debug("[handleUnprocessableBtcTx] Unprocessable tx {}. Reason {}", btcTx.getHash(), unrefundablePeginReason);
eventLogger.logUnrefundablePegin(btcTx, unrefundablePeginReason);
}
/**
* Legacy version for processing peg-ins
* Use instead {@link co.rsk.peg.BridgeSupport#processPegIn}
*
* @param btcTx Peg-in transaction to process
* @param rskTxHash Hash of the RSK transaction where the prg-in is being processed
* @param height Peg-in transaction height in Bitcoin network
* @deprecated
*/
@Deprecated
private void legacyProcessPegin(
BtcTransaction btcTx,
Keccak256 rskTxHash,
int height
) throws IOException, RegisterBtcTransactionException {
Coin totalAmount = computeTotalAmountSent(btcTx);
PeginInformation peginInformation = new PeginInformation(
btcLockSenderProvider,
peginInstructionsProvider,
activations
);
try {
peginInformation.parse(btcTx);
} catch (PeginInstructionsException e) {
if (activations.isActive(ConsensusRule.RSKIP170)) {
if (activations.isActive(ConsensusRule.RSKIP181)) {
eventLogger.logRejectedPegin(btcTx, RejectedPeginReason.PEGIN_V1_INVALID_PAYLOAD);
}
// If possible to get the sender address, refund
refundTxSender(btcTx, rskTxHash, peginInformation, totalAmount);
markTxAsProcessed(btcTx);
}
String message = String.format(
"Error while trying to parse peg-in information for tx %s. %s",
btcTx.getHash(),
e.getMessage()
);
logger.warn("[legacyProcessPegin] {}", message);
throw new RegisterBtcTransactionException(message);
}
int protocolVersion = peginInformation.getProtocolVersion();
logger.debug("[legacyProcessPegin] Protocol version: {}", protocolVersion);
switch (protocolVersion) {
case 0:
processPegInVersionLegacy(btcTx, rskTxHash, height, peginInformation, totalAmount);
break;
case 1:
processPegInVersion1(btcTx, rskTxHash, peginInformation, totalAmount);
break;
default:
markTxAsProcessed(btcTx);
String message = String.format("Invalid peg-in protocol version: %d", protocolVersion);
logger.warn("[legacyProcessPegin] {}", message);
throw new RegisterBtcTransactionException(message);
}
markTxAsProcessed(btcTx);
}
private void processPegInVersionLegacy(
BtcTransaction btcTx,
Keccak256 rskTxHash,
int height,
PeginInformation peginInformation,
Coin totalAmount) throws IOException, RegisterBtcTransactionException {
Address senderBtcAddress = peginInformation.getSenderBtcAddress();
TxSenderAddressType senderBtcAddressType = peginInformation.getSenderBtcAddressType();
if (!BridgeUtils.txIsProcessableInLegacyVersion(senderBtcAddressType, activations)) {
logger.warn("[processPeginVersionLegacy] [btcTx:{}] Could not get BtcLockSender from Btc tx", btcTx.getHash());
if (activations.isActive(ConsensusRule.RSKIP181)) {
eventLogger.logRejectedPegin(btcTx, RejectedPeginReason.LEGACY_PEGIN_UNDETERMINED_SENDER);
}
throw new RegisterBtcTransactionException("Could not get BtcLockSender from Btc tx");
}
// Confirm we should process this lock
if (shouldProcessPegInVersionLegacy(senderBtcAddressType, btcTx, senderBtcAddress, totalAmount, height)) {
executePegIn(btcTx, peginInformation, totalAmount);
} else {
if (activations.isActive(ConsensusRule.RSKIP181)) {
if (!isTxLockableForLegacyVersion(senderBtcAddressType, btcTx, senderBtcAddress)) {
eventLogger.logRejectedPegin(btcTx, RejectedPeginReason.LEGACY_PEGIN_MULTISIG_SENDER);
} else if (!verifyLockDoesNotSurpassLockingCap(btcTx, totalAmount)) {
eventLogger.logRejectedPegin(btcTx, RejectedPeginReason.PEGIN_CAP_SURPASSED);
}
}
generateRejectionRelease(btcTx, senderBtcAddress, rskTxHash, totalAmount);
}
}
private void processPegInVersion1(
BtcTransaction btcTx,
Keccak256 rskTxHash,
PeginInformation peginInformation,
Coin totalAmount) throws RegisterBtcTransactionException, IOException {
if (!activations.isActive(ConsensusRule.RSKIP170)) {
throw new RegisterBtcTransactionException("Can't process version 1 peg-ins before RSKIP 170 activation");
}
// Confirm we should process this lock
if (verifyLockDoesNotSurpassLockingCap(btcTx, totalAmount)) {
executePegIn(btcTx, peginInformation, totalAmount);
} else {
logger.debug("[processPegInVersion1] Peg-in attempt surpasses locking cap. Amount attempted to lock: {}", totalAmount);
if (activations.isActive(ConsensusRule.RSKIP181)) {
eventLogger.logRejectedPegin(btcTx, RejectedPeginReason.PEGIN_CAP_SURPASSED);
}
refundTxSender(btcTx, rskTxHash, peginInformation, totalAmount);
}
}
private void executePegIn(BtcTransaction btcTx, PeginInformation peginInformation, Coin amount) {
RskAddress rskDestinationAddress = peginInformation.getRskDestinationAddress();
Address senderBtcAddress = peginInformation.getSenderBtcAddress();
TxSenderAddressType senderBtcAddressType = peginInformation.getSenderBtcAddressType();
int protocolVersion = peginInformation.getProtocolVersion();
co.rsk.core.Coin amountInWeis = co.rsk.core.Coin.fromBitcoin(amount);
logger.debug("[executePegIn] [btcTx:{}] Is a peg-in from a {} sender", btcTx.getHash(), senderBtcAddressType);
this.transferTo(peginInformation.getRskDestinationAddress(), amountInWeis);
logger.info(
"[executePegIn] Transferring from BTC address {}. RSK address: {}. Amount: {}",
senderBtcAddress,
rskDestinationAddress,
amountInWeis
);
if (activations.isActive(ConsensusRule.RSKIP146)) {
if (activations.isActive(ConsensusRule.RSKIP170)) {
eventLogger.logPeginBtc(rskDestinationAddress, btcTx, amount, protocolVersion);
} else {
eventLogger.logLockBtc(rskDestinationAddress, btcTx, senderBtcAddress, amount);
}
}
// Save UTXOs from the federation(s) only if we actually locked the funds
saveNewUTXOs(btcTx);
}
private void refundTxSender(
BtcTransaction btcTx,
Keccak256 rskTxHash,
PeginInformation peginInformation,
Coin amount) throws IOException {
Address btcRefundAddress = peginInformation.getBtcRefundAddress();
if (btcRefundAddress != null) {
generateRejectionRelease(btcTx, btcRefundAddress, rskTxHash, amount);
} else {
logger.debug("[refundTxSender] No btc refund address provided, couldn't get sender address either. Can't refund");
if (activations.isActive(ConsensusRule.RSKIP181)) {
if (peginInformation.getProtocolVersion() == 1) {
eventLogger.logUnrefundablePegin(btcTx, UnrefundablePeginReason.PEGIN_V1_REFUND_ADDRESS_NOT_SET);
} else {
eventLogger.logUnrefundablePegin(btcTx, UnrefundablePeginReason.LEGACY_PEGIN_UNDETERMINED_SENDER);
}
}
}
}
private void markTxAsProcessed(BtcTransaction btcTx) throws IOException {
// Mark tx as processed on this block (and use the txid without the witness)
long rskHeight = rskExecutionBlock.getNumber();
provider.setHeightBtcTxhashAlreadyProcessed(btcTx.getHash(false), rskHeight);
logger.debug(
"[markTxAsProcessed] Mark btc transaction {} as processed at height {}",
btcTx.getHash(),
rskHeight
);
}
protected void processPegoutOrMigration(BtcTransaction btcTx) throws IOException {
markTxAsProcessed(btcTx);
saveNewUTXOs(btcTx);
logger.info("[processPegoutOrMigration] BTC Tx {} processed in RSK", btcTx.getHash(false));
}
private boolean shouldProcessPegInVersionLegacy(
TxSenderAddressType txSenderAddressType,
BtcTransaction btcTx,
Address senderBtcAddress,
Coin totalAmount,
int height) {
return isTxLockableForLegacyVersion(txSenderAddressType, btcTx, senderBtcAddress) &&
whitelistSupport.verifyLockSenderIsWhitelisted(senderBtcAddress, totalAmount, height) &&
verifyLockDoesNotSurpassLockingCap(btcTx, totalAmount);
}
protected boolean isTxLockableForLegacyVersion(TxSenderAddressType txSenderAddressType, BtcTransaction btcTx, Address senderBtcAddress) {
if (txSenderAddressType == TxSenderAddressType.P2PKH ||
(txSenderAddressType == TxSenderAddressType.P2SHP2WPKH && activations.isActive(ConsensusRule.RSKIP143))) {
return true;
} else {
logger.warn(
"[isTxLockableForLegacyVersion]: [btcTx:{}] Btc tx type not supported: {}, returning funds to sender: {}",
btcTx.getHash(),
txSenderAddressType,
senderBtcAddress
);
return false;
}
}
/**
* Internal method to transfer RSK to an RSK account
* It also produce the appropiate internal transaction subtrace if needed
*
* @param receiver address that receives the amount
* @param amount amount to transfer
*/
private void transferTo(RskAddress receiver, co.rsk.core.Coin amount) {
rskRepository.transfer(
PrecompiledContracts.BRIDGE_ADDR,
receiver,
amount
);
DataWord from = DataWord.valueOf(PrecompiledContracts.BRIDGE_ADDR.getBytes());
DataWord to = DataWord.valueOf(receiver.getBytes());
long gas = 0L;
DataWord value = DataWord.valueOf(amount.getBytes());
TransferInvoke invoke = new TransferInvoke(from, to, gas, value);
ProgramResult result = ProgramResult.empty();
ProgramSubtrace subtrace = ProgramSubtrace.newCallSubtrace(CallType.CALL, invoke, result, null, Collections.emptyList());
logger.info("Transferred {} weis to {}", amount, receiver);
this.subtraces.add(subtrace);
}
/*
Add the btcTx outputs that send btc to the federation(s) to the UTXO list
*/
private void saveNewUTXOs(BtcTransaction btcTx) {
// Outputs to the active federation
Wallet activeFederationWallet = getActiveFederationWallet(false);
List<TransactionOutput> outputsToTheActiveFederation = btcTx.getWalletOutputs(
activeFederationWallet
);
for (TransactionOutput output : outputsToTheActiveFederation) {
UTXO utxo = new UTXO(
btcTx.getHash(),
output.getIndex(),
output.getValue(),
0,
btcTx.isCoinBase(),
output.getScriptPubKey()
);
federationSupport.getActiveFederationBtcUTXOs().add(utxo);
}
logger.debug("[saveNewUTXOs] Registered {} UTXOs sent to the active federation", outputsToTheActiveFederation.size());
// Outputs to the retiring federation (if any)
Wallet retiringFederationWallet = getRetiringFederationWallet(false);
if (retiringFederationWallet != null) {
List<TransactionOutput> outputsToTheRetiringFederation = btcTx.getWalletOutputs(retiringFederationWallet);
for (TransactionOutput output : outputsToTheRetiringFederation) {
UTXO utxo = new UTXO(
btcTx.getHash(),
output.getIndex(),
output.getValue(),
0,
btcTx.isCoinBase(),
output.getScriptPubKey()
);
federationSupport.getRetiringFederationBtcUTXOs().add(utxo);
}
logger.debug("[saveNewUTXOs] Registered {} UTXOs sent to the retiring federation", outputsToTheRetiringFederation.size());
}
}
/**
* Initiates the process of sending coins back to BTC.
* This is the default contract method.
* The funds will be sent to the bitcoin address controlled by the private key that signed the rsk tx.
* The amount sent to the bridge in this tx will be the amount sent in the btc network minus fees.
* @param rskTx The rsk tx being executed.
* @throws IOException
*/
public void releaseBtc(Transaction rskTx) throws IOException {
final co.rsk.core.Coin pegoutValueInWeis = rskTx.getValue();
final Coin pegoutValueInSatoshis = pegoutValueInWeis.toBitcoin();
final RskAddress senderAddress = rskTx.getSender(signatureCache);
logger.debug(
"[releaseBtc] Releasing {} weis from RSK address {} in tx {}",
pegoutValueInWeis,
senderAddress,
rskTx.getHash()
);
// Peg-out from a smart contract not allowed since it's not possible to derive a BTC address from it
if (BridgeUtils.isContractTx(rskTx)) {
logger.trace(
"[releaseBtc] Contract {} tried to release funds. Release is just allowed from EOA",
senderAddress
);
if (activations.isActive(ConsensusRule.RSKIP185)) {
emitRejectEvent(pegoutValueInSatoshis, senderAddress, RejectedPegoutReason.CALLER_CONTRACT);
return;
} else {
String message = "Contract calling releaseBTC";
logger.debug("[releaseBtc] {}", message);
throw new Program.OutOfGasException(message);
}
}
Context.propagate(btcContext);
NetworkParameters btcParams = bridgeConstants.getBtcParams();
Address btcDestinationAddress = BridgeUtils.recoverBtcAddressFromEthTransaction(rskTx, btcParams);
logger.debug("[releaseBtc] BTC destination address: {}", btcDestinationAddress);
requestRelease(btcDestinationAddress, pegoutValueInSatoshis, rskTx);
}
private void refundAndEmitRejectEvent(Coin value, RskAddress senderAddress, RejectedPegoutReason reason) {
logger.trace(
"[refundAndEmitRejectEvent] Executing a refund of {} to {}. Reason: {}",
value,
senderAddress,
reason
);
rskRepository.transfer(
PrecompiledContracts.BRIDGE_ADDR,
senderAddress,
co.rsk.core.Coin.fromBitcoin(value)
);
emitRejectEvent(value, senderAddress, reason);
}
private void emitRejectEvent(Coin value, RskAddress senderAddress, RejectedPegoutReason reason) {
eventLogger.logReleaseBtcRequestRejected(senderAddress.toHexString(), value, reason);
}
/**
* Creates a request for BTC release and
* adds it to the request queue for it
* to be processed later.
*
* @param destinationAddress the destination BTC address.
* @param value the amount of BTC to release.
* @throws IOException
*/
private void requestRelease(Address destinationAddress, Coin value, Transaction rskTx) throws IOException {
Optional<RejectedPegoutReason> optionalRejectedPegoutReason = Optional.empty();
if (activations.isActive(RSKIP219)) {
int pegoutSize = getRegularPegoutTxSize(activations, getActiveFederation());
Coin feePerKB = getFeePerKb();
// The pegout transaction has a cost related to its size and the current feePerKB
// The actual cost cannot be asserted exactly so the calculation is approximated
// On top of this, the remainder after the fee should be enough for the user to be able to operate
// For this, the calculation includes an additional percentage to assert for this
Coin requireFundsForFee = feePerKB
.multiply(pegoutSize) // times the size in bytes
.divide(1000); // Get the s/b
requireFundsForFee = requireFundsForFee
.add(requireFundsForFee
.times(bridgeConstants.getMinimumPegoutValuePercentageToReceiveAfterFee())
.divide(100)
); // add the gap
// The pegout value should be greater or equals than the max of these two values
Coin minValue = Coin.valueOf(Math.max(bridgeConstants.getMinimumPegoutTxValue().value, requireFundsForFee.value));
// Since Iris the peg-out the rule is that the minimum is inclusive
if (value.isLessThan(minValue)) {
optionalRejectedPegoutReason = Optional.of(
Objects.equals(minValue, requireFundsForFee) ?
RejectedPegoutReason.FEE_ABOVE_VALUE:
RejectedPegoutReason.LOW_AMOUNT
);
}
} else {
// For legacy peg-outs the rule stated that the minimum was exclusive
if (!value.isGreaterThan(bridgeConstants.getLegacyMinimumPegoutTxValue())) {
optionalRejectedPegoutReason = Optional.of(RejectedPegoutReason.LOW_AMOUNT);
}
}
if (optionalRejectedPegoutReason.isPresent()) {
logger.warn(
"[requestRelease] releaseBtc ignored. To {}. Tx {}. Value {}. Reason: {}",
destinationAddress,
rskTx,
value,
optionalRejectedPegoutReason.get()
);
if (activations.isActive(ConsensusRule.RSKIP185)) {
refundAndEmitRejectEvent(
value,
rskTx.getSender(signatureCache),
optionalRejectedPegoutReason.get()
);
}
} else {
if (activations.isActive(ConsensusRule.RSKIP146)) {
provider.getReleaseRequestQueue().add(destinationAddress, value, rskTx.getHash());
} else {
provider.getReleaseRequestQueue().add(destinationAddress, value);
}
if (activations.isActive(ConsensusRule.RSKIP185)) {
eventLogger.logReleaseBtcRequestReceived(rskTx.getSender(signatureCache).toHexString(), destinationAddress, value);
}
logger.info("[requestRelease] releaseBtc successful to {}. Tx {}. Value {}.", destinationAddress, rskTx, value);
}
}
/**
* Executed every now and then.
* Performs a few tasks: processing of any pending btc funds
* migrations from retiring federations;
* processing of any outstanding pegout requests; and
* processing of any outstanding confirmed pegouts.
* @throws IOException
* @param rskTx current RSK transaction
*/
public void updateCollections(Transaction rskTx) throws IOException {
Context.propagate(btcContext);
eventLogger.logUpdateCollections(rskTx);
processFundsMigration(rskTx);
processPegoutRequests(rskTx);
processConfirmedPegouts(rskTx);
updateFederationCreationBlockHeights();
}
protected void updateFederationCreationBlockHeights() {
federationSupport.updateFederationCreationBlockHeights();
}
private void processFundsMigration(Transaction rskTx) throws IOException {
Wallet retiringFederationWallet = activations.isActive(RSKIP294) ?
getRetiringFederationWallet(true, bridgeConstants.getMaxInputsPerPegoutTransaction()) :
getRetiringFederationWallet(true);
List<UTXO> availableUTXOs = federationSupport.getRetiringFederationBtcUTXOs();
Federation activeFederation = getActiveFederation();
if (federationIsInMigrationAge(activeFederation)) {
long federationAge = rskExecutionBlock.getNumber() - activeFederation.getCreationBlockNumber();
logger.trace("[processFundsMigration] Active federation (age={}) is in migration age.", federationAge);
if (hasMinimumFundsToMigrate(retiringFederationWallet)){
Coin retiringFederationBalance = retiringFederationWallet.getBalance();
String retiringFederationBalanceInFriendlyFormat = retiringFederationBalance.toFriendlyString();
logger.info(
"[processFundsMigration] Retiring federation has funds to migrate: {}.",
retiringFederationBalanceInFriendlyFormat
);
migrateFunds(
rskTx.getHash(),
retiringFederationWallet,
activeFederation.getAddress(),
availableUTXOs
);
}
}
if (retiringFederationWallet != null && federationIsPastMigrationAge(activeFederation)) {
if (retiringFederationWallet.getBalance().isGreaterThan(Coin.ZERO)) {
Coin retiringFederationBalance = retiringFederationWallet.getBalance();
String retiringFederationBalanceInFriendlyFormat = retiringFederationBalance.toFriendlyString();
logger.info(
"[processFundsMigration] Federation is past migration age and will try to migrate remaining balance: {}.",
retiringFederationBalanceInFriendlyFormat
);
try {
migrateFunds(