Ccip-3398 populate state initial PR #14391

AnieeG · 2024-09-10T19:04:49Z

Adds snapshot creation for a set of contracts. The state snapshot can be updated later based on what more fields are required for each one. This is just to set the standard approach to be followed for state extraction.

TokenAdminRegistry
FeeQuoter
NonceManager
Router
RMN
OnRamp

Rest of the contracts will be covered on subsequent PRs.

…develop

…t/chainlink into ccip-3398-populate-state

ogtownsend · 2024-09-11T01:33:28Z

integration-tests/deployment/ccip/state.go

@@ -219,7 +213,7 @@ func LoadChainState(chain deployment.Chain, addresses map[string]deployment.Type
 			if err != nil {
 				return state, err
 			}
-			state.RMNRemote = rmnRemote
+			state.RMNRemote = rmn1_6.New(rmnRemote)


how come rmn1_6 if this case statement is pointing to Version1_0_0?

case deployment.NewTypeAndVersion(RMNRemote, deployment.Version1_0_0...

good catch, I will update it.

@ogtownsend can you point me to the code ref ? I see that TypeAndVersion for RMN is RMNRemote 1.6.0-dev

I see what you mean, @connorwstein I think the case statement should be changed to Version1_6_0_dev, am I missing something?

yeah should be changed

connorwstein · 2024-09-13T15:04:21Z

integration-tests/deployment/ccip/view/chain.go

+)
+
+type Chain struct {
+	DestinationChainSelectors []uint64 `json:"destinationChainSelectors,omitempty"`


I worry about caching state from specific contracts at this top level - hard to follow where it comes from. Can we keep the state from each contract in the contract specific view so that its explicit?

Needed DestinationChainSelectors in OnRamp and feeQuoter as of now to populate corresponding config. Do you suggest we pass router struct in the corresponding snapshot function to retrieve the chain selectors by calling getOffRamps?

connorwstein · 2024-09-13T15:05:24Z

integration-tests/deployment/ccip/view/chain.go

+	DestinationChainSelectors []uint64 `json:"destinationChainSelectors,omitempty"`
+	// TODO - populate supportedTokensByDestination
+	SupportedTokensByDestination map[uint64][]string                `json:"supportedTokensByDestination,omitempty"`
+	TokenAdminRegistry           map[string]v1_5.TokenAdminRegistry `json:"tokenAdminRegistry,omitempty"`


interesting - I wasn't imagining we'd have multiple deployments of the same version of a contract on the same chain at any given time, but I guess its still possible so good to keep that flexibility.

connorwstein · 2024-09-13T15:06:11Z

integration-tests/deployment/ccip/view/chain.go

+	// TODO - populate supportedTokensByDestination
+	SupportedTokensByDestination map[uint64][]string                `json:"supportedTokensByDestination,omitempty"`
+	TokenAdminRegistry           map[string]v1_5.TokenAdminRegistry `json:"tokenAdminRegistry,omitempty"`
+	FeeQuoter                    map[string]v1_6.FeeQuoter          `json:"feeQuoter,omitempty"`


I think the json marshalling would still work if we kept keys as common.Address right because they have a String() method? Stronger typing there would prevent unexpected keys like "blah"

connorwstein · 2024-09-13T15:07:05Z

integration-tests/deployment/ccip/view/types/contract_state.go

@@ -0,0 +1,33 @@
+package types


idk if the types directory is helping much - think we could just have

view/chain.go view/v1_2/.. view/v1_5/...

The type directory is to avoid import cycle, We have the Contract struct getting imported into v1_2 ,v1_5 etc from parent view and then Chain struct has elements from v1_2, v1_5 in the parent view package

I see - I think it could be on the same hierarchical level though just to avoid the nesting

connorwstein · 2024-09-13T15:07:50Z

integration-tests/deployment/ccip/view/types/contract_state.go

+	Address        string `json:"address,omitempty"`
+}
+
+type ContractState interface {


unused interface?

connorwstein · 2024-09-13T15:12:09Z

integration-tests/deployment/ccip/view/types/v1_2/router.go

+	types.Contract
+	WrappedNative string            `json:"wrappedNative,omitempty"`
+	ARMProxy      string            `json:"armProxy,omitempty"`
+	OnRamps       map[uint64]string `json:"onRamps,omitempty"`  // Map of DestinationChainSelectors to OnRamp Addresses


Since the views are supposed to be human readable, I think we want to resolve the chain selectors into chain names here

Chain name derived from chain-selectors repo?

on second thought, let's think more about how to do this in a uniform way for both selectors and addresses. Can leave it like this for now

connorwstein · 2024-09-13T15:14:53Z

integration-tests/deployment/ccip/view/types/v1_5/tokenadminregistry.go

+}
+
+func TokenAdminRegistrySnapshot(taContract *token_admin_registry.TokenAdminRegistry) (TokenAdminRegistry, error) {
+	tokens, err := taContract.GetAllConfiguredTokens(nil, 0, 10)


will be an interesting problem here, there could be an unbounded number of tokens since its permissionless. We can start by just listing them all but lets add a TODO here for smarter pruning/DoS protection later.

connorwstein · 2024-09-13T15:16:38Z

integration-tests/deployment/ccip/view/types/v1_2/router.go

+		onRamps[selector] = onRamp.Hex()
+	}
+	return Router{
+		Contract: types.Contract{


Owner is a pretty widespread field we can include that in the Contract type too I think

connorwstein · 2024-09-13T15:29:13Z

integration-tests/deployment/ccip/view/types/v1_5/tokenadminregistry.go

+	if err != nil {
+		return TokenAdminRegistry{}, err
+	}
+	return TokenAdminRegistry{


we definitely want to display the registry modules too. Sadly we have to filter events for that

connorwstein · 2024-09-13T15:30:22Z

integration-tests/deployment/ccip/view/types/v1_6/feequoter.go

+	TokenDecimals   uint8  `json:"tokenDecimals,omitempty"`
+}
+
+func FeeQuoterSnapshot(fqContract *fee_quoter.FeeQuoter, tokensByDestination map[uint64][]string) (FeeQuoter, error) {


I'd prefer just only gethwrapper arguments, makes it explicit which contracts the view has dependencies on

connorwstein · 2024-09-20T19:01:31Z

integration-tests/deployment/ccip/view/types/contract_state.go

+}
+
+func NewContractMetaData(tv Meta, addr common.Address) (ContractMetaData, error) {
+	tvStr, err := tv.TypeAndVersion(nil)


these might not always exist (e.g. WETH) but we can come back to that later, can just be empty in that case

connorwstein · 2024-09-20T19:02:50Z

integration-tests/deployment/ccip/state.go

@@ -49,6 +54,63 @@ type CCIPChainState struct {
 	TestRouter *router.Router
 }

+func (c CCIPChainState) GenerateView() (view.ChainView, error) {
+	chainView := view.NewChain()
+	r := c.Router


ultranit - we can avoid these variables and just use c.Router then if c.Router != nil {c.Router.Address()}

cl-sonarqube-production · 2024-09-20T20:40:56Z

Quality Gate passed

Issues
2 New issues
4 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarQube

AnieeG added 6 commits August 22, 2024 21:50

Merge branch 'develop' of github.com:smartcontractkit/chainlink into …

df3df9d

…develop

Merge branch 'develop' of github.com:smartcontractkit/chainlink into …

9106334

…develop

Merge branch 'develop' of github.com:smartcontractkit/chainlink into …

65efde9

…develop

Merge branch 'develop' of github.com:smartcontractkit/chainlink into …

99ab4c1

…develop

initial draft

2d7dc6a

individual snapshot

e575c22

AnieeG requested a review from a team as a code owner September 10, 2024 19:04

AnieeG and others added 12 commits September 10, 2024 12:09

change interface name

8fcec56

changes

17460da

add all destchainselectors

5a8812c

rmn details

85e01a8

more changes

f133c38

omitempty

54dbed8

add onRamp reader

2ea45cc

changes

6c5abd9

Merge branch 'ccip-3398-populate-state' of github.com:smartcontractki…

a7846c4

…t/chainlink into ccip-3398-populate-state

format errors

0fa1505

add Feequoter

9e932ec

Merge branch 'ccip-3398-populate-state' of github.com:smartcontractki…

460bccb

…t/chainlink into ccip-3398-populate-state

ogtownsend reviewed Sep 11, 2024

View reviewed changes

AnieeG added 4 commits September 12, 2024 10:28

change approach direct go-binding reference

5267bc6

fix import cycle

c2dddc4

moduler

55424e8

fix panic

25c21ac

connorwstein reviewed Sep 13, 2024

View reviewed changes

AnieeG added 5 commits September 13, 2024 13:33

add interface for snapshot

1684ad4

update state generate

939b246

more changes

c7d6023

rename

53b4c40

fix lint

fe85444

connorwstein previously approved these changes Sep 20, 2024

View reviewed changes

review comments

fa3760d

AnieeG dismissed connorwstein’s stale review via fa3760d September 20, 2024 19:34

AnieeG added 2 commits September 20, 2024 12:39

more review comments

dc695c9

fix rmnremote version

9fda18b

connorwstein previously approved these changes Sep 20, 2024

View reviewed changes

AnieeG enabled auto-merge September 20, 2024 19:50

one more fix

145bf8f

AnieeG dismissed connorwstein’s stale review via 145bf8f September 20, 2024 20:01

connorwstein approved these changes Sep 20, 2024

View reviewed changes

cmalec approved these changes Sep 20, 2024

View reviewed changes

AnieeG added this pull request to the merge queue Sep 20, 2024

Merged via the queue into develop with commit 674605e Sep 20, 2024
159 checks passed

AnieeG deleted the ccip-3398-populate-state branch September 20, 2024 21:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ccip-3398 populate state initial PR #14391

Ccip-3398 populate state initial PR #14391

AnieeG commented Sep 10, 2024 •

edited

Loading

ogtownsend Sep 11, 2024

AnieeG Sep 11, 2024

AnieeG Sep 11, 2024

AnieeG Sep 11, 2024

connorwstein Sep 13, 2024

connorwstein Sep 13, 2024

AnieeG Sep 13, 2024

connorwstein Sep 13, 2024

connorwstein Sep 13, 2024

connorwstein Sep 13, 2024

AnieeG Sep 13, 2024 •

edited

Loading

connorwstein Sep 17, 2024

connorwstein Sep 13, 2024

connorwstein Sep 13, 2024

AnieeG Sep 13, 2024

connorwstein Sep 13, 2024

connorwstein Sep 13, 2024

connorwstein Sep 13, 2024

connorwstein Sep 13, 2024

connorwstein Sep 13, 2024

connorwstein Sep 20, 2024

connorwstein Sep 20, 2024

cl-sonarqube-production bot commented Sep 20, 2024

Ccip-3398 populate state initial PR #14391

Ccip-3398 populate state initial PR #14391

Conversation

AnieeG commented Sep 10, 2024 • edited Loading

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

AnieeG Sep 13, 2024 • edited Loading

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

cl-sonarqube-production bot commented Sep 20, 2024

Quality Gate passed

AnieeG commented Sep 10, 2024 •

edited

Loading

AnieeG Sep 13, 2024 •

edited

Loading