Dapp开发指南
Dapp开发指南

本文档通过介绍Dapp的整体开发流程,讲解开发过程中涉及的相关知识以及工具链,帮助您基于Starcoin快速构建属于自己的Dapp。

开发流程

任何公链的Dapp,从前端页面开始,最终调用到链上部署的智能合约,都包含以下的主要环节:

dapp_1

这里以Starcoin为例进行讲解,上图涉及到的主要组件有:

  1. 交互入口页面;
  2. 跟链节点通讯的SDK;
  3. 也可能通过浏览器插件钱包StarMask跟链的节点通讯(实际上,StarMask也是调用了JS的SDK);
  4. 启动链的节点;
  5. 链上部署的合约;

上面提到的每一步都涉及到相关的知识和可用的工具,如下图所示:

dapp_2

这里按从左到右的顺序,先简单介绍一下开发者比较关心的内容(后面会展开介绍):

  1. 入门Dapp:适合想快速了解和体验Dapp,或者想开发Dapp页面的前端开发者;
  2. StarMask API:Dapp开发中经常会遇到签名等场景,需要调用浏览器插件钱包StarMask的API,与钱包进行交互,完成用户操作以及常见的链交互;
  3. SDK:SDK是跟链交互的另一种常用方式,Starcoin包含多语言版本的SDK,开发者可以根据自己的需求选择对应版本的SDK:
    1. JS SDK
    2. Java SDK
    3. Python SDK
    4. Go SDK
    5. Dart SDK
  4. Starcoin节点RPC接口:包含了Starcoin节点对外的所有服务和对应接口,开发者或者SDK可以通过这些接口跟链进行交互;
  5. Move智能合约:开发者通过Move语言将逻辑表达出来并部署到Starcoin链上,供所有的用户调用;

以上是基于Starcoin开发Dapp可能涉及的主要环节和内容的简单介绍,下面将进一步对每一个环节展开来介绍。如果您只对其中的某一部分或者某一个环节感兴趣,可以直接跳转到对应的内容。

入门Dapp

这是一个简单的入门Dapp,也是用户真正能够使用和感受Dapp的产品入口。您可以通过它快速地了解什么是Dapp,感受Dapp如何跟链进行交互。如果您是开发人员,还可以通过查看它的源代码,了解一个简单的Dapp的代码结构,快速上手构建属于自己的Dapp。

  • 体验入口:https://starmask-test-dapp.starcoin.org/

  • 代码仓库:https://github.com/starcoinorg/starmask-test-dapp

StarMask

StarMask是Starcoin官方发布的浏览器插件钱包,不仅是用户管理链上数字资产的一种方式,也是Dapp跟链上进行交互的一种选择。例如,用户对Dapp的交易进行签名,并将签名后的交易提交到远程节点的Txpool中。这里带您深入了解一下StarMask:

  • 安装指南:https://github.com/starcoinorg/starmask-extension/blob/main/docs/how-to-install.md

  • 使用指南:https://github.com/starcoinorg/starmask-extension/blob/main/docs/how-to-use.md

SDK

跟链交互,除了StarMask这种方式,还可以选择SDK的方式。Starcoin官方提供了多个语言版本的SDK,以方便开发者通过编程的方式跟Starcoin节点进行交互。以下是Starcoin支持的SDK:

  1. JS SDK

    • 开发者文档:https://starcoin.org/zh/developer/sdk/javascript/
    • 源代码:https://github.com/starcoinorg/starcoin.js
  2. Java SDK

    • 开发者文档:https://github.com/starcoinorg/starcoin-java#readme
    • 源代码:https://github.com/starcoinorg/starcoin-java
  3. Python SDK

    • 开发者文档:https://starcoin-sdk-python.readthedocs.io
    • 源代码:https://github.com/starcoinorg/starcoin-sdk-python
  4. Go SDK

    • 开发者文档:https://github.com/starcoinorg/starcoin-go/blob/main/README.md
    • 源代码:https://github.com/starcoinorg/starcoin-go
  5. Dart SDK

    • 源代码:https://github.com/starcoinorg/starcoin.dart

Starcoin节点&RPC接口

