Merge pull request #2653 from planetarium/release/1.13.0

Release/1.13.0

.Lib9c.Benchmarks/Program.cs

@@ -121,7 +121,7 @@ static void Main(string[] args)
                     block.Transactions.Count()
                 );
 
-                chain.DetermineBlockStateRootHash(block, out IReadOnlyList<ICommittedActionEvaluation> blockEvals);
+                chain.DetermineNextBlockStateRootHash(block, out IReadOnlyList<ICommittedActionEvaluation> blockEvals);
                 txs += block.Transactions.LongCount();
                 actions += block.Transactions.Sum(tx =>
                     tx.Actions is { } customActions ? customActions.LongCount() : 0);

.Lib9c.Tests/Action/RewardGoldTest.cs

@@ -491,88 +491,6 @@ void AssertMinerReward(int blockIndex, string expected)
             AssertMinerReward(50457601, "0");
         }
 
-        [Theory]
-        [InlineData(true)]
-        [InlineData(false)]
-        public async Task Genesis_StateRootHash(bool mainnet)
-        {
-            BlockPolicySource blockPolicySource = new BlockPolicySource();
-            NCStagePolicy stagePolicy = new NCStagePolicy(default, 2);
-            IBlockPolicy policy = blockPolicySource.GetPolicy();
-            Block genesis;
-            if (mainnet)
-            {
-                const string genesisBlockPath = "https://release.nine-chronicles.com/genesis-block-9c-main";
-                var uri = new Uri(genesisBlockPath);
-                using var client = new HttpClient();
-                var rawBlock = await client.GetByteArrayAsync(uri);
-                var blockDict = (Bencodex.Types.Dictionary)new Codec().Decode(rawBlock);
-                genesis = BlockMarshaler.UnmarshalBlock(blockDict);
-            }
-            else
-            {
-                var adminPrivateKey = new PrivateKey();
-                var adminAddress = adminPrivateKey.Address;
-                var activatedAccounts = ImmutableHashSet<Address>.Empty;
-                var nonce = new byte[] { 0x00, 0x01, 0x02, 0x03 };
-                var privateKey = new PrivateKey();
-                (ActivationKey activationKey, PendingActivationState pendingActivation) =
-                    ActivationKey.Create(privateKey, nonce);
-                var pendingActivationStates = new List<PendingActivationState>
-                {
-                    pendingActivation,
-                };
-                var initializeStates = new InitializeStates(
-                    rankingState: new RankingState0(),
-                    shopState: new ShopState(),
-                    gameConfigState: new GameConfigState(),
-                    redeemCodeState: new RedeemCodeState(Bencodex.Types.Dictionary.Empty
-                        .Add("address", RedeemCodeState.Address.Serialize())
-                        .Add("map", Bencodex.Types.Dictionary.Empty)
-                    ),
-                    adminAddressState: new AdminState(adminAddress, 1500000),
-                    activatedAccountsState: new ActivatedAccountsState(activatedAccounts),
-#pragma warning disable CS0618
-                    // Use of obsolete method Currency.Legacy(): https://github.com/planetarium/lib9c/discussions/1319
-                    goldCurrencyState: new GoldCurrencyState(Currency.Legacy("NCG", 2, null)),
-#pragma warning restore CS0618
-                    goldDistributions: new GoldDistribution[0],
-                    tableSheets: TableSheetsImporter.ImportSheets(),
-                    pendingActivationStates: pendingActivationStates.ToArray()
-                );
-                var tempActionEvaluator = new ActionEvaluator(
-                    policyBlockActionGetter: _ => policy.BlockAction,
-                    stateStore: new TrieStateStore(new MemoryKeyValueStore()),
-                    actionTypeLoader: new NCActionLoader());
-                genesis = BlockChain.ProposeGenesisBlock(
-                    tempActionEvaluator,
-                    transactions: ImmutableList<Transaction>.Empty
-                        .Add(Transaction.Create(
-                            0,
-                            new PrivateKey(),
-                            null,
-                            new ActionBase[] { initializeStates }.ToPlainValues()))
-                );
-            }
-
-            var store = new DefaultStore(null);
-            var stateStore = new TrieStateStore(new DefaultKeyValueStore(null));
-            var blockChain = BlockChain.Create(
-                policy: policy,
-                store: store,
-                stagePolicy: stagePolicy,
-                stateStore: stateStore,
-                genesisBlock: genesis,
-                actionEvaluator: new ActionEvaluator(
-                    policyBlockActionGetter: _ => policy.BlockAction,
-                    stateStore: stateStore,
-                    actionTypeLoader: new NCActionLoader()
-                ),
-                renderers: new IRenderer[] { new ActionRenderer(), new BlockRenderer() }
-            );
-            Assert.Equal(genesis.StateRootHash, blockChain.Genesis.StateRootHash);
-        }
-
         [Theory]
         [InlineData(5, 4)]
         [InlineData(101, 100)]

.Lib9c.Tests/Policy/BlockPolicyTest.cs

@@ -5,12 +5,14 @@ namespace Lib9c.Tests
     using System.Collections.Immutable;
     using System.Linq;
     using System.Numerics;
+    using System.Security.Cryptography;
     using Bencodex.Types;
     using Lib9c.Renderers;
     using Libplanet.Action;
     using Libplanet.Action.State;
     using Libplanet.Blockchain;
     using Libplanet.Blockchain.Policies;
+    using Libplanet.Common;
     using Libplanet.Crypto;
     using Libplanet.Store;
     using Libplanet.Store.Trie;
@@ -395,7 +397,7 @@ public void EarnMiningGoldWhenSuccessMining()
             Block block = blockChain.ProposeBlock(adminPrivateKey);
             blockChain.Append(block, GenerateBlockCommit(block, adminPrivateKey));
             FungibleAssetValue actualBalance = blockChain
-                .GetWorldState()
+                .GetNextWorldState()
                 .GetBalance(adminAddress, _currency);
             FungibleAssetValue expectedBalance = new FungibleAssetValue(_currency, 10, 0);
             Assert.True(expectedBalance.Equals(actualBalance));
@@ -424,17 +426,18 @@ public void ValidateNextBlockWithManyTransactions()
 
             using var store = new DefaultStore(null);
             var stateStore = new TrieStateStore(new MemoryKeyValueStore());
+            var actionEvaluator = new ActionEvaluator(
+                policyBlockActionGetter: _ => policy.BlockAction,
+                stateStore: stateStore,
+                actionTypeLoader: new NCActionLoader()
+            );
             var blockChain = BlockChain.Create(
                 policy,
                 stagePolicy,
                 store,
                 stateStore,
                 genesis,
-                new ActionEvaluator(
-                    policyBlockActionGetter: _ => policy.BlockAction,
-                    stateStore: stateStore,
-                    actionTypeLoader: new NCActionLoader()
-                )
+                actionEvaluator
             );
 
             int nonce = 0;
@@ -465,7 +468,7 @@ List<Transaction> GenerateTransactions(int count)
                     txHash: BlockContent.DeriveTxHash(txs),
                     lastCommit: null),
                 transactions: txs).Propose();
-            Block block1 = EvaluateAndSign(blockChain, preEvalBlock1, adminPrivateKey);
+            Block block1 = EvaluateAndSign(store, actionEvaluator, preEvalBlock1, adminPrivateKey);
             blockChain.Append(block1, GenerateBlockCommit(block1, adminPrivateKey));
             Assert.Equal(2, blockChain.Count);
             Assert.True(blockChain.ContainsBlock(block1.Hash));
@@ -479,7 +482,7 @@ List<Transaction> GenerateTransactions(int count)
                     txHash: BlockContent.DeriveTxHash(txs),
                     lastCommit: GenerateBlockCommit(blockChain.Tip, adminPrivateKey)),
                 transactions: txs).Propose();
-            Block block2 = EvaluateAndSign(blockChain, preEvalBlock2, adminPrivateKey);
+            Block block2 = EvaluateAndSign(store, actionEvaluator, preEvalBlock2, adminPrivateKey);
             blockChain.Append(block2, GenerateBlockCommit(block2, adminPrivateKey));
             Assert.Equal(3, blockChain.Count);
             Assert.True(blockChain.ContainsBlock(block2.Hash));
