CCIP - add price reader interfaces to ChainAccessor and move some generic types, clean others up by ogtownsend · Pull Request #1487 · smartcontractkit/chainlink-common

ogtownsend · 2025-08-19T00:18:15Z

The last remaining components to be migrated off of ChainReader and to ChainAccessor that will be required by Solana and TON are PriceReader and USDCReader.

Note: these are not required for the TON2EVM E2E test, but will be needed for future TON milestones and for LOOPPed Solana.

This PR:

Adds the USDCMessageReader and PriceReader interfaces to the ChainAccessor interface
Adds their protobuf definitions
Adds their gRPC wrapper conversion logic
Moves a few types from pkg/types/ccipocr3/chainaccessor.go to a better home
GetLatestPriceSeqNr(ctx context.Context) (uint64, error) uses uint64 as the return value but other code paths use ccipocr3.SeqNum, update to ccipocr3.SeqNum
Updates GetChainFeePriceUpdate to return an error
GetTokenPriceUSD returns a ccipocr3.TimestampedUnixBig, but GetChainFeePriceUpdate returns a map[ccipocr3.ChainSelector]ccipocr3.TimestampedBig, prefer to use TimestampedUnixBig
Adds persistence for chain accessor Sync() calls inside the grpc client and server impls

Corresponding cl-ccip PR: smartcontractkit/chainlink-ccip#1175

ogtownsend · 2025-08-19T04:34:10Z

