feat: introduce txid->blockhash index on IStore

CHANGES.md

@@ -153,6 +153,14 @@ To be released.
      -  Removed `Transaction<T>.EvaluateActions()` method.
  -  Parameters `action`, `inputContext`, and `outputStates` for
     `ActionEvaluation()` constructor can no longer be `null`.  [[#1305]]
+ -  Added `IStore.PutTxIdBlockHashIndex(TxId, BlockHash)` method.
+    [[#1294], [#1328]]
+ -  Added `IStore.GetFirstTxIdBlockHashIndex(TxId)` method.
+    [[#1294], [#1328]]
+ -  Added `IStore.DeleteTxIdBlockHashIndex(TxId, BlockHash)` method.
+    [[#1294], [#1328]]
+-  Added `IStore.IterateTxIdBlockHashIndex(TxId)` method.
+    [[#1294], [#1328]]
 
 ### Backward-incompatible network protocol changes
 
@@ -281,10 +289,12 @@ To be released.
 [#1285]: https://github.com/planetarium/libplanet/issues/1285
 [#1287]: https://github.com/planetarium/libplanet/pull/1287
 [#1289]: https://github.com/planetarium/libplanet/pull/1289
+[#1294]: https://github.com/planetarium/libplanet/issues/1294
 [#1298]: https://github.com/planetarium/libplanet/pull/1298
 [#1301]: https://github.com/planetarium/libplanet/issues/1301
 [#1305]: https://github.com/planetarium/libplanet/pull/1305
 [#1325]: https://github.com/planetarium/libplanet/pull/1325
+[#1328]: https://github.com/planetarium/libplanet/pull/1328
 [#1339]: https://github.com/planetarium/libplanet/issues/1339
 [#1342]: https://github.com/planetarium/libplanet/pull/1342
 

Libplanet.Explorer/Store/LiteDBRichStore.cs

@@ -101,6 +101,18 @@ public void PutTxExecution(TxFailure txFailure) =>
         public TxExecution GetTxExecution(BlockHash blockHash, TxId txid) =>
             _store.GetTxExecution(blockHash, txid);
 
+        public void PutTxIdBlockHashIndex(TxId txId, BlockHash blockHash) =>
+            _store.PutTxIdBlockHashIndex(txId, blockHash);
+
+        public BlockHash? GetFirstTxIdBlockHashIndex(TxId txId) =>
+            _store.GetFirstTxIdBlockHashIndex(txId);
+
+        public IEnumerable<BlockHash> IterateTxIdBlockHashIndex(TxId txId) =>
+            _store.IterateTxIdBlockHashIndex(txId);
+
+        public void DeleteTxIdBlockHashIndex(TxId txId, BlockHash blockHash) =>
+            _store.DeleteTxIdBlockHashIndex(txId, blockHash);
+
         public DateTimeOffset? GetBlockPerceivedTime(BlockHash blockHash)
         {
             return _store.GetBlockPerceivedTime(blockHash);

Libplanet.Explorer/Store/MySQLRichStore.cs

@@ -65,6 +65,18 @@ public void PutTxExecution(TxFailure txFailure) =>
         public TxExecution GetTxExecution(BlockHash blockHash, TxId txid) =>
             _store.GetTxExecution(blockHash, txid);
 
+        public void PutTxIdBlockHashIndex(TxId txId, BlockHash blockHash) =>
+            _store.PutTxIdBlockHashIndex(txId, blockHash);
+
+        public BlockHash? GetFirstTxIdBlockHashIndex(TxId txId) =>
+            _store.GetFirstTxIdBlockHashIndex(txId);
+
+        public IEnumerable<BlockHash> IterateTxIdBlockHashIndex(TxId txId) =>
+            _store.IterateTxIdBlockHashIndex(txId);
+
+        public void DeleteTxIdBlockHashIndex(TxId txId, BlockHash blockHash) =>
+            _store.DeleteTxIdBlockHashIndex(txId, blockHash);
+
         public DateTimeOffset? GetBlockPerceivedTime(BlockHash blockHash) =>
             _store.GetBlockPerceivedTime(blockHash);
 

Libplanet.RocksDBStore/MonoRocksDBStore.cs

@@ -27,6 +27,7 @@ public class MonoRocksDBStore : BaseStore
         private const string TxDbName = "tx";
         private const string StagedTxDbName = "stagedtx";
         private const string TxExecutionDbName = "txexec";
+        private const string TxIdBlockHashIndexDbName = "txbindex";
         private const string ChainDbName = "chain";
         private const int ForkWriteBatchSize = 100000;
 
@@ -36,6 +37,7 @@ public class MonoRocksDBStore : BaseStore
         private static readonly byte[] TxNonceKeyPrefix = { (byte)'N' };
         private static readonly byte[] StagedTxKeyPrefix = { (byte)'t' };
         private static readonly byte[] TxExecutionKeyPrefix = { (byte)'e' };
+        private static readonly byte[] TxIdBlockHashIndexPrefix = { (byte)'i' };
         private static readonly byte[] IndexCountKey = { (byte)'c' };
         private static readonly byte[] CanonicalChainIdIdKey = { (byte)'C' };
 
@@ -56,6 +58,7 @@ public class MonoRocksDBStore : BaseStore
         private readonly RocksDb _txDb;
         private readonly RocksDb _stagedTxDb;
         private readonly RocksDb _txExecutionDb;
+        private readonly RocksDb _txIdBlockHashIndexDb;
         private readonly RocksDb _chainDb;
         private bool _disposed = false;
 
@@ -125,6 +128,8 @@ public MonoRocksDBStore(
             _stagedTxDb = RocksDBUtils.OpenRocksDb(_options, RocksDbPath(StagedTxDbName));
             _txExecutionDb =
                 RocksDBUtils.OpenRocksDb(_options, RocksDbPath(TxExecutionDbName));
+            _txIdBlockHashIndexDb =
+                RocksDBUtils.OpenRocksDb(_options, RocksDbPath(TxIdBlockHashIndexDbName));
 
             // When opening a DB in a read-write mode, you need to specify all Column Families that
             // currently exist in a DB. https://github.com/facebook/rocksdb/wiki/Column-Families
@@ -543,6 +548,33 @@ public override TxExecution GetTxExecution(BlockHash blockHash, TxId txid)
             return null;
         }
 
+        /// <inheritdoc cref="BaseStore.PutTxIdBlockHashIndex(TxId, BlockHash)"/>
+        public override void PutTxIdBlockHashIndex(TxId txId, BlockHash blockHash)
+        {
+            _txIdBlockHashIndexDb.Put(
+                TxIdBlockHashIndexKey(txId, blockHash),
+                blockHash.ToByteArray()
+            );
+        }
+
+        /// <inheritdoc cref="BaseStore.DeleteTxIdBlockHashIndex(TxId, BlockHash)"/>
+        public override void DeleteTxIdBlockHashIndex(TxId txId, BlockHash blockHash)
+        {
+            _txIdBlockHashIndexDb.Remove(
+                TxIdBlockHashIndexKey(txId, blockHash)
+            );
+        }
+
+        /// <inheritdoc cref="BaseStore.IterateTxIdBlockHashIndex(TxId)"/>
+        public override IEnumerable<BlockHash> IterateTxIdBlockHashIndex(TxId txId)
+        {
+            var prefix = TxIdBlockHashIndexTxIdKey(txId);
+            foreach (var it in IterateDb(_txIdBlockHashIndexDb, prefix, null))
+            {
+                yield return new BlockHash(it.Value());
+            }
+        }
+
         /// <inheritdoc cref="BaseStore.SetBlockPerceivedTime(BlockHash, DateTimeOffset)"/>
         public override void SetBlockPerceivedTime(
             BlockHash blockHash,
@@ -655,6 +687,7 @@ public override void Dispose()
                 _blockDb?.Dispose();
                 _blockPerceptionDb?.Dispose();
                 _txExecutionDb?.Dispose();
+                _txIdBlockHashIndexDb?.Dispose();
                 _stagedTxDb?.Dispose();
                 _disposed = true;
             }
@@ -680,6 +713,12 @@ private byte[] TxExecutionKey(in BlockHash blockHash, in TxId txId) =>
         private byte[] TxExecutionKey(TxExecution txExecution) =>
             TxExecutionKey(txExecution.BlockHash, txExecution.TxId);
 
+        private byte[] TxIdBlockHashIndexKey(in TxId txId, in BlockHash blockHash) =>
+            TxIdBlockHashIndexTxIdKey(txId).Concat(blockHash.ByteArray).ToArray();
+
+        private byte[] TxIdBlockHashIndexTxIdKey(in TxId txId) =>
+            TxIdBlockHashIndexPrefix.Concat(txId.ByteArray).ToArray();
+
         private IEnumerable<Iterator> IterateDb(RocksDb db, byte[] prefix, Guid? chainId = null)
         {
             ColumnFamilyHandle cf = GetColumnFamily(db, chainId);

Libplanet.RocksDBStore/RocksDBStore.cs

@@ -30,6 +30,7 @@ public class RocksDBStore : BaseStore
         private const string TxIndexDbName = "txindex";
         private const string StagedTxDbName = "stagedtx";
         private const string TxExecutionDbName = "txexec";
+        private const string TxIdBlockHashIndexDbName = "txbindex";
         private const string ChainDbName = "chain";
         private const int ForkWriteBatchSize = 100000;
 
@@ -39,6 +40,7 @@ public class RocksDBStore : BaseStore
         private static readonly byte[] TxNonceKeyPrefix = { (byte)'N' };
         private static readonly byte[] StagedTxKeyPrefix = { (byte)'t' };
         private static readonly byte[] TxExecutionKeyPrefix = { (byte)'e' };
+        private static readonly byte[] TxIdBlockHashIndexPrefix = { (byte)'i' };
         private static readonly byte[] IndexCountKey = { (byte)'c' };
         private static readonly byte[] CanonicalChainIdIdKey = { (byte)'C' };
         private static readonly byte[] PreviousChainIdKey = { (byte)'P' };
@@ -67,6 +69,7 @@ public class RocksDBStore : BaseStore
         private readonly LruCache<string, RocksDb> _txDbCache;
         private readonly RocksDb _stagedTxDb;
         private readonly RocksDb _txExecutionDb;
+        private readonly RocksDb _txIdBlockHashIndexDb;
         private readonly RocksDb _chainDb;
 
         private readonly ReaderWriterLockSlim _rwTxLock;
@@ -158,6 +161,8 @@ public RocksDBStore(
             _stagedTxDb = RocksDBUtils.OpenRocksDb(_options, RocksDbPath(StagedTxDbName));
             _txExecutionDb =
                 RocksDBUtils.OpenRocksDb(_options, RocksDbPath(TxExecutionDbName));
+            _txIdBlockHashIndexDb =
+                RocksDBUtils.OpenRocksDb(_options, RocksDbPath(TxIdBlockHashIndexDbName));
 
             // When opening a DB in a read-write mode, you need to specify all Column Families that
             // currently exist in a DB. https://github.com/facebook/rocksdb/wiki/Column-Families
@@ -783,6 +788,33 @@ public override bool ContainsBlock(BlockHash blockHash)
             return false;
         }
 
+        /// <inheritdoc cref="BaseStore.PutTxIdBlockHashIndex(TxId, BlockHash)"/>
+        public override void PutTxIdBlockHashIndex(TxId txId, BlockHash blockHash)
+        {
+            _txIdBlockHashIndexDb.Put(
+                TxIdBlockHashIndexKey(txId, blockHash),
+                blockHash.ToByteArray()
+                );
+        }
+
+        /// <inheritdoc cref="BaseStore.DeleteTxIdBlockHashIndex(TxId, BlockHash)"/>
+        public override void DeleteTxIdBlockHashIndex(TxId txId, BlockHash blockHash)
+        {
+            _txIdBlockHashIndexDb.Remove(
+                TxIdBlockHashIndexKey(txId, blockHash)
+            );
+        }
+
+        /// <inheritdoc cref="BaseStore.IterateTxIdBlockHashIndex(TxId)"/>
+        public override IEnumerable<BlockHash> IterateTxIdBlockHashIndex(TxId txId)
+        {
+            var prefix = TxIdBlockHashIndexTxIdKey(txId);
+            foreach (var it in IterateDb(_txIdBlockHashIndexDb, prefix, null))
+            {
+                yield return new BlockHash(it.Value());
+            }
+        }
+
         /// <inheritdoc cref="BaseStore.PutTxExecution(Libplanet.Tx.TxSuccess)"/>
         public override void PutTxExecution(TxSuccess txSuccess) =>
             _txExecutionDb.Put(
@@ -928,6 +960,7 @@ public override void Dispose()
                     _blockPerceptionDb?.Dispose();
                     _stagedTxDb?.Dispose();
                     _txExecutionDb?.Dispose();
+                    _txIdBlockHashIndexDb?.Dispose();
                     foreach (var db in _txDbCache.Values)
                     {
                         db.Dispose();
@@ -1000,6 +1033,12 @@ private byte[] TxExecutionKey(in BlockHash blockHash, in TxId txId) =>
         private byte[] TxExecutionKey(TxExecution txExecution) =>
             TxExecutionKey(txExecution.BlockHash, txExecution.TxId);
 
+        private byte[] TxIdBlockHashIndexKey(in TxId txId, in BlockHash blockHash) =>
+            TxIdBlockHashIndexTxIdKey(txId).Concat(blockHash.ByteArray).ToArray();
+
+        private byte[] TxIdBlockHashIndexTxIdKey(in TxId txId) =>
+            TxIdBlockHashIndexPrefix.Concat(txId.ByteArray).ToArray();
+
         private byte[] ForkedChainsKey(Guid guid) =>
             ForkedChainsKeyPrefix.Concat(guid.ToByteArray()).ToArray();
 

Libplanet.Tests/Store/StoreTest.cs

@@ -442,6 +442,56 @@ void AssertTxFailuresEqual(TxFailure expected, TxExecution actual)
             Assert.Null(Fx.Store.GetTxExecution(Fx.Hash2, Fx.TxId2));
         }
 
+        [SkippableFact]
+        public void TxIdBlockHashIndex()
+        {
+            Assert.Null(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId1));
+            Assert.Null(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId2));
+            Assert.Null(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId3));
+
+            Fx.Store.PutTxIdBlockHashIndex(Fx.TxId1, Fx.Hash1);
+            Assert.Null(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId2));
+            Assert.Null(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId3));
+
+            Fx.Store.PutTxIdBlockHashIndex(Fx.TxId2, Fx.Hash2);
+            Fx.Store.PutTxIdBlockHashIndex(Fx.TxId3, Fx.Hash3);
+
+            Assert.True(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId1)?.Equals(Fx.Hash1));
+            Assert.True(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId2)?.Equals(Fx.Hash2));
+            Assert.True(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId3)?.Equals(Fx.Hash3));
+
+            Fx.Store.PutTxIdBlockHashIndex(Fx.TxId1, Fx.Hash3);
+            Fx.Store.PutTxIdBlockHashIndex(Fx.TxId2, Fx.Hash3);
+            Fx.Store.PutTxIdBlockHashIndex(Fx.TxId3, Fx.Hash1);
+            Assert.Equal(2, Fx.Store.IterateTxIdBlockHashIndex(Fx.TxId1).Count());
+            Assert.Equal(2, Fx.Store.IterateTxIdBlockHashIndex(Fx.TxId2).Count());
+            Assert.Equal(2, Fx.Store.IterateTxIdBlockHashIndex(Fx.TxId3).Count());
+
+            Fx.Store.DeleteTxIdBlockHashIndex(Fx.TxId1, Fx.Hash1);
+            Fx.Store.DeleteTxIdBlockHashIndex(Fx.TxId2, Fx.Hash2);
+            Fx.Store.DeleteTxIdBlockHashIndex(Fx.TxId3, Fx.Hash3);
+
+            Assert.True(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId1)?.Equals(Fx.Hash3));
+            Assert.True(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId2)?.Equals(Fx.Hash3));
+            Assert.True(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId3)?.Equals(Fx.Hash1));
+
+            Assert.Single(Fx.Store.IterateTxIdBlockHashIndex(Fx.TxId1));
+            Assert.Single(Fx.Store.IterateTxIdBlockHashIndex(Fx.TxId2));
+            Assert.Single(Fx.Store.IterateTxIdBlockHashIndex(Fx.TxId3));
+
+            Fx.Store.DeleteTxIdBlockHashIndex(Fx.TxId1, Fx.Hash1);
+            Fx.Store.DeleteTxIdBlockHashIndex(Fx.TxId2, Fx.Hash2);
+            Fx.Store.DeleteTxIdBlockHashIndex(Fx.TxId3, Fx.Hash3);
+
+            Fx.Store.DeleteTxIdBlockHashIndex(Fx.TxId1, Fx.Hash3);
+            Fx.Store.DeleteTxIdBlockHashIndex(Fx.TxId2, Fx.Hash3);
+            Fx.Store.DeleteTxIdBlockHashIndex(Fx.TxId3, Fx.Hash1);
+
+            Assert.Null(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId1));
+            Assert.Null(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId2));
+            Assert.Null(Fx.Store.GetFirstTxIdBlockHashIndex(Fx.TxId3));
+        }
+
         [SkippableFact]
         public void BlockPerceivedTime()
         {

Libplanet.Tests/Store/StoreTracker.cs

@@ -71,6 +71,30 @@ public TxExecution GetTxExecution(BlockHash blockHash, TxId txid)
             return _store.GetTxExecution(blockHash, txid);
         }
 
+        public void PutTxIdBlockHashIndex(TxId txId, BlockHash blockHash)
+        {
+            Log(nameof(PutTxIdBlockHashIndex), txId, blockHash);
+            _store.PutTxIdBlockHashIndex(txId, blockHash);
+        }
+
+        public BlockHash? GetFirstTxIdBlockHashIndex(TxId txId)
+        {
+            Log(nameof(GetFirstTxIdBlockHashIndex), txId);
+            return _store.GetFirstTxIdBlockHashIndex(txId);
+        }
+
+        public IEnumerable<BlockHash> IterateTxIdBlockHashIndex(TxId txId)
+        {
+            Log(nameof(IterateTxIdBlockHashIndex), txId);
+            return _store.IterateTxIdBlockHashIndex(txId);
+        }
+
+        public void DeleteTxIdBlockHashIndex(TxId txId, BlockHash blockHash)
+        {
+            Log(nameof(DeleteTxIdBlockHashIndex), txId, blockHash);
+            _store.DeleteTxIdBlockHashIndex(txId, blockHash);
+        }
+
         public void SetBlockPerceivedTime(BlockHash blockHash, DateTimeOffset perceivedTime)
         {
             Log(nameof(SetBlockPerceivedTime), blockHash, perceivedTime);

Libplanet/Store/BaseStore.cs

@@ -138,6 +138,30 @@ public abstract void PutBlock<T>(Block<T> block)
         /// <inheritdoc cref="IStore.GetTxExecution(BlockHash, TxId)"/>
         public abstract TxExecution GetTxExecution(BlockHash blockHash, TxId txid);
 
+        /// <inheritdoc cref="IStore.PutTxIdBlockHashIndex(TxId, BlockHash)"/>
+        public abstract void PutTxIdBlockHashIndex(TxId txId, BlockHash blockHash);
+
+        public BlockHash? GetFirstTxIdBlockHashIndex(TxId txId)
+        {
+            BlockHash? blockHash;
+            try
+            {
+                blockHash = IterateTxIdBlockHashIndex(txId).First();
+            }
+            catch (InvalidOperationException)
+            {
+                blockHash = null;
+            }
+
+            return blockHash;
+        }
+
+        /// <inheritdoc cref="IStore.IterateTxIdBlockHashIndex(TxId)"/>
+        public abstract IEnumerable<BlockHash> IterateTxIdBlockHashIndex(TxId txId);
+
+        /// <inheritdoc cref="IStore.DeleteTxIdBlockHashIndex(TxId, BlockHash)"/>
+        public abstract void DeleteTxIdBlockHashIndex(TxId txId, BlockHash blockHash);
+
         /// <inheritdoc cref="IStore.SetBlockPerceivedTime(BlockHash, DateTimeOffset)"/>
         public abstract void SetBlockPerceivedTime(
             BlockHash blockHash,