在Dapp的整个生命周期中,不管是使用StarMask还是使用SDK跟链交互,最终都是在跟分布式网络里面的一个Starcoin节点通信。所以,一个稳定的Starcoin节点是Dapp交易能够打包上链的必要条件。Starcoin节点对链下环境提供了统一必要的接口,这里深入介绍一下Starcoin节点:

  1. 选择网络

    Starcoin根据目标的不同,设计了多个不同的网络,覆盖了开发周期的每个阶段。包括Dev、Test、Halley、Proxima、Barnard、Main:

    • Dev:用于本地开发
    • Test:用于单元测试和集成测试
    • Halley:总是运行 Stdlib 的 latest 版本,如果Stdlib 变更则会立刻重置 Genesis Block, 清理原来的数据
    • Proxima:用于Dapp上线前测试,会定期清数据
    • Barnard:用于Dapp上线前测试,不删除数据,必须兼容性升级
    • Main:Starcoin主网

    在启动Starcoin节点前,建议先根据自己的需求,选择不同的网络。

  2. 节点安装

    Starcoin有多种安装方式(查看详情

    • 根据不同的平台,下载对应的二进制,Starcoin同时支持 Windows、Mac 和 Linux。下载链接
    • 源代码编译成二进制,操作指南
    • 通过 Docker 安装,操作指南
  3. 运行节点

    根据前面「节点安装」的不同,节点运行方式也稍微有点区别

    不管是通过哪种方式运行,需要修改-n参数选择符合自己需求的网络。

  4. 控制台

    Starcoin节点运行过程中,经常需要通过控制台连接上节点,以命令行的形式查看运行状态。Starcoin提供了console命令用于连接节点,操作指南

  5. 命令行操作文档

    Starcoin支持了丰富的命令,常用的命令如下:

    • account:账号相关的命令
    • chain:链相关的命令
    • node:节点相关的命令
    • state:状态相关的命令

    还有很多其他的命令,查看更多详情

  6. RPC协议

    前面介绍了跟节点相关的信息,重点介绍了通过控制台的方式访问Starcoin节点。实际上,还可以通过RPC接口的形式来访问Starcoin节点。可以说,这是通过编程来访问节点的最佳方式,SDK正是通过这些RPC接口跟节点进行交互。这里是详细的RPC协议文档,开发者在必要的时候,可以查看RPC详情进行编程。

  7. 运行原理

    如果您是开发者,想进一步了解Starcoin的原理,可以从以下方面入手:

    • 关键概念:https://starcoin.org/zh/developer/key_concepts/
    • SIPs:https://starcoin.org/zh/developer/sips/
    • 源代码:https://github.com/starcoinorg/starcoin

Move

Starcoin是第一个支持Move智能合约的无许可公链。

在区块链的场景下,开源是常态。相比过去中心化场景,对智能合约开发者来说,既要实现业务,又要兼顾安全,无疑是一个非常大的挑战。而DeFi等场景的安全,又显得尤为重要。正是基于这些考虑,智能合约语言Move把安全当成首要设计目标,从语言层面对金融场景进行安全加固,开箱即用,极大程度地降低智能合约开发者的门槛。可以说,Move是目前唯一不影响货币功能的智能合约。

Move语法简单,安全特性开箱即用,能够做到轻松上手。对于想要编写Move合约的开发者,Starcoin准备了非常丰富的开发教程,完善的开发工具。

  1. Move教程:
  • Move book》中文版
  • Move基础篇:https://weibo.com/l/wblive/p/show/1022:2321324653445776015474
  • Move进阶篇:https://weibo.com/l/wblive/p/show/1022:2321324655638159687840
  • Move & Dapp实战:https://weibo.com/l/wblive/p/show/1022:2321324658455788257683
  • Move开发实战:https://weibo.com/l/wblive/p/show/1022:2321324661355444568427
  • Move语言设计思路:https://weibo.com/l/wblive/p/show/1022:2321324661515499208925
  • Move & DeFi 开发:https://weibo.com/tv/show/1042211:4664043403935862
  • Move & DeFi安全:https://weibo.com/tv/show/1042211:4672003286958120
  • Move为 DeFi 而生:https://learnblockchain.cn/article/2636
  • Move中文社区 :https://www.movelang.io/
  1. IDE:
  • Starcoin IDE:https://marketplace.visualstudio.com/items?itemName=starcoinorg.starcoin-ide
  • Move-cli:这是一个非常轻量级的测试、发布Move合约的工具,下载链接和操作指南
  1. 测试

    Move支持多种测试方案

  2. 编译&部署

    合约完成之后,需要编译并部署到Starcoin的链上。部署合约也有多种方式:

    这里需要注意的是,选择合适的网络进行部署。

  3. Move入门例子

Stdlib & 协议

Starcoin有 Stdlib 特性,完全使用 Move语言开发,感兴趣的朋友可以查看源代码

Starcoin在 Stdlib 中定义了多种常用协议,如下图所示(更多协议在陆续制定中):

dapp_1

  1. DAO协议

    DAO协议是Stdlib中一个基础的协议,通过DAO协议能够很好的进行链上治理。这里是通过链上治理进行代码升级的例子。

  2. NFT协议

  3. Stdlib使用指南

其他开发者工具

  1. 官网

    Starcoin的官网。通过官网能获取到非常多的信息,比如白皮书、开发者、工具链、Starcoin最新动态等等。

  2. 水龙头

    在测试过程中免不了需要测试网的STC,比如支付gas。开发者可以通过Starcoin提供的不同网络(暂时只开放Barnad)的水龙头申请STC:

    • Barnard:https://faucet.starcoin.org/barnard
  3. 浏览器

    浏览器也是常用的开发者工具,是链的一个补充。Starcoin常用的浏览器是stcscan

  4. 投票Dapp

    投票Dapp也是常用的开发者工具,是Starcoin链上治理的入口。开发者可以通过这个Dapp发起自己的提案,社区会进行通过这个Dapp进行公开、公平、公正地投票,只有投票通过才能在链上执行。

  5. Starcoin logos && icons

    下载地址: https://starcoin.org/downloads/logo.zip