-	resp[contract][chain] = address
-	return resp
-}
+type PriceReader interface {


This will replace chainlink-ccip/pkg/reader/price_reader.go

ogtownsend · 2025-08-19T04:34:52Z

+// USDCMessageReader retrieves each of the CCTPv1 MessageSent event created
+// when a ccipSend is made with USDC token transfer. The events are created
+// when the USDC Token pool calls the 3rd party MessageTransmitter contract.
+type USDCMessageReader interface {


This will replace chainlink-ccip/pkg/reader/usdc_reader.go for solana and EVM

github-actions · 2025-09-04T18:09:32Z

apidiff results - backwards-incompatible changes detected ❌

Module: `github-com-smartcontractkit-chainlink-common`

Status: ❌ 10 incompatible, 5 compatible

Incompatible Changes (10)

Element	Change
`./pkg/types/ccipocr3.DestinationAccessor.GetChainFeePriceUpdate`	changed from `func(context.Context, []ChainSelector) map[ChainSelector]TimestampedBig` to `func(context.Context, []ChainSelector) (map[ChainSelector]TimestampedUnixBig, error)`
`./pkg/types/ccipocr3.DestinationAccessor.GetLatestPriceSeqNr`	changed from `func(context.Context) (uint64, error)` to `func(context.Context) (SeqNum, error)`
`./pkg/types/ccipocr3.NewTimestampedBig`	changed from `func(int64, time.Time) TimestampedBig` to `func(int64, time.Time) TimestampedBig`
`./pkg/types/ccipocr3.PriceReader.GetFeedPricesUSD`	added
`./pkg/types/ccipocr3.PriceReader.GetFeeQuoterTokenUpdates`	added
`./pkg/types/ccipocr3.TimestampedBig`	changed from `TimestampedBig` to `TimestampedBig`
`./pkg/types/ccipocr3.TimestampedBig.Timestamp`	changed from `time.Time` to `uint32`
`./pkg/types/ccipocr3.TimestampedBig.Value`	changed from `BigInt` to `*math/big.Int`
`./pkg/types/ccipocr3.TimeStampedBigFromUnix`	changed from `func(TimestampedUnixBig) TimestampedBig` to `func(TimestampedUnixBig) TimestampedBig`
`./pkg/types/ccipocr3.USDCMessageReader.MessagesByTokenID`	added

(Full summary: https://github.com/smartcontractkit/chainlink-common/actions/runs/17624183574/#summary-50076828284)

ogtownsend · 2025-09-09T15:55:31Z

+		var pbSyncs []*pb.SyncRequest
+		for _, s := range persistedSyncs {
+			pbSyncs = append(pbSyncs, &pb.SyncRequest{
+				ContractName:    s.ContractName,
+				ContractAddress: s.ContractAddress,
+			})
+		}


I ran into protoc gen madness trying to reuse the chain accessor pb.SyncRequest, the import "models.proto"; in chainlink-common/pkg/loop/internal/pb/ccipocr3/chainaccessor.proto caused several build issues when trying to import SyncRequest into relayer.proto

ogtownsend · 2025-09-09T18:28:25Z

+	// If grpc call succeeded, store the sync request contents so we can re-populate them if the relayer restarts.
+	if err != nil {
+		c.mu.Lock()
+		c.syncs = append(c.syncs, req) // TODO: maybe dedupe these if needed


Sync() is called many times, this will grow very quickly, should likely change to a map

ogtownsend · 2025-09-10T14:04:27Z

👋 @archseer @winder @jmank88 , can I get some eyes on this PR please?

…eric types

ogtownsend had a problem deploying to integration August 19, 2025 00:18 — with GitHub Actions Failure

ogtownsend commented Aug 19, 2025

View reviewed changes

ogtownsend force-pushed the ogt/chain-accessor-add-price-reader-interfaces branch from 0f74219 to c8b62ee Compare August 19, 2025 04:36

ogtownsend had a problem deploying to integration August 19, 2025 04:36 — with GitHub Actions Failure

ogtownsend force-pushed the ogt/chain-accessor-add-price-reader-interfaces branch from c8b62ee to c33e090 Compare August 19, 2025 17:00

ogtownsend had a problem deploying to integration August 19, 2025 17:01 — with GitHub Actions Failure

ogtownsend force-pushed the ogt/chain-accessor-add-price-reader-interfaces branch from c33e090 to 52d976b Compare September 4, 2025 18:08

ogtownsend had a problem deploying to integration September 4, 2025 18:08 — with GitHub Actions Failure

ogtownsend temporarily deployed to integration September 4, 2025 18:08 — with GitHub Actions Inactive

ogtownsend had a problem deploying to integration September 4, 2025 18:08 — with GitHub Actions Failure

ogtownsend changed the title ~~CCIP - add price reader interfaces to ChainAccessor and move some generic types~~ CCIP - add price reader interfaces to ChainAccessor and move some generic types, clean others up Sep 4, 2025

ogtownsend force-pushed the ogt/chain-accessor-add-price-reader-interfaces branch from 52d976b to dedf05b Compare September 4, 2025 18:28

ogtownsend marked this pull request as ready for review September 4, 2025 18:28

ogtownsend requested review from a team as code owners September 4, 2025 18:28

ogtownsend requested review from 0xAustinWang, KodeyThomas, asoliman92, makramkd, mateusz-sekara and winder September 4, 2025 18:28

ogtownsend force-pushed the ogt/chain-accessor-add-price-reader-interfaces branch from fd62697 to 5abe799 Compare September 9, 2025 15:44

ogtownsend had a problem deploying to integration September 9, 2025 15:44 — with GitHub Actions Error

ogtownsend force-pushed the ogt/chain-accessor-add-price-reader-interfaces branch from 5abe799 to 6f15e13 Compare September 9, 2025 15:45

ogtownsend had a problem deploying to integration September 9, 2025 15:46 — with GitHub Actions Failure

ogtownsend temporarily deployed to integration September 9, 2025 15:46 — with GitHub Actions Inactive

ogtownsend had a problem deploying to integration September 9, 2025 15:46 — with GitHub Actions Failure

ogtownsend commented Sep 9, 2025

View reviewed changes

jmank88 reviewed Sep 10, 2025

View reviewed changes

Comment thread pkg/loop/internal/relayer/pluginprovider/ext/ccipocr3/chainaccessor.go Outdated

archseer reviewed Sep 10, 2025

View reviewed changes

Comment thread pkg/loop/internal/relayer/pluginprovider/ext/ccipocr3/chainaccessor.go Outdated

archseer previously approved these changes Sep 10, 2025

View reviewed changes

jmank88 reviewed Sep 10, 2025

View reviewed changes

Comment thread pkg/loop/internal/relayer/relayer.go Outdated

jmank88 previously approved these changes Sep 10, 2025

View reviewed changes

ogtownsend added 10 commits September 10, 2025 16:05

CCIP - add price reader interfaces to ChainAccessor and move some gen…

6bf184c

…eric types

update a few more functions

1cca0c5

use TimestampedUnixBig instead of TimestampedBig

b4de7ac

preserve zeros when converting between PB types

2c4cac5

move TokenInfo to cl-common and add to GetFeedPricesUSD args

11fbd86

resync accessor sync calls on relayer restart

3d3b353

nits

3cf6b14

change persisted sync storage to a map[] instead of SyncRequest

bce1d57

use maps.Clone

db2e3c8

move persisted syncs conversion to ccipprovider

104a3a4

archseer approved these changes Sep 10, 2025

View reviewed changes

jmank88 approved these changes Sep 10, 2025

View reviewed changes

agusaldasoro approved these changes Sep 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CCIP - add price reader interfaces to ChainAccessor and move some generic types, clean others up#1487

CCIP - add price reader interfaces to ChainAccessor and move some generic types, clean others up#1487
archseer merged 10 commits intomainfrom
ogt/chain-accessor-add-price-reader-interfaces

ogtownsend commented Aug 19, 2025 •

edited

Loading

Uh oh!

ogtownsend Aug 19, 2025

Uh oh!

ogtownsend Aug 19, 2025

Uh oh!

github-actions Bot commented Sep 4, 2025 •

edited

Loading

Uh oh!

ogtownsend Sep 9, 2025

Uh oh!

ogtownsend Sep 9, 2025

Uh oh!

ogtownsend commented Sep 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

ogtownsend commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ogtownsend Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

ogtownsend Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

apidiff results - backwards-incompatible changes detected ❌

Module: github-com-smartcontractkit-chainlink-common

Incompatible Changes (10)

Uh oh!

ogtownsend Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

ogtownsend Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

ogtownsend commented Sep 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ogtownsend commented Aug 19, 2025 •

edited

Loading

github-actions Bot commented Sep 4, 2025 •

edited

Loading

Module: `github-com-smartcontractkit-chainlink-common`