Dubhe CLI for Sui

Before getting started with Dubhe CLI, please install the required dependencies:

pnpm install -D @0xobelisk/sui-cli @0xobelisk/sui-common

Note: @0xobelisk/sui-common contains essential configuration type definitions like DubheConfig.

The Dubhe CLI

The Dubhe CLI is a development toolkit for building and managing Dubhe projects on the Sui blockchain.

Core features:

schemagen: Generate Dubhe schemas automatically from your store schemas configuration
publish: Deploy your Dubhe projects to any Sui network (mainnet/testnet/devnet/localnet)
upgrade: Upgrade your Dubhe Move contracts
node: Manage local Sui node for development
faucet: Interface with Sui faucets to fund addresses on testnet/devnet/localnet
generate-key: Generate a new account key pair and save it to a .env file
check-balance: Check the balance of the account
config-store: Store configuration for the Dubhe project
build: Build Dubhe Move contracts
test: Run tests for Dubhe contracts
call: Call a function in a module
query: Query schema struct state

Installation

The CLI should be installed as a project dependency rather than globally. When you create a new project using pnpm create dubhe, the CLI is automatically added as a dev dependency.

Using the CLI

Some commands expect a dubhe config in the same folder where the CLI is being executed. This includes schemagen and publish.

faucet and node can be executed anywhere.

Commands

`schemagen`

Generate Store libraries from a dubhe.config.ts file. See the Store Config and schemagen documentation in the Store section for more details.

dubhe schemagen [--network <network>] [--framework-id <id>]
 
Options:
  --config-path    Path to config file (default: "dubhe.config.ts")
  --network        Target network
  --framework-id   Framework Package ID

`publish`

Deploy Dubhe contracts to Sui network. This tool will use the dubhe.config.ts to detect all systems and schemas to deploy them to the specified network.

Before deploying the contract, please ensure:

You have sufficient tokens in your account for deployment fees
For testnet/devnet/localnet deployments, you can get test tokens via dubhe faucet
For localnet deployments, ensure your local node is running

dubhe publish --network <network> [--contract-name <name>] [--gas-budget <number>]
 
Options:
  --network        Target network (mainnet/testnet/devnet/localnet)
  --config-path    Config file path (default: "dubhe.config.ts")
  --contract-name  Optional specific contract to deploy
  --gas-budget     Optional gas budget for transaction

`upgrade`

Upgrade deployed Dubhe contracts.

dubhe upgrade --network <network>
 
Options:
  --network        Target network (mainnet/testnet/devnet/localnet)
  --config-path    Path to config file (default: "dubhe.config.ts")

`node`

Manage local Sui node using the official sui binary.

dubhe node

Local RPC endpoint: http://127.0.0.1:9000

Note: Make sure your local node is running properly before using other commands that require a local node (e.g., dubhe publish --network localnet).

`faucet`

Request test tokens from the Sui faucet. The default faucet service automatically gives test tokens to accounts in .env.

dubhe faucet --network <network> [--recipient <address>]
 
Options:
  --network     Network to request tokens on (testnet/devnet/localnet)
  --recipient   Optional recipient address (uses PRIVATE_KEY env if not specified)

`generate-key`

Generate new account keypair.

dubhe generate-key [--force] [--output-ts-path <path>]
 
Options:
  --force           Force generate new keypair
  --output-ts-path  Path to output TypeScript key file

`check-balance`

Check account balance on specified network.

dubhe check-balance --network <network> [--amount <number>]
 
Options:
  --network    Network to check balance on (mainnet/testnet/devnet/localnet)
  --amount     Amount of SUI to check for (default: 2)

`config-store`

Store configuration for the Dubhe project.

dubhe config-store --network <network> [--output-ts-path <path>]
 
Options:
  --network          Network to store config for
  --config-path      Path to config file (default: "dubhe.config.ts")
  --output-ts-path   Output path for generated TypeScript config

`build`

Build your Dubhe Move contracts.

dubhe build --network <network> [--dump-bytecode-as-base64]
 
Options:
  --network                 Network to build for (mainnet/testnet/devnet/localnet)
  --dump-bytecode-as-base64 Output bytecode as base64 (optional)
  --config-path            Path to config file (default: "dubhe.config.ts")

`test`

Run tests for Dubhe contracts.

dubhe test [--test <test_name>]
 
Options:
  --config-path    Path to config file (default: "dubhe.config.ts")
  --test          Name of specific test to run

`call`

Call a function in a module.

dubhe call --network <network> --module <module_name> --function <function_name> [options]
 
Options:
  --network        Network to use (mainnet/testnet/devnet/localnet)
  --module         Module name
  --function       Function name
  --config-path    Path to config file (default: "dubhe.config.ts")
  --package-id     Package ID (optional)
  --metadata-path  Path to metadata JSON file (optional)
  --params         Parameters for the function (optional)

`query`

Query schema struct state. Supports different storage types:

StorageValue (no params required)
StorageMap (1 param required)
StorageDoubleMap (2 params required)

dubhe query --network <network> --schema <schema_name> --field <field_name> [options]
 
Options:
  --network        Network to use (mainnet/testnet/devnet/localnet)
  --schema         Schema name
  --field         Field name
  --config-path    Path to config file (default: "dubhe.config.ts")
  --object-id     Object ID (optional)
  --package-id    Package ID (optional)
  --metadata-path Path to metadata JSON file (optional)
  --params        Parameters for storage type (optional)

Examples:

Query StorageValue:

dubhe query --network devnet --schema counter --field value

Query StorageMap:

dubhe query --network devnet --schema token --field balances --params "0x123...def"

Query StorageDoubleMap:

dubhe query --network devnet --schema game --field player_relations --params "0x123...456" "0x789...abc"

Environment Setup

Some commands require environment variables to be set:

PRIVATE_KEY: Required for deployment and some other operations
Can be set up using a .env file in your project root

When using the deployer, you must set the private key of the deployer using the PRIVATE_KEY environment variable. You can make this easier by using dotenv before running commands.

Network Support

The CLI supports the following networks:

Mainnet
Testnet
Devnet
Localnet

For testnet/devnet/localnet operations, you can get test tokens using the faucet command.

Project setup Client