feat(monitor): add xcall loadgen to the monitor app #2723

kc1116 · 2024-12-19T21:24:40Z

This PR adds xcall load generation to the monitor app.

- implement GetPortal func on xconnector - add xcaller and config - add xcall forever

- enable xcaller in devnet1 manifest

kevinhalliday · 2024-12-23T14:48:08Z

lib/netconf/static.go

@@ -131,7 +131,7 @@ func (s Static) ConsensusRPC() string {
 	if s.Network == Devnet {
 		// First halo in devnet docker-compose.
 		// Note that it might not be running.
-		return "http://localhost:5701"
+		return "http://validator01:26657"


lib/netconf/static.go should remain external RPCs. which for devnet, are local host

with have internalEndpoints() in e2e to get endpoints from within a network (docker or gcp)

kevinhalliday · 2024-12-23T19:07:53Z

monitor/app/testdata/default_monitor.toml

 [loadgen]
 # Validator keys glob defines the validator keys to use for self-delegation.
 validator-keys-glob = "path/*/1"
+
+[xcaller]
+enabled = "false"
+
+# Chain ID pairs, where each pair specifies a 'from' and 'to' chain for sending xCalls.
+[xcaller.chainid-pairs]
+# arbitrum_one = "optimism"
+# base = "arbitrum_one"
+


xcaller is part of loadgen, so let's make it part of loadgen config

kevinhalliday · 2024-12-23T19:08:58Z

monitor/loadgen/loadgen.go

+		xCallerAddr := eoa.MustAddress(network.ID, eoa.RoleXCaller)
+		go xCallForever(ctx, xCallerAddr, period, xCallerCfg.ChainIDs, backends, connector)
+	}
+


This Start function has a lot of stuff in it now. First half about loadgening validator updates. Second part about loadgening xcalls. Maybe put both in their own function

kevinhalliday · 2024-12-23T19:21:57Z

e2e/manifests/devnet1.toml

+xcaller_enabled = true

 [node.validator01]
 [node.validator02]

 [node.fullnode01]
 mode="archive"
+
+[xcaller_chainid_pairs]
+mock_l1 = "mock_l2"
+mock_l2 = "mock_l1"


Some thoughts on config.

let's make it clear these are part of loadgen config

we use chain names, not chain ids.

do we have a reason for specifying which xcalls to to make xcalls from / to? if not, let's just do all of them. until we have a reason for more granular control

[loadgen.xcalls] enabled = true

if we do have a need to specify, I think pairs are limitting. for ex, we could not loadtest xcalls on all streams by configuring pairs (at least, not as written). What about just specifying source and destination chains with a regex

[loadgen.xcall] from = "mock_l1|mock_l2" to = "*"

corverroos · 2025-01-06T10:41:38Z

e2e/types/manifest.go

@@ -132,6 +132,12 @@ type Manifest struct {

 	// FeatureFlags defines the feature flags to enable.
 	FeatureFlags feature.Flags `toml:"feature_flags"`
+
+	// XCallerEnabled defines whether to enable the xcaller load generator for the monitor app.
+	XCallerEnabled bool `toml:"xcaller_enabled"`


lets follow the existing loadgen pattern, "Validator self-delegation" is simply enabled by presence of the key. Also, avoid complex configuration options in v1, simply hardcode the chain pairs in monitor. lessismore.

corverroos · 2025-01-06T10:44:42Z

lib/xchain/connect/connect.go

@@ -51,6 +53,21 @@ func (c Connector) Backend(chainID uint64) (*ethbackend.Backend, error) {
 	return ethbackend.NewBackend(chain.Name, chainID, chain.BlockPeriod, cl)
 }

+// GetPortal returns an OmniPortal binding for the portal at the provided address.
+func (c Connector) GetPortal(chainID uint64, backend bind.ContractBackend) (*bindings.OmniPortal, error) {


xconnector isn't used in monitor, it is only used in scripts, lets keep it that way. please remove this.

- send single xMsgs each configured period

corverroos · 2025-01-13T14:54:20Z

e2e/app/definition.go

@@ -435,7 +435,7 @@ func internalEndpoints(def Definition, nodePrefix string) xchain.RPCEndpoints {
 	endpoints[omniEVM.Chain.Name] = omniEVM.InternalRPC

 	node := nodeByPrefix(def.Testnet, nodePrefix)
-	endpoints[def.Testnet.Network.Static().OmniConsensusChain().Name] = node.AddressRPC()
+	endpoints[def.Testnet.Network.Static().OmniConsensusChain().Name] = fmt.Sprintf("http://%s", node.AddressRPC())


is this required, things work without this, lets remove is not abs required

corverroos · 2025-01-13T14:55:36Z

monitor/loadgen/loadgen.go

-func Start(ctx context.Context, network netconf.Network, ethClients map[uint64]ethclient.Client, cfg Config) error {
+// - Makes XCalls from -> to random EVM portals on periodic basis.
+func Start(ctx context.Context, network netconf.Network, ethClients map[uint64]ethclient.Client, cfg Config, rpcEndpoints xchain.RPCEndpoints) error {
+	err := startSelfDelegationLoadgen(ctx, network, ethClients, cfg)


can remove loadgen suffix since this is loadgen package

corverroos · 2025-01-13T14:57:04Z

monitor/loadgen/loadgen.go

@@ -81,3 +98,32 @@ func Start(ctx context.Context, network netconf.Network, ethClients map[uint64]e

 	return nil
 }
+
+func startXCallLoadgen(ctx context.Context, network netconf.Network, rpcEndpoints xchain.RPCEndpoints) error {
+	xCallerPK, err := eoa.PrivateKey(ctx, network.ID, eoa.RoleXCaller)


lets stick to existing pattern, see cfg.ValidatorKeysGlob. At this point, app don't need GPC perms and don't download keys, lets stick to that pattern.

can remove xcaller prefix, since we are in xcaller function.

corverroos · 2025-01-13T14:58:42Z

monitor/loadgen/loadgen.go

+func startXCallLoadgen(ctx context.Context, network netconf.Network, rpcEndpoints xchain.RPCEndpoints) error {
+	xCallerPK, err := eoa.PrivateKey(ctx, network.ID, eoa.RoleXCaller)
+	if err != nil {
+		return errors.Wrap(err, "failed to get RoleXCaller priv key exiting xcall loadgen")


simplify wrapped msgs, also, no need to add "failed" when wrapping, see Golang style guide in notion. e.g. errors.Wrap(err, "get xcaller priv key") is sufficient.

corverroos · 2025-01-13T15:01:06Z

monitor/loadgen/loadgen.go

+	var xCallPeriod = time.Hour * 2
+	if network.ID == netconf.Devnet {
+		xCallPeriod = time.Second * 30
+	}


make these package level globals, e.g. xcallPerid and xcallPeriodDevnet

corverroos · 2025-01-13T15:11:02Z

monitor/loadgen/xcall.go

+)
+
+const (
+	dead = "0x000000000000000000000000000000000000dead"


nit: deadAddr

corverroos · 2025-01-13T15:11:49Z

monitor/loadgen/xcall.go

+		return err
+	}
+
+	var data []byte


nil: nilData

corverroos · 2025-01-13T15:12:27Z

monitor/loadgen/xcall.go

+}
+
+func xCall(ctx context.Context, cfg *XCallConfig, getChainPair func() (from netconf.Chain, to netconf.Chain)) error {
+	fromChain, dstChain := getChainPair()


nit: we commonly use srcChain, not fromChain

corverroos · 2025-01-13T15:13:34Z

monitor/loadgen/xcall.go

+			"dst_chain_id", dstChain.ID,
+		)
+	}
+	log.Debug(ctx, fmt.Sprintf("xcall made %s -> %s %s", fromChain.Name, dstChain.Name, tx.Hash()))


avoid %s or %v in logging, use structured log attributes rather

corverroos · 2025-01-13T15:13:57Z

monitor/loadgen/xcall.go

+	}
+
+	txOpts.Value = fee
+	tx, err := fromPortal.Xcall(txOpts, dstChain.ID, uint8(xchain.ConfLatest), to, data, gasLimit)


you have to waitmined the tx

corverroos

LGTM

corverroos · 2025-01-14T05:34:12Z

monitor/loadgen/xcall.go

+		return err
+	}
+
+	fromPortal, err := getPortal(ctx, cfg.NetworkID, srcChain.ID, cfg.Backends)


nit: rename srcPortal

kc1116 added 5 commits December 17, 2024 18:42

xcall loadgen

b82fb5f

- implement GetPortal func on xconnector - add xcaller and config - add xcall forever

update monitor config

b239788

fix chain ids config

fa665e4

add xcaller config fields to the manifest

c6cbf4d

fix devnet rpc endpoints

f479861

- enable xcaller in devnet1 manifest

kc1116 changed the title ~~feat(monitor): Add xcall loadgen to the monitor app~~ feat(monitor): add xcall loadgen to the monitor app Dec 19, 2024

kc1116 marked this pull request as ready for review December 23, 2024 14:37

kc1116 requested review from corverroos, chmllr and kevinhalliday as code owners December 23, 2024 14:37

kevinhalliday reviewed Dec 23, 2024

View reviewed changes

corverroos requested changes Jan 6, 2025

View reviewed changes

kc1116 added 3 commits January 13, 2025 09:18

remove all configs and flags

eaa0daf

- send single xMsgs each configured period

revert unused changes

6a107b4

split self delegation and xcall loadgen into their own funcs

58dd7e6

kc1116 requested review from corverroos and kevinhalliday January 13, 2025 15:02

corverroos reviewed Jan 13, 2025

View reviewed changes

kc1116 added 12 commits January 13, 2025 11:14

remove loadgen suffix

88aaaaa

simplify error wraps

ea95891

make periods package level const

d6db3c5

dont export types by default

c14f532

avoid pointers by default

6cb7a34

simplify tick immediately

37390ed

simplify getChainPair

fb42b38

use portal.XMsgMinGasLimit

b939ced

add context to call opts

20ebdf2

rename dead -> deadAddr

3cea5d1

rename data -> nilData

970ee8f

rename fromChain -> srcChain

d78c48c

kc1116 added 4 commits January 13, 2025 11:44

use structured log attributes

21f8d15

wait for tx to be mined

2524d44

dont need http prefix in node addressRPC

b0ca8e5

use private key path instead of eoa

99ee1ff

kc1116 requested a review from corverroos January 13, 2025 19:02

corverroos approved these changes Jan 14, 2025

View reviewed changes

rename fromPortal -> srcPortal

0b76724

kc1116 merged commit 57d375d into main Jan 14, 2025
19 checks passed

kc1116 deleted the khalil/xcall-loadgen-monitor branch January 14, 2025 16:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(monitor): add xcall loadgen to the monitor app #2723

feat(monitor): add xcall loadgen to the monitor app #2723

kc1116 commented Dec 19, 2024

kevinhalliday Dec 23, 2024

kevinhalliday Dec 23, 2024

kevinhalliday Dec 23, 2024

kc1116 Jan 13, 2025

kevinhalliday Dec 23, 2024

corverroos Jan 6, 2025

corverroos Jan 6, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos Jan 13, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos Jan 13, 2025

kc1116 Jan 13, 2025

corverroos left a comment

corverroos Jan 14, 2025

kc1116 Jan 14, 2025

feat(monitor): add xcall loadgen to the monitor app #2723

feat(monitor): add xcall loadgen to the monitor app #2723

Conversation

kc1116 commented Dec 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

corverroos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment