Skip to main content

Quick Start

(NOTE: Our LDK & local devnet is still highly experimental. Apologize for the inconvenience if you run into any errors/bugs. We'll open-source our platform code soon. Please stay tuned.)

  • Install the LDK:
    curl ldk.lyquor.dev -L | bash
  • To start a local devnet, run start-devnet (if this command doesn't exist, try ~/.shakenup/bin/start-devnet).

Now you can try our examples:

For Lyquor Platform Code Developers

There are two parts of code in our project:

  • lyquor (and lyquor-*): implements our Lyquor platform node program (think of it as an "L1 validator") and its tooling. Our platform code uses stable Rust, and can be directly built on Unix-like platforms (MacOS/Linux/Android).

  • lyquid: Lyquid Development Kit that's used by Lyquid developers to build their lyquids. Lyquid code requires Rust nightly toolchain for a few features like allocator_api.

  1. First, make sure you have rustup installed on your machine.

  2. Then, install both nightly (wasm32) and stable toolchain.

# Stable Rust toolchain
rustup toolchain install stable
rustup default stable

# Lyquid toolchain
rustup toolchain install nightly
rustup component add rust-src --toolchain nightly
rustup target add wasm32-unknown-unknown --toolchain nightly

You can start the local devnet with the code in the repo by running scripts/start-devnet.sh. This is useful for some quick debug of the code.