Merge pull request #98 from multiversx/spica-21-1

Improve handling of claim developer rewards
multiversx · Aug 21, 2024 · 05fed49 · 05fed49
2 parents b6829d9 + 9bcda27
commit 05fed49
Show file tree

Hide file tree

Showing 18 changed files with 289 additions and 21 deletions.
diff --git a/cmd/rosetta/cli.go b/cmd/rosetta/cli.go
@@ -1,6 +1,8 @@
 package main
 
 import (
+	"math"
+
 	logger "github.com/multiversx/mx-chain-logger-go"
 	"github.com/urfave/cli"
 )
@@ -166,6 +168,13 @@ VERSION:
 		Usage:    "Specifies the configuration file for custom currencies.",
 		Required: false,
 	}
+
+	cliFlagActivationEpochSpica = cli.UintFlag{
+		Name:     "activation-epoch-spica",
+		Usage:    "Specifies the activation epoch for Spica release.",
+		Required: false,
+		Value:    math.MaxUint32,
+	}
 )
 
 func getAllCliFlags() []cli.Flag {
@@ -194,6 +203,7 @@ func getAllCliFlags() []cli.Flag {
 		cliFlagNumHistoricalEpochs,
 		cliFlagShouldHandleContracts,
 		cliFlagConfigFileCustomCurrencies,
+		cliFlagActivationEpochSpica,
 	}
 }
 
@@ -223,6 +233,7 @@ type parsedCliFlags struct {
 	numHistoricalEpochs         uint32
 	shouldHandleContracts       bool
 	configFileCustomCurrencies  string
+	activationEpochSpica        uint32
 }
 
 func getParsedCliFlags(ctx *cli.Context) parsedCliFlags {
@@ -252,5 +263,6 @@ func getParsedCliFlags(ctx *cli.Context) parsedCliFlags {
 		numHistoricalEpochs:         uint32(ctx.GlobalUint(cliFlagNumHistoricalEpochs.Name)),
 		shouldHandleContracts:       ctx.GlobalBool(cliFlagShouldHandleContracts.Name),
 		configFileCustomCurrencies:  ctx.GlobalString(cliFlagConfigFileCustomCurrencies.Name),
+		activationEpochSpica:        uint32(ctx.GlobalUint(cliFlagActivationEpochSpica.Name)),
 	}
 }
