Hyperledger Fabric V1.4.10能否使用Node SDK实现链码打包与安装

前置场景对齐 #

当前基于Fabric V1.4.10开发部署应用的已具备能力和目标：

• 已可通过Node SDK API 正常完成链码的安装、升级全流程操作
• 原有存储方案为将整个链码项目压缩为zip包，存在node_modules冗余依赖、ts源码、未编译js文件等非必需内容导致包体过大的问题
• 核心目标是在部署应用内部实现和peer chaincode package能力等价的轻量打包能力，精准剔除冗余文件、缩小存储构件体积
• 已梳理Node SDK中打包相关能力：定位到BasePackager类具备打包逻辑，同时明确了install方法支持两类入参结构：
  • 包安装类请求（ChaincodePackageInstallRequest）：直接传入链码包Buffer即可发起安装
  • 路径安装类请求（ChaincodePathInstallRequest）：传入链码ID、版本、代码路径、类型等信息发起安装

打包环节的方案选择 #

结论前置：完全可以直接使用Node SDK内置的BasePackager完成和peer chaincode package完全等价的打包流程，无需强制依赖peer CLI

• 能力兼容性层面：V1.4版本Node SDK的打包逻辑完全复用了peer CLI的链码包结构规范，BasePackager生成的tgz格式链码包和peer chaincode package命令输出的包结构完全一致，不存在格式兼容问题
• 方案适配性层面：用SDK打包可以直接在应用代码内精准控制文件过滤规则，直接排除ts源码、devDependencies依赖、测试文件、本地临时配置这类非链码运行必需的内容，从根源上压缩包体，不需要额外编写外部脚本做目录裁剪
• 仅在两类场景下更适合选择peer chaincode package：
  • 需要在部署应用之外独立生成离线归档的链码包
  • 需要严格复刻peer CLI默认的打包规则，不需要做自定义文件裁剪

最小可用调用参考 #

const { BasePackager } = require('fabric-client/lib/BasePackager');
const packager = new BasePackager();

// 传入链码源码路径、元数据路径完成打包，返回可直接用于安装的Buffer对象
const chaincodePkgBuffer = await packager.package({
  codePath: '/本地链码源码绝对路径',
  metadataPath: '/链码元数据目录绝对路径'
});

注：可通过实例化Packager时覆盖默认ignore规则，实现自定义文件过滤，比如排除所有ts后缀文件、node_modules下的devDependencies目录。

安装环节的方案选择 #

结论前置：无论你是通过Node SDK打包、还是通过peer CLI打包生成的链码包，都可以直接通过Node SDK的install方法完成安装，无需切回peer CLI

• 当你获取到打包完成的Buffer对象时，直接匹配ChaincodePackageInstallRequest的参数结构传参即可，不需要重复传入链码ID、版本、代码路径这类冗余信息：
  • 将打包生成的Buffer值直接赋值给入参的chaincodePackage字段
  • 按需指定待安装的Peer节点列表、关联Channel列表、交易ID，即可直接调用install方法
• 原有路径安装逻辑的包体过大根因：如果直接使用ChaincodePathInstallRequest传参走默认安装流程，SDK内部会自动调用BasePackager做全量目录打包，默认会将指定路径下的所有文件都纳入包体，没有做文件过滤，这也是之前全量压缩项目包体过大的核心原因
• 仅在两类场景下更适合选择peer chaincode install：
  • 部署应用没有对接SDK、不具备连接Peer节点的网络权限
  • 需要排查底层通信问题，直接和Peer节点的原始gRPC接口做交互

实操踩坑提示 #

• 严禁自行将普通zip格式的链码源码包作为chaincodePackage字段的值传入，SDK会严格校验链码包的tgz结构格式，不符合规范的包会直接触发安装失败
• 明确哪些内容是部署必需的，从源头裁剪包体：
  • 编译完成的、可直接运行的js链码逻辑：必需
  • 链码运行时需要的生产依赖包（在dependencies字段声明的内容）：必需
  • ts源码文件、devDependencies下的编译/测试工具、本地配置、测试用例：非必需，可从打包范围剔除
• 对于Node类型的链码，仅纳入生产依赖的情况下，通常可以减少70%以上的包体体积
• 打包时需要和后续安装、实例化时声明的链码类型保持一致，避免出现包内容和类型不匹配的问题

内容的提问来源于stack exchange，提问作者Ana Franco