plugin-ccip

This repo contains OCR3 plugins for CCIP. See the documentation for more.

Getting Started

Go Version

The version of go is specified in the project's go.mod file. You can install Go from their installation page.

Running the Linter

We use golangci-lint as our linting tool. Run the linter like this:

make lint

Running the Unit Tests

make test

Generating the Mocks

We use mockery to generate mocks and they're organized in the mockery.yaml file.

make generate

Development Cycle

In order to keep the ccip-develop branch in working condition, we need to make sure the integration test written in the CCIP repo will pass.

As such, part of CI will run this integration test combined with your latest pushed change.

Follow the steps below to ensure that we don't run into any unexpected breakages.

1. Create a PR on plugin-ccip with the changes you want to make.
2. CI will run the integration test in the CCIP repo after applying your changes.
3. If the integration test fails, make sure to fix it first before merging your changes into the ccip-develop branch of plugin-ccip. You can do this by:
   • Creating a branch in the CCIP repo and running go get github.com/goplugin/plugin-ccip@<your-branch-commit-sha>.
   • Fixing the build/tests.
4. Once your ccip PR is approved, merge it.
5. Go back to your plugin-ccip PR and re-run the integration test workflow.
6. Once the integration test passes, merge your plugin-ccip PR into ccip-develop, however do not delete the branch on the remote.
7. Create a new PR in ccip that points to the newly merged commit in the ccip-develop tree and merge that.