Hyperledger Fabric v2.x基础网络开发-API篇

Alan

4 年前

Fabric SDK

与Fabric网络交互
- fabric-client：已淘汰，v1.4中使用它开发的客户端仍可与 v2.x 进行交互但无法使用 v2.x的新功能
- fabric-network：推荐使用
管理和治理
- fabric-client 中的 tx api 由 fabric-common 取代
- fabric-client 中的链码管理 api 由fabric-admin 取代

header+payload+signature

本文中的代码参见：https://github.com/alanhou/blockchain/tree/main/fabric-network

api-v1.4

cd api-v1.4
npm install

1 2	cd api-v1.4 npm install

注册用户

通过向 http://localhost:4000/users 提交 post 请求即可注册用户（首次注册会默认注册一个 admin），并在crypto和fabric-client-kv-xxx 中生成相应的文件：

此时获取的 token 用作稍后请求时携带的 JWT 参数

交易调用

示例：POST http://192.168.xx.xxx:4000/channels/mychannel/chaincodes/fabcar

BODY（通过修改参数中最后一个字段即相关将所有权转让）

{
    "fcn": "createCar",
    "peers": ["peer0.org1.alanhou.org", "peer0.org2.alanhou.org"],
    "chaincodeName": "fabcar",
    "channelName": "mychannel",
    "args": ["SuperCar", "Tesla", "F1-Reloaded", "White", "John"]
}

{

"fcn": "createCar",

"peers": ["peer0.org1.alanhou.org", "peer0.org2.alanhou.org"],

"chaincodeName": "fabcar",

"channelName": "mychannel",

"args": ["SuperCar", "Tesla", "F1-Reloaded", "White", "John"]

}

RESPONSE

{
    "result": {
        "tx_id": "8a0f304a92f81c3411c1ae5019982f4e79a318a4d4efe788277e156fb1590882"
    },
    "error": null,
    "errorData": null
}

