长安链使用Golang编写智能合约教程(一)

2024-05-26 14:44

本文主要是介绍长安链使用Golang编写智能合约教程(一),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

编写前的注意事项:

1、运行一条带有Doker_GoVM的链

2、建议直接用官方的在线IDE去写合约,因为写完可以直接测,缺点只是调试不方便。

3、自己拉环境在本地写合约,编译时注意编译环境,官方有提醒你去Linux下去编译。


本教程使用官方的在线IDE去写合约

教程是基于官方文档写的,只是会多写一些解析步骤


1、首先新建一个合约

2、打开main.go文件(这是新增工程的默认存证模板)

package mainimport ("encoding/json""log""strconv""chainmaker/pb/protogo""chainmaker/shim"
)//FactContract 合约对象
type FactContract struct {
}//Fact 存证对象,存证合约的数据内容
type Fact struct {FileHash string FileName string Time     int
}//NewFact 新建存证对象
func NewFact(fileHash, fileName string, time int) *Fact {return &Fact{FileHash: fileHash,FileName: fileName,Time:     time,}
}//InitContract 合约初始化方法
func (f *FactContract) InitContract(stub shim.CMStubInterface) protogo.Response {return shim.Success([]byte("Init Success"))
}// UpgradeContract 合约升级方法
func (f *FactContract) UpgradeContract(stub shim.CMStubInterface) protogo.Response {return shim.Success([]byte("Upgrade Success"))
}//InvokeContract 调用合约
func (f *FactContract) InvokeContract(stub shim.CMStubInterface) protogo.Response {//获取调用合约哪个方法method := string(stub.GetArgs()["method"])// 这里必须写成 switch {case "a": ... [case "b": ...[...]] default:...} 形式// 而且case后面的内容必须是字符串,不能是常量// 这里必须写成 switch {case "a": ... [case "b": ...[...]] default:...} 形式// 而且case后面的内容必须是字符串,不能是常量// 这里必须写成 switch {case "a": ... [case "b": ...[...]] default:...} 形式// 而且case后面的内容必须是字符串,不能是常量// 如果 method == "save", 执行FactContract的save方法// 如果 method == "findByFileHash", 执行FactContract的findByFileHash方法// 如果没有对应的 case 语句,返回错误switch method {case "save":return f.Save(stub)case "findByFileHash":return f.FindByFileHash(stub)default:return shim.Error("invalid method")}
}//save 存证,把数据存储到链上
func (f *FactContract) Save(stub shim.CMStubInterface) protogo.Response {// 获取调用合约的全部参数params := stub.GetArgs()// 获取指定的参数fileHash := string(params["file_hash"])fileName := string(params["file_name"])timeStr := string(params["time"])if fileHash == "" || fileName == "" || timeStr == "" {//返回合约执行错误,以及错误信息return shim.Error("fileHash and fileName and time must not empty")}time, err := strconv.Atoi(timeStr)if err != nil {msg := "time is [" + timeStr + "] not int"// 打印日志,使用 stub.Log 打印的日志会在控制台的输出中显示stub.Log(msg + err.Error())//返回合约执行错误,以及错误信息return shim.Error(msg)}fact := NewFact(fileHash, fileName, time)// 序列化factBytes, err := json.Marshal(fact)if err != nil {msg := "marshal data fail"stub.Log(msg + err.Error())return shim.Error(msg)}//向链上发送事件,发送的事件会在控制台的事件中显示stub.EmitEvent("topic_vx", []string{fact.FileHash, fact.FileName})key := getHashKey(fact.FileHash)//把数据存到链上err = stub.PutStateFromKeyByte(key, factBytes)if err != nil {msg := "fail to save fact"stub.Log(msg + err.Error())return shim.Error(msg)}//打印日志,使用 stub.Log 打印的日志会在控制台的输出中显示stub.Log("[save] file hash:" + fact.FileHash)stub.Log("[save] file name:" + fact.FileName)// 返回执行成功return shim.Success([]byte(fact.FileName + fact.FileHash))}//findByFileHash 根据文件哈希从链上查找数据
func (f *FactContract) FindByFileHash(stub shim.CMStubInterface) protogo.Response {// 获取调用合约的全部参数params := stub.GetArgs()// 获取指定参数fileHash := string(params["file_hash"])// 查询结果key := getHashKey(fileHash)result, err := stub.GetStateFromKeyByte(key)if err != nil {msg := "failed to call get_state"// 打印日志,使用 stub.Log 打印的日志会在控制台的输出中显示stub.Log(msg + err.Error())//返回合约执行错误,以及错误信息return shim.Error(msg)}// 反序列化var fact Facterr = json.Unmarshal(result, &fact)if err != nil {msg := "unmarshal data fail"stub.Log(msg + err.Error())return shim.Error(msg)}// 记录日志stub.Log("[find_by_file_hash] file hash:" + fact.FileHash)stub.Log("[find_by_file_hash] file name:" + fact.FileName)// 返回执行成功return shim.Success(result)}func getHashKey(hash string) string {return "fact_hash" + hash
}func main() {//运行合约err := shim.Start(new(FactContract))if err != nil {log.Fatal(err)}
}

3、模板解析

17行:Fact结构体就是要存在区块链中的,根据你自己的需要去变更结构体的字段

//Fact 存证对象,存证合约的数据内容
type Fact struct {
    FileHash string 
    FileName string 
    Time     int
}

 24行:新建存证对象,根据Fact 结构体的变化而变化

//NewFact 新建存证对象

func NewFact(fileHash, fileName string, time int) *Fact {
    return &Fact{
        FileHash: fileHash,
        FileName: fileName,
        Time:     time,
    }
}

InitContract、UpgradeContract、InvokeContract  三个方法解析

  • InitContract、UpgradeContract:这是合约默认必须要有的方法,不要动。如果你在13行把对应合约对象的名称改了,对应你在方法名前的名称也要改成一致。
  • InvokeContract:这里是合约方法、根据你写了几个方法,依葫芦画瓢,继续补充就行。

//InitContract 合约初始化方法
func (f *FactContract) InitContract(stub shim.CMStubInterface) protogo.Response {
    return shim.Success([]byte("Init Success"))
}

// UpgradeContract 合约升级方法
func (f *FactContract) UpgradeContract(stub shim.CMStubInterface) protogo.Response {
    return shim.Success([]byte("Upgrade Success"))
}

//InvokeContract 调用合约
func (f *FactContract) InvokeContract(stub shim.CMStubInterface) protogo.Response {

//获取调用合约哪个方法
    method := string(stub.GetArgs()["method"])
    switch method {
    case "save":
        return f.Save(stub)
    case "findByFileHash":
        return f.FindByFileHash(stub)
    default:
        return shim.Error("invalid method")
    }
}

存证方法

以下大部分依葫芦画瓢就好了,重点关注以下内容:

  • 105行:key := getHashKey(fact.FileHash)  这是模板自定义的方法,在字符串前拼接一段字符,不必理会;
  • 108行:err = stub.PutStateFromKeyByte(key, factBytes),这就是最重要的将数据上链的方法!   其中 key相当于id值,你之后查的话就要根据key去查。(别忘了模板中在105行给key前加了一段字符,你查的时候也要加上)      关于上链的方法官方还提供了其他几种。
  • stub.Log  :都是可以输出在控制台上的,方便调试排查错误,可写可不写;
  • 120行,返回值要遵从官方的这个格式。

//save 存证,把数据存储到链上
func (f *FactContract) Save(stub shim.CMStubInterface) protogo.Response {
    // 获取调用合约的全部参数
    params := stub.GetArgs()

    // 获取指定的参数
    fileHash := string(params["file_hash"])
    fileName := string(params["file_name"])
    timeStr := string(params["time"])

    if fileHash == "" || fileName == "" || timeStr == "" {
        //返回合约执行错误,以及错误信息
        return shim.Error("fileHash and fileName and time must not empty")
    }

    time, err := strconv.Atoi(timeStr)
    if err != nil {
        msg := "time is [" + timeStr + "] not int"
        // 打印日志,使用 stub.Log 打印的日志会在控制台的输出中显示
        stub.Log(msg + err.Error())
        //返回合约执行错误,以及错误信息
        return shim.Error(msg)
    }

    fact := NewFact(fileHash, fileName, time)

    // 序列化
    factBytes, err := json.Marshal(fact)
    if err != nil {
        msg := "marshal data fail"
        stub.Log(msg + err.Error())
        return shim.Error(msg)
    }

    //向链上发送事件,发送的事件会在控制台的事件中显示
    stub.EmitEvent("topic_vx", []string{fact.FileHash, fact.FileName})

    key := getHashKey(fact.FileHash)

    //把数据存到链上
    err = stub.PutStateFromKeyByte(key, factBytes)
    if err != nil {
        msg := "fail to save fact"
        stub.Log(msg + err.Error())
        return shim.Error(msg)
    }

    //打印日志,使用 stub.Log 打印的日志会在控制台的输出中显示
    stub.Log("[save] file hash:" + fact.FileHash)
    stub.Log("[save] file name:" + fact.FileName)

    // 返回执行成功
    return shim.Success([]byte(fact.FileName + fact.FileHash))

}

取证方法

以下大部分依葫芦画瓢就好了,重点关注以下内容:

  • 133行:这里就是去拼接了字符串
  • 134行:取证的方法:stub.GetStateFromKeyByte(key)  ,返回的result是byte[ ]类型
  • 145行:反序列化
  • 157行:返回值遵从官方规范。

//findByFileHash 根据文件哈希从链上查找数据
func (f *FactContract) FindByFileHash(stub shim.CMStubInterface) protogo.Response {
    // 获取调用合约的全部参数
    params := stub.GetArgs()

    // 获取指定参数
    fileHash := string(params["file_hash"])

    // 查询结果
    key := getHashKey(fileHash)
    result, err := stub.GetStateFromKeyByte(key)
    if err != nil {
        msg := "failed to call get_state"
        // 打印日志,使用 stub.Log 打印的日志会在控制台的输出中显示
        stub.Log(msg + err.Error())
        //返回合约执行错误,以及错误信息
        return shim.Error(msg)
    }

    // 反序列化
    var fact Fact
    err = json.Unmarshal(result, &fact)
    if err != nil {
        msg := "unmarshal data fail"
        stub.Log(msg + err.Error())
        return shim.Error(msg)
    }

    // 记录日志
    stub.Log("[find_by_file_hash] file hash:" + fact.FileHash)
    stub.Log("[find_by_file_hash] file name:" + fact.FileName)

    // 返回执行成功
    return shim.Success(result)

}

其他

这就是前面说的拼接字符串的方法,他在hash前加了“fact_hash”

func getHashKey(hash string) string {
    return "fact_hash" + hash
}

2、代码入口包名必须为main  (注意事项在注释中)

// sdk代码中,有且仅有一个main()方法
func main() {  // main()方法中,下面的代码为必须代码,不建议修改main()方法当中的代码// 其中,FactContract为用户实现合约的具体名称err := sandbox.Start(new(FactContract))if err != nil {log.Fatal(err)}
}




4、在官方模板上新增一个查询历史记录的方法

注意:

1、之前的合约是根据Key ,去进行存证、取证的。这个key和数据库中的唯一主键不同,在区块链中,你可以通过key 去多次存证,比如说你可以存  {key:1 ,value:2},{key:1 ,value:3},{key:1 ,value:4}

2、假设你用存证方法,存储了1中说的三条数据,你调用取证方法,只会返回最近最新的一条数据{key:1 ,value:4},这是因为联盟链中 有一个状态数据库和一个历史数据库,取证方法调用的是GetStateFromKeyByte()方法,他只会去状态数据库中查。

3、如果你想要查询出当时存证时输入key=1的所有存证记录,那么就要调用NewHistoryKvIterForKey()方法,官方的存证合约并没有这个方法,现在进行一步步补充。

我去,长安链时是分2.1.+和2.3.+两个版本,上面说的是2.1.+

算了,不写了,我用的是2.3.+   ,抽时间写个2.3.+的教程

 

这篇关于长安链使用Golang编写智能合约教程(一)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1004758

相关文章

Python pandas库自学超详细教程

《Pythonpandas库自学超详细教程》文章介绍了Pandas库的基本功能、安装方法及核心操作,涵盖数据导入(CSV/Excel等)、数据结构(Series、DataFrame)、数据清洗、转换... 目录一、什么是Pandas库(1)、Pandas 应用(2)、Pandas 功能(3)、数据结构二、安

Python使用Tenacity一行代码实现自动重试详解

《Python使用Tenacity一行代码实现自动重试详解》tenacity是一个专为Python设计的通用重试库,它的核心理念就是用简单、清晰的方式,为任何可能失败的操作添加重试能力,下面我们就来看... 目录一切始于一个简单的 API 调用Tenacity 入门:一行代码实现优雅重试精细控制:让重试按我

MySQL中EXISTS与IN用法使用与对比分析

《MySQL中EXISTS与IN用法使用与对比分析》在MySQL中,EXISTS和IN都用于子查询中根据另一个查询的结果来过滤主查询的记录,本文将基于工作原理、效率和应用场景进行全面对比... 目录一、基本用法详解1. IN 运算符2. EXISTS 运算符二、EXISTS 与 IN 的选择策略三、性能对比

使用Python构建智能BAT文件生成器的完美解决方案

《使用Python构建智能BAT文件生成器的完美解决方案》这篇文章主要为大家详细介绍了如何使用wxPython构建一个智能的BAT文件生成器,它不仅能够为Python脚本生成启动脚本,还提供了完整的文... 目录引言运行效果图项目背景与需求分析核心需求技术选型核心功能实现1. 数据库设计2. 界面布局设计3

使用IDEA部署Docker应用指南分享

《使用IDEA部署Docker应用指南分享》本文介绍了使用IDEA部署Docker应用的四步流程:创建Dockerfile、配置IDEADocker连接、设置运行调试环境、构建运行镜像,并强调需准备本... 目录一、创建 dockerfile 配置文件二、配置 IDEA 的 Docker 连接三、配置 Do

全面解析Golang 中的 Gorilla CORS 中间件正确用法

《全面解析Golang中的GorillaCORS中间件正确用法》Golang中使用gorilla/mux路由器配合rs/cors中间件库可以优雅地解决这个问题,然而,很多人刚开始使用时会遇到配... 目录如何让 golang 中的 Gorilla CORS 中间件正确工作一、基础依赖二、错误用法(很多人一开

Android Paging 分页加载库使用实践

《AndroidPaging分页加载库使用实践》AndroidPaging库是Jetpack组件的一部分,它提供了一套完整的解决方案来处理大型数据集的分页加载,本文将深入探讨Paging库... 目录前言一、Paging 库概述二、Paging 3 核心组件1. PagingSource2. Pager3.

python使用try函数详解

《python使用try函数详解》Pythontry语句用于异常处理,支持捕获特定/多种异常、else/final子句确保资源释放,结合with语句自动清理,可自定义异常及嵌套结构,灵活应对错误场景... 目录try 函数的基本语法捕获特定异常捕获多个异常使用 else 子句使用 finally 子句捕获所

C++11右值引用与Lambda表达式的使用

《C++11右值引用与Lambda表达式的使用》C++11引入右值引用,实现移动语义提升性能,支持资源转移与完美转发;同时引入Lambda表达式,简化匿名函数定义,通过捕获列表和参数列表灵活处理变量... 目录C++11新特性右值引用和移动语义左值 / 右值常见的左值和右值移动语义移动构造函数移动复制运算符

Python对接支付宝支付之使用AliPay实现的详细操作指南

《Python对接支付宝支付之使用AliPay实现的详细操作指南》支付宝没有提供PythonSDK,但是强大的github就有提供python-alipay-sdk,封装里很多复杂操作,使用这个我们就... 目录一、引言二、准备工作2.1 支付宝开放平台入驻与应用创建2.2 密钥生成与配置2.3 安装ali