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

Feat/productionize examples #1035

Closed
wants to merge 107 commits into from
Closed

Conversation

jhweintraub
Copy link
Contributor

@jhweintraub jhweintraub commented Jun 17, 2024

Motivation

To help end users implement CCIP, we need canonical code that

  1. contains Chainlink’s opinion on best practices,
  2. Are a “kernel” that can be used by other Chainlink teams as part of their artifact creation in other types of educational and reference material (eg workshops, masterclasses, bootcamps, hackathons, starter kits, quick start etc)
  3. external CCIP users can use and be assured of reliability and security,
  4. external CCIP users can rely on if they go to mainnet

Solution

The examples and reference contracts have been refactored to better reflect these principles and simplify the process of building CCIP-compliant examples.

The following contracts have been created

  1. CCIPReceiver - A basic implementation of a contract capable of receiving incoming messages from CCIP. It includes various defensive security measures such as chain & sender validation, token recovery, and manual message re-execution.
  2. CCIPSender - An example of what a contract which sends arbitrary messages from external users looks like and how different CCIPSend message parameters can be configured and utilized.
  3. CCIPReceiverWithACK - An extension of CCIPReceiver whereby an incoming message is processed, and then a secondary message is sent back through the bridge to the sender, acknowledging that the original message was processed correctly.
  4. CCIPClient - A contract which implements both the sender and receiver functionality of the other two client types.

There are also various other contracts

  1. CCIPBase - An abstract parent contract which includes management functionality such as chain validation and Ownership functions.
  2. PingPongDemo.sol - An updated version of the Ping Pong example currently on the developer docs, but updated to use the defensive design patterns of CCIPReceiver.

Copy link
Contributor

Go solidity wrappers are out-of-date, regenerate them via the make wrappers-all command

Copy link
Contributor

Go solidity wrappers are out-of-date, regenerate them via the make wrappers-all command

@jhweintraub jhweintraub requested a review from a team as a code owner June 28, 2024 15:32
@cl-sonarqube-production
Copy link

@cl-sonarqube-production
Copy link

Copy link
Contributor

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@github-actions github-actions bot added the Stale label Oct 25, 2024
Copy link
Contributor

github-actions bot commented Nov 4, 2024

This PR was closed because it has been stalled for 10 days with no activity.

@github-actions github-actions bot closed this Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants