-
Notifications
You must be signed in to change notification settings - Fork 144
/
BlockChain.cs
1204 lines (1094 loc) · 48.7 KB
/
BlockChain.cs
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
#nullable disable
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Linq;
using System.Threading;
using Libplanet.Action;
using Libplanet.Action.Loader;
using Libplanet.Action.State;
using Libplanet.Blockchain.Policies;
using Libplanet.Blockchain.Renderers;
using Libplanet.Common;
using Libplanet.Crypto;
using Libplanet.Store;
using Libplanet.Types.Assets;
using Libplanet.Types.Blocks;
using Libplanet.Types.Tx;
using Serilog;
namespace Libplanet.Blockchain
{
#pragma warning disable MEN002
/// <summary>
/// <para>
/// A class have <see cref="Block"/>s, <see cref="Transaction"/>s, and the chain
/// information.
/// </para>
/// <para>
/// In order to watch its state changes, implement <see cref="IRenderer"/> interface
/// and pass it to the
/// <see cref="BlockChain(IBlockPolicy, IStagePolicy, IStore, IStateStore, Block, IBlockChainStates, IActionEvaluator, IEnumerable{IRenderer})"/>
/// constructor.
/// </para>
/// </summary>
/// <remarks>This object is guaranteed that it has at least one block, since it takes a genesis
/// block when it's instantiated.</remarks>
#pragma warning restore MEN002
public partial class BlockChain : IBlockChainStates
{
// FIXME: The _rwlock field should be private.
[SuppressMessage(
"StyleCop.CSharp.OrderingRules",
"SA1401:FieldsMustBePrivate",
Justification = "Temporary visibility.")]
internal readonly ReaderWriterLockSlim _rwlock;
private readonly object _txLock;
private readonly ILogger _logger;
private readonly IBlockChainStates _blockChainStates;
/// <summary>
/// All <see cref="Block"/>s in the <see cref="BlockChain"/>
/// storage, including orphan <see cref="Block"/>s.
/// Keys are <see cref="Block.Hash"/>es and values are
/// their corresponding <see cref="Block"/>s.
/// </summary>
private IDictionary<BlockHash, Block> _blocks;
/// <summary>
/// Cached genesis block.
/// </summary>
private Block _genesis;
/// <summary>
/// Initializes a new instance of the <see cref="BlockChain"/> class by loading
/// the canonical chain from given <paramref name="store"/>.
/// </summary>
/// <param name="policy"><see cref="IBlockPolicy"/> to use in the
/// <see cref="BlockChain"/>.</param>
/// <param name="stagePolicy">The staging policy to follow.</param>
/// <param name="store"><see cref="IStore"/> to store <see cref="Block"/>s,
/// <see cref="Transaction"/>s, and <see cref="BlockChain"/> information.</param>
/// <param name="genesisBlock">The genesis <see cref="Block"/> of
/// the <see cref="BlockChain"/>, which is a part of the consensus.
/// If the given <paramref name="store"/> already contains the genesis block
/// it checks if the existing genesis block and this argument is the same.
/// If the <paramref name="store"/> has no genesis block yet this argument will
/// be used for that.</param>
/// <param name="blockChainStates">The <see cref="IBlockChainStates"/> implementation for
/// state lookup.</param>
/// <param name="actionEvaluator">The <see cref="ActionEvaluator" /> implementation to
/// calculate next states when append new blocks.</param>
/// <param name="renderers">Listens state changes on the created chain. Listens nothing
/// by default or if it is <see langword="null"/>. Note that action renderers receive
/// events made by unsuccessful transactions too; see also
/// <see cref="AtomicActionRenderer"/> for workaround.</param>
/// <param name="stateStore"><see cref="IStateStore"/> to store states.</param>
/// <exception cref="ArgumentException">Thrown when <paramref name="store"/> does not
/// have canonical chain id set, i.e. <see cref="IStore.GetCanonicalChainId()"/> is
/// <see langword="null"/>.</exception>
/// <exception cref="ArgumentNullException">Thrown when either of <paramref name="store"/>
/// or <paramref name="stateStore"/> is <see langword="null"/>.</exception>
/// <exception cref="InvalidGenesisBlockException">Thrown when the <paramref name="store"/>
/// has a genesis block and it does not match to what the network expects
/// (i.e., <paramref name="genesisBlock"/>).</exception>
public BlockChain(
IBlockPolicy policy,
IStagePolicy stagePolicy,
IStore store,
IStateStore stateStore,
Block genesisBlock,
IBlockChainStates blockChainStates,
IActionEvaluator actionEvaluator,
IEnumerable<IRenderer> renderers = null)
#pragma warning disable SA1118 // The parameter spans multiple lines
: this(
policy,
stagePolicy,
store,
stateStore,
store.GetCanonicalChainId() ??
throw new ArgumentException(
$"Given {nameof(store)} does not have canonical chain id set.",
nameof(store)),
genesisBlock,
blockChainStates,
actionEvaluator,
renderers)
{
}
private BlockChain(
IBlockPolicy policy,
IStagePolicy stagePolicy,
IStore store,
IStateStore stateStore,
Guid id,
Block genesisBlock,
IBlockChainStates blockChainStates,
IActionEvaluator actionEvaluator,
IEnumerable<IRenderer> renderers)
{
if (store is null)
{
throw new ArgumentNullException(nameof(store));
}
else if (store.CountIndex(id) == 0)
{
throw new ArgumentException(
$"Given store does not contain chain id {id}.", nameof(store));
}
else if (stateStore is null)
{
throw new ArgumentNullException(nameof(stateStore));
}
Id = id;
Policy = policy;
StagePolicy = stagePolicy;
Store = store;
StateStore = stateStore;
_blockChainStates = blockChainStates;
_blocks = new BlockSet(store);
Renderers = renderers is IEnumerable<IRenderer> r
? r.ToImmutableArray()
: ImmutableArray<IRenderer>.Empty;
ActionRenderers = Renderers.OfType<IActionRenderer>().ToImmutableArray();
_rwlock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion);
_txLock = new object();
_logger = Log
.ForContext<BlockChain>()
.ForContext("Source", nameof(BlockChain))
.ForContext("ChainId", Id);
ActionEvaluator = actionEvaluator;
if (!Genesis.Equals(genesisBlock))
{
string msg =
$"The genesis block that the given {nameof(IStore)} contains does not match " +
"to the genesis block that the network expects. You might pass the wrong " +
"store which is incompatible with this chain. Or your network might " +
"restarted the chain with a new genesis block so that it is incompatible " +
"with your existing chain in the local store.";
throw new InvalidGenesisBlockException(
message: msg,
networkExpected: genesisBlock.Hash,
stored: Genesis.Hash
);
}
}
~BlockChain()
{
_rwlock?.Dispose();
}
/// <summary>
/// An event which is invoked when <see cref="Tip"/> is changed.
/// </summary>
// FIXME: This should be completely replaced by IRenderer.RenderBlock() or any other
// alternatives.
internal event EventHandler<(Block OldTip, Block NewTip)> TipChanged;
#pragma warning disable MEN002
/// <summary>
/// The list of registered renderers listening the state changes.
/// </summary>
/// <remarks>
/// Since this value is immutable, renderers cannot be registered after once a <see
/// cref="BlockChain"/> object is instantiated; use <c>renderers</c> option of
/// <see cref="BlockChain(IBlockPolicy, IStagePolicy, IStore, IStateStore, Block, IBlockChainStates, IActionEvaluator, IEnumerable{IRenderer})"/>
/// constructor instead.
/// </remarks>
#pragma warning restore MEN002
public IImmutableList<IRenderer> Renderers { get; }
/// <summary>
/// A filtered list, from <see cref="Renderers"/>, which contains only <see
/// cref="IActionRenderer"/> instances.
/// </summary>
public IImmutableList<IActionRenderer> ActionRenderers { get; }
/// <summary>
/// The block and blockchain policy.
/// </summary>
public IBlockPolicy Policy { get; }
/// <summary>
/// The staging policy.
/// </summary>
public IStagePolicy StagePolicy { get; set; }
/// <summary>
/// The topmost <see cref="Block"/> of the current blockchain.
/// </summary>
public Block Tip => this[-1];
/// <summary>
/// The first <see cref="Block"/> in the <see cref="BlockChain"/>.
/// </summary>
public Block Genesis => _genesis ??= this[0];
public Guid Id { get; private set; }
/// <summary>
/// All <see cref="Block.Hash"/>es in the current index. The genesis block's hash goes
/// first, and the tip goes last.
/// Returns a <see cref="long"/> integer that represents the number of elements in the
/// <see cref="BlockChain"/>.
/// </summary>
public IEnumerable<BlockHash> BlockHashes => IterateBlockHashes();
/// <summary>
/// Returns a <see cref="long"/> that represents the number of <see cref="Block"/>s in a
/// <see cref="BlockChain"/>. This is guaranteed to be greater than or equal to 1,
/// as <see cref="BlockChain"/> always contains at least
/// its genesis <see cref="Block"/>.
/// </summary>
/// <returns>The number of <see cref="Block"/>s in the <see cref="BlockChain"/>.
/// </returns>
public long Count => Store.CountIndex(Id);
internal IStore Store { get; }
internal IStateStore StateStore { get; }
internal IActionEvaluator ActionEvaluator { get; }
/// <summary>
/// Whether the instance is canonical or not.
/// </summary>
internal bool IsCanonical => Store.GetCanonicalChainId() is Guid guid && Id == guid;
/// <summary>
/// Gets the block corresponding to the <paramref name="index"/>.
/// </summary>
/// <param name="index">A number of index of <see cref="Block"/>.</param>
/// <exception cref="ArgumentOutOfRangeException">Thrown when the given index of
/// <see cref="Block"/> does not exist.</exception>
public Block this[int index] => this[(long)index];
/// <summary>
/// Gets the block corresponding to the <paramref name="index"/>.
/// </summary>
/// <param name="index">A number of index of <see cref="Block"/>.</param>
/// <exception cref="ArgumentOutOfRangeException">Thrown when the given index of
/// <see cref="Block"/> does not exist.</exception>
public Block this[long index]
{
get
{
_rwlock.EnterReadLock();
try
{
BlockHash? blockHash = Store.IndexBlockHash(Id, index);
return blockHash is { } bh
? _blocks[bh]
: throw new ArgumentOutOfRangeException();
}
finally
{
_rwlock.ExitReadLock();
}
}
}
/// <summary>
/// Gets the block corresponding to the <paramref name="blockHash"/>.
/// </summary>
/// <param name="blockHash">A <see cref="Block.Hash"/> of the <see cref="Block"/> to
/// get. </param>
/// <exception cref="KeyNotFoundException">Thrown when there is no <see cref="Block"/>
/// with a given <paramref name="blockHash"/>.</exception>
public Block this[in BlockHash blockHash]
{
get
{
if (!ContainsBlock(blockHash))
{
throw new KeyNotFoundException(
$"The given hash[{blockHash}] was not found in this chain."
);
}
_rwlock.EnterReadLock();
try
{
return _blocks[blockHash];
}
finally
{
_rwlock.ExitReadLock();
}
}
}
#pragma warning disable SA1611
/// <summary>
/// Creates a new instance of <see cref="BlockChain"/> from an empty
/// <see cref="IStore"/>.
/// </summary>
/// <returns>A newly created <see cref="BlockChain"/>.</returns>
/// <exception cref="ArgumentNullException">Thrown when either <paramref name="store"/>
/// or <paramref name="stateStore"/> is <see langword="null"/>.</exception>
/// <exception cref="ArgumentException">Thrown when <paramref name="store"/> already has a
/// canonical chain id.</exception>
/// <exception cref="InvalidBlockException">Thrown when <paramref name="genesisBlock"/>
/// is invalid.</exception>
/// <exception cref="InvalidTxException">Thrown when <paramref name="genesisBlock"/>
/// contains an invalid <see cref="Transaction"/>.</exception>
public static BlockChain Create(
IBlockPolicy policy,
IStagePolicy stagePolicy,
IStore store,
IStateStore stateStore,
Block genesisBlock,
IActionEvaluator actionEvaluator,
IEnumerable<IRenderer> renderers = null,
IBlockChainStates blockChainStates = null)
#pragma warning restore SA1611 // The documentation for parameters are missing.
{
if (store is null)
{
throw new ArgumentNullException(nameof(store));
}
else if (stateStore is null)
{
throw new ArgumentNullException(nameof(stateStore));
}
else if (actionEvaluator is null)
{
throw new ArgumentNullException(nameof(actionEvaluator));
}
else if (store.GetCanonicalChainId() is { } canonId)
{
throw new ArgumentException(
$"Given {nameof(store)} already has its canonical chain id set: {canonId}",
nameof(store));
}
// Extract pre-evaluation block and re-evaluate through
// determine-state-root-hash method with an ephemeral state store
// to check the state root hash validity
var preEval = new PreEvaluationBlock(
genesisBlock.Header, genesisBlock.Transactions);
var computedStateRootHash = DetermineGenesisStateRootHash(
actionEvaluator,
preEval,
out var _);
if (!genesisBlock.StateRootHash.Equals(computedStateRootHash))
{
throw new InvalidBlockStateRootHashException(
"Given block #{Index} {Hash} has a state root hash {ExpectedStateRootHash} " +
"that is different from the calculated state root hash {ActualStateRootHash}",
genesisBlock.StateRootHash,
computedStateRootHash);
}
var id = Guid.NewGuid();
ValidateGenesis(genesisBlock);
var nonceDeltas = ValidateGenesisNonces(genesisBlock);
store.PutBlock(genesisBlock);
store.AppendIndex(id, genesisBlock.Hash);
foreach (var tx in genesisBlock.Transactions)
{
store.PutTxIdBlockHashIndex(tx.Id, genesisBlock.Hash);
}
foreach (KeyValuePair<Address, long> pair in nonceDeltas)
{
store.IncreaseTxNonce(id, pair.Key, pair.Value);
}
store.SetCanonicalChainId(id);
blockChainStates ??= new BlockChainStates(store, stateStore);
return new BlockChain(
policy,
stagePolicy,
store,
stateStore,
id,
genesisBlock,
blockChainStates,
actionEvaluator,
renderers);
}
/// <summary>
/// Determines whether the <see cref="BlockChain"/> contains <see cref="Block"/>
/// the specified <paramref name="blockHash"/>.
/// </summary>
/// <param name="blockHash">The <see cref="HashDigest{T}"/> of the <see cref="Block"/> to
/// check if it is in the <see cref="BlockChain"/>.</param>
/// <returns>
/// <see langword="true"/> if the <see cref="BlockChain"/> contains
/// <see cref="Block"/> with the specified <paramref name="blockHash"/>; otherwise,
/// <see langword="false"/>.
/// </returns>
public bool ContainsBlock(BlockHash blockHash)
{
_rwlock.EnterReadLock();
try
{
return
_blocks.ContainsKey(blockHash) &&
Store.GetBlockIndex(blockHash) is { } branchPointIndex &&
branchPointIndex <= Tip.Index &&
Store.IndexBlockHash(Id, branchPointIndex).Equals(blockHash);
}
finally
{
_rwlock.ExitReadLock();
}
}
/// <summary>
/// Gets the transaction corresponding to the <paramref name="txId"/>.
/// </summary>
/// <param name="txId">A <see cref="TxId"/> of the <see cref="Transaction"/> to get.
/// </param>
/// <returns><see cref="Transaction"/> with <paramref name="txId"/>.</returns>
/// <exception cref="KeyNotFoundException">Thrown when there is no
/// <see cref="Transaction"/> with a given <paramref name="txId"/>.</exception>
public Transaction GetTransaction(TxId txId)
{
if (StagePolicy.Get(this, txId) is { } tx)
{
return tx;
}
_rwlock.EnterReadLock();
try
{
if (Store.GetTransaction(txId) is { } transaction)
{
return transaction;
}
throw new KeyNotFoundException($"No such transaction: {txId}");
}
finally
{
_rwlock.ExitReadLock();
}
}
/// <summary>
/// Queries the recorded <see cref="TxExecution"/> for a successful or failed
/// <see cref="Transaction"/> within a <see cref="Block"/>.
/// </summary>
/// <param name="blockHash">The <see cref="Block.Hash"/> of the <see cref="Block"/>
/// that the <see cref="Transaction"/> is executed within.</param>
/// <param name="txid">The executed <see cref="Transaction"/>'s
/// <see cref="Transaction.Id"/>.</param>
/// <returns>The recorded <see cref="TxExecution"/>. If the transaction has never been
/// executed within the block, it returns <see langword="null"/> instead.</returns>
public TxExecution GetTxExecution(BlockHash blockHash, TxId txid) =>
Store.GetTxExecution(blockHash, txid);
/// <summary>
/// Adds a <paramref name="block"/> to the end of this chain.
/// <para><see cref="Block.Transactions"/> in the <paramref name="block"/> updates
/// states and balances in the blockchain, and <see cref="TxExecution"/>s for
/// transactions are recorded.</para>
/// <para>Note that <see cref="Renderers"/> receive events right after the <paramref
/// name="block"/> is confirmed (and thus all states reflect changes in the <paramref
/// name="block"/>).</para>
/// </summary>
/// <param name="block">A next <see cref="Block"/>, which is mined,
/// to add.</param>
/// <param name="blockCommit">A <see cref="BlockCommit"/> that has +2/3 commits for the
/// given block.</param>
/// <exception cref="BlockPolicyViolationException">Thrown when given
/// <paramref name="block"/> does not satisfy any of the constraints
/// validated by <see cref="IBlockPolicy.ValidateNextBlock"/> of <see cref="Policy"/>.
/// </exception>
/// <exception cref="InvalidBlockException">Thrown when the given <paramref name="block"/>
/// is invalid, in itself or according to the <see cref="Policy"/>.</exception>
/// <exception cref="InvalidActionException">Thrown when given <paramref name="block"/>
/// contains an action that cannot be loaded with <see cref="IActionLoader"/>.</exception>
/// <exception cref="InvalidTxNonceException">Thrown when the
/// <see cref="Transaction.Nonce"/> is different from
/// <see cref="GetNextTxNonce"/> result of the
/// <see cref="Transaction.Signer"/>.</exception>
/// <exception cref="InvalidBlockCommitException">Thrown when the given
/// <paramref name="block"/> and <paramref name="blockCommit"/> is invalid.</exception>
public void Append(
Block block,
BlockCommit blockCommit
) =>
Append(block, blockCommit, render: true);
/// <summary>
/// Adds <paramref name="transaction"/> to the pending list so that a next
/// <see cref="Block"/> to be mined may contain given <paramref name="transaction"/>.
/// </summary>
/// <param name="transaction"><see cref="Transaction"/> to add to the pending list.
/// </param>
/// <returns><see langword="true"/> if staging was successful,
/// <see langword="false"/> otherwise.</returns>
/// <exception cref="InvalidTxGenesisHashException">Thrown when given
/// <paramref name="transaction"/> has invalid <see cref="Transaction.GenesisHash"/>.
/// </exception>
public bool StageTransaction(Transaction transaction)
{
if (!transaction.GenesisHash.Equals(Genesis.Hash))
{
var msg = "GenesisHash of the transaction is not compatible " +
"with the BlockChain.Genesis.Hash.";
throw new InvalidTxGenesisHashException(
msg,
transaction.Id,
Genesis.Hash,
transaction.GenesisHash);
}
return StagePolicy.Stage(this, transaction);
}
/// <summary>
/// Removes a <paramref name="transaction"/> from the pending list.
/// </summary>
/// <param name="transaction">A <see cref="Transaction"/>
/// to remove from the pending list.</param>
/// <returns><see langword="true"/> if unstaging was successful,
/// <see langword="false"/> otherwise.</returns>
/// <seealso cref="StageTransaction"/>
public bool UnstageTransaction(Transaction transaction) =>
StagePolicy.Unstage(this, transaction.Id);
/// <summary>
/// Gets next <see cref="Transaction.Nonce"/> of the address.
/// </summary>
/// <param name="address">The <see cref="Address"/> from which to obtain the
/// <see cref="Transaction.Nonce"/> value.</param>
/// <returns>The next <see cref="Transaction.Nonce"/> value of the
/// <paramref name="address"/>.</returns>
public long GetNextTxNonce(Address address)
=> StagePolicy.GetNextTxNonce(this, address);
/// <summary>
/// Creates a new <see cref="Transaction"/> with custom actions and stage it.
/// It's available only if the genesis block exists.
/// </summary>
/// <param name="privateKey">A <see cref="PrivateKey"/> of the account who creates and
/// signs a new transaction.</param>
/// <param name="actions">A list of custom actions to include to a new transaction.
/// </param>
/// <param name="maxGasPrice"> The maximum gas price this transaction can pay fee. </param>
/// <param name="gasLimit"> The maximum amount of gas this transaction can consume.
/// </param>
/// <param name="timestamp">The time this <see cref="Transaction"/> is created and
/// signed.</param>
/// <returns>A created new <see cref="Transaction"/> signed by the given
/// <paramref name="privateKey"/>.</returns>
public Transaction MakeTransaction(
PrivateKey privateKey,
IEnumerable<IAction> actions,
FungibleAssetValue? maxGasPrice = null,
long? gasLimit = null,
DateTimeOffset? timestamp = null)
{
timestamp = timestamp ?? DateTimeOffset.UtcNow;
lock (_txLock)
{
// FIXME: Exception should be documented when the genesis block does not exist.
Transaction tx = Transaction.Create(
GetNextTxNonce(privateKey.Address),
privateKey,
Genesis.Hash,
actions.Select(x => x.PlainValue),
maxGasPrice,
gasLimit,
timestamp);
StageTransaction(tx);
return tx;
}
}
/// <summary>
/// Lists all staged <see cref="TxId"/>s.
/// </summary>
/// <returns><see cref="IImmutableSet{TxId}"/> of staged transactions.</returns>
public IImmutableSet<TxId> GetStagedTransactionIds()
{
// FIXME: How about turning this method to the StagedTransactions property?
return StagePolicy.Iterate(this).Select(tx => tx.Id).ToImmutableHashSet();
}
/// <summary>
/// Finds the branch point <see cref="BlockHash"/> between this <see cref="BlockChain"/>
/// and <paramref name="locator"/> and returns the list of <see cref="BlockHash"/>es of
/// successive <see cref="Block"/>s starting from the branch point
/// <see cref="BlockHash"/>.</summary>
/// <param name="locator">The <see cref="BlockLocator"/> to find the branching point
/// from.</param>
/// <param name="stop">The <see cref="BlockHash"/> to stop looking for subsequent blocks
/// once encountered.
/// </param>
/// <param name="count">The Maximum number of <see cref="BlockHash"/>es to return.</param>
/// <returns>A tuple of the index of the branch point and <see cref="BlockHash"/>es
/// including the branch point <see cref="BlockHash"/>. If no branch point is found,
/// returns a tuple of <see langword="null"/> and an empty array of
/// <see cref="BlockHash"/>es.</returns>
public Tuple<long?, IReadOnlyList<BlockHash>> FindNextHashes(
BlockLocator locator,
BlockHash? stop = null,
int count = 500)
{
Stopwatch stopwatch = new Stopwatch();
stopwatch.Start();
// FIXME Theoretically, we don't accept empty chain. so `tip` can't be null on this
// assumption. but during some test case(e.g. GetDemandBlockHashesDuringReorg),
// it had been occurred.
// We should find a reason for that and fix it before remote this early return.
BlockHash? tip = Store.IndexBlockHash(Id, -1);
if (tip is null)
{
return new Tuple<long?, IReadOnlyList<BlockHash>>(null, Array.Empty<BlockHash>());
}
if (!(FindBranchpoint(locator) is BlockHash branchpoint))
{
return new Tuple<long?, IReadOnlyList<BlockHash>>(null, Array.Empty<BlockHash>());
}
if (!(Store.GetBlockIndex(branchpoint) is long branchpointIndex))
{
return new Tuple<long?, IReadOnlyList<BlockHash>>(null, Array.Empty<BlockHash>());
}
var result = new List<BlockHash>();
foreach (BlockHash hash in Store.IterateIndexes(Id, (int)branchpointIndex, count))
{
if (count == 0)
{
break;
}
result.Add(hash);
count--;
if (hash.Equals(stop))
{
break;
}
}
_logger
.ForContext("Tag", "Metric")
.ForContext("Subtag", "FindHashesDuration")
.Information(
"Found {HashCount} hashes from storage with {ChainIdCount} chain ids " +
"in {DurationMs} ms",
result.Count,
Store.ListChainIds().Count(),
stopwatch.ElapsedMilliseconds);
return new Tuple<long?, IReadOnlyList<BlockHash>>(branchpointIndex, result);
}
/// <summary>
/// Forks the chain at <paramref name="point"/> and returns the newly forked chain.
/// </summary>
/// <param name="point">The hash in which to fork from.</param>
/// <param name="inheritRenderers">Whether to inherit the renderers from the existing chain.
/// </param>
/// <returns>An instance of the newly forked chain.</returns>
/// <exception cref="ArgumentException">Throws when the provided <paramref name="point"/>
/// does not exist in the current chain.</exception>
public BlockChain Fork(BlockHash point, bool inheritRenderers = true)
{
if (!ContainsBlock(point))
{
throw new ArgumentException(
$"The block [{point}] doesn't exist.",
nameof(point));
}
Block pointBlock = this[point];
if (!point.Equals(this[pointBlock.Index].Hash))
{
throw new ArgumentException(
$"The block [{point}] doesn't exist in the chain index.",
nameof(point));
}
var forkedId = Guid.NewGuid();
IEnumerable<IRenderer> renderers = inheritRenderers
? Renderers
: Enumerable.Empty<IRenderer>();
try
{
_rwlock.EnterReadLock();
Store.AppendIndex(forkedId, Genesis.Hash);
var forked = new BlockChain(
Policy,
StagePolicy,
Store,
StateStore,
forkedId,
Genesis,
_blockChainStates,
ActionEvaluator,
renderers);
Store.ForkBlockIndexes(Id, forkedId, point);
if (GetBlockCommit(point) is { } p)
{
Store.PutChainBlockCommit(forkedId, GetBlockCommit(point));
}
Store.ForkTxNonces(Id, forked.Id);
for (Block block = Tip;
block.PreviousHash is { } hash && !block.Hash.Equals(point);
block = _blocks[hash])
{
IEnumerable<(Address, int)> signers = block
.Transactions
.GroupBy(tx => tx.Signer)
.Select(g => (g.Key, g.Count()));
foreach ((Address address, int txCount) in signers)
{
Store.IncreaseTxNonce(forked.Id, address, -txCount);
}
}
_logger.Information(
"Forked chain at #{Index} {Hash} from id {PreviousId} to id {ForkedId}",
pointBlock.Index,
pointBlock.Hash,
Id,
forkedId);
return forked;
}
catch (Exception e)
{
_logger.Error(
e,
"An unexpected exception occurred while forking a chain");
Store.DeleteChainId(forkedId);
throw;
}
finally
{
_rwlock.ExitReadLock();
}
}
/// <summary>
/// Returns a new <see cref="BlockLocator"/> from the tip of current chain.
/// </summary>
/// <param name="threshold">The amount of consequent blocks to include before sampling.
/// </param>
/// <returns>A instance of block locator.</returns>
public BlockLocator GetBlockLocator(int threshold = 10)
{
long startIndex;
Guid id;
_rwlock.EnterReadLock();
try
{
startIndex = Tip.Index;
id = Id;
}
finally
{
_rwlock.ExitReadLock();
}
return BlockLocator.Create(
startIndex: startIndex,
indexToBlockHash: idx => Store.IndexBlockHash(Id, idx),
sampleAfter: threshold);
}
/// <summary>
/// Returns a <see cref="BlockCommit"/> of given <see cref="Block"/> index.
/// </summary>
/// <param name="index">A index value (height) of <see cref="Block"/> to retrieve.
/// </param>
/// <returns>Returns a <see cref="BlockCommit"/> of given <see cref="Block"/> index.
/// Following conditions will return <see langword="null"/>:
/// <list type="bullet">
/// <item>
/// Given <see cref="Block"/> <see cref="Block.ProtocolVersion"/> is
/// Proof-of-Work.
/// </item>
/// <item>
/// Given <see cref="Block"/> is <see cref="BlockChain.Genesis"/> block.
/// </item>
/// </list>
/// </returns>
/// <exception cref="KeyNotFoundException">Thrown if given index does not exist in the
/// blockchain.</exception>
/// <remarks>The <see cref="BlockChain.Genesis"/> block does not have
/// <see cref="BlockCommit"/> because the genesis block is not committed by a consensus.
/// </remarks>
public BlockCommit GetBlockCommit(long index)
{
Block block = this[index];
if (block.ProtocolVersion <= BlockMetadata.PoWProtocolVersion)
{
return null;
}
return index == Tip.Index
? Store.GetChainBlockCommit(Id)
: this[index + 1].LastCommit;
}
/// <summary>
/// Returns a <see cref="BlockCommit"/> of given <see cref="Block"/> index.
/// </summary>
/// <param name="blockHash">A hash value of <see cref="Block"/> to retrieve.
/// </param>
/// <returns>Returns a <see cref="BlockCommit"/> of given <see cref="Block"/> hash, if
/// the <see cref="BlockCommit"/> of <see cref="BlockChain.Genesis"/> block is requested,
/// then returns <see langword="null"/>.</returns>
/// <exception cref="KeyNotFoundException">Thrown if given hash does not exist in the
/// blockchain.</exception>
/// <remarks>The <see cref="BlockChain.Genesis"/> block does not have
/// <see cref="BlockCommit"/> because the genesis block is not committed by a consensus.
/// </remarks>
public BlockCommit GetBlockCommit(BlockHash blockHash) =>
GetBlockCommit(this[blockHash].Index);
#pragma warning disable MEN003
internal void Append(
Block block,
BlockCommit blockCommit,
bool render,
IReadOnlyList<ICommittedActionEvaluation> actionEvaluations = null
)
{
if (Count == 0)
{
throw new ArgumentException(
"Cannot append a block to an empty chain.");
}
else if (block.Index == 0)
{
throw new ArgumentException(
$"Cannot append genesis block #{block.Index} {block.Hash} to a chain.",
nameof(block));
}
_logger.Information(
"Trying to append block #{BlockIndex} {BlockHash}...", block.Index, block.Hash);
block.ValidateTimestamp();
_rwlock.EnterUpgradeableReadLock();
Block prevTip = Tip;
try
{
ValidateBlock(block);
ValidateBlockCommit(block, blockCommit);
var nonceDeltas = ValidateBlockNonces(
block.Transactions
.Select(tx => tx.Signer)
.Distinct()
.ToDictionary(signer => signer, signer => Store.GetTxNonce(Id, signer)),
block);
if (Policy.ValidateNextBlock(this, block) is { } bpve)
{
throw bpve;
}
foreach (Transaction tx in block.Transactions)
{
if (Policy.ValidateNextBlockTx(this, tx) is { } tpve)
{
throw new TxPolicyViolationException(
"According to BlockPolicy, this transaction is not valid.",
tx.Id,
tpve);
}
}
_rwlock.EnterWriteLock();
try
{
if (actionEvaluations is null)
{
_logger.Information(
"Executing actions in block #{BlockIndex} {BlockHash}...",
block.Index,
block.Hash);
ValidateBlockStateRootHash(block, out actionEvaluations);
_logger.Information(
"Executed actions in block #{BlockIndex} {BlockHash}",
block.Index,
block.Hash);
}
// FIXME: Using evaluateActions as a proxy flag for preloading status.
const string TimestampFormat = "yyyy-MM-ddTHH:mm:ss.ffffffZ";
_logger
.ForContext("Tag", "Metric")
.ForContext("Subtag", "BlockAppendTimestamp")
.Information(
"Block #{BlockIndex} {BlockHash} with " +
"timestamp {BlockTimestamp} appended at {AppendTimestamp}",
block.Index,
block.Hash,
block.Timestamp.ToString(
TimestampFormat, CultureInfo.InvariantCulture),
DateTimeOffset.UtcNow.ToString(
TimestampFormat, CultureInfo.InvariantCulture));
_blocks[block.Hash] = block;
IEnumerable<TxExecution> txExecutions =
MakeTxExecutions(block, actionEvaluations);
UpdateTxExecutions(txExecutions);
foreach (KeyValuePair<Address, long> pair in nonceDeltas)
{
Store.IncreaseTxNonce(Id, pair.Key, pair.Value);
}
foreach (var tx in block.Transactions)
{
Store.PutTxIdBlockHashIndex(tx.Id, block.Hash);
}
if (block.Index != 0 && blockCommit is { })
{
Store.PutChainBlockCommit(Id, blockCommit);
}
Store.AppendIndex(Id, block.Hash);
}
finally
{
_rwlock.ExitWriteLock();
}
if (IsCanonical)
{
_logger.Information(
"Unstaging {TxCount} transactions from block #{BlockIndex} {BlockHash}...",
block.Transactions.Count(),
block.Index,
block.Hash);
foreach (Transaction tx in block.Transactions)
{
UnstageTransaction(tx);
}
_logger.Information(
"Unstaged {TxCount} transactions from block #{BlockIndex} {BlockHash}...",
block.Transactions.Count(),