Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented new approach of gas estimation. #3723

Merged
merged 10 commits into from
Jan 7, 2022
Merged

Implemented new approach of gas estimation. #3723

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
629806b
Added implementation of EstimateGas based on binary search.
kjazgar Dec 23, 2021
f08bb06
Refactored tests.
kjazgar Dec 23, 2021
8138bd9
refactoring
kjazgar Dec 23, 2021
eb14daa
Applied requested changes.
kjazgar Jan 5, 2022
0cf53c9
Refactor, move additional responsibilities to GasEstimator (renamed f…
LukaszRozmej Jan 6, 2022
fb5a6a5
Fixed tests, added new tracer, optimized binary search boundaries.
kjazgar Jan 6, 2022
e6ee26e
Fixed tests.
kjazgar Jan 6, 2022
6ba3c62
Refactored code.
kjazgar Jan 6, 2022
e37e3c4
Refactored code.
kjazgar Jan 6, 2022
afa5fad
Removed unnecessary casting.
kjazgar Jan 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
247 changes: 157 additions & 90 deletions src/Nethermind/Nethermind.Evm.Test/Tracing/EstimateGasTracerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,36 +17,73 @@
using System;
using FluentAssertions;
using Nethermind.Core;
using Nethermind.Core.Extensions;
using Nethermind.Core.Specs;
using Nethermind.Core.Test.Builders;
using Nethermind.Crypto;
using Nethermind.Db;
using Nethermind.Evm.Tracing;
using Nethermind.Evm.TransactionProcessing;
using Nethermind.Int256;
using Nethermind.Logging;
using Nethermind.Specs;
using Nethermind.Specs.Forks;
using Nethermind.State;
using Nethermind.Trie.Pruning;
using NSubstitute;
using NUnit.Framework;

namespace Nethermind.Evm.Test.Tracing
{
[TestFixture(true)]
[TestFixture(false)]
[Parallelizable(ParallelScope.All)]
[Parallelizable(ParallelScope.Self)]
public class EstimateGasTracerTests
kjazgar marked this conversation as resolved.
Show resolved Hide resolved
{
private readonly ExecutionType _executionType;
private readonly IReleaseSpec _releaseSpec = Berlin.Instance;
private readonly ISpecProvider _specProvider;
private IEthereumEcdsa _ethereumEcdsa;
private TransactionProcessor _transactionProcessor;
private IStateProvider _stateProvider;
kjazgar marked this conversation as resolved.
Show resolved Hide resolved


public EstimateGasTracerTests(bool useCreates)
{
_executionType = useCreates ? ExecutionType.Create : ExecutionType.Call;
_specProvider = MainnetSpecProvider.Instance;

}

[SetUp]
public void Setup()
{
MemDb stateDb = new();
TrieStore trieStore = new(stateDb, LimboLogs.Instance);
_stateProvider = new StateProvider(trieStore, new MemDb(), LimboLogs.Instance);
_stateProvider.CreateAccount(TestItem.AddressA, 1.Ether());
_stateProvider.Commit(_specProvider.GenesisSpec);
_stateProvider.CommitTree(0);

StorageProvider storageProvider = new(trieStore, _stateProvider, LimboLogs.Instance);
VirtualMachine virtualMachine = new(TestBlockhashProvider.Instance, _specProvider, LimboLogs.Instance);
_transactionProcessor = new TransactionProcessor(_specProvider, _stateProvider, storageProvider, virtualMachine, LimboLogs.Instance);
_ethereumEcdsa = new EthereumEcdsa(_specProvider.ChainId, LimboLogs.Instance);
}

[Test]
public void Does_not_take_into_account_precompiles()
{
Transaction tx = Build.A.Transaction.WithGasLimit(1000).TestObject;
Block block = Build.A.Block.WithNumber(1).WithTransactions(tx).TestObject;

EstimateGasTracer tracer = new();
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Call, true);
tracer.ReportActionEnd(400, Array.Empty<byte>()); // this would not happen but we want to ensure that precompiles are ignored
tracer.ReportActionEnd(600, Array.Empty<byte>());
tracer.CalculateEstimate(Build.A.Transaction.WithGasLimit(1000).TestObject, _releaseSpec).Should().Be(0);

GasEstimator estimator = new(_transactionProcessor, _stateProvider, _specProvider);
estimator.Estimate(tx, block.Header, tracer).Should().Be(0);
}

[Test]
Expand All @@ -63,20 +100,28 @@ public void Only_traces_actions_and_receipts()
|| tracer.IsTracingStack
|| tracer.IsTracingOpLevelStorage).Should().BeFalse();
}

