chainlink-sui

Chainlink Sui

• Chainlink Sui
  • Development and Contribution
    • Prerequisites
    • Developing in a stable dev environment
    • Running Tasks
  • Get something running
    • Prerequisites
    • Running Sui (Local) Dev Net
    • Deploying Sample Contracts
  • Relayer
  • Generate Documentation

Development and Contribution

Prerequisites

Nix

Install Nix using the Determinate Systems installer to get Nix with Flakes installed.

$ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install

Developing in a stable dev environment

The repository comes with a developer environment (devShell) which can be accessed by running:

$ nix develop
# to exit the shell enviroment enter "exit" in your shell

The devShell provides all the system tools and dependencies required to develop and run the project

(nix:nix-shell-env) $ go version # go version go1.23.7
(nix:nix-shell-env) $ sui version # sui 1.44.3-615516edb0ed

To make sure that your sui environment is ready, you can first check the active address using the cli

(nix:nix-shell-env) $ sui client active-address

Then you can proceed to make sure that you can the local RPC available in the list of sui cli environments

(nix:nix-shell-env) $ sui client envs

And if you don't see "local", you can add it as follows

sui client new-env --alias local --rpc http://127.0.0.1:9000
sui client switch --env local

Running Tasks

We use Task to execute development tasks. You can find every task referenced in the Taskfile

(nix:nix-shell-env) $ task lint
(nix:nix-shell-env) $ task lint:fix

Get something running

Prerequisites

• Docker
• Docker Compose
• Docker Desktop (or OrbStack)

Running Sui (Local) Dev Net

1. Run docker compose up to get the sui devnet up and running
2. You can now exec into the container by running docker compose exec -it sui bash
3. Run sui client envs to view the available sui environments

NOTE: You can view the open ports and the commands used by inspecting the /sui/docker-compose.yml file. It is a work in-progress and will likely change.

Deploying Sample Contracts

Once you have the local Sui devnet running, you can deploy the sample contracts using:

./scripts/deploy_contracts.sh

This will build and deploy the contracts in contracts/test to your local Sui network.

Relayer

For detailed documentation about using the Sui Relayer Plugin, including how to configure and use the ChainReader and ChainWriter components, see RELAYER.md.

Generate Documentation

Ensure you have docsify installed globally.

npm install -g docsify-cli

Then run the following command to serve the documentation locally.

task docs:serve