@@ -493,7 +496,7 @@ List<Transaction> GenerateTransactions(int count)
                     txHash: BlockContent.DeriveTxHash(txs),
                     lastCommit: GenerateBlockCommit(blockChain.Tip, adminPrivateKey)),
                 transactions: txs).Propose();
-            Block block3 = EvaluateAndSign(blockChain, preEvalBlock3, adminPrivateKey);
+            Block block3 = EvaluateAndSign(store, actionEvaluator, preEvalBlock3, adminPrivateKey);
             Assert.Throws<InvalidBlockTxCountException>(
                 () => blockChain.Append(block3, GenerateBlockCommit(block3, adminPrivateKey)));
             Assert.Equal(3, blockChain.Count);
@@ -525,17 +528,18 @@ public void ValidateNextBlockWithManyTransactionsPerSigner()
 
             using var store = new DefaultStore(null);
             var stateStore = new TrieStateStore(new MemoryKeyValueStore());
+            var actionEvaluator = new ActionEvaluator(
+                policyBlockActionGetter: _ => policy.BlockAction,
+                stateStore: stateStore,
+                actionTypeLoader: new NCActionLoader()
+            );
             var blockChain = BlockChain.Create(
                 policy,
                 stagePolicy,
                 store,
                 stateStore,
                 genesis,
-                new ActionEvaluator(
-                    policyBlockActionGetter: _ => policy.BlockAction,
-                    stateStore: stateStore,
-                    actionTypeLoader: new NCActionLoader()
-                )
+                actionEvaluator
             );
 
             int nonce = 0;
@@ -566,7 +570,7 @@ List<Transaction> GenerateTransactions(int count)
                     txHash: BlockContent.DeriveTxHash(txs),
                     lastCommit: null),
                 transactions: txs).Propose();
-            Block block1 = EvaluateAndSign(blockChain, preEvalBlock1, adminPrivateKey);
+            Block block1 = EvaluateAndSign(store, actionEvaluator, preEvalBlock1, adminPrivateKey);
 
             // Should be fine since policy hasn't kicked in yet.
             blockChain.Append(block1, GenerateBlockCommit(block1, adminPrivateKey));
@@ -583,7 +587,7 @@ List<Transaction> GenerateTransactions(int count)
                     txHash: BlockContent.DeriveTxHash(txs),
                     lastCommit: GenerateBlockCommit(blockChain.Tip, adminPrivateKey)),
                 transactions: txs).Propose();
-            Block block2 = EvaluateAndSign(blockChain, preEvalBlock2, adminPrivateKey);
+            Block block2 = EvaluateAndSign(store, actionEvaluator, preEvalBlock2, adminPrivateKey);
 
             // Subpolicy kicks in.
             Assert.Throws<InvalidBlockTxCountPerSignerException>(
@@ -604,7 +608,7 @@ List<Transaction> GenerateTransactions(int count)
                     txHash: BlockContent.DeriveTxHash(txs),
                     lastCommit: GenerateBlockCommit(blockChain.Tip, adminPrivateKey)),
                 transactions: txs).Propose();
-            Block block3 = EvaluateAndSign(blockChain, preEvalBlock3, adminPrivateKey);
+            Block block3 = EvaluateAndSign(store, actionEvaluator, preEvalBlock3, adminPrivateKey);
             blockChain.Append(block3, GenerateBlockCommit(block3, adminPrivateKey));
             Assert.Equal(3, blockChain.Count);
             Assert.True(blockChain.ContainsBlock(block3.Hash));
