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

prover: implement token methods, gas price, fix copy tracer on deploy #195

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

prover: implement token methods, gas price, fix copy tracer on deploy #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b6d1ef
feat(prover): implement token-related methods, gas price in tracer st…
x-mass Feb 5, 2025
7c6d7d9
fix(prover): copy tracer memory read
x-mass Feb 5, 2025
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
5 changes: 3 additions & 2 deletions nil/internal/execution/transactions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"github.com/NilFoundation/nil/nil/common/logging"
"github.com/NilFoundation/nil/nil/internal/tracing"
"github.com/NilFoundation/nil/nil/internal/types"
"github.com/NilFoundation/nil/nil/internal/vm"
)

var sharedLogger = logging.NewLogger("execution")
Expand Down Expand Up @@ -35,10 +36,10 @@ func (m dummyPayer) String() string {

type transactionPayer struct {
transaction *types.Transaction
es *ExecutionState
es vm.StateDB
akokoshn marked this conversation as resolved.
Show resolved Hide resolved
}

func NewTransactionPayer(transaction *types.Transaction, es *ExecutionState) transactionPayer {
func NewTransactionPayer(transaction *types.Transaction, es vm.StateDB) transactionPayer {
return transactionPayer{
transaction: transaction,
es: es,
Expand Down
16 changes: 8 additions & 8 deletions nil/services/synccommittee/prover/tracer/copy_tracer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ var copyEventExtractors = map[vm.OpCode]copyEventExtractor{
if err != nil {
return copyEvent{}, err
}
data := getDataOverflowSafe(code, src, size)
data := getFixedSizeDataSafe(code, src, size)

return newFinalizedCopyEvent(CopyEvent{
From: CopyParticipant{
Expand Down Expand Up @@ -234,7 +234,7 @@ var copyEventExtractors = map[vm.OpCode]copyEventExtractor{
if err != nil {
return copyEvent{}, err
}
data := getDataOverflowSafe(code, src, size)
data := getFixedSizeDataSafe(code, src, size)

return newFinalizedCopyEvent(CopyEvent{
From: CopyParticipant{
Expand All @@ -256,7 +256,7 @@ var copyEventExtractors = map[vm.OpCode]copyEventExtractor{
dst = tCtx.stack.PopUint64()
src = tCtx.stack.PopUint64()
size = tCtx.stack.PopUint64()
data = getDataOverflowSafe(tCtx.vmCtx.CallInput(), src, size)
data = getFixedSizeDataSafe(tCtx.vmCtx.CallInput(), src, size)
)

return newFinalizedCopyEvent(CopyEvent{
Expand All @@ -278,7 +278,7 @@ var copyEventExtractors = map[vm.OpCode]copyEventExtractor{
var (
src = tCtx.stack.PopUint64()
size = tCtx.stack.PopUint64()
data = tCtx.vmCtx.MemoryData()[src : src+size]
data = getDataIfStartValid(tCtx.vmCtx.MemoryData(), src, size)
)

return newFinalizedCopyEvent(CopyEvent{
Expand Down Expand Up @@ -327,7 +327,7 @@ var copyEventExtractors = map[vm.OpCode]copyEventExtractor{
_ = tCtx.stack.Pop() // value
src = tCtx.stack.PopUint64()
size = tCtx.stack.PopUint64()
data = tCtx.vmCtx.MemoryData()[src : src+size]
data = getDataIfStartValid(tCtx.vmCtx.MemoryData(), src, size)
)
return newCopyEventWithFinalizer(CopyEvent{
From: CopyParticipant{
Expand All @@ -352,7 +352,7 @@ var copyEventExtractors = map[vm.OpCode]copyEventExtractor{
_ = tCtx.stack.Pop() // value
src = tCtx.stack.PopUint64()
size = tCtx.stack.PopUint64()
data = tCtx.vmCtx.MemoryData()[src : src+size]
data = getDataIfStartValid(tCtx.vmCtx.MemoryData(), src, size)
)

return newCopyEventWithFinalizer(CopyEvent{
Expand Down Expand Up @@ -382,7 +382,7 @@ var copyEventExtractors = map[vm.OpCode]copyEventExtractor{
var (
src = tCtx.stack.PopUint64()
size = tCtx.stack.PopUint64()
data = tCtx.vmCtx.MemoryData()[src : src+size]
data = getDataIfStartValid(tCtx.vmCtx.MemoryData(), src, size)
)

return newCopyEventWithFinalizer(CopyEvent{
Expand Down Expand Up @@ -427,7 +427,7 @@ func newLogCopyEvent(tCtx copyEventTraceContext) (copyEvent, error) {
return newEmptyCopyEvent(), nil
}

data := tCtx.vmCtx.MemoryData()[src : src+size]
data := getDataIfStartValid(tCtx.vmCtx.MemoryData(), src, size)

return newFinalizedCopyEvent(CopyEvent{
From: CopyParticipant{
Expand Down
161 changes: 124 additions & 37 deletions nil/services/synccommittee/prover/tracer/state_db.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"runtime/debug"

"github.com/NilFoundation/nil/nil/common"
"github.com/NilFoundation/nil/nil/common/check"
"github.com/NilFoundation/nil/nil/internal/config"
"github.com/NilFoundation/nil/nil/internal/db"
"github.com/NilFoundation/nil/nil/internal/execution"
Expand All @@ -22,7 +23,6 @@ import (
type TracerStateDB struct {
client api.RpcClient
shardId types.ShardId
shardBlockNumber types.BlockNumber
InTransactions []*types.Transaction
blkContext *vm.BlockContext
Traces ExecutionTraces
Expand All @@ -31,12 +31,14 @@ type TracerStateDB struct {
AccountSparseMpt mpt.MerklePatriciaTrie
logger zerolog.Logger
mptTracer *mpttracer.MPTTracer // unlike others MPT tracer keeps its state between transactions

// gas price for current block
GasPrice types.Value
gasPrice types.Value
refund uint64

// Reinited for each transaction
txnTraceCtx *transactionTraceContext
// txnFeeCredit holds the total fee credit for the inbound transaction. It can be changed during execution in case
// of Response tx, thus we use this separate variable instead of the one in the transaction.
txnFeeCredit types.Value
}

var _ vm.StateDB = (*TracerStateDB)(nil)
Expand Down Expand Up @@ -158,7 +160,7 @@ func NewTracerStateDB(
aggTraces ExecutionTraces,
client api.RpcClient,
shardId types.ShardId,
shardBlockNumber types.BlockNumber,
prevBlockNumber types.BlockNumber,
blkContext *vm.BlockContext,
db db.DB,
logger zerolog.Logger,
Expand All @@ -169,13 +171,14 @@ func NewTracerStateDB(
}

return &TracerStateDB{
client: client,
mptTracer: mpttracer.New(client, shardBlockNumber, rwTx, shardId),
shardId: shardId,
shardBlockNumber: shardBlockNumber,
blkContext: blkContext,
Traces: aggTraces,
logger: logger,
client: client,
mptTracer: mpttracer.New(client, prevBlockNumber, rwTx, shardId),
shardId: shardId,
blkContext: blkContext,
Traces: aggTraces,
logger: logger,

gasPrice: types.NewZeroValue(),
}, nil
}

Expand All @@ -197,7 +200,7 @@ func (tsdb *TracerStateDB) getOrNewAccount(addr types.Address) (*execution.Accou
}

// OutTransactions don't requre handling, they are just included into block
func (tsdb *TracerStateDB) HandleInTransaction(transaction *types.Transaction) (err error) {
func (tsdb *TracerStateDB) HandleInTransaction(transaction *types.Transaction, payer execution.Payer) (err error) {
tsdb.logger.Trace().
Int64("seqno", int64(transaction.Seqno)).
Str("flags", transaction.Flags.String()).
Expand All @@ -222,26 +225,31 @@ func (tsdb *TracerStateDB) HandleInTransaction(transaction *types.Transaction) (
panic(r) // all unmanaged errors (runtime or explicit panic() calls) are rethrown from tracer with stack logging
}()

tsdb.txnFeeCredit = transaction.FeeCredit

tsdb.updateGasPrice(transaction)
buyGas(payer, transaction)

switch {
case transaction.IsRefund():
err = tsdb.HandleRefundTransaction(transaction)
err = tsdb.handleRefundTransaction(transaction)
case transaction.IsDeploy():
err = tsdb.HandleDeployTransaction(transaction)
err = tsdb.handleDeployTransaction(transaction)
case transaction.IsExecution():
err = tsdb.HandleExecutionTransaction(transaction)
err = tsdb.handleExecutionTransaction(transaction)
default:
err = fmt.Errorf("unknown transaction type: %+v", transaction)
}

tsdb.Stats.ProcessedInTxnsN++
return //nolint:nakedret
return err
}

func (tsdb *TracerStateDB) HandleRefundTransaction(transaction *types.Transaction) error {
func (tsdb *TracerStateDB) handleRefundTransaction(transaction *types.Transaction) error {
return tsdb.AddBalance(transaction.To, transaction.Value, tracing.BalanceIncreaseRefund)
}

func (tsdb *TracerStateDB) HandleExecutionTransaction(transaction *types.Transaction) error {
func (tsdb *TracerStateDB) handleExecutionTransaction(transaction *types.Transaction) error {
if transaction.IsResponse() {
return errors.New("Can't handle response yet")
}
Expand All @@ -263,7 +271,7 @@ func (tsdb *TracerStateDB) HandleExecutionTransaction(transaction *types.Transac
)
defer tsdb.resetTxnTrace()

gas := transaction.FeeCredit.ToGas(tsdb.GasPrice) // mb previous block, not current one?
gas := transaction.FeeCredit.ToGas(tsdb.gasPrice)
ret, gasLeft, err := tsdb.txnTraceCtx.evm.Call(caller, transaction.To, callData, gas.Uint64(), transaction.Value.Int())
_, _ = ret, gasLeft

Expand All @@ -274,7 +282,7 @@ func (tsdb *TracerStateDB) HandleExecutionTransaction(transaction *types.Transac
return tsdb.txnTraceCtx.saveTransactionTraces(tsdb.Traces)
}

func (tsdb *TracerStateDB) HandleDeployTransaction(transaction *types.Transaction) error {
func (tsdb *TracerStateDB) handleDeployTransaction(transaction *types.Transaction) error {
addr := transaction.To
deployTxn := types.ParseDeployPayload(transaction.Data)

Expand All @@ -287,7 +295,7 @@ func (tsdb *TracerStateDB) HandleDeployTransaction(transaction *types.Transactio
)
defer tsdb.resetTxnTrace()

gas := transaction.FeeCredit.ToGas(tsdb.GasPrice)
gas := transaction.FeeCredit.ToGas(tsdb.gasPrice)
ret, addr, leftOver, err := tsdb.txnTraceCtx.evm.Deploy(addr, (vm.AccountRef)(transaction.From), deployTxn.Code(), gas.Uint64(), transaction.Value.Int())
if err != nil {
return err
Expand All @@ -310,7 +318,7 @@ func (tsdb *TracerStateDB) initTransactionTraceContext(
txnId := uint(len(tsdb.InTransactions) - 1)
codeHash := getCodeHash(executingCode)
txnTraceCtx := &transactionTraceContext{
evm: vm.NewEVM(tsdb.blkContext, tsdb, origin, types.DefaultGasPrice, state),
evm: vm.NewEVM(tsdb.blkContext, tsdb, origin, tsdb.gasPrice, state),
code: executingCode,
codeHash: codeHash,
rwCounter: &tsdb.RwCounter,
Expand Down Expand Up @@ -378,12 +386,29 @@ func (tsdb *TracerStateDB) GetTransactionFlags() types.TransactionFlags {
panic("not implemented")
}

func (tsdb *TracerStateDB) GetTokens(types.Address) map[types.TokenId]types.Value {
panic("not implemented")
func (tsdb *TracerStateDB) GetTokens(addr types.Address) map[types.TokenId]types.Value {
acc, err := tsdb.mptTracer.GetAccount(addr)
check.PanicIfErr(err)
if acc == nil {
return nil
}

res := make(map[types.TokenId]types.Value)
for k, v := range acc.TokenTree.Iterate() {
var c types.TokenBalance
c.Token = types.TokenId(k)
if err := c.Balance.UnmarshalSSZ(v); err != nil {
tsdb.logger.Error().Err(err).Msg("failed to unmarshal token balance")
x-mass marked this conversation as resolved.
Show resolved Hide resolved
continue
}
res[c.Token] = c.Balance
}

return res
}

func (tsdb *TracerStateDB) GetGasPrice(types.ShardId) (types.Value, error) {
return types.Value{}, errors.New("not implemented")
return tsdb.gasPrice, nil
}

// Write methods
Expand Down Expand Up @@ -431,16 +456,65 @@ func (tsdb *TracerStateDB) GetBalance(addr types.Address) (types.Value, error) {
return acc.Balance, nil
}

func (tsdb *TracerStateDB) AddToken(to types.Address, tokenId types.TokenId, amount types.Value) error {
panic("not implemented")
func (tsdb *TracerStateDB) AddToken(addr types.Address, tokenId types.TokenId, amount types.Value) error {
tsdb.logger.Debug().
Stringer("addr", addr).
Stringer("amount", amount).
Stringer("id", tokenId).
Msg("Add token")

acc, err := tsdb.mptTracer.GetAccount(addr)
if err != nil {
return err
}
if acc == nil {
return fmt.Errorf("destination account %v not found", addr)
}

balance := acc.GetTokenBalance(tokenId)
if balance == nil {
balance = &types.Value{}
}
newBalance := balance.Add(amount)
// Amount can be negative(token burning). So, if the new balance is negative, set it to 0
if newBalance.Cmp(types.Value{}) < 0 {
newBalance = types.Value{}
}
acc.SetTokenBalance(tokenId, newBalance)

return nil
}

func (tsdb *TracerStateDB) SubToken(to types.Address, tokenId types.TokenId, amount types.Value) error {
panic("not implemented")
func (tsdb *TracerStateDB) SubToken(addr types.Address, tokenId types.TokenId, amount types.Value) error {
tsdb.logger.Debug().
Stringer("addr", addr).
Stringer("amount", amount).
Stringer("id", tokenId).
Msg("Sub token")

acc, err := tsdb.mptTracer.GetAccount(addr)
if err != nil {
return err
}
if acc == nil {
return fmt.Errorf("destination account %v not found", addr)
}

balance := acc.GetTokenBalance(tokenId)
if balance == nil {
balance = &types.Value{}
}
if balance.Cmp(amount) < 0 {
return fmt.Errorf("%w: %s < %s, token %s",
vm.ErrInsufficientBalance, balance, amount, tokenId)
}
acc.SetTokenBalance(tokenId, balance.Sub(amount))

return nil
}

func (tsdb *TracerStateDB) SetTokenTransfer([]types.TokenBalance) {
panic("not implemented")
func (tsdb *TracerStateDB) SetTokenTransfer(tokens []types.TokenBalance) {
tsdb.txnTraceCtx.evm.SetTokenTransfer(tokens)
}

func (tsdb *TracerStateDB) GetSeqno(addr types.Address) (types.Seqno, error) {
Expand Down Expand Up @@ -489,17 +563,18 @@ func (tsdb *TracerStateDB) SetCode(addr types.Address, code []byte) error {
return nil
}

func (tsdb *TracerStateDB) AddRefund(uint64) {
panic("not implemented")
func (tsdb *TracerStateDB) AddRefund(gas uint64) {
tsdb.refund += gas
}

func (tsdb *TracerStateDB) SubRefund(uint64) {
panic("not implemented")
func (tsdb *TracerStateDB) SubRefund(gas uint64) {
check.PanicIff(gas > tsdb.refund, "Refund counter below zero (gas: %d > refund: %d)", gas, tsdb.refund)
tsdb.refund -= gas
}

// GetRefund returns the current value of the refund counter.
func (tsdb *TracerStateDB) GetRefund() uint64 {
panic("not implemented")
panic("unreachable") // Not used in ExecutionState for now
x-mass marked this conversation as resolved.
Show resolved Hide resolved
}

func (tsdb *TracerStateDB) GetCommittedState(addr types.Address, key common.Hash) common.Hash {
Expand Down Expand Up @@ -698,3 +773,15 @@ func (tsdb *TracerStateDB) FinalizeTraces() error {
tsdb.Stats.AffectedContractsN = uint(len(mptTraces.ContractTrieTraces))
return nil
}

func (tsdb *TracerStateDB) updateGasPrice(txn *types.Transaction) {
tsdb.gasPrice = types.NewValueFromBigMust(tsdb.blkContext.BaseFee).Add(txn.MaxPriorityFeePerGas)

if tsdb.gasPrice.Cmp(txn.MaxFeePerGas) > 0 {
tsdb.gasPrice = txn.MaxFeePerGas
}
}

func buyGas(payer execution.Payer, transaction *types.Transaction) {
payer.SubBalance(transaction.FeeCredit)
}
Loading