fabric-contract-api-go快速上手

hi,好久没有更新Fabric相关文章,今天给大家带来fabric-contract-api-go快速上手,相较于原文省略较多,希望深入理解的小伙伴可以点原文学习。

背景

Fabric提供了大量的API来开发智能合约,支持 Go, Node.js, 和Java。本文对fabric-contract-api-go进行简单梳理,可以使读者快速上手。

原文:https://github.com/hyperledger/fabric-contract-api-go/blob/main/tutorials/getting-started.md

一、环境准备

装好Docker、Go的ubuntu,版本尽量新一点。详细请参考原文。

二、contractapi 简述

contractapi 通过打包一个或多个合约打包成一个chaincode(链码),在链码中使用的合约需要实现 contractapi.ContractInterface接口(实现接口相当于继承其中的方法与属性),最简单的方式就是在我们自己创建的合约中嵌入contractapi.Contract结构体。代码示例:

go 复制代码
package main
import (
    "errors"
    "fmt"

    "github.com/hyperledger/fabric-contract-api-go/contractapi"
)
// SimpleContract contract for handling writing and reading from the world state
type SimpleContract struct {
    contractapi.Contract
}
三、合约函数编写的一些规则

合约仅可以返回0个、1个或2个值。0个值的情况下,所有调用都返回成功;1个值的情况下可以返回规定中的任意类型或error;2个值的情况下,第一个值是数据,第二个值是error。

四、Create合约函数解释

Create函数可以在Fabric的world state中存储键值对。因为需要和world state交互,我们需要传入交易的上下文,在示例代码中使用了默认的contractapi.TransactionContextInterfaceTransactionContextInterface是一个接口类型,实现该接口的交易上下文可以传入。然后交易上下文获取

go 复制代码
// Create adds a new key with value to the world state
func (sc *SimpleContract) Create(ctx contractapi.TransactionContextInterface, key string, value string) error {
    existing, err := ctx.GetStub().GetState(key)

    if err != nil {
        return errors.New("Unable to interact with world state")
    }

    if existing != nil {
        return fmt.Errorf("Cannot create world state pair with key %s. Already exists", key)
    }

    err = ctx.GetStub().PutState(key, []byte(value))

    if err != nil {
        return errors.New("Unable to interact with world state")
    }

    return nil
}

附上package shim的官方解释:

复制代码
// Package shim provides APIs for the chaincode to access its state
// variables, transaction context and call other chaincodes.

stub的官方解释:

复制代码
// ChaincodeStub is an object passed to chaincode for shim side handling of
// APIs.

个人理解:我们在编写合约时使用stub来对账本进行操作,shim提供了API进行实际的操作,即链码与peer节点之间的通信。

五、完整的合约:
go 复制代码
package main

import (
    "errors"
    "fmt"

    "github.com/hyperledger/fabric-contract-api-go/contractapi"
)

// SimpleContract contract for handling writing and reading from the world state
type SimpleContract struct {
    contractapi.Contract
}

// Create adds a new key with value to the world state
func (sc *SimpleContract) Create(ctx contractapi.TransactionContextInterface, key string, value string) error {
    existing, err := ctx.GetStub().GetState(key)

    if err != nil {
        return errors.New("Unable to interact with world state")
    }

    if existing != nil {
        return fmt.Errorf("Cannot create world state pair with key %s. Already exists", key)
    }

    err = ctx.GetStub().PutState(key, []byte(value))

    if err != nil {
        return errors.New("Unable to interact with world state")
    }

    return nil
}

// Update changes the value with key in the world state
func (sc *SimpleContract) Update(ctx contractapi.TransactionContextInterface, key string, value string) error {
    existing, err := ctx.GetStub().GetState(key)

    if err != nil {
        return errors.New("Unable to interact with world state")
    }

    if existing == nil {
        return fmt.Errorf("Cannot update world state pair with key %s. Does not exist", key)
    }

    err = ctx.GetStub().PutState(key, []byte(value))

    if err != nil {
        return errors.New("Unable to interact with world state")
    }

    return nil
}

// Read returns the value at key in the world state
func (sc *SimpleContract) Read(ctx contractapi.TransactionContextInterface, key string) (string, error) {
    existing, err := ctx.GetStub().GetState(key)

    if err != nil {
        return "", errors.New("Unable to interact with world state")
    }

    if existing == nil {
        return "", fmt.Errorf("Cannot read world state pair with key %s. Does not exist", key)
    }

    return string(existing), nil
}
六、使用合约

在同一个文件夹中创建一个main.go,添加main函数。通过 contractapi.NewChaincode()方法使用先前的合约创建出来一个chaincode。

go 复制代码
package main

import (
    "github.com/hyperledger/fabric-contract-api-go/contractapi"
)

func main() {
    simpleContract := new(SimpleContract)

    cc, err := contractapi.NewChaincode(simpleContract)

    if err != nil {
        panic(err.Error())
    }

    if err := cc.Start(); err != nil {
        panic(err.Error())
    }
}
相关推荐
joker_zsl4 分钟前
docker的安装和简单使用(ubuntu环境)
运维·docker·容器
Run1.21 分钟前
深入解析 Linux 中动静态库的加载机制:从原理到实践
linux·运维·服务器
VI8664956I2621 分钟前
全链路自动化AIGC内容工厂:构建企业级智能内容生产系统
运维·自动化·aigc
Yeats_Liao1 小时前
Go 语言 TCP 端口扫描器实现与 Goroutine 池原理
开发语言·tcp/ip·golang
我的golang之路果然有问题1 小时前
速成GO访问sql,个人笔记
经验分享·笔记·后端·sql·golang·go·database
264玫瑰资源库2 小时前
斗鱼娱乐电玩平台源码搭建实录
运维·服务器·游戏·娱乐
Jogging-Snail2 小时前
从零开始掌握Linux数据流:管道与重定向完全指南
linux·运维·管道·重定向·linux 数据流·管道原理
niuTaylor2 小时前
Linux驱动开发快速上手指南:从理论到实战
linux·运维·开发语言·驱动开发·c#
fxshy3 小时前
ai聊天流式响应,阻塞式和流式响应 nginx遇到的坑
运维·javascript·nginx
mit6.8243 小时前
[OS_8] 终端和 UNIX Shell | 会话和进程组 | sigaction | dash
运维·服务器