EOS开发(3) -- currency合约分析

2018-04-03 本文已影响456人 freelands

currency.png

合约结构

currency_contract.png

可以看到在contracts合约目录下有个currency目录,这个目录里的内容就是我们所要分析的
主要分析是后面三个文件,abi应用程序二进制接口文件,hppc++头文件,cppc++代码逻辑文件
abi 文件主要是定义接口和整体的结构
hpp 主要是去引入一些依赖和做一些结构的声明,设计上的事情都放在这里
cpp 主要就是合约的逻辑了,对于不同的事件去应用不同的处理逻辑,还包括合约初始化的方法

hpp头文件分析

//eos的头文件依赖
#include <eoslib/eos.hpp>  
//定义token的头文件依赖 比如token结构体
#include <eoslib/token.hpp>
//操作区块链的底层方法的头文件
#include <eoslib/db.hpp>

namespace currency {
   //定义一个currency token结构 泛型第一个代表token的类型,第二个是token_name
   typedef eosio::token<uint64_t,N(currency)> currency_tokens;

   /**
    *  在用户表里存的每一条记录(可以理解成我们数据库里的每一行)
    *  @abi table
    */
   struct account {
      //构造函数 
      account( currency_tokens b = currency_tokens() ):balance(b){}

      
      //key 是 constant 因为每个用户只在每个currency里存在一条
      const uint64_t     key = N(account);
      
      //每个账户里的余额
      currency_tokens     balance;

      //验证余额是否为空方法 c++ struct类似于class 不过默认对成员的访问是public的 class是private的 
      bool  is_empty()const  { return balance.quantity == 0; }
   };

   //账户表记录每个用户当前的状态 
   using accounts = eosio::table<N(defaultscope),N(currency),N(account),account,uint64_t>;

   //一般token都会涉及到转账的动作 这个就是转账的结构体
   //@abi action
   struct transfer {
      /**
      * 从哪个账户转账
      */
      account_name       from;
      /**
      * 到哪个账户
      */
      account_name       to;
      /**
      * 多少数量的该token
      */
      currency_tokens    quantity;
   };

    //这个接口是给第三方调用的 为了查某个用户的账户信息 如果账户不存在 则会构造一个默认的账户返回(我的理解currency token 为0)
   inline account get_account( account_name owner ) {
      account owned_account;
      accounts::get( owned_account, owner );
      return owned_account;
   }
}

整体分析下来没有什么难以理解的,首先要定义一个currency token那么需要引入token结构体,并声明一个currency_token
然后转账设计到账户需要定义账户的表结构包括账户名和账户余额
账户信息需要存储在区块链上所以引入账户table accounts
账户之间会有转账所以声明一个transfer action
然后提供一个接口给第三方查看某个用户的余额,区块链上的数据公开透明的,这里的账户名owner不是真正的名字,其实是一个hash值,如下

typedef unsigned long long   uint64_t;
typedef uint64_t account_name;

abi文件分析

{
  "types": [{
      "new_type_name": "account_name",
      "type": "name"
    }
  ],
  "structs": [{
      "name": "transfer",
      "base": "",
      "fields": {
        "from": "account_name",
        "to": "account_name",
        "quantity": "uint64"
      }
    },{
      "name": "account",
      "base": "",
      "fields": {
        "key": "name",
        "balance": "uint64"
      }
    }
  ],
  "actions": [{
      "action_name": "transfer",
      "type": "transfer"
    }
  ],
  "tables": [{
      "table_name": "account",
      "type": "account",
      "index_type": "i64",
      "key_names" : ["key"],
      "key_types" : ["name"]
    }
  ]
}

可以看到abi里有四种结构 types,structs,actions,tables
我看到很多合约types都是一样的,所以暂时先这样写,不做分析,等官方文档通知
structs可以理解成定义的所有结构,包括转账的transfer结构,account的schema结构
action对应的是合约的所有事件这里只有转账一种
tables对应的是我们所涉及到在区块链上数据的存储,这里账户的信息会存在区块链上

cpp文件分析

#include <currency/currency.hpp> /// defines transfer struct (abi)

namespace TOKEN_NAME {
   using namespace eosio;

   // 创建账户的时候 如果检查余额为空则删除
   void store_account( account_name account_to_store, const account& a ) {
      //这个就是上面hpp文件里的判断余额是否为空方法
      if( a.is_empty() ) {
         accounts::remove( a, account_to_store );
      } else {
         //不为空就存到区块链上
         accounts::store( a, account_to_store );
      }
   }

   void apply_currency_transfer( const TOKEN_NAME::transfer& transfer_msg ) {
      //做一些通知
      require_notice( transfer_msg.to, transfer_msg.from );
      //做一些权限的检查
      require_auth( transfer_msg.from );
      //解析message
      auto from = get_account( transfer_msg.from );
      auto to   = get_account( transfer_msg.to );
      //下面的-= +=操作符是重载过的 会自动做上溢出 和下溢出的assert检查 
      from.balance -= transfer_msg.quantity; 
      to.balance   += transfer_msg.quantity; 
      // 更新区块链上的值
      store_account( transfer_msg.from, from );
      store_account( transfer_msg.to, to );
   }

}  // namespace TOKEN_NAME

using namespace TOKEN_NAME;
//下面的c代码是整个程序的入口点
extern "C" {
   //init是在合约发布或者更新的时候去调用的,如果账户不存在则发现1亿的token
    void init()  {
       account owned_account;
       if ( !accounts::get( owned_account, N(currency) )) {
          store_account( N(currency), account( currency_tokens(1000ull*1000ull*1000ull) ) );
       }
    }

    //apply方法实现了该合约对不同事件对应处理程序的分发
    void apply( uint64_t code, uint64_t action ) {
       //code 是这个合约
       if( code == N(currency) ) {
          //事件是transfer 转账 则执行转账的逻辑
          if( action == N(transfer) ) 
             TOKEN_NAME::apply_currency_transfer( current_message< TOKEN_NAME::transfer >() );
       }
    }
}

可以看到整体上都挺好理解的,只是代码是c++写的,所以你有可能看着不习惯

总结

以上就是对currency合约的整体分析,只代表个人的理解,可能有不正确的地方欢迎指出
大学的时候刚开始用的就是c,所以搞起c++不是什么难事,但是用c++开发企业级的代码还是需要下点功夫的
以太坊上的合约是不可变的也就是你发布后不能去修改合约代码
EOS可以支持合约的重新部署,但是向前兼容还要,不兼容就是一个大问题了
智能合约开发和传统的开发有点区别,平时我们开发有bug可以滚动发布去修复,但是智能合约不是儿戏,每次改动都可以理解成一次分叉,如果不兼容可能会导致硬分叉,所以在设计之初一定要考虑好做什么? 怎么做?

EOS开发(3) -- currency合约分析

目录

合约结构

hpp头文件分析

abi文件分析

cpp文件分析

总结

猜你喜欢

热点阅读