-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f3aa665
commit d00d90b
Showing
5 changed files
with
260 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| // Copyright (C) 2015-2023 The Neo Project. | ||
| // | ||
| // The Neo.Plugins.StatesDumper is free software distributed under the MIT software license, | ||
| // see the accompanying file LICENSE in the main directory of the | ||
| // project or http://www.opensource.org/licenses/mit-license.php | ||
| // for more details. | ||
| // | ||
| // Redistribution and use in source and binary forms with or without | ||
| // modifications are permitted. | ||
|
|
||
| using Microsoft.Extensions.Configuration; | ||
| using Neo.SmartContract.Native; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
|
|
||
| namespace Neo.Plugins | ||
| { | ||
| internal class Settings | ||
| { | ||
| /// <summary> | ||
| /// Amount of storages states (heights) to be dump in a given json file | ||
| /// </summary> | ||
| public uint BlockCacheSize { get; } | ||
| /// <summary> | ||
| /// Height to begin storage dump | ||
| /// </summary> | ||
| public uint HeightToBegin { get; } | ||
|
|
||
| public IReadOnlyList<int> Exclude { get; } | ||
|
|
||
| public static Settings Default { get; private set; } | ||
|
|
||
| private Settings(IConfigurationSection section) | ||
| { | ||
| /// Geting settings for storage changes state dumper | ||
| this.BlockCacheSize = section.GetValue("BlockCacheSize", 1000u); | ||
| this.HeightToBegin = section.GetValue("HeightToBegin", 0u); | ||
| this.Exclude = section.GetSection("Exclude").Exists() | ||
| ? section.GetSection("Exclude").GetChildren().Select(p => int.Parse(p.Value)).ToArray() | ||
| : new[] { NativeContract.Ledger.Id }; | ||
| } | ||
|
|
||
| public static void Load(IConfigurationSection section) | ||
| { | ||
| Default = new Settings(section); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| // Copyright (C) 2015-2023 The Neo Project. | ||
| // | ||
| // The Neo.Plugins.StatesDumper is free software distributed under the MIT software license, | ||
| // see the accompanying file LICENSE in the main directory of the | ||
| // project or http://www.opensource.org/licenses/mit-license.php | ||
| // for more details. | ||
| // | ||
| // Redistribution and use in source and binary forms with or without | ||
| // modifications are permitted. | ||
|
|
||
| using Neo.ConsoleService; | ||
| using Neo.IO; | ||
| using Neo.Json; | ||
| using Neo.Ledger; | ||
| using Neo.Network.P2P.Payloads; | ||
| using Neo.Persistence; | ||
| using Neo.SmartContract.Native; | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using System.Linq; | ||
|
|
||
| namespace Neo.Plugins | ||
| { | ||
| public class StorageDumper : Plugin | ||
| { | ||
| private readonly Dictionary<uint, NeoSystem> systems = new Dictionary<uint, NeoSystem>(); | ||
|
|
||
| private StreamWriter _writer; | ||
| private JObject _currentBlock; | ||
| private string _lastCreateDirectory; | ||
|
|
||
|
|
||
| public override string Description => "Exports Neo-CLI status data"; | ||
|
|
||
| public StorageDumper() | ||
| { | ||
| Blockchain.Committing += OnCommitting; | ||
| Blockchain.Committed += OnCommitted; | ||
| } | ||
|
|
||
| public override void Dispose() | ||
| { | ||
| Blockchain.Committing -= OnCommitting; | ||
| Blockchain.Committed -= OnCommitted; | ||
| } | ||
|
|
||
| protected override void Configure() | ||
| { | ||
| Settings.Load(GetConfiguration()); | ||
| } | ||
|
|
||
| protected override void OnSystemLoaded(NeoSystem system) | ||
| { | ||
| systems.Add(system.Settings.Network, system); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Process "dump contract-storage" command | ||
| /// </summary> | ||
| [ConsoleCommand("dump contract-storage", Category = "Storage", Description = "You can specify the contract script hash or use null to get the corresponding information from the storage")] | ||
| private void OnDumpStorage(uint network, UInt160 contractHash = null) | ||
| { | ||
| if (!systems.ContainsKey(network)) throw new InvalidOperationException("invalid network"); | ||
| string path = $"dump_{network}.json"; | ||
| byte[] prefix = null; | ||
| if (contractHash is not null) | ||
| { | ||
| var contract = NativeContract.ContractManagement.GetContract(systems[network].StoreView, contractHash); | ||
| if (contract is null) throw new InvalidOperationException("contract not found"); | ||
| prefix = BitConverter.GetBytes(contract.Id); | ||
| } | ||
| var states = systems[network].StoreView.Find(prefix); | ||
| JArray array = new JArray(states.Where(p => !Settings.Default.Exclude.Contains(p.Key.Id)).Select(p => new JObject | ||
| { | ||
| ["key"] = Convert.ToBase64String(p.Key.ToArray()), | ||
| ["value"] = Convert.ToBase64String(p.Value.ToArray()) | ||
| })); | ||
| File.WriteAllText(path, array.ToString()); | ||
| ConsoleHelper.Info("States", | ||
| $"({array.Count})", | ||
| " have been dumped into file ", | ||
| $"{path}"); | ||
| } | ||
|
|
||
| private void OnCommitting(NeoSystem system, Block block, DataCache snapshot, IReadOnlyList<Blockchain.ApplicationExecuted> applicationExecutedList) | ||
| { | ||
| InitFileWriter(system.Settings.Network, snapshot); | ||
| OnPersistStorage(system.Settings.Network, snapshot); | ||
| } | ||
|
|
||
| private void OnPersistStorage(uint network, DataCache snapshot) | ||
| { | ||
| uint blockIndex = NativeContract.Ledger.CurrentIndex(snapshot); | ||
| if (blockIndex >= Settings.Default.HeightToBegin) | ||
| { | ||
| JArray array = new JArray(); | ||
|
|
||
| foreach (var trackable in snapshot.GetChangeSet()) | ||
| { | ||
| if (Settings.Default.Exclude.Contains(trackable.Key.Id)) | ||
| continue; | ||
| JObject state = new JObject(); | ||
| switch (trackable.State) | ||
| { | ||
| case TrackState.Added: | ||
| state["state"] = "Added"; | ||
| state["key"] = Convert.ToBase64String(trackable.Key.ToArray()); | ||
| state["value"] = Convert.ToBase64String(trackable.Item.ToArray()); | ||
| // Here we have a new trackable.Key and trackable.Item | ||
| break; | ||
| case TrackState.Changed: | ||
| state["state"] = "Changed"; | ||
| state["key"] = Convert.ToBase64String(trackable.Key.ToArray()); | ||
| state["value"] = Convert.ToBase64String(trackable.Item.ToArray()); | ||
| break; | ||
| case TrackState.Deleted: | ||
| state["state"] = "Deleted"; | ||
| state["key"] = Convert.ToBase64String(trackable.Key.ToArray()); | ||
| break; | ||
| } | ||
| array.Add(state); | ||
| } | ||
|
|
||
| JObject bs_item = new JObject(); | ||
| bs_item["block"] = blockIndex; | ||
| bs_item["size"] = array.Count; | ||
| bs_item["storage"] = array; | ||
| _currentBlock = bs_item; | ||
| } | ||
| } | ||
|
|
||
|
|
||
| private void OnCommitted(NeoSystem system, Block block) | ||
| { | ||
| OnCommitStorage(system.Settings.Network, system.StoreView); | ||
| } | ||
|
|
||
| void OnCommitStorage(uint network, DataCache snapshot) | ||
| { | ||
| if (_currentBlock != null) | ||
| { | ||
| _writer.WriteLine(_currentBlock.ToString()); | ||
| _writer.Flush(); | ||
| } | ||
| } | ||
|
|
||
| private void InitFileWriter(uint network, DataCache snapshot) | ||
| { | ||
| uint blockIndex = NativeContract.Ledger.CurrentIndex(snapshot); | ||
| if (_writer == null | ||
| || blockIndex % Settings.Default.BlockCacheSize == 0) | ||
| { | ||
| string path = GetOrCreateDirectory(network, blockIndex); | ||
| var filepart = (blockIndex / Settings.Default.BlockCacheSize) * Settings.Default.BlockCacheSize; | ||
| path = $"{path}/dump-block-{filepart}.dump"; | ||
| if (_writer != null) | ||
| { | ||
| _writer.Dispose(); | ||
| } | ||
| _writer = new StreamWriter(new FileStream(path, FileMode.Append)); | ||
| } | ||
| } | ||
|
|
||
| private string GetOrCreateDirectory(uint network, uint blockIndex) | ||
| { | ||
| string dirPathWithBlock = GetDirectoryPath(network, blockIndex); | ||
| if (_lastCreateDirectory != dirPathWithBlock) | ||
| { | ||
| Directory.CreateDirectory(dirPathWithBlock); | ||
| _lastCreateDirectory = dirPathWithBlock; | ||
| } | ||
| return dirPathWithBlock; | ||
| } | ||
|
|
||
| private string GetDirectoryPath(uint network, uint blockIndex) | ||
| { | ||
| //Default Parameter | ||
| uint storagePerFolder = 100000; | ||
| uint folder = (blockIndex / storagePerFolder) * storagePerFolder; | ||
| return $"./StorageDumper_{network}/BlockStorage_{folder}"; | ||
| } | ||
|
|
||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <PackageId>Neo.Plugins.StorageDumper</PackageId> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| <Nullable>enable</Nullable> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Neo.ConsoleService" Version="1.2.0" /> | ||
| </ItemGroup> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "PluginConfiguration": { | ||
| "BlockCacheSize": 1000, | ||
| "HeightToBegin": 0, | ||
| "Exclude": [ -4 ] | ||
| } | ||
| } |