README.md

Left Curve

This is a monorepo containing a number of Left Curve Software products:

Name	Language	Description
dango	Rust	A suite of DeFi application smart contracts
grug	Rust	An execution environment for blockchains
sdk	TypeScript	An SDK for interacting with Grug chains
ui	TypeScript	A web interface for accessing Dango and other Grug chains

How to use

Prerequisites:

• Rust with wasm32-unknown-unknown target
• Just
• Docker
• Node.js version 18+
• pnpm

We use VS Code as text editor with the following plugins:

• AstroBuild
• Biomejs
• Code Spell Checker
• Dependi
• EditorConfig
• Error Lens
• Even Better TOML
• Markdown All in One
• markdownlint
• rust-analyzer
• Todo Tree
• Trailing Spaces

Rust

Install the grug command line software:

just install

Run tests:

just test

Lint the code:

just lint

Compile and optimize smart contracts:

just optimize

TypeScript

Before running any command is necessary to run:

pnpm install

Start the development mode for all packages in the sdk/packages:

pnpm dev:pkg

Start the development mode for the app located in the ui/portal directory:

pnpm dev:portal

Build the SDK:

pnpm build:pkg

Build both the SDK and the Portal App:

pnpm build:portal

Run tests:

pnpm test

Run linter:

pnpm lint

Generate documentation:

pnpm doc

Storybook:

pnpm storybook

Book:

cargo install mdbook
cargo install mdbook-katex
mdbook build

Acknowledgement

TODO

License

TBD