@0xobelisk/sui-cli

The Dubhe CLI

The Dubhe CLI is used for building and developing a Dubhe project.

It comes with

1. generate: Generate Move code from dubhe.config.ts
2. publish: Deploy your own project on the specified sui network.
3. upgrade: Upgrade your own project on the specified sui network.
4. localnode: Start a local Sui node for development
5. faucet: An interface to the Devnet/Localnet faucet. It makes it easy to fund addresses on the Devnet/localnet

Installation

We don't recommend installing the CLI globally.

Instead, you should add the CLI as a dev dependency to your project (done automatically if you start from a starter kit using pnpm create dubhe), and use it with pnpm build inside your project directory.

Using the CLI

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

faucet, and localnode can be executed anywhere.

Commands

generate

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

# in a folder with a dubhe.config.ts
dubhe generate --config-path dubhe.config.ts

publish

Deploy a Dubhe contract project with the dubhe framework.

This tool will use the dubhe.config.ts to detect all systems, schemas and projectName in the project and will deploy them to the chain specified.

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 dubhe publish in your deployment script.

To set up the target network for deploying the contract (mainnet/testnet/devnet/localnet), before deploying the contract, please make sure that you have some tokens in your account, which will be used for some fees when deploying the contract. (If you choose devnet/localnet, you can get some test tokens via dubhe faucet), if you need to deploy the contract on localnet, please make sure you have started localnode.

# to deploy sui locally
dubhe publish --network localnet
# to deploy to sui devnet
dubhe publish --network devnet
# to deploy to sui testnet
dubhe publish --network testnet
# to deploy to sui mainnet
dubhe publish --network mainnet

upgrade

Upgrade Dubhe contract project.

When you add a new schema or modify the system code, you need to upgrade the contract through the upgrade method. (Migration Guide)

dubhe upgrade --network <network:mainnet/testnet/devnet/localnet>

localnode

The localnode uses the official sui-test-validator binary provided by sui to start the localnode.

The local rpc is http://127.0.0.1:9000

dubhe localnode

faucet

Connects to a Dubhe faucet service to fund an address.

dubhe faucet --network <network:devnet/localnet>
dubhe faucet --network <network:devnet/localnet> --recipient <address>

The default faucet service automatically gives test tokens to accounts in dotenv.

To fund an address on the devnet/localnet, run dubhe faucet --recipient <address>