Skip to main content

API Reference Overview

The canoLiq plugin runs a small read-only HTTP server inside the plugin process so operators can read plugin-owned state without going through the FSM.

Enabling the API

Set CANOLIQ_RPC_ADDR (or Config.RpcAddress) to a listen address. Empty/unset disables the server.

export CANOLIQ_RPC_ADDR=127.0.0.1:8587
CANOPY_PLUGIN_MODE=canoliq ./go-plugin

Docker Localnet Ports

NodeContainer PortHost Port
node-185878587
node-285878588

Design

  • All routes are read-only — they go through query.go helpers that issue point StateRead calls
  • JSON encoding piggybacks on @gotags already attached to proto types
  • google.protobuf.Any fields serialize as {typeUrl, value}

Error Responses

StatusCause
400Malformed address or invalid parameter
404Missing entity
405Non-GET method
500Plugin-internal failure (with JSON error body)

Address parameters accept 0x-prefixed or bare 40-character hex.