Starcoin Developer Documents

Starcoin is a Layered Cryptocurrency and Decentralized Blockchain System.


Starcoin’s roadmap


Starcoin’s main features.


This article guides you on how to install starcoin.Starcoin support windows/Mac/Linux.

Build from Source

Build starcoin from source.

Run/Join Network

starcoin is used to start a local network or join a starcoin network. Running a local network or join test network makes it easier to test and debug your code changes. You can use the CLI command dev to compile, publish, and execute Move programs on your local network or test network.

First Transaction

This article guides you on how to execute your first transaction on the starcoin blockchain. Before that, I recommend you read tech-related articles to get some idea of the basic concepts of starcoin.

Run custom chain network

starcoin supports run a user-defined blockchain network, allowing users to build private chain for testing or development.

Deploy Move Contract

This article guides you on how to compile and deploy a Move contract to the starcoin blockchain.

User Defined Token

This is a example for How to define user custom Token on starcoin blockchain.

Formal Verification

Introduce to Move’s formal verification tool


starcoin_miner Command line tools are used to remotely connect to starcoin nodes and provide mining capabilities.

Upgrade module with Dao
compile the module which you want to upgrade. unlock your account. starcoin% account unlock <account address> submit upgrade module proposal with your account. starcoin% dev module_proposal -s <account address> -m <module path> -v <version> query proposal state. starcoin% dev call --module-address <module address> --module-name Dao --func-name proposal_state -t 0x1::STC::STC -t 0x1::UpgradeModuleDaoProposal::UpgradeModule --arg <proposal address> --arg <proposal number> anyone can vote proposal when the proposal state is ACTIVE.

Some technical documentation about starcoin.

Key Concepts

This document briefly describes the key concepts of the Starcoin protocol.