Ika

A starter kit for building a Sui applications. It includes a basic structure for a Sui application with a e2e local testing envrionment as a cli. Join our Discord!

Installation

Firstly you need to go through the process of installing Sui. You can find this here

Install ika from this repo.

cargo install --git https://github.com/Ludex-Labs/ika.git ika

Create a new project

To create a new project run the following command

ika new <project-name>

Run tests against the project

To run tests against the project run the following command

ika test

This will run the test entry in Move.toml under ika (which acts as a e2e test) and the Sui move tests.

[package]
...

[dependencies]
Sui = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework", rev = "devnet" }

[addresses]
...

[ika]
test = "npm run test"

Flags can be provided to skip the Sui tests or the e2e tests

ika test --skip-contract --skip-e2e

Update Sui binaries

Utility to update sui binaries. It wraps cargo install --locked --git https://github.com/MystenLabs/sui.git --branch devnet sui

ika update-sui

Prior Art

Anchor

Hardhat