chainlink-stellar

Chainlink CCIP Stellar

Tooling Commands

Build contracts

stellar contract build

Generate Contract Interfaces

make generate-interfaces

Note: This command also builds the contracts.

⚠️ Because interfaces are also used within contracts as a crate, it is required that it can compile.

Generate Bindings

make generate-bindings

Note: This command also builds the contracts and generates interfaces. It then uses the interfaces to generate the Go bindings.

DevEnv Overview

sequenceDiagram
    participant Chain Integration as Developer
    participant CLI as ccv up (devenv CLI)
    participant Docker as Docker Containers
    participant Out as Output TOML
    participant Test as E2E Tests

    Dev->>CLI: CTF_CONFIGS=tests/env/env-{chain}.toml
    CLI->>CLI: Load[Cfg](configs) -- parse + merge TOML
    CLI->>Docker: Deploy blockchains (Anvil, {chain} node)
    CLI->>Docker: Deploy contracts (via CCIP17Configuration)
    CLI->>Docker: Launch services (verifier, aggregator, indexer, executor)
    CLI->>Out: Store() -- write env-{chain}-out.toml
    Note over Out: Contains deployed addresses,<br/>RPC URLs, service endpoints,<br/>CLDF datastore

    Test->>Out: LoadOutput[Cfg](path) -- read + hydrate DataStore
    Test->>Test: NewLib(logger, path, families...)
    Test->>Test: lib.Chains(ctx) -- ImplFactory.New() per family
    Test->>Test: SendMessage(), assert events, etc.

Running Tests

Integration Tests

❕ Make sure the contracts are built and Go bindings are generated before running the tests. Running make generate-bindings is sufficient to have the pre-requisites necessary.

To run all integration tests, use the following command from the base directory:

go test ./tests/integration/... -v -tags=integration -count=1 -p=1 -timeout=15m

To run a specific integration test, use the -run flag instead of specifying the file directly:

go test ./tests/integration/... -v -tags=integration -count=1 -p=1 -timeout=15m -run TestRmnRemote

Note: This is required to make sure that a single test env setup is done when running multiple tests. This approach speeds up the spin up time to avoid having each test suite wait for 120-150 seconds for the local Stellar node to be ready.

Contract Tests

To run the tests written in Rust (found in various test.rs files within /contracts), run the following command:

cargo test

To run a specific crate's tests, use the -p flag to specify the package:

cargo test -p ccvs-committee-verifier

E2E Tests

❕ Make sure you have the environment (docker containers) already running including the necessary Verifier container which is specified in the topology TOML file. To read more on setting up the E2E testing environment, see the E2E setup guide document.

Use the make command / alias to spin up the environment

make up

This command is current an alias for go run ./tests/testutils/cmd/devenv up tests/env/env-stellar-evm.toml.

This will run the CCV CLI's up command and point the the default network topology TOML file. It will also generate (or overwrite) an out toplogy file (usually named $TOPLOGY_FILE_NAME-out.toml where $TOPLOGY_FILE_NAME is the file that was used as input for the up command).

Running the E2E tests is now as simple running regular Go tets with go test -v -timeout 15m ./tests/e2e/...