@@ -663,13 +667,29 @@ private Block MakeGenesisBlock(
         }
 
         private Block EvaluateAndSign(
-            BlockChain blockChain,
+            IStore store,
+            ActionEvaluator actionEvaluator,
             PreEvaluationBlock preEvaluationBlock,
             PrivateKey privateKey
         )
         {
-            var stateRootHash = blockChain.DetermineBlockStateRootHash(preEvaluationBlock, out _);
-            return preEvaluationBlock.Sign(privateKey, stateRootHash);
+            if (preEvaluationBlock.Index < 1)
+            {
+                throw new ArgumentException(
+                    $"Given {nameof(preEvaluationBlock)} must have block index " +
+                    $"higher than 0");
+            }
+
+            if (preEvaluationBlock.ProtocolVersion < BlockMetadata.SlothProtocolVersion)
+            {
+                throw new ArgumentException(
+                    $"{nameof(preEvaluationBlock)} of which protocol version less than" +
+                    $"{BlockMetadata.SlothProtocolVersion} is not acceptable");
+            }
+
+            var stateRootHash = store.GetNextStateRootHash((BlockHash)preEvaluationBlock.PreviousHash);
+
+            return preEvaluationBlock.Sign(privateKey, (HashDigest<SHA256>)stateRootHash);
         }
     }
 }

.Lib9c.Tools/SubCommand/State.cs

@@ -118,14 +118,16 @@ IStateStore stateStore
                     _ => policy.BlockAction,
                     stateStore,
                     actionLoader);
-                HashDigest<SHA256> stateRootHash = block.Index < 1
-                    ? BlockChain.DetermineGenesisStateRootHash(
-                        actionEvaluator,
-                        preEvalBlock,
-                        out _)
-                    : chain.DetermineBlockStateRootHash(
-                        preEvalBlock,
-                        out _);
+
+                HashDigest<SHA256>? refSrh = block.ProtocolVersion < BlockMetadata.SlothProtocolVersion
+                   ? store.GetStateRootHash(block.PreviousHash)
+                   : store.GetStateRootHash(block.Hash);
+
+                IReadOnlyList<ICommittedActionEvaluation> evals = actionEvaluator.Evaluate(block, refSrh);
+                HashDigest<SHA256> stateRootHash = evals.Count > 0
+                    ? evals[evals.Count - 1].OutputState
+                    : refSrh is { } prevSrh ? prevSrh : MerkleTrie.EmptyRootHash;
+
                 DateTimeOffset now = DateTimeOffset.Now;
                 if (invalidStateRootHashBlock is null && !stateRootHash.Equals(block.StateRootHash))
                 {

@planetarium/lib9c/docs/.gitignore

@@ -0,0 +1 @@
+.vitepress/cache

@planetarium/lib9c/docs/.vitepress/config.ts

@@ -0,0 +1,74 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "@planetarium/lib9c",
+  description: "Documentation for @planetarium/lib9c package",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Docs', link: '/docs/index.md' },
+      { text: 'API Reference', link: 'https://jsr.io/@planetarium/lib9c' },
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/planetarium/lib9c/tree/development/%40planetarium/lib9c' }
+    ],
+
+    i18nRouting: true,
+    sidebar: [
+      {
+        link: '/docs/index.md',
+        text: "Introduction"
+      },
+      {
+        link: '/docs/installation.md',
+        text: "Installation"
+      },
+      {
+        link: '/docs/actions.md',
+        text: "Actions"
+      },
+      {
+        link: '/docs/utility.md',
+        text: "Utility"
+      }
+    ],
+    outline: 'deep'
+  },
+  locales: {
+    root: {
+      label: 'English',
+      lang: 'en',
+    },
+    ko: {
+      label: 'Korean',
+      lang: 'ko',
+      themeConfig: {
+        i18nRouting: true,
+        nav: [
+          { text: '문서', link: '/ko/docs/index.md' },
+          { text: 'API Reference', link: 'https://jsr.io/@planetarium/lib9c' },
+        ],
+        sidebar: [
+          {
+            link: '/ko/docs/index.md',
+            text: "소개"
+          },
+          {
+            link: '/ko/docs/installation.md',
+            text: "설치"
+          },
+          {
+            link: '/ko/docs/actions.md',
+            text: "액션"
+          },
+          {
+            link: '/ko/docs/utility.md',
+            text: "유틸리티"
+          }
+        ]
+      }
+    },
+  }
+})