Skip to content

Running

Prerequisites

  • node.js >= 22.0.0
  • yarn >= 1.22.0 (can be installed using sudo npm i -g yarn)
  • docker >= 20.0.0

Installing CLI utility

npm i --global @cambrianone/camb-client@latest

Cambrian CLI utility

AVS management

  • camb avs run [-d, --detach] [-v, --verbose] [-u, --update] - run AVS
  • camb avs stop - stop AVS
  • camb avs list - list AVS instances

Operator node management

  • camb operator list -a <AVS public key> - list operator nodes
  • camb operator run [-d, --detach] [-v, --verbose] [-u, --update] <operator public key> - run operator node
  • camb operator stop <operator public key> - stop operator node
  • camb operator info [<operator public key>] - get operator node(s) info

Running payload

  • camb payload run-container -a <AVS public key | AVS URL> [-p period in seconds] <payload container image> - Run payload from container for the given AVS

Project scaffolding

  • camb init -t AVS <output directory> - scaffold AVS project
  • camb init -t operator <output directory> - scaffold operator project

Management

  • camb manage poa get-state -a <AVS public key> - get PoA state
  • camb manage poa init -a <AVS public key> - initialize PoA
  • camb manage poa set-threshold -a <AVS public key> threshold - update threshold in PoA
  • camb manage add-external -n <service name> -p <path to AVS/operator directory> -i <external service container image> [-e <NAME1=VALUE1...>] - add external service to run with existing AVS/operator

Flow

Detailed flow

  • Scaffold AVS: camb proposal init -t AVS <output directory>
  • Run AVS: camb avs run -u -v <AVS public key>
  • List registered operators: camb operator list -a <AVS public key>
  • Build payload image: git clone https://github.com/cambrianone/payload-images && docker build -t payload-check-oracle ./payload-images/check-oracle
  • Scaffold operator(s): camb proposal init -t operator <output directory>, you can find an admin private key in ~/.cambrian/config.toml
  • Run operator(s): camb operator run -a <AVS public key> -v <voter public key>
  • Run payload: camb payload run-container -a <AVS public key | AVS URL> payload-check-oracle

Running payload

Payload can be executed using camb payload run-container command

Container receives a parameter serialized as JSON-object. It's type is:

type TPayloadInput = {
  executorPDA: string;
  apiUrl: string;
  extraSigners: Array<string>;
}

extraSigners represents an optional array of serialized private keys used for signing transaction.

Container should write a JSON-stringified object. It's type is:

type TPayloadOutput = {
  proposalInstructions: Array<{
    accounts: Array<{
      address: string;
      role: 0 | 1 | 2 | 3    
    }>,
    data: string;
    programmAddress: string;
  }>;
  storagePayload:
  | { encoding: 'utf-8'; data: string }
  | { encoding: 'bytes'; data: number[] }
  | { encoding: 'base58'; data: string }
  | { encoding: 'base64'; data: string };  
}

where instructions data is base58-serialized data buffer and account role is the following enum:

enum AccountRole {
    // Bitflag guide: is signer ⌄⌄ is writable
    WRITABLE_SIGNER = /* 3 */ 0b11,
    READONLY_SIGNER = /* 2 */ 0b10,
    WRITABLE =        /* 1 */ 0b01,
    READONLY =        /* 0 */ 0b00,
}

Running in development mode

Start

yarn set version berry
yarn config set nodeLinker node-modules
yarn config set enableGlobalCache false
yarn workspaces foreach -A install
yarn build:packages
LOG_LEVEL=debug docker compose -f docker/docker-compose.yml up

Usage

curl -v -kisL http://localhost:3000/upload -F "file=@./services/camb-operator/src/test/payload-demo.ts"

Configuration

Environment variables

camb-operator

Name Description Default value
WS_URL AVS WebSocket URL ws://localhost:3001/
WALLET_KEY Wallet private key as an array of integers
OPERATOR_KEY Operator private key as an array of integers
API_URL Solana RPC URL https://devnet.helius-rpc.com/?api-key=e3278038-4bfb-4b21-bb4c-c6203303cc70