[Test]
public void Handles_well_top_level()
{
EstimateGasTracer tracer = new();
Transaction tx = Build.A.Transaction.WithGasLimit(1000).TestObject;
Block block = Build.A.Block.WithNumber(1).WithTransactions(tx).TestObject;

tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportActionEnd(600, Array.Empty<byte>());
tracer.CalculateEstimate(Build.A.Transaction.WithGasLimit(1000).TestObject, _releaseSpec).Should().Be(0);

GasEstimator estimator = new(_transactionProcessor, _stateProvider, _specProvider);
estimator.Estimate(tx, block.Header, tracer).Should().Be(0);
}

[Test]
public void Handles_well_serial_calls()
{
EstimateGasTracer tracer = new();
Transaction tx = Build.A.Transaction.WithGasLimit(1000).TestObject;
Block block = Build.A.Block.WithNumber(1).WithTransactions(tx).TestObject;

tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
tracer.ReportActionEnd(400, Array.Empty<byte>());
Expand All @@ -92,17 +137,21 @@ public void Handles_well_serial_calls()
tracer.ReportActionEnd(300, Array.Empty<byte>()); // should not happen
}

tracer.CalculateEstimate(Build.A.Transaction.WithGasLimit(1000).TestObject, _releaseSpec).Should().Be(14L);
GasEstimator estimator = new(_transactionProcessor, _stateProvider, _specProvider);
estimator.Estimate(tx, block.Header, tracer).Should().Be(14L);
}

[Test]
public void Handles_well_errors()
{
EstimateGasTracer tracer = new();
Transaction tx = Build.A.Transaction.WithGasLimit(1000).TestObject;
Block block = Build.A.Block.WithNumber(1).WithTransactions(tx).TestObject;

tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
tracer.ReportAction(400, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);

if (_executionType.IsAnyCreate())
{
tracer.ReportActionError(EvmExceptionType.Other);
Expand All @@ -116,96 +165,114 @@ public void Handles_well_errors()
tracer.ReportActionEnd(500, Array.Empty<byte>()); // should not happen
}

tracer.CalculateEstimate(Build.A.Transaction.WithGasLimit(1000).TestObject, _releaseSpec).Should().Be(24L);
}

