Scaf: Development Framework for the Sui Blockchain

Scaf is a development environment for the Sui blockchain. With Scaf you can:

• Develop, build, and deploy Sui Move smart contracts.
• Interract with Sui Move smart contracts on mainnet, testnet, devnet, and localnet.
• Manage a project-specific local Sui network for development, testing, and simulating interaction.

NOTE: If you are interested in a GitHub Action for running tests with Sui Move: @cNikolaou/test-sui-move

Prerequisites

Scaf requires the sui CLI for building the Sui Move smart contracts and for running the local network and the local validator. You can run the ./install_sui_dependencies.sh to install both.

Otherwise, to install the SUI CLI run:

cargo install --locked --git https://github.com/MystenLabs/sui.git --branch releases/sui-v${VERSION}-release sui

And check if the CLI is installed:

sui --version

To use the local network and validator for development and testing you need to install the sui-test-validator

cargo install --locked --git https://github.com/MystenLabs/sui.git --branch releases/sui-v${VERSION}-release sui-test-validator

And verify it's installed with:

sui-test-validator -V
sui-test-validator --help

Installation

You can install Scaf with npm. To start a new project and develop Sui Move smart contracts

mkdir sui_move_project
cd sui_move_project

npm init -y
npm install @cnikolaou/scaf

Setup and Configuration

After installing scaf, you can create a structure for your project with:

npx scaf init

This will create the following structure:

.
├── packages/
├── scripts/
├── genesis.yaml
└── scaf.config.js

• The packages/ directory includes sample Sui Move packages.
• The scripts/ directory includes a sample script that:
  • Starts a local, project-specific Sui blockchain with the Network.startNetwork() function.
  • Publishes the packages/fungible_token package in a local Sui blockchain.
  • Interracts with the published package.
• genesis.yaml is the file used by Network.resetNetwork() to configure the initial state of the local blockchain. You need to update the file with your public addresses under accounts:.
• scaf.config.js selects against which network the script actions will run. The options are mainnet, testnet, devnet, and localnet.

Run

To run the sample project you need to create a local .env file with the following information (make sure not to include that file in any commit):

SEED='YOUR-SEED-PHRASE'
SCHEMA='SCHEMA-USED-FOR-PRIVATE-KEY'
SEND_TO='PUBLIC-ADDRESS-OF-RECEIVER'

Then run the sample script by:

npx scaf run scripts/fungibleToken

And open the Sui explorer to see the results on the local network: https://suiexplorer.com/?network=local

You can create and run your own scripts that interract with the Sui blockchain (either localnet or any other Sui network), by selecting the active network for the scripts in scaf.config.js. You can automate interractions with smart contracts or deploying your own Sui Move smart contracts.