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:

• Step-by-step tutorial for hello.
• ERC20-Compatible Lyquid.

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 as runtime and SDK. While enjoying the blazingly fast and easy data model (DMA), multi-threaded off-chain execution, it also uses stable Rust.

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

2. To setup the development environment, simply run the setup script:

./scripts/dev-setup.sh

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.