[Test]
public void Handles_well_revert()
{
long gasLimit = 100000000;
EstimateGasTracer tracer = new();
long gasLeft = gasLimit - 22000;
tracer.ReportAction(gasLeft, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
gasLeft = 63 * gasLeft / 64;
tracer.ReportAction(gasLeft, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
gasLeft = 63 * gasLeft / 64;
tracer.ReportAction(gasLeft, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);

if (_executionType.IsAnyCreate())
{
tracer.ReportActionError(EvmExceptionType.Revert, 96000000);
tracer.ReportActionError(EvmExceptionType.Revert, 98000000);
tracer.ReportActionError(EvmExceptionType.Revert, 99000000);
}
else
{
tracer.ReportActionError(EvmExceptionType.Revert, 96000000);
tracer.ReportActionError(EvmExceptionType.Revert, 98000000);
tracer.ReportActionError(EvmExceptionType.Revert, 99000000);
}

tracer.CalculateEstimate(Build.A.Transaction.WithGasLimit(100000000).TestObject, _releaseSpec).Should().Be(35146L);
}

[Test]
public void Easy_one_level_case()
{
EstimateGasTracer tracer = new();
tracer.ReportAction(128, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportAction(100, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);

tracer.ReportActionEnd(63, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(65, Array.Empty<byte>());

tracer.CalculateEstimate(Build.A.Transaction.WithGasLimit(128).TestObject, _releaseSpec).Should().Be(1);
GasEstimator estimator = new(_transactionProcessor, _stateProvider, _specProvider);
estimator.Estimate(tx, block.Header, tracer).Should().Be(24L);
}

[Test]
public void Handles_well_nested_calls_where_most_nested_defines_excess()
{
EstimateGasTracer tracer = new();
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
tracer.ReportAction(400, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
public void Handles_well_revert()
{
long gasLimit = 100000000;
Transaction tx = Build.A.Transaction.WithGasLimit(100000000).TestObject;
Block block = Build.A.Block.WithNumber(1).WithTransactions(tx).TestObject;

EstimateGasTracer tracer = new();
long gasLeft = gasLimit - 22000;
tracer.ReportAction(gasLeft, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
gasLeft = 63 * gasLeft / 64;
tracer.ReportAction(gasLeft, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
gasLeft = 63 * gasLeft / 64;
tracer.ReportAction(gasLeft, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);

if (_executionType.IsAnyCreate())
{
tracer.ReportActionError(EvmExceptionType.Revert, 96000000);
tracer.ReportActionError(EvmExceptionType.Revert, 98000000);
tracer.ReportActionError(EvmExceptionType.Revert, 99000000);
}
else
{
tracer.ReportActionError(EvmExceptionType.Revert, 96000000);
tracer.ReportActionError(EvmExceptionType.Revert, 98000000);
tracer.ReportActionError(EvmExceptionType.Revert, 99000000);
}

if (_executionType.IsAnyCreate())
{
tracer.ReportActionEnd(200, Address.Zero, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(400, Address.Zero, Array.Empty<byte>());
tracer.ReportActionEnd(500, Array.Empty<byte>()); // should not happen
}
else
{
tracer.ReportActionEnd(200, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(400, Array.Empty<byte>());
tracer.ReportActionEnd(500, Array.Empty<byte>()); // should not happen
}
GasEstimator estimator = new(_transactionProcessor, _stateProvider, _specProvider);
estimator.Estimate(tx, block.Header, tracer).Should().Be(35146L);
}

[Test]
public void Easy_one_level_case()
{
EstimateGasTracer tracer = new();
Transaction tx = Build.A.Transaction.WithGasLimit(128).TestObject;
Block block = Build.A.Block.WithNumber(1).WithTransactions(tx).TestObject;

tracer.ReportAction(128, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportAction(100, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);

tracer.ReportActionEnd(63, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(65, Array.Empty<byte>());

tracer.CalculateEstimate(Build.A.Transaction.WithGasLimit(1000).TestObject, _releaseSpec).Should().Be(18);
}
GasEstimator estimator = new(_transactionProcessor, _stateProvider, _specProvider);
estimator.Estimate(tx, block.Header, tracer).Should().Be(1);
}

[Test]
public void Handles_well_nested_calls_where_most_nested_defines_excess()
{
EstimateGasTracer tracer = new();
Transaction tx = Build.A.Transaction.WithGasLimit(1000).TestObject;
Block block = Build.A.Block.WithNumber(1).WithTransactions(tx).TestObject;

tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
tracer.ReportAction(400, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);

if (_executionType.IsAnyCreate())
{
tracer.ReportActionEnd(200, Address.Zero, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(400, Address.Zero, Array.Empty<byte>());
tracer.ReportActionEnd(500, Array.Empty<byte>()); // should not happen
}
else
{
tracer.ReportActionEnd(200, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(400, Array.Empty<byte>());
tracer.ReportActionEnd(500, Array.Empty<byte>()); // should not happen
}

[Test]
public void Handles_well_nested_calls_where_least_nested_defines_excess()
{
EstimateGasTracer tracer = new();
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
tracer.ReportAction(400, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
GasEstimator estimator = new(_transactionProcessor, _stateProvider, _specProvider);
estimator.Estimate(tx, block.Header, tracer).Should().Be(18);
}

if (_executionType.IsAnyCreate())
{
tracer.ReportActionEnd(300, Address.Zero, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(200, Address.Zero, Array.Empty<byte>());
tracer.ReportActionEnd(500, Array.Empty<byte>()); // should not happen
}
else
{
tracer.ReportActionEnd(300, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(200, Array.Empty<byte>());
tracer.ReportActionEnd(500, Array.Empty<byte>()); // should not happen
}
[Test]
public void Handles_well_nested_calls_where_least_nested_defines_excess()
{
EstimateGasTracer tracer = new();
Transaction tx = Build.A.Transaction.WithGasLimit(1000).TestObject;
Block block = Build.A.Block.WithNumber(1).WithTransactions(tx).TestObject;

tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), ExecutionType.Transaction, false);
tracer.ReportAction(1000, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);
tracer.ReportAction(400, 0, Address.Zero, Address.Zero, Array.Empty<byte>(), _executionType, false);

if (_executionType.IsAnyCreate())
{
tracer.ReportActionEnd(300, Address.Zero, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(200, Address.Zero, Array.Empty<byte>());
tracer.ReportActionEnd(500, Array.Empty<byte>()); // should not happen
}
else
{
tracer.ReportActionEnd(300, Array.Empty<byte>()); // second level
tracer.ReportActionEnd(200, Array.Empty<byte>());
tracer.ReportActionEnd(500, Array.Empty<byte>()); // should not happen
}

tracer.CalculateEstimate(Build.A.Transaction.WithGasLimit(1000).TestObject, _releaseSpec).Should().Be(17);
}
GasEstimator estimator = new(_transactionProcessor, _stateProvider, _specProvider);
estimator.Estimate(tx, block.Header, tracer).Should().Be(17);
}
}

}
Loading