【许晓笛】 EOS 智能合约案例解析(2)

本文涉及的产品
云解析 DNS,旗舰版 1个月
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介:

详解 EOS 智能合约的 cpp 文件

之前的文章介绍了 eosio.token 智能合约的 hpp 文件,这次向大家介绍 eosio.token.cpp 文件,cpp 文件即 C++ 代码文件,智能合约所有的业务逻辑内容都是在 cpp 文件中实现的。

eosio.token.cpp 文件地址: https://github.com/EOSIO/eos/blob/master/contracts/eosio.token/eosio.token.cpp

了解 C/C++ 开发的同学肯定熟悉,cpp 文件的主要使命是实现 hpp 文件中声明的函数(方法),包括公有函数(EOS 里也叫 action)和私有函数。hpp 里挖的坑,cpp 要一个不留地实现。

私有函数

照惯例,私有函数都是工具函数,供类内部的其他函数调用。

sub_balance(减资产)函数

作用:从指定账户中减去资产
参数:被操作账户,资产数,资产状态

//                   参数:被操作账户          资产种类与数量      资产状态结构体
void token::sub_balance( account_name owner, asset value, const currency_stats& st ) {
   //建立一个 multi_index,用来操作数据库
   //这里的参数 _self 表示数据的拥有者为智能合约本身,参数 owner 表示储存在名为被操作账户的表中
   //这样并不是直接建立了一个新表,而是让 C++ 程序与数据库对应的表之间建立了数据传输的通道
   accounts from_acnts( _self, owner );
   
   //在数据表中查询要减少的代币结构体,就是 hpp 文件中定义的 account 结构体
   const auto& from = from_acnts.get( value.symbol.name() );
   //校验,要减少的代币数量应该小于目前拥有的代币数量,否则会报错。
   eosio_assert( from.balance.amount >= value.amount, "overdrawn balance" );
   
   //判断是否有被操作账户的授权
   if( has_auth( owner ) ) {
      //校验,账户是否被冻结
      eosio_assert( !st.can_freeze || !from.frozen, "account is frozen by issuer" );
      //校验,这种代币是否被冻结
      eosio_assert( !st.can_freeze || !st.is_frozen, "all transfers are frozen by issuer" );
      //校验,账户是否在白名单中
      eosio_assert( !st.enforce_whitelist || from.whitelist, "account is not white listed" );
   //如果没有被操作账户的授权,检查是否有发币者的授权
   } else if( has_auth( st.issuer ) ) {
      //如果有发币者的授权,那么肯定是在召回代币,查看代币是否可以召回
      eosio_assert( st.can_recall, "issuer may not recall token" );
   } else {
      //如果两种授权都没有,则失败,没有足够的权限
      eosio_assert( false, "insufficient authority" );
   }
   //通过 Lambda 表达式(匿名函数)修改将代币结构体
   from_acnts.modify( from, owner, [&]( auto& a ) {
      //匿名函数 函数体   
       a.balance -= value;
   });
}

add_balance(增加资产)函数

作用:从指定账户中增加资产
参数:被操作账户,资产数,资产状态,存储资源支付账户

//                   参数:被操作账户         代币数量      代币状态结构体             储存支付账户
void token::add_balance( account_name owner, asset value, const currency_stats& st, account_name ram_payer )
{
   //建立一个 multi_index,用来操作数据库
   accounts to_acnts( _self, owner );
   //在数据表中查询要增加的代币结构体
   auto to = to_acnts.find( value.symbol.name() );
   //如果 to == to_acnts.end(),说明查找到数据表的末尾都没有对应的结构体,说明该账户没有该代币
   if( to == to_acnts.end() ) {
      //校验,该代币是否开启了白名单功能
      eosio_assert( !st.enforce_whitelist, "can only transfer to white listed accounts" );
      //使用 emplace 方法,在数据表中增加一项
      to_acnts.emplace( ram_payer, [&]( auto& a ){
        //匿名函数体,代币数量等于每次转入的数量,因为之前没有
        a.balance = value;
      });
      //如果数据表中已经存在此项,只需增加代币数量
   } else {
      //检查账户是否在白名单中
      eosio_assert( !st.enforce_whitelist || to->whitelist, "receiver requires whitelist by issuer" );
      //使用 modify 方法,修改项目
      to_acnts.modify( to, 0, [&]( auto& a ) {
        //直接修改代币数量
        a.balance += value;
      });
   }
}

公有函数

EOS 合约中的公有函数大多是供别的账户调用的 Action,根据 hpp 文件,我们需要实现 create、issue、transfer 三个公有函数(action)。

create(新建代币)函数

create 函数用来创建一种新的代币,并设置这种新代币的各种参数。

                    //参数:发币账户
