Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 2.48 KB

dev_quick_start.md

File metadata and controls

95 lines (63 loc) · 2.48 KB

Libra Dev Quick Start

TL;DR

  • You need our fork of diem before working on libra-framework
git clone https://github.com/0LNetworkCommunity/diem -b release --single-branch
  • compile diem and diem-node to $HOME/.cargo/bin
cargo build --profile cli -p diem -p diem-node --target-dir ~/.cargo/bin
# make them executable
chmod +x ~/.cargo/diem
chmod +x ~/.cargo/diem-node
  • export these env vars in your dev env, ~/.bashrc or ~/.zshrc
export RUST_MIN_STACK=104857600
export DIEM_FORGE_NODE_BIN_PATH="$HOME/.cargo/bin/diem-node"

Set up environment

You should have two repos that you are working with. This one libra-framework, as well as diem. We'll need to build some executables from diem and install them on your dev machine.

Get the DIEM dependencies

You need our fork of diem before working on libra-framework

git clone https://github.com/0LNetworkCommunity/diem -b release --single-branch

check env

This assumes that you have a ~/.cargo/bin which is added to your environment's $PATH.

build executables

You want to create a diem executable so you can run the move cli with the framework changes.

You'll want diem (cli for move tests), diem-node (for smoke tests only).

Note that the --profile cli compilation profile makes for much smaller binaries (e.g. diem goes from about 2GB to 30MB).

cargo build --profile cli -p diem -p diem-node --target-dir ~/.cargo/bin
# see you tomorrow.

# next day, make them executable.
chmod +x ~/.cargo/diem
chmod +x ~/.cargo/diem-node

Just check those executables appear in your path. which diem

Now you can run commands as below.

Running Move unit tests

Change into a Move project dir (i.e., the directory with a Move.toml).

diem move test

optionally with filters:

diem move test -f

Build a libra framework release for smoke tests (head.mrb)

cd ./framework
cargo run release

Your release will be in ./releases/head.mrb, you will need this for genesis and smoketests.

Note for smoke tests: you must regenerate the .mrb file, EVERYTIME YOU MAKE A CHANGE TO CORE MOVE CODE. Otherwise your tests will be against the old code

running smoke tests

Do it yourself: Make sure you are in the root of the project.

Note: there is an issue with the rust default stack size for tests which involve compiling, and then starting a local testnet

cd ./smoke-tests
export RUST_MIN_STACK=104857600
export DIEM_FORGE_NODE_BIN_PATH="$HOME/.cargo/bin/diem-node"
cargo test