diff --git a/cmd/rosetta/main.go b/cmd/rosetta/main.go
@@ -82,6 +82,7 @@ func startRosetta(ctx *cli.Context) error {
 		FirstHistoricalEpoch:        cliFlags.firstHistoricalEpoch,
 		NumHistoricalEpochs:         cliFlags.numHistoricalEpochs,
 		ShouldHandleContracts:       cliFlags.shouldHandleContracts,
+		ActivationEpochSpica:        cliFlags.activationEpochSpica,
 	})
 	if err != nil {
 		return err

diff --git a/server/factory/interface.go b/server/factory/interface.go
@@ -35,5 +35,6 @@ type NetworkProvider interface {
 	ComputeReceiptHash(apiReceipt *transaction.ApiReceipt) (string, error)
 	ComputeTransactionFeeForMoveBalance(tx *transaction.ApiTransactionResult) *big.Int
 	GetMempoolTransactionByHash(hash string) (*transaction.ApiTransactionResult, error)
+	IsReleaseSpicaActive(epoch uint32) bool
 	LogDescription()
 }
diff --git a/server/factory/provider.go b/server/factory/provider.go
@@ -49,6 +49,7 @@ type ArgsCreateNetworkProvider struct {
 	FirstHistoricalEpoch        uint32
 	NumHistoricalEpochs         uint32
 	ShouldHandleContracts       bool
+	ActivationEpochSpica        uint32
 }
 
 // CreateNetworkProvider creates a network provider
@@ -140,6 +141,7 @@ func CreateNetworkProvider(args ArgsCreateNetworkProvider) (NetworkProvider, err
 		FirstHistoricalEpoch:        args.FirstHistoricalEpoch,
 		NumHistoricalEpochs:         args.NumHistoricalEpochs,
 		ShouldHandleContracts:       args.ShouldHandleContracts,
+		ActivationEpochSpica:        args.ActivationEpochSpica,
 
 		ObserverFacade: &components.ObserverFacade{
 			Processor:            baseProcessor,

diff --git a/server/provider/networkProvider.go b/server/provider/networkProvider.go
@@ -42,6 +42,7 @@ type ArgsNewNetworkProvider struct {
 	FirstHistoricalEpoch        uint32
 	NumHistoricalEpochs         uint32
 	ShouldHandleContracts       bool
+	ActivationEpochSpica        uint32
 
 	ObserverFacade observerFacade
 
@@ -64,6 +65,7 @@ type networkProvider struct {
 	firstHistoricalEpoch        uint32
 	numHistoricalEpochs         uint32
 	shouldHandleContracts       bool
+	activationEpochSpica        uint32
 
 	observerFacade observerFacade
 
@@ -104,6 +106,7 @@ func NewNetworkProvider(args ArgsNewNetworkProvider) (*networkProvider, error) {
 		firstHistoricalEpoch:        args.FirstHistoricalEpoch,
 		numHistoricalEpochs:         args.NumHistoricalEpochs,
 		shouldHandleContracts:       args.ShouldHandleContracts,
+		activationEpochSpica:        args.ActivationEpochSpica,
 
 		observerFacade: args.ObserverFacade,
 
@@ -413,7 +416,7 @@ func (provider *networkProvider) GetMempoolTransactionByHash(hash string) (*tran
 	return nil, nil
 }
 
-// ComputeTransactionFeeForMoveBalance computes the fee for a move-balance transaction.
+// ComputeTransactionFeeForMoveBalance computes the fee for a move-balance transaction
 func (provider *networkProvider) ComputeTransactionFeeForMoveBalance(tx *transaction.ApiTransactionResult) *big.Int {
 	minGasLimit := provider.networkConfig.MinGasLimit
 	extraGasLimitGuardedTx := provider.networkConfig.ExtraGasLimitGuardedTx
@@ -429,6 +432,11 @@ func (provider *networkProvider) ComputeTransactionFeeForMoveBalance(tx *transac
 	return fee
 }
 
+// IsReleaseSpicaActive returns whether the Spica release is active in the provided epoch
+func (provider *networkProvider) IsReleaseSpicaActive(epoch uint32) bool {
+	return epoch >= provider.activationEpochSpica
+}
+
 // LogDescription writes a description of the network provider in the log output
 func (provider *networkProvider) LogDescription() {
 	log.Info("Description of network provider",

diff --git a/server/services/constants.go b/server/services/constants.go
@@ -55,4 +55,5 @@ var (
 	numTopicsOfEventESDTNFTBurn                     = 3
 	numTopicsOfEventESDTNFTAddQuantity              = 3
 	numTopicsOfEventSCDeployBeforeSirius            = 2
+	numTopicsOfEventClaimDeveloperRewards           = 2
 )
diff --git a/server/services/interface.go b/server/services/interface.go
@@ -34,4 +34,5 @@ type NetworkProvider interface {
 	ComputeReceiptHash(apiReceipt *transaction.ApiReceipt) (string, error)
 	ComputeTransactionFeeForMoveBalance(tx *transaction.ApiTransactionResult) *big.Int
 	GetMempoolTransactionByHash(hash string) (*transaction.ApiTransactionResult, error)
+	IsReleaseSpicaActive(epoch uint32) bool
 }
diff --git a/server/services/operations.go b/server/services/operations.go
@@ -12,6 +12,7 @@ const (
 	opScResult                   = "SmartContractResult"
 	opFeeRefundAsScResult        = "FeeRefundAsSmartContractResult"
 	opDeveloperRewardsAsScResult = "DeveloperRewardsAsSmartContractResult"
+	opDeveloperRewards           = "DeveloperRewards"
 	opFeeOfInvalidTx             = "FeeOfInvalidTransaction"
 	opFeeRefund                  = "FeeRefund"
 	opCustomTransfer             = "CustomTransfer"
@@ -27,6 +28,7 @@ var (
 		opScResult,
 		opFeeRefundAsScResult,
 		opDeveloperRewardsAsScResult,
+		opDeveloperRewards,
 		opFeeOfInvalidTx,
 		opFeeRefund,
 		opCustomTransfer,

diff --git a/server/services/testdata/blocks_with_claim_developer_rewards.json b/server/services/testdata/blocks_with_claim_developer_rewards.json
@@ -0,0 +1,77 @@
+[
+    {
+        "comment": "block with claim developer rewards",
+        "miniBlocks": [
+            {
+                "transactions": [
+                    {
+                        "type": "normal",
+                        "processingTypeOnSource": "BuiltInFunctionCall",
+                        "processingTypeOnDestination": "BuiltInFunctionCall",
+                        "hash": "96b1a0533ff17df3d1777889117023d0b178cc80fa72535d1b8ec1a13bcf3a75",
+                        "epoch": 20,
+                        "value": "0",
+                        "receiver": "erd1qqqqqqqqqqqqqpgqagjekf5mxv86hy5c62vvtug5vc6jmgcsq6uq8reras",
+                        "sender": "erd1tn62hjp72rznp8vq0lplva5csav6rccpqqdungpxtqz0g2hcq6uq9k4cc6",
+                        "data": "Q2xhaW1EZXZlbG9wZXJSZXdhcmRz",
+                        "signature": "132aa54ec093c21e2d0d447bf9a9b1da5c33d4120da66fb53dbc78d1d3d007e2314fa06348302f503e96a91b697dd943189df0ad4c3750416a704de2ac007e06",
+                        "sourceShard": 0,
+                        "destinationShard": 0,
+                        "logs": {
+                            "address": "erd1qqqqqqqqqqqqqpgqagjekf5mxv86hy5c62vvtug5vc6jmgcsq6uq8reras",
+                            "events": [
+                                {
+                                    "address": "erd1qqqqqqqqqqqqqpgqagjekf5mxv86hy5c62vvtug5vc6jmgcsq6uq8reras",
+                                    "identifier": "completedTxEvent",
+                                    "topics": [
+                                        "lrGgUz/xffPRd3iJEXAj0LF4zID6clNdG47BoTvPOnU="
+                                    ],
+                                    "data": null,
+                                    "additionalData": null
+                                }
+                            ]
+                        },
+                        "operation": "ClaimDeveloperRewards",
+                        "initiallyPaidFee": "160685000000000"
+                    }
+                ]
+            },
+            {
+                "transactions": [
+                    {
+                        "type": "unsigned",
+                        "processingTypeOnSource": "MoveBalance",
+                        "processingTypeOnDestination": "MoveBalance",
+                        "hash": "d05c5f65f564d740aa1e81f7a96581d739783a43c232a6c86112afa1e6c318c4",
+                        "epoch": 20,
+                        "value": "1774725000000",
+                        "receiver": "erd1tn62hjp72rznp8vq0lplva5csav6rccpqqdungpxtqz0g2hcq6uq9k4cc6",
+                        "sender": "erd1tn62hjp72rznp8vq0lplva5csav6rccpqqdungpxtqz0g2hcq6uq9k4cc6",
+                        "previousTransactionHash": "96b1a0533ff17df3d1777889117023d0b178cc80fa72535d1b8ec1a13bcf3a75",
+                        "originalTransactionHash": "96b1a0533ff17df3d1777889117023d0b178cc80fa72535d1b8ec1a13bcf3a75",
+                        "originalSender": "erd1tn62hjp72rznp8vq0lplva5csav6rccpqqdungpxtqz0g2hcq6uq9k4cc6",
+                        "sourceShard": 0,
+                        "destinationShard": 0
+                    },
+                    {
+                        "type": "unsigned",
+                        "processingTypeOnSource": "MoveBalance",
+                        "processingTypeOnDestination": "MoveBalance",
+                        "hash": "bc89442d5e77113f0b4e7383e5d078776fc6724690ba9f98d1704202c324e090",
+                        "epoch": 20,
+                        "value": "29185000000000",
+                        "receiver": "erd1tn62hjp72rznp8vq0lplva5csav6rccpqqdungpxtqz0g2hcq6uq9k4cc6",
+                        "sender": "erd1qqqqqqqqqqqqqpgqagjekf5mxv86hy5c62vvtug5vc6jmgcsq6uq8reras",
+                        "previousTransactionHash": "96b1a0533ff17df3d1777889117023d0b178cc80fa72535d1b8ec1a13bcf3a75",
+                        "originalTransactionHash": "96b1a0533ff17df3d1777889117023d0b178cc80fa72535d1b8ec1a13bcf3a75",
+                        "sourceShard": 0,
+                        "destinationShard": 0,
+                        "nonce": 29,
+                        "data": "QDZmNmI=",
+                        "isRefund": true
+                    }
+                ]
+            }
+        ]
+    }
+]
diff --git a/server/services/transactionEventsController.go b/server/services/transactionEventsController.go
@@ -2,6 +2,7 @@ package services
 
 import (
 	"fmt"
+	"math/big"
 	"strings"
 
 	"github.com/multiversx/mx-chain-core-go/data/transaction"
@@ -263,6 +264,31 @@ func (controller *transactionEventsController) extractEventsESDTNFTAddQuantity(t
 	return typedEvents, nil
 }
 
+func (controller *transactionEventsController) extractEventsClaimDeveloperRewards(tx *transaction.ApiTransactionResult) ([]*eventClaimDeveloperRewards, error) {
+	rawEvents := controller.findManyEventsByIdentifier(tx, transactionEventClaimDeveloperRewards)
+	typedEvents := make([]*eventClaimDeveloperRewards, 0, len(rawEvents))
+
+	for _, event := range rawEvents {
+		numTopics := len(event.Topics)
+		if numTopics != numTopicsOfEventClaimDeveloperRewards {
+			return nil, fmt.Errorf("%w: bad number of topics for %s event = %d", errCannotRecognizeEvent, transactionEventClaimDeveloperRewards, numTopics)
+		}
+
+		valueBytes := event.Topics[0]
+		receiverPubkey := event.Topics[1]
+
+		value := big.NewInt(0).SetBytes(valueBytes)
+		receiver := controller.provider.ConvertPubKeyToAddress(receiverPubkey)
+
+		typedEvents = append(typedEvents, &eventClaimDeveloperRewards{
+			value:           value.String(),
+			receiverAddress: receiver,
+		})
+	}
+
+	return typedEvents, nil
+}
+
 func (controller *transactionEventsController) findManyEventsByIdentifier(tx *transaction.ApiTransactionResult, identifier string) []*transaction.Events {
 	events := make([]*transaction.Events, 0)
 

diff --git a/server/services/transactionEventsController_test.go b/server/services/transactionEventsController_test.go
@@ -281,4 +281,29 @@ func TestTransactionEventsController_ExtractEvents(t *testing.T) {
 		require.Equal(t, []byte{0x2a}, events[0].nonceAsBytes)
 		require.Equal(t, "100", events[0].value)
 	})
+
+	t.Run("ClaimDeveloperRewards", func(t *testing.T) {
+		topic0 := []byte{0x64}
+		topic1, _ := hex.DecodeString("5cf4abc83e50c5309d807fc3f676988759a1e301001bc9a0265804f42af806b8")
+
+		tx := &transaction.ApiTransactionResult{
+			Logs: &transaction.ApiLogs{
+				Events: []*transaction.Events{
+					{
+						Identifier: "ClaimDeveloperRewards",
+						Topics: [][]byte{
+							topic0,
+							topic1,
+						},
+					},
+				},
+			},
+		}
+
+		events, err := controller.extractEventsClaimDeveloperRewards(tx)
+		require.NoError(t, err)
+		require.Len(t, events, 1)
+		require.Equal(t, "100", events[0].value)
+		require.Equal(t, "erd1tn62hjp72rznp8vq0lplva5csav6rccpqqdungpxtqz0g2hcq6uq9k4cc6", events[0].receiverAddress)
+	})
 }
diff --git a/server/services/transactionsFeaturesDetector.go b/server/services/transactionsFeaturesDetector.go
@@ -1,8 +1,6 @@
 package services
 
 import (
-	"bytes"
-
 	"github.com/multiversx/mx-chain-core-go/data/transaction"
 )
 
@@ -23,23 +21,37 @@ func (detector *transactionsFeaturesDetector) doesContractResultHoldRewardsOfCla
 	contractResult *transaction.ApiTransactionResult,
 	allTransactionsInBlock []*transaction.ApiTransactionResult,
 ) bool {
-	claimDeveloperRewardsTxs := make(map[string]struct{})
+	hasData := len(contractResult.Data) > 0
+	hasNonZeroNonce := contractResult.Nonce > 0
+	if hasData || hasNonZeroNonce {
+		return false
+	}
 
 	for _, tx := range allTransactionsInBlock {
 		matchesTypeOnSource := tx.ProcessingTypeOnSource == transactionProcessingTypeBuiltInFunctionCall
+		if !matchesTypeOnSource {
+			continue
+		}
+
 		matchesTypeOnDestination := tx.ProcessingTypeOnDestination == transactionProcessingTypeBuiltInFunctionCall
-		matchesData := bytes.Equal(tx.Data, []byte(builtInFunctionClaimDeveloperRewards))
+		if !matchesTypeOnDestination {
+			continue
+		}
 
-		if matchesTypeOnSource && matchesTypeOnDestination && matchesData {
-			claimDeveloperRewardsTxs[tx.Hash] = struct{}{}
+		matchesOperation := tx.Operation == builtInFunctionClaimDeveloperRewards
+		if !matchesOperation {
+			continue
 		}
-	}
 
-	_, isResultOfClaimDeveloperRewards := claimDeveloperRewardsTxs[contractResult.OriginalTransactionHash]
-	hasNoData := len(contractResult.Data) == 0
-	hasZeroNonce := contractResult.Nonce == 0
+		matchesOriginalTransactionHash := tx.Hash == contractResult.OriginalTransactionHash
+		if !matchesOriginalTransactionHash {
+			continue
+		}
+
+		return true
+	}
 
-	return isResultOfClaimDeveloperRewards && hasNoData && hasZeroNonce
+	return false
 }
 
 // isInvalidTransactionOfTypeMoveBalanceThatOnlyConsumesDataMovementGas detects (intra-shard) invalid transactions