Skip to content

Updated CCIP provider args and types#1561

Merged
winder merged 7 commits intomainfrom
feature/update-ccip-provider-args-and-types
Sep 24, 2025
Merged

Updated CCIP provider args and types#1561
winder merged 7 commits intomainfrom
feature/update-ccip-provider-args-and-types

Conversation

@amit-momin
Copy link
Copy Markdown
Contributor

No description provided.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Sep 24, 2025

apidiff results - backwards-incompatible changes detected ❌

Module: github-com-smartcontractkit-chainlink-common

Status: ❌ 2 incompatible, 5 compatible

Incompatible Changes (2)

Element Change
./pkg/types.CCIPProviderArgs.OffRampAddress changed from string to github.com/smartcontractkit/chainlink-common/pkg/types/ccipocr3.UnknownAddress
./pkg/types.CCIPProviderArgs.PluginType changed from uint32 to github.com/smartcontractkit/chainlink-common/pkg/types/ccipocr3.PluginType

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

Comment thread pkg/loop/internal/pb/relayer.proto Outdated
// pluginType is actually a uint8 but uint32 is the smallest supported by protobuf
uint32 pluginType = 5;
map<string, bytes> synced_addresses = 6; // map[contract_name]contract_address
string transmitter = 7;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: could we name this TransmitterAddress or TransmitterAddrString to make it clear what it is

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated in the latest commit. Went with TransmitterAddress

Comment on lines +63 to +67
bytes offRampAddress = 4;
// pluginType is actually a uint8 but uint32 is the smallest supported by protobuf
uint32 pluginType = 5;
map<string, bytes> synced_addresses = 6; // map[contract_name]contract_address
string transmitterAddress = 7;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

you had mentioned bytes offRampAddress is easier to manage if it's passed in as bytes, does the same apply for transmitterAddress?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Keeping transmitter as a string is ok since we don't have to decode it. It's just used to serve as a string out of the transmitter here

Comment thread pkg/loop/internal/relayer/relayer.go Outdated
OffRampAddress: rargs.OffRampAddress,
PluginType: rargs.PluginType,
PluginType: ccipocr3types.PluginType(rargs.PluginType),
Transmitter: rargs.Transmitter,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

TransmitterAddress

pluginType uint32
offRampAddress ccipocr3.UnknownAddress
pluginType ccipocr3.PluginType
transmitter string
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same

Comment thread pkg/types/provider_ccip.go Outdated
ExternalJobID uuid.UUID
OffRampAddress ccipocr3.UnknownAddress
PluginType ccipocr3.PluginType
TransmitterAddress string
Copy link
Copy Markdown
Contributor

@ogtownsend ogtownsend Sep 24, 2025

Choose a reason for hiding this comment

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

similar to above, could we make this ccipocr3.UnknownAddress for consistency, or does that introduce codec complications

@ogtownsend ogtownsend requested a review from archseer September 24, 2025 19:28
ogtownsend
ogtownsend previously approved these changes Sep 24, 2025
@ogtownsend ogtownsend requested a review from jmank88 September 24, 2025 20:19
@ogtownsend
Copy link
Copy Markdown
Contributor

@jmank88 or @winder do you have permission to merge this? 🙏

@winder winder merged commit 853372a into main Sep 24, 2025
19 of 22 checks passed
@winder winder deleted the feature/update-ccip-provider-args-and-types branch September 24, 2025 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants