Skip to main content

Quick Start

(NOTE: Our LDK & local devnet is still experimental. Apologies for the inconvenience if you run into any errors/bugs. Please report them on the LDK repository.)

  • Install the LDK: 
    curl ldk.lyquor.dev -L | bash
    This installs everything you need into ~/.shakenup: the Lyquor node and developer tools (lyquor, shaker, ladle), plus the Rust and Foundry toolchains and the LDK itself (under ~/.shakenup/ldk).
  • Start a local devnet with Docker Compose (requires Docker Engine and Docker Compose v2): 
    docker compose -f ~/.shakenup/ldk/docker/single/docker-compose.yaml up -d
    This starts a single Lyquor node and a bootstrap service that deploys the bartender registry. The node API is served at http://localhost:10087/api and the dashboard at http://localhost:10087/lyquor/. For a 4-node topology, use docker/multi/docker-compose.yaml.

Now you can try our examples:

LDK Source Code

The Lyquid Development Kit is open source at github.com/lyquor-labs/ldk. It contains everything a Lyquid developer builds against:

  • lyquid/: the Lyquid runtime and SDK. While enjoying the blazingly fast and easy data model (DMA) and multi-threaded off-chain execution, it uses stable Rust.
  • lyquid-examples/: the example Lyquids used throughout these docs (hello, erc20, basicswap).
  • lyquid-template/: a cargo-generate template for starting a new Lyquid project.
  • bartender/: the reference registry Lyquid that tracks deployments on a Lyquor network.
  • primitives/: shared primitive types used by the runtime and tools.
  • docker/: Docker Compose setups for running a local devnet — single/ (one node) and multi/ (a 4-node topology); see each directory's README.

The Lyquor platform node program itself (think of it as an "L1 validator", written in stable Rust, running on macOS/Linux/WSL/Android without rooting the device) is currently distributed as prebuilt binaries via LDK releases, which is what the install script downloads. Its source code is not open-sourced yet. Please stay tuned.