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.

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

New CLI flag: --handle-contracts. Minor refactoring. #89

Merged
merged 2 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
17 changes: 17 additions & 0 deletions cmd/rosetta/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -156,11 +156,22 @@ VERSION:
Required: true,
}

cliFlagShouldHandleContracts = cli.BoolFlag{
Name: "handle-contracts",
Usage: "Whether to handle balance changes of smart contracts or not.",
}

cliFlagConfigFileCustomCurrencies = cli.StringFlag{
Name: "config-custom-currencies",
Usage: "Specifies the configuration file for custom currencies.",
Required: false,
}

cliFlagConfigFileNodeFeatures = cli.StringFlag{
Name: "config-node-features",
Usage: "Specifies the configuration file for features activation on Node's side.",
Required: false,
}
)

func getAllCliFlags() []cli.Flag {
Expand All @@ -187,7 +198,9 @@ func getAllCliFlags() []cli.Flag {
cliFlagNativeCurrencySymbol,
cliFlagFirstHistoricalEpoch,
cliFlagNumHistoricalEpochs,
cliFlagShouldHandleContracts,
cliFlagConfigFileCustomCurrencies,
cliFlagConfigFileNodeFeatures,
}
}

Expand Down Expand Up @@ -215,7 +228,9 @@ type parsedCliFlags struct {
nativeCurrencySymbol string
firstHistoricalEpoch uint32
numHistoricalEpochs uint32
shouldHandleContracts bool
configFileCustomCurrencies string
configFileNodeFeatures string
}

func getParsedCliFlags(ctx *cli.Context) parsedCliFlags {
Expand Down Expand Up @@ -243,6 +258,8 @@ func getParsedCliFlags(ctx *cli.Context) parsedCliFlags {
nativeCurrencySymbol: ctx.GlobalString(cliFlagNativeCurrencySymbol.Name),
firstHistoricalEpoch: uint32(ctx.GlobalUint(cliFlagFirstHistoricalEpoch.Name)),
numHistoricalEpochs: uint32(ctx.GlobalUint(cliFlagNumHistoricalEpochs.Name)),
shouldHandleContracts: ctx.GlobalBool(cliFlagShouldHandleContracts.Name),
configFileCustomCurrencies: ctx.GlobalString(cliFlagConfigFileCustomCurrencies.Name),
configFileNodeFeatures: ctx.GlobalString(cliFlagConfigFileNodeFeatures.Name),
}
}
1 change: 1 addition & 0 deletions cmd/rosetta/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ func startRosetta(ctx *cli.Context) error {
GenesisBlockHash: cliFlags.genesisBlock,
FirstHistoricalEpoch: cliFlags.firstHistoricalEpoch,
NumHistoricalEpochs: cliFlags.numHistoricalEpochs,
ShouldHandleContracts: cliFlags.shouldHandleContracts,
})
if err != nil {
return err
Expand Down
2 changes: 2 additions & 0 deletions server/factory/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ type ArgsCreateNetworkProvider struct {
GenesisTimestamp int64
FirstHistoricalEpoch uint32
NumHistoricalEpochs uint32
ShouldHandleContracts bool
}

// CreateNetworkProvider creates a network provider
Expand Down Expand Up @@ -138,6 +139,7 @@ func CreateNetworkProvider(args ArgsCreateNetworkProvider) (NetworkProvider, err
GenesisTimestamp: args.GenesisTimestamp,
FirstHistoricalEpoch: args.FirstHistoricalEpoch,
NumHistoricalEpochs: args.NumHistoricalEpochs,
ShouldHandleContracts: args.ShouldHandleContracts,

ObserverFacade: &components.ObserverFacade{
Processor: baseProcessor,
Expand Down
16 changes: 10 additions & 6 deletions server/provider/networkProvider.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ type ArgsNewNetworkProvider struct {
GenesisTimestamp int64
FirstHistoricalEpoch uint32
NumHistoricalEpochs uint32
ShouldHandleContracts bool

ObserverFacade observerFacade

Expand All @@ -62,6 +63,7 @@ type networkProvider struct {
genesisTimestamp int64
firstHistoricalEpoch uint32
numHistoricalEpochs uint32
shouldHandleContracts bool

observerFacade observerFacade

Expand Down Expand Up @@ -101,6 +103,7 @@ func NewNetworkProvider(args ArgsNewNetworkProvider) (*networkProvider, error) {
genesisTimestamp: args.GenesisTimestamp,
firstHistoricalEpoch: args.FirstHistoricalEpoch,
numHistoricalEpochs: args.NumHistoricalEpochs,
shouldHandleContracts: args.ShouldHandleContracts,

observerFacade: args.ObserverFacade,

Expand Down Expand Up @@ -312,14 +315,15 @@ func (provider *networkProvider) IsAddressObserved(address string) (bool, error)
}

shard := provider.observerFacade.ComputeShardId(pubKey)
isObservedActualShard := shard == provider.observedActualShard
isObservedProjectedShard := pubKey[len(pubKey)-1] == byte(provider.observedProjectedShard)

if provider.observedProjectedShardIsSet {
return isObservedProjectedShard, nil
}
noConstraintAboutProjectedShard := !provider.observedProjectedShardIsSet
noConstraintAboutHandlingContracts := provider.shouldHandleContracts
Comment on lines +319 to +320
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some "aliases", for more explicit code.


passesConstraintAboutObservedActualShard := shard == provider.observedActualShard
passesConstraintAboutObservedProjectedShard := noConstraintAboutProjectedShard || pubKey[len(pubKey)-1] == byte(provider.observedProjectedShard)
passesConstraintAboutHandlingContracts := noConstraintAboutHandlingContracts || !core.IsSmartContractAddress(pubKey)

return isObservedActualShard, nil
return passesConstraintAboutObservedActualShard && passesConstraintAboutObservedProjectedShard && passesConstraintAboutHandlingContracts, nil
}

// ComputeShardIdOfPubKey computes the shard ID of a public key
Expand Down
94 changes: 94 additions & 0 deletions server/provider/networkProvider_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ func TestNewNetworkProvider(t *testing.T) {
GenesisTimestamp: 123456789,
FirstHistoricalEpoch: 1000,
NumHistoricalEpochs: 1024,
ShouldHandleContracts: true,
ObserverFacade: testscommon.NewObserverFacadeMock(),
Hasher: testscommon.RealWorldBlake2bHasher,
MarshalizerForHashing: testscommon.MarshalizerForHashing,
Expand Down Expand Up @@ -71,6 +72,7 @@ func TestNewNetworkProvider(t *testing.T) {
assert.Equal(t, int64(123456789), provider.GetGenesisTimestamp())
assert.Equal(t, uint32(1000), provider.firstHistoricalEpoch)
assert.Equal(t, uint32(1024), provider.numHistoricalEpochs)
assert.Equal(t, true, provider.shouldHandleContracts)
}

func TestNetworkProvider_DoGetBlockByNonce(t *testing.T) {
Expand Down Expand Up @@ -236,6 +238,98 @@ func Test_ComputeTransactionFeeForMoveBalance(t *testing.T) {
})
}

func TestNetworkProvider_IsAddressObserved(t *testing.T) {
t.Run("no projected shard, do not handle contracts", func(t *testing.T) {
args := createDefaultArgsNewNetworkProvider()
args.ObservedActualShard = 0
args.ShouldHandleContracts = false

provider, err := NewNetworkProvider(args)
require.Nil(t, err)
require.NotNil(t, provider)

isObserved, err := provider.IsAddressObserved("erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th")
require.NoError(t, err)
require.False(t, isObserved)

isObserved, err = provider.IsAddressObserved("erd1spyavw0956vq68xj8y4tenjpq2wd5a9p2c6j8gsz7ztyrnpxrruqzu66jx")
require.NoError(t, err)
require.True(t, isObserved)

isObserved, err = provider.IsAddressObserved("erd1k2s324ww2g0yj38qn2ch2jwctdy8mnfxep94q9arncc6xecg3xaq6mjse8")
require.NoError(t, err)
require.False(t, isObserved)

isObserved, err = provider.IsAddressObserved("erd1qqqqqqqqqqqqqpgqws44xjx2t056nn79fn29q0rjwfrd3m43396ql35kxy")
require.NoError(t, err)
require.False(t, isObserved)
})

t.Run("with projected shard, do not handle contracts", func(t *testing.T) {
args := createDefaultArgsNewNetworkProvider()
args.ObservedActualShard = 0
args.ObservedProjectedShard = 0
args.ObservedProjectedShardIsSet = true
args.ShouldHandleContracts = false

provider, err := NewNetworkProvider(args)
require.Nil(t, err)
require.NotNil(t, provider)

isObserved, err := provider.IsAddressObserved("erd1ldjsdetjvegjdnda0qw2h62kq6rpvrklkc5pw9zxm0nwulfhtyqqtyc4vq")
require.NoError(t, err)
require.True(t, isObserved)

isObserved, err = provider.IsAddressObserved("erd1spyavw0956vq68xj8y4tenjpq2wd5a9p2c6j8gsz7ztyrnpxrruqzu66jx")
require.NoError(t, err)
require.False(t, isObserved)

isObserved, err = provider.IsAddressObserved("erd1qqqqqqqqqqqqqpgqws44xjx2t056nn79fn29q0rjwfrd3m43396ql35kxy")
require.NoError(t, err)
require.False(t, isObserved)
})

t.Run("no projected shard, handle contracts", func(t *testing.T) {
args := createDefaultArgsNewNetworkProvider()
args.ObservedActualShard = 0
args.ShouldHandleContracts = true

provider, err := NewNetworkProvider(args)
require.Nil(t, err)
require.NotNil(t, provider)

isObserved, err := provider.IsAddressObserved("erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th")
require.NoError(t, err)
require.False(t, isObserved)

isObserved, err = provider.IsAddressObserved("erd1spyavw0956vq68xj8y4tenjpq2wd5a9p2c6j8gsz7ztyrnpxrruqzu66jx")
require.NoError(t, err)
require.True(t, isObserved)

isObserved, err = provider.IsAddressObserved("erd1k2s324ww2g0yj38qn2ch2jwctdy8mnfxep94q9arncc6xecg3xaq6mjse8")
require.NoError(t, err)
require.False(t, isObserved)

isObserved, err = provider.IsAddressObserved("erd1qqqqqqqqqqqqqpgqws44xjx2t056nn79fn29q0rjwfrd3m43396ql35kxy")
require.NoError(t, err)
require.True(t, isObserved)
})

t.Run("with error", func(t *testing.T) {
args := createDefaultArgsNewNetworkProvider()
args.ObservedActualShard = 0
args.ShouldHandleContracts = true

provider, err := NewNetworkProvider(args)
require.Nil(t, err)
require.NotNil(t, provider)

isObserved, err := provider.IsAddressObserved("erd1test")
require.Error(t, err)
require.False(t, isObserved)
})
}

func createDefaultArgsNewNetworkProvider() ArgsNewNetworkProvider {
return ArgsNewNetworkProvider{
IsOffline: false,
Expand Down
2 changes: 1 addition & 1 deletion server/services/blockService.go
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ func (service *blockService) createGenesisOperations(balances []*resources.Genes
operations = append(operations, operation)
}

operations, err := filterOperationsByAddress(operations, service.extension.isAddressObserved)
operations, err := filterOperationsByAddress(operations, service.provider.IsAddressObserved)
if err != nil {
return nil, err
}
Expand Down
18 changes: 6 additions & 12 deletions server/services/networkProviderExtension.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,16 @@ func (extension *networkProviderExtension) getGenesisBlockIdentifier() *types.Bl
return blockSummaryToIdentifier(summary)
}

func (extension *networkProviderExtension) isAddressObserved(address string) (bool, error) {
belongsToObservedShard, err := extension.provider.IsAddressObserved(address)
if err != nil {
return false, err
}

isUserAddress := extension.isUserAddress(address)
return belongsToObservedShard && isUserAddress, nil
}

func (extension *networkProviderExtension) isUserAddress(address string) bool {
pubkey, err := extension.provider.ConvertAddressToPubKey(address)
pubKey, err := extension.provider.ConvertAddressToPubKey(address)
if err != nil {
// E.g., when address = "metachain"
return false
}

return !core.IsSmartContractAddress(pubkey)
return extension.isUserPubKey(pubKey)
}

func (extension *networkProviderExtension) isUserPubKey(pubKey []byte) bool {
return !core.IsSmartContractAddress(pubKey)
}
2 changes: 1 addition & 1 deletion server/services/transactionsTransformer.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ func (transformer *transactionsTransformer) transformBlockTxs(block *api.Block)
}

for _, rosettaTx := range rosettaTxs {
filteredOperations, err := filterOperationsByAddress(rosettaTx.Operations, transformer.extension.isAddressObserved)
filteredOperations, err := filterOperationsByAddress(rosettaTx.Operations, transformer.provider.IsAddressObserved)
if err != nil {
return nil, err
}
Expand Down
3 changes: 2 additions & 1 deletion systemtests/proxyToObserverAdapter.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ func startAdapter(ctx *cli.Context) error {
sleepDuration: ctx.GlobalUint(cliFlagSleep.Name),
}

router := gin.Default()
router := gin.New()
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor optimization within system tests.

router.Use(gin.Recovery())
router.GET("/node/status", adapter.getNodeStatus)
router.GET("/node/epoch-start/:epoch", adapter.getEpochStart)
router.GET("/block/by-nonce/:nonce", adapter.getBlockByNonce)
Expand Down
Loading