Skip to content

Latest commit

 

History

History
131 lines (105 loc) · 4.27 KB

README.md

File metadata and controls

131 lines (105 loc) · 4.27 KB

Aptos-Specification-Workshop

For the purposes of demonstrating the formal verification capability of Aptos, we build this tutorial about specifying your code by Aptos Move Prover. We hope through this project, you can learn and understand about formal verification techniques, and build your specifications to guarantee the safety of your Dapp.

Environment Setup

Before we start, setting up the environment is necessary. The Move Prover (MVP) is integrated in the Aptos CLI, a command line tool for developing, debugging, deploying and operating on the Aptos Network. So what we need to do is to include the installation of the Aptos CLI and the dependencies for the MVP.

Install Aptos CLI

Four installation methods are provided; please choose the preferred one.

Install On Mac

For Mac, the easiest way to install the Aptos CLI is with the package manager brew.

  1. Ensure you have brew installed.
  2. Execute the following commands to install client. 
    brew update
brew install aptos
  3. Check if client is installed. 
    aptos help

Install On Windows

For Windows, the easiest way to install the Aptos CLI tool is via Python script.

  1. Ensure you have python 3.6+ installed.
  2. Run the install script in PowerShell. 
    iwr "https://aptos.dev/scripts/install_cli.py" -useb | Select-Object -ExpandProperty Content | python3
  3. Update your PATH with the command looks something like the following one. 
    setx PATH "%PATH%;C:\Users\<your_account_name>\.aptoscli\bin"
  4. Check if client is installed. 
    aptos help

Install On Linux

For Linux, the easiest way to install the Aptos CLI tool is via Python script.

  1. Ensure you have python 3.6+ installed.
  2. Run the install script in your terminal. 
    curl -fsSL "https://aptos.dev/scripts/install_cli.py" | python3
    Or use the equivalent wget command: 
    wget -qO- "https://aptos.dev/scripts/install_cli.py" | python3
  3. Update your PATH with the command looks something like the following one. 
    echo 'export PATH=/usr/local/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
  4. Check if client is installed. 
    aptos help

Install Specific Versions(Advanced)

If you need a specific version of the Aptos CLI, you can build it directly from the Aptos source code.

  1. Follow the steps to build Aptos from source here
  2. Ensure you have cargo installed.
  3. Build the CLI tool:. 
    cargo build --package aptos --profile cli.
    The binary will be available at target/cli/aptos or target\cli\aptos.exe.
  4. (Optional) Move this executable to a place in your PATH.
  5. Check if client is installed. 
    # for Linux/macOS
target/cli/aptos help
# for Windows
target/cli/aptos.exe help
    Or 
    aptos help

Install Dependencies Of MVP

If you want to use the Move Prover, install the Move Prover dependencies after installing the CLI binary.

  1. Clone the Aptos repository.

    git clone https://github.com/aptos-labs/aptos-core.git

  2. Install dependencies.

    For Linux/macOS

    cd aptos-core/
./scripts/dev_setup.sh -yp
source ~/.profile

    For Windows

    PowerShell -ExecutionPolicy Bypass -File ./scripts/windows_dev_setup.ps1 -y

    Note: Execute the Windows' command as an administrator!

If you’ve persisted up to this step, congratulations on completing the environment setup!