void token::create( account_name issuer,
                    //最大发行量
                    asset        maximum_supply,
                    //发币者是否可以冻结代币
                    uint8_t      issuer_can_freeze,
                    //发币者是否可以召回代币
                    uint8_t      issuer_can_recall,
                    //是否可以设置白名单
                    uint8_t      issuer_can_whitelist )
{
    //需要 eosio.token 账户本身的授权
    require_auth( _self );
    
    auto sym = maximum_supply.symbol;
    //校验,新代币名称是否有效
    eosio_assert( sym.is_valid(), "invalid symbol name" );
    //校验,最大发行量是否有效
    eosio_assert( maximum_supply.is_valid(), "invalid supply");
    //校验,最大发行量是否大于零
    eosio_assert( maximum_supply.amount > 0, "max-supply must be positive");
    
    //建立一个 milti_index 数据表,用来与数据库交互
    stats statstable( _self, sym.name() );
    //在表中搜索相同名称的代币
    auto existing = statstable.find( sym.name() );
    //校验,是否已经存在相同名称的代币
    eosio_assert( existing == statstable.end(), "token with symbol already exists" );
    
    //使用 emplace 方法,在数据表中增加一项
    statstable.emplace( _self, [&]( auto& s ) {
       // 使用匿名函数,将传入的参数赋值给 currency_stats 结构体
       s.supply.symbol = maximum_supply.symbol;
       s.max_supply    = maximum_supply;
       s.issuer        = issuer;
       s.can_freeze    = issuer_can_freeze;
       s.can_recall    = issuer_can_recall;
       s.can_whitelist = issuer_can_whitelist;
    });
}

transfer(转账)函数

transfer 应该是这个智能合约最常用的函数,就是将代币从一个账户转到另一个。

                    //转出方账户名
void token::transfer( account_name from,
                    //转入方账户名
                      account_name to,
                    //代币种类与数量
                      asset        quantity,
                    //转账备忘(目前还没实现)
                      string       /*memo*/ )
{
    //打印转账提示
    print( "transfer" );
    //检查转出方权限
    require_auth( from );
    //得到代币名称
    auto sym = quantity.symbol.name();

    //建立一个 milti_index 数据表,用来与数据库交互
    stats statstable( _self, sym );
    //在数据表中寻找代币的 currency_stats 结构体
    const auto& st = statstable.get( sym );

    //向转出方获取回执
    require_recipient( from );
    //向转入方获取回执
    require_recipient( to );
    
    //校验,转出的代币是否有效
    eosio_assert( quantity.is_valid(), "invalid quantity" );
    //校验,转账数量要大于0
    eosio_assert( quantity.amount > 0, "must transfer positive quantity" );
    
    //调用 sub_balance 私有方法
    sub_balance( from, quantity, st );
    //调用 add_balance 私有方法
    add_balance( to, quantity, st, from );
}

issue(发币)函数

上面的 create 函数创建代币后只是给定了参数,并没有真正的代币被创建出来,需要 issue 函数进行发币。

                //参数:代币接收方     代币数量和种类      备忘
void token::issue( account_name to, asset quantity, string memo )
{
    //打印提示
    print( "issue" );
    //获取代币名称
    auto sym = quantity.symbol.name();
    //建立一个 milti_index 数据表,用来与数据库交互
    stats statstable( _self, sym );
    //在数据表中搜索代币 currency_stats 结构体
    const auto& st = statstable.get( sym );
    
    //检查发币者授权
    require_auth( st.issuer );
    //检查资产是否有效
    eosio_assert( quantity.is_valid(), "invalid quantity" );
    //检查资产是否大于零
    eosio_assert( quantity.amount > 0, "must issue positive quantity" );
    //检查创造的总资产是否大于最大代币数
    eosio_assert( quantity <= st.max_supply - st.supply, "quantity exceeds available supply");
    
    //更新资产创造数量记录
    statstable.modify( st, 0, [&]( auto& s ) {
       s.supply += quantity;
    });
    
    //给发布者增加资产
    add_balance( st.issuer, quantity, st, st.issuer );
    
    //判断代币接受方是否是发币者
    if( to != st.issuer )
    {
        //这里使用了一个特殊处理,先给发币者增加相应的代币,再调用 transfer 函数转账给代币接受方。
        //这样做的目的是让代币接受方收到通知
       SEND_INLINE_ACTION( *this, transfer, {st.issuer,N(active)}, {st.issuer, to, quantity, memo} );
    }
}

设置 action

大家知道 EOS 系统的智能合约是以 action 为基本动作单位的,我们要将需要声明为 action 的函数告知 EOS 系统,通过以下宏即可实现。

