美文网首页
BAIC智能合约开发说明书

BAIC智能合约开发说明书

作者: BAIC区块链 | 来源:发表于2018-08-24 17:34 被阅读0次

    BAIC智能合约开发说明书

    1.  概述

    本文对BAIC公链的智能合约开发的相关知识做简要说明,为智能合约开发提供示例说明。

    2.  所需知识背景

    2.1. C/C++

    BAIC区块链平台使用Web

    Assembly(WASM)执行开发者提供的应用代码。目前最成熟的用于构建应用及WASM代码编译的工具链是clang/llvm及其C/C++编译器。从应用的高性能特性和安全需求出发,C++将成为智能合约开发的最佳语言。

    2.2. 开发环境

    BAIC智能合约开发需要在特定的平台环境中开发,开发者至少熟悉其中一个开发环境。

    BAIC支持的开发环境:

    Ubuntu 16.10 或更高

    MacOS Sierra 或更高

    3.  环境搭建

    开发BACI智能合约,开发环境平台需要安装的软件包:

    安装C++ /boost库          

    安装Clang编译器

    安装BAIC官方软件包baic-sdk

    软件包安装完成后设置环境变量即可。

    4.  智能合约开发

    本节详细描述BAIC智能合约的运作机制和开发过程,包括智能合约的代码编写、代码编译、可执行文件生成、文件格式描述等。

    4.1. 合约开发基础

    4.1.1.      通信模型

    BAIC智能合约通过action及共享内存数据库相互通信。异步通信导致的spam问题将由资源限制算法来解决。通信模型Inline保证执行当前的transaction或unwind;无论成功或失败都会有通知。Inline 操作的scopes和authorities和原来的transaction一样。

    4.1.2.  action vs transaction

    一个action代表单个操作, 一个transaction是一个或多个action的集合。合约和账户通过action通信。action可以单个地发送,如果希望一次执行批处理也可以集合起来发送。

    4.1.3.   action名的限定

    action的类型实际上是base32编码的64位整数。所以action名的最多10个字符,并且限制在字母a-z,A-Z, 0-9, 以及'_' 中。

    4.1.4. transaction确认

    获得一个transaction哈希并不等于transaction完成,它只表示该节点无报错地接受了,而其他区块生产者很可能也会接受它。但要确认该transaction,你需要在transaction历史中查看含有该transaction的区块数。

    4.1.5. 技术限制

    需要在1 ms内执行。 transaction的执行时间需要在*小于等于1ms否则transaction将会失败。

    最大 30 tps。 目前根据测试公网设置,每个账户最多每秒可发布30个transactions。

    4.2.智能合约文件

    4.2.1.  HPP

    HPP是包含CPP文件所引用的变量、常量、函数的头文件。

    4.2.2.   CPP

    CPP文件是包含合约功能的源文件。

    #include

    using namespace baic;

    class example: public baic::contract {

      public:

          using contract::contract;

          /// @abi action

          void action1( account_name user ) {

             print( "action1");

          }

          void action2( int para1,int para2,... ) {

             print( "action2");

          }

    };

    BAIC_ABI( example,(action1)(action2))

    从代码中可以看到创建的合约(example)将继承一个基础合约baic::contract,这个合约是baic基础合约,所有的开发的合约都要继承这个合约。

    在类中添加方法,作为action操作。例如上面的类中action1/action2方法就是合约的action操作。

    BAIC_ABI这个宏是替开发者实现了 apply 函数,使得开发者可以专注于业务逻辑。 开发人员只需要在宏中指定合同中的代码和操作名称,并且所有底层C代码映射逻辑都由宏生成。在第一个参数中填入合约名称(如example),第二个参数是action名称(如(action1)(action2)。

    4.2.3. WASM

    想要部署到BAIC区块链上的任何程序都需要先编译成WASM格式。这是区块链目前能接受的格式。

    一旦您完成了CPP文件的开发,您可以用clang工具将它编译成一个文本版本的WASM 文件。

    简要的生成过程如下:实际使用中要添加相关参数,具体见示例代码。

    1.      把源文件编译成bc字节码

    $ clang  -c example.cpp  -o  example.bc

    2.      把多个bc字节码链接成一个linked.bc文件

    $ llvm-link  -only-needed -o  example.linked.bc  example.bc 

    3.      通过linked.bc文件生成二进制s文件

    $ llc  -o example.s example.linked.bc

    4.      将s文件转成wast文件

    $ baic-s2wast -oexample.wast -s 16384 example.s

    5.  将wast文件编译成wasm文件

    $ baic-wast2wasmexample.wast example.wasm -n

    6.      生成abi文件

    $ baic-abigen  -destination-file=example.abi -verbose=0 example.hpp

    4.2.4.    ABI

    Application

    Binary Interface (ABI)是一个基于JSON的描述文件,是关于转换JSON和二进制格式的用户actions的。ABI还描述了如何将数据库状态和JSON的互相转换。一旦您通过ABI描述了您的合约,开发者和用户就能够用JSON和您的合约无缝交互了。生成abi过程见上文。

    5.   智能合约演示

    5.1. 示例代码

    本节中,我们将一步步地构建一个example合约。开始前,先完成上文的所有步骤。

    #include

    using namespace baic;

    class example: public baic::contract {

      public:

          using contract::contract;

          /// @abi action

          void action1(account_name

    user) {

             print( "action1");

          }

          void action2( int para1,int para2,... ) {

             print( "action2");

          }

    };

    BAIC_ABI( example,(action1)(action2))

    示例代码中 action1 和action2 都是一个动作,一个动作表示单个操作,而一个交易是一个或多个动作的集合。合约和账户以动作的形式进行交流。动作可以单独发送,也可以组合的形式发送。

    5.2. 部署步骤

    [if !supportLists]5.2.1.      [endif]编译代码

    编译步骤按上文描述依次编译,参照安装包中示例代码的编译过程,生成wast/wasm/abi文件。因文件参数太多,不在此描述。

    5.2.2.      创建账号

    $ baic_cli create account creater  example ${owner-public-key} ${active-public-key}

    5.2.3.     部署合约

    $ baic_cli set contract example ../example -p example

    5.2.4.     调用合约

      $ baic_cli push action example action1 '["user"]' -p user

    action1 是一个action调用,中括号里面为action的参数,本参数中是一个账户名称。

    附件

    合约开发示例也可以参照baic-sdk包中的test示例。

    合约部署详细流程参照BAIC区块链智能合约部署流程。

     

    BAIC开发者社区(论坛):http://baic.imio.io/bbs/

    BAIC官方网址:www.baic.io

    BAIC电报群:OfficialBAIC Group:https://t.me/baicgroup

    BAIC电报群(海外):Official BAIC Tribe:ttps://t.me/OfficialBAICTribe

    相关文章

      网友评论

          本文标题:BAIC智能合约开发说明书

          本文链接:https://www.haomeiwen.com/subject/mbriiftx.html