Skip to content

Latest commit

 

History

History
122 lines (78 loc) · 3.71 KB

NOTES.md

File metadata and controls

122 lines (78 loc) · 3.71 KB

Developer enviroment

Aptos scripts require go, docker, geth, aptos, jq, and curl .

Enter the developer enviroment using Nix:

nix develop

macOS

Notice:

  • Aptos CLI is currently excluded from the Nix devshell for Mac (needs to get packaged), alternatively install manually via homebrew.
  • Docker emulation via Rosetta might not work (e.g., "Illegal instruction" error for Aptos node container), alternatively use default (slower) QEMU emulation by disabling the "Use Rosetta for x86_64/amd64 emulation on Apple Silicon" Docker config.

Getting started - local setup

Create a shared network for the containers

docker network create chainlink
docker network create beholder_default

Build a core image with plugins (OCR3 capability) and the aptos relayer

scripts/build.sh

Export a test key for local geth:

# openssl rand -hex 32
# NOTE: this is an example key from docs, DO NOT USE OUTSIDE OF DEVNET: https://web3js.readthedocs.io/en/v1.2.11/web3-eth-accounts.html#privatekeytoaccount
export ACCOUNT_KEY="348ce564d427a3311b6536bbcff9390d69395b06ed6c486954e971d960fe8709"
export ADDRESS="0xb8CE9ab6943e0eCED004cDe8e3bBed6568B2Fa01"

Switch to the chainlink repo:

core/scripts/keystone:

Add a node list file under .cache

(Ports from the node are forwarded so that host can talk to them if running in rootless containers to which DNS can't be resolved)

NodesList.txt

localhost:50100 chainlink.core.1:50100 notreal@fakeemail.ch fj293fbBnlQ!f9vNs
localhost:50101 chainlink.core.2:50101 notreal@fakeemail.ch fj293fbBnlQ!f9vNs
localhost:50102 chainlink.core.3:50102 notreal@fakeemail.ch fj293fbBnlQ!f9vNs
localhost:50103 chainlink.core.4:50103 notreal@fakeemail.ch fj293fbBnlQ!f9vNs
localhost:50104 chainlink.core.5:50104 notreal@fakeemail.ch fj293fbBnlQ!f9vNs

Switch back to the aptos repository.

scripts/setup.sh

After the setup, you'll want to redeploy the workflows to include the correct data feeds address. You can get the data feeds address via $(cat contracts/data-feeds-contract_address.txt), then modify your workflow and redeploy it. The workflow is located at scripts/workflow.toml. The field to modify is .targets[0].config.address.

To update workflows, run the same deploy-workflows command, it'll upsert the workflows, then restart the core node, the workflows don't seem to shut down otherwise.

docker restart $(docker ps -q --filter "name=chainlink.core*")

Atlas/Beholder local env

For monitoring we use Beholder API and infrastructure.

Run local Beholder env:

  1. Check out the Atlas repo
  2. cd $ATLAS_PATH/beholder
  3. make start && docker stop beholderdemo - to start the stack and stop polluting the Kafka topic with demo messages
  4. make consume-topic - to check for new messages on the topic (requires redpanda rpk CLI)

Stop local Beholder env:

  1. make stop

The Beholder local env should be stable and can be reused across runs/projects once running.

The Beholder stack is connected to the beholder_default Docker network.

Tips

Access chainlink CLI directly in a container of a node

podman exec chainlink.core.1 chainlink admin login -f /tmp/api_credentials --bypass-version-check

Inspect round:

curl http://127.0.0.1:8080/v1/transactions/by_hash/0xe69848c6fe69b57b4feb763e720db12ea16dd214d8007995090a18ca52a82bb4 | jq '.events[] | select(.type | contains("FeedUpdated"))'

Protobuf

We use protobuf to define monitoring messages types.

Lint .proto files using:

protolint lint --fix .

To generate Go type bindings from .proto files run:

go generate ./...