//将 create issue transfer 三个共有函数声明为 action,供其他账户调用。
EOSIO_ABI( eosio::token, (create)(issue)(transfer) )
相关文章
|
2月前
|
存储 设计模式 算法
【23种设计模式·全精解析 | 行为型模式篇】11种行为型模式的结构概述、案例实现、优缺点、扩展对比、使用场景、源码解析
行为型模式用于描述程序在运行时复杂的流程控制,即描述多个类或对象之间怎样相互协作共同完成单个对象都无法单独完成的任务,它涉及算法与对象间职责的分配。行为型模式分为类行为模式和对象行为模式,前者采用继承机制来在类间分派行为,后者采用组合或聚合在对象间分配行为。由于组合关系或聚合关系比继承关系耦合度低,满足“合成复用原则”,所以对象行为模式比类行为模式具有更大的灵活性。 行为型模式分为: • 模板方法模式 • 策略模式 • 命令模式 • 职责链模式 • 状态模式 • 观察者模式 • 中介者模式 • 迭代器模式 • 访问者模式 • 备忘录模式 • 解释器模式
【23种设计模式·全精解析 | 行为型模式篇】11种行为型模式的结构概述、案例实现、优缺点、扩展对比、使用场景、源码解析
|
2月前
|
NoSQL Java Linux
《docker高级篇(大厂进阶):2.DockerFile解析》包括:是什么、DockerFile构建过程解析、DockerFile常用保留字指令、案例、小总结
《docker高级篇(大厂进阶):2.DockerFile解析》包括:是什么、DockerFile构建过程解析、DockerFile常用保留字指令、案例、小总结
282 75
|
2月前
|
存储 监控 调度
云服务器成本优化深度解析与实战案例
本文深入探讨了云服务器成本优化的策略与实践,涵盖基本原则、具体策略及案例分析。基本原则包括以实际需求为导向、动态调整资源、成本控制为核心。具体策略涉及选择合适计费模式、优化资源配置、存储与网络配置、实施资源监控与审计、应用性能优化、利用优惠政策及考虑多云策略。文章还通过电商、制造企业和初创团队的实际案例,展示了云服务器成本优化的有效性,最后展望了未来的发展趋势,包括智能化优化、多云管理和绿色节能。
|
3月前
|
存储 人工智能 自然语言处理
高效档案管理案例介绍:文档内容批量结构化解决方案解析
档案文件内容丰富多样,传统人工管理耗时低效。思通数科AI平台通过自动布局分析、段落与标题检测、表格结构识别、嵌套内容还原及元数据生成等功能,实现档案的高精度分块处理和结构化存储,大幅提升管理和检索效率。某历史档案馆通过该平台完成了500万页档案的数字化,信息检索效率提升60%。
|
3月前
|
Prometheus 监控 Cloud Native
实战经验:成功的DevOps实施案例解析
实战经验:成功的DevOps实施案例解析
131 6
|
4月前
|
安全 Java
Java多线程通信新解:本文通过生产者-消费者模型案例,深入解析wait()、notify()、notifyAll()方法的实用技巧
【10月更文挑战第20天】Java多线程通信新解:本文通过生产者-消费者模型案例,深入解析wait()、notify()、notifyAll()方法的实用技巧,包括避免在循环外调用wait()、优先使用notifyAll()、确保线程安全及处理InterruptedException等,帮助读者更好地掌握这些方法的应用。
44 1
|
4月前
|
数据格式
常用的Lambda表达式案例解析,工作中都会用到!
常用的Lambda表达式案例解析,工作中都会用到!
|
1月前
|
自然语言处理 数据处理 索引
mindspeed-llm源码解析(一)preprocess_data
mindspeed-llm是昇腾模型套件代码仓,原来叫"modelLink"。这篇文章带大家阅读一下数据处理脚本preprocess_data.py(基于1.0.0分支),数据处理是模型训练的第一步,经常会用到。
53 0
|
2月前
|
设计模式 存储 安全
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
结构型模式描述如何将类或对象按某种布局组成更大的结构。它分为类结构型模式和对象结构型模式,前者采用继承机制来组织接口和类,后者釆用组合或聚合来组合对象。由于组合关系或聚合关系比继承关系耦合度低,满足“合成复用原则”,所以对象结构型模式比类结构型模式具有更大的灵活性。 结构型模式分为以下 7 种: • 代理模式 • 适配器模式 • 装饰者模式 • 桥接模式 • 外观模式 • 组合模式 • 享元模式
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
|
2月前
|
设计模式 存储 安全
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
创建型模式的主要关注点是“怎样创建对象?”,它的主要特点是"将对象的创建与使用分离”。这样可以降低系统的耦合度,使用者不需要关注对象的创建细节。创建型模式分为5种:单例模式、工厂方法模式抽象工厂式、原型模式、建造者模式。
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析

热门文章

最新文章

推荐镜像

更多