{

"result": {

"tx_id": "8a0f304a92f81c3411c1ae5019982f4e79a318a4d4efe788277e156fb1590882"

"error": null,

"errorData": null

}

根据 id 查询内容

示例： GET http://192.168.xx.xxx:4000/channels/mychannel/chaincodes/fabcar?args=%5B“SuperCar”%5D&peer=peer0.org1.alanhou.org&fcn=queryCar

RESPONSE

{
    "make": "Tesla",
    "model": "F1-Reloaded",
    "colour": "White",
    "owner": "John"
}

{

"make": "Tesla",

"model": "F1-Reloaded",

"colour": "White",

"owner": "John"

}

交易更新操作

示例：POST http://192.168.xx.xxx:4000/channels/mychannel/chaincodes/fabcar

BODY

{
    "fcn": "changeCarOwner",
    "peers": ["peer0.org1.alanhou.org", "peer0.org2.alanhou.org"],
    "chaincodeName": "fabcar",
    "channelName": "mychannel",
    "args": ["SuperCar", "Jasmine"]
}

{

"fcn": "changeCarOwner",

"peers": ["peer0.org1.alanhou.org", "peer0.org2.alanhou.org"],

"chaincodeName": "fabcar",

"channelName": "mychannel",

"args": ["SuperCar", "Jasmine"]

}

RESPONSE

{
    "result": {
        "tx_id": "921c7a68cb2355b5c30e3d22f27ab9d51c0a2dadbeae28225f94b3e624995f8e"
    },
    "error": null,
    "errorData": null
}

{

"result": {

"tx_id": "921c7a68cb2355b5c30e3d22f27ab9d51c0a2dadbeae28225f94b3e624995f8e"

"error": null,

"errorData": null

}

根据交易id 查询交易内容

示例： GET http://192.168.xx.xxx:4000/channels/mychannel/transactions/921c7a68cb2355b5c30e3d22f27ab9d51c0a2dadbeae28225f94b3e624995f8e?peer=peer0.org1.alanhou.org

RESPONSE

根据区块编号查询区块内容

示例： GET http://192.168.xx.xxx:4000/channels/mychannel/blocks/6?peer=peer0.org1.alanhou.org

RESPONSE

查询资产历史交易

示例： GET http://192.168.xx.xxx:4000/channels/mychannel/chaincodes/fabcar?args=%5B“SuperCar”%5D&peer=peer0.org1.alanhou.org&fcn=getHistoryForAsset

RESPONSE

[
    {
        "TxId": "5abf48773fbcc6a4d148ab71b326234041636cebfe2b9de1e2ad20717bf51b2f",
        "Value": {
            "make": "Tesla",
            "model": "F1-Reloaded",
            "colour": "White",
            "owner": "Jasmine"
        },
        "Timestamp": "2021-05-10 13:07:00.941 +0000 UTC",
        "IsDelete": "false"
    },
    {
        "TxId": "9761cb2c6648ce8557cfae3db840870e2dddae6399e6a62e06447d7e5cee9a54",
        "Value": {
            "make": "Tesla",
            "model": "F1-Reloaded",
            "colour": "White",
            "owner": "John"
        },
        "Timestamp": "2021-05-10 13:03:33.06 +0000 UTC",
        "IsDelete": "false"
    }
]

[

{

"TxId": "5abf48773fbcc6a4d148ab71b326234041636cebfe2b9de1e2ad20717bf51b2f",

"Value": {

"make": "Tesla",

"model": "F1-Reloaded",

"colour": "White",

"owner": "Jasmine"

"Timestamp": "2021-05-10 13:07:00.941 +0000 UTC",

"IsDelete": "false"

{

"TxId": "9761cb2c6648ce8557cfae3db840870e2dddae6399e6a62e06447d7e5cee9a54",

"Value": {

"make": "Tesla",

"model": "F1-Reloaded",

"colour": "White",

"owner": "John"

"Timestamp": "2021-05-10 13:03:33.06 +0000 UTC",

"IsDelete": "false"

}

]

Composite Key

首先使用同一个人多次调用 createCar（之后再调用 changeCarOwner 不受影响）

示例： GET http://192.168.xx.xxx:4000/channels/mychannel/chaincodes/fabcar?args=%5B“John”%5D&peer=peer0.org1.alanhou.org&fcn=queryCarsByOwner

RESPONSE

[
    {
        "make": "Tesla",
        "model": "F1-Reloaded",
        "colour": "White",
        "owner": "Jasmine"
    },
    {
        "colour": "White",
        "make": "Tesla",
        "model": "F1-Reloaded",
        "owner": "John"
    },
    {
        "colour": "White",
        "make": "Tesla",
        "model": "F1-Reloaded",
        "owner": "John"
    }
]

[

{

"make": "Tesla",

"model": "F1-Reloaded",

"colour": "White",

"owner": "Jasmine"

{

"colour": "White",

"make": "Tesla",

"model": "F1-Reloaded",

"owner": "John"

{

"colour": "White",

"make": "Tesla",

"model": "F1-Reloaded",

"owner": "John"

}

]

区块链浏览器

cd explorer
docker-compose up -d

1 2	cd explorer docker-compose up -d

logger

import "github.com/hyperledger/fabric/common/flogging"

var logger = flogging.MustGetLogger("fabcar_cc")

logger.info(xxxx)
logger.error(xxxx)

import "github.com/hyperledger/fabric/common/flogging"

var logger = flogging.MustGetLogger("fabcar_cc")

logger.info(xxxx)

logger.error(xxxx)

基于属性的权限控制

import "github.com/hyperledger/fabric-chaincode-go/pkg/cid"

val, ok, err := cid.GetAttributeValue(APIstub, "属性名")  
# 下面添加根据val判断的逻辑

# 客户端添加通过 attrs 属性指定，比如指定一个 role 属性，在业务逻辑中指定该属性
let secret = await caClient.register({
  enrollmentID: username,
  affiliation: userOrg.toLowerCase() + '.department1',
  attrs: [{ name: 'role', value: 'approver', ecert: true }]
}, adminUserObj);

# 查看证书内容
openssl x509 -in xxx.pem --text

import "github.com/hyperledger/fabric-chaincode-go/pkg/cid"

val, ok, err := cid.GetAttributeValue(APIstub, "属性名")

# 下面添加根据val判断的逻辑

# 客户端添加通过 attrs 属性指定，比如指定一个 role 属性，在业务逻辑中指定该属性

let secret = await caClient.register({

enrollmentID: username,

affiliation: userOrg.toLowerCase() + '.department1',

attrs: [{ name: 'role', value: 'approver', ecert: true }]

}, adminUserObj);

# 查看证书内容

openssl x509 -in xxx.pem --text

Ledger账本

账本是一个数据库，由两部分组成

当前状态（World State）
区块链（Chain of the block）

版本号可参见数据中_rev 字段横杠前的部分

#区块链文件地址
/var/hyperledger/production/ledgersData/chains/chains/mychannel/blockfile_000000
# 查看创世块
configtxgen -inspectBlock genesis.block
configtxgen -inspectBlock mychannel.block

#区块链文件地址

/var/hyperledger/production/ledgersData/chains/chains/mychannel/blockfile_000000

# 查看创世块

configtxgen -inspectBlock genesis.block

configtxgen -inspectBlock mychannel.block

更新链码

将更新后的链码上传到相应目录，然后修改 deploy-chaincode.sh 中的 version 重新执行即可，更新后镜像中的数字也会发生变化：

dev-peer0.org2.alanhou.org-fabcar_2-xxx

api-v2.x

在connection-org1.json和connection-org2.json中配置tlsCACerts，需使用单行模式（原换行替换为\n）,证书示例地址为crypto-config/peerOrganizations/org1.alanhou.org/tlsca/tlsca.org1.alanhou.org-cert.pem

sudo apt install make g++ -y
cd api-v2.x
npm install
nodemon app.js

sudo apt install make g++ -y

cd api-v2.x

npm install

nodemon app.js

注册用户

通过向 http://localhost:4000/users 提交 post 请求即可注册用户（首次注册会默认注册一个 admin），并在xxx-wallet 中生成相应的文件，其中的 xxx 与orgName的值有关

参见api-1.4部分执行交易调用、交易更新操作、根据 id 查询内容

生成证书

在线测试工具

参见 app/sign-tx.js

手动创建证书部署链码

cd create-certificate-with-ca
docker-compose up -d
./create-certificate-with-ca.sh
cp crypto-config-ca ../crypto-config
cd ..
cmd/create-artifacts.sh # 注释掉 cryptogen 及以上的内容
docker-compose up -d    # 注释掉 CA 的创建
cmd/create-channel.sh
cmd/deploy-chaincode.sh

cd create-certificate-with-ca

docker-compose up -d

./create-certificate-with-ca.sh

cp crypto-config-ca ../crypto-config

cd ..

cmd/create-artifacts.sh # 注释掉 cryptogen 及以上的内容

docker-compose up -d # 注释掉 CA 的创建

cmd/create-channel.sh

cmd/deploy-chaincode.sh

常见问题

1、Failed to invoke chaincode. cause:Failed to send Proposal and receive all good ProposalResponse

可能是由于重新部署了节点，但未清除前端项目下的crypto和fabric-client-kv-xxx目录

Credit: https://www.youtube.com/c/PavanAdhav

Section 3 – Dive In to Network

Transaction Flow
Chaincode Walkthrough(Old and New(2.0))
Node API Walkthrough
Transaction Structure
Block Structure
Ledger
Update Asset/Get History of Asset
Indexes In Couch DB
Composite Key in Couch DB
Private data Collection
Testing Chaincode
Attribute Based Access Control
Securing the Couch DB with Credential
Adding Logging in Chaincode