CN112148284A - 一种通用型区块链软件开发工具包 - Google Patents

Abstract

本发明公开了一种通用型区块链软件开发工具包，包括：接口模块，用将软件开发需要实现的功能接口最大集合定义成规范；通信模块，用于通过对区块链节点发起请求，然后获取对应返回结果数据；账号模块，用于将和区块链账户相关的功能最大集合定义成规范；ABI模块，用于实现区块链智能合约相关操作时需要拼接额外的参数信息功能；密钥管理模块，用于创建账号、列出所有账号、导出私钥密文、导出私钥明文、导入私钥密文、导入私钥明文和获取指定地址的私钥。密钥算法模块，用于将和区块链密码算法相关的功能最大集合定义成规范。本发明的技术方案解决相关技术中，区块链SDK都是支持单条链的，无法支持多条链的技术问题。

Description

一种通用型区块链软件开发工具包

技术领域

本发明涉及区块链技术领域，尤其涉及一种通用型区块链软件开发工具包。

背景技术

区块链技术是利用块链式数据结构来验证与存储数据、利用分布式节点共识算法来生成和更新数据、利用密码学的方式保证数据传输和访问的安全、利用由自动化脚本代码组成的智能合约来编程和操作数据的一种全新的分布式基础架构与计算方式。

SDK是Software Development Kit的缩写。Software可以翻译为“软件”；Development可以翻译为“开发，形成”；Kit可以翻译为“成套工具，装备“。SDK通常被称为“软件开发套件”或“软件开发工具包”。

SDK具体的是指，被软件工程师用于为特定的软件包、软件框架、硬件平台、操作系统等创建应用软件的开发工具的集合。它可以包括简单的为某个编程语言提供应用程序接口的文件，也可以包括能与某种嵌入式系统通讯的复杂的硬件。一般的工具包括用于调试和其他用途的实用工具。SDK还经常包括示例代码、支持性的技术注解或者其他的为基本参考资料澄清疑点的支持文档。

由于每个系统的不同，开发套件的工具也不相同。比如，微软提供开发者的工具Directx SDK；IOS提供的Xcode；Google提供的Android SDK和Android DNK。区块链系统中，以太坊就给开发者提供了EthBox开发套件，让开发者可以一键部署以太坊开发环境。总之，经常可以遇到一些公链项目，在白皮书中会提到“提供SDK”开发者套件，能够方便开发者，降低开发过程中的各种成本。

区块链开发完毕，需要通过SDK给其他开发者予以调用，所以SDK是降低区块链使用门槛必要的手段。

目前每个区块链根据语言的不同分别封装了不同的SDK版本，有go语言版本、node.js版本、java版本等等；不同区块链都有各自独立的SDK，不同区块链的SDK实现方式都存在着或多或少的差别；

目前的区块链SDK都是支持单条链的，无法支持多条链的功能。

因此，有必要提供一种新的通用型区块链软件开发工具包，以解决上述技术问题。

发明内容

本发明的主要目的在于提供一种通用型区块链软件开发工具包，旨在解决相关技术中，区块链SDK都是支持单条链的，无法支持多条链的技术问题。

为实现上述目的，本发明提供的一种通用型区块链软件开发工具包，包括：

接口模块，所述接口模块用将软件开发需要实现的功能接口最大集合定义成规范；

通信模块，所述通信模块用于通过对区块链节点发起请求，然后获取对应返回结果数据；

账号模块，所述账号模块用于将和区块链账户相关的功能最大集合定义成规范；

ABI模块，所述ABI模块用于实现区块链智能合约相关操作时需要拼接额外的参数信息功能；

密钥管理模块，所述密钥管理模块用于创建账号、列出所有账号、导出私钥密文、导出私钥明文、导入私钥密文、导入私钥明文和获取指定地址的私钥；

密钥算法模块，所述密钥算法模块用于将和区块链密码算法相关的功能最大集合定义成规范。

优选地，所述接口模块具体用于实现如下功能：创建账号、列出所有账号、导出私钥密文、导出私钥明文、导入私钥密文、导入私钥明文、获取区块号、获取区块链信息、通过区块号获取区块信息、根据交易唯一值获取交易详情、根据交易唯一值获取交易回执、获取指定账户余额、发送原生交易和调用智能合约的常量方法。

优选地，所述通信模块具体用于实现如下功能：在创建实例时传入通信类型和节点IP信息，请求时传入请求方法名称、请求参数、请求方式、请求参数格式和返回值变量。

优选地，所述账号模块具体用于实现如下功能：根据私钥明文和密码生成私钥密文、通过公钥得到地址和通过私钥密文和密码得到私钥密文和通过私钥获得公钥。

优选地，所述ABI模块具体用于实现如下功能：定义规范传入每个合约方法相关规则、合约文件需要部署到区块链上的内容、调用合约方法名称、调用方法需要传入的参数信息统一类型和返回数据统一类型。

优选地，所述密钥管理模块管理账号时采用了BIP32、BIP39、BIP44的设计方案，以实现单个软件开发工具包能够安全及简单的管理多条链的密钥，并且能够对一条链的不同类型的账号非常方便的管理。

优选地，所述密钥算法模块具体用于实现如下功能：通过私钥获取公钥和签名。

本发明提供的通用型区块链软件开发工具包。经过多个区块链SDK功能的分析与梳理，区块链SDK主要分为SDK对外暴露的接口部分、和区块链节点通信的部分、和区块链账号相关的账号部分、和区块链合约交易参数数据拼接相关的ABI部分、密钥管理部分、密码算法部分。

每个模块针对每个区块链都有很多通用的东西，把通用的部分抽象出来定义好规范，SDK底层针对每个区块链的不同去实现对应的业务，对用户使用完全透明，使用方式一致；将区块链SDK通用模块形成规范，可以让使用该方法编写的SDK具有很好的扩展性，一个SDK能够支持多条区块链的业务逻辑。

解决所有区块链的SDK实现都能够通过一种SDK规范，然后根据不同区块链修改部分，实现就是本发明要解决的主要课题。

附图说明

图1为本发明提供的通用型区块链软件开发工具包的一较优实施例的架构图；

图2为图1所示的接口模块的使用情景图。

本发明目的实现、功能特点及优点将结合实施例，参照附图做进一步说明。

具体实施方式

应当理解，此处所描述的具体实施例仅仅用以解释本发明，并不用于限定本发明。

本发明提供一种通用型区块链软件开发工具包。

请结合参阅图1-2，为实现上述目的，本发明的一实施例中，通用型区块链软件开发工具包，包括：

接口模块，所述接口模块用将软件开发需要实现的功能接口最大集合定义成规范；

通信模块，所述通信模块用于通过对区块链节点发起请求，然后获取对应返回结果数据；

账号模块，所述账号模块用于将和区块链账户相关的功能最大集合定义成规范；

ABI模块，所述ABI模块用于实现区块链智能合约相关操作时需要拼接额外的参数信息功能；

密钥管理模块，所述密钥管理模块用于创建账号、列出所有账号、导出私钥密文、导出私钥明文、导入私钥密文、导入私钥明文和获取指定地址的私钥；

密钥算法模块，所述密钥算法模块用于将和区块链密码算法相关的功能最大集合定义成规范。

所述接口模块具体用于实现如下功能：创建账号、列出所有账号、导出私钥密文、导出私钥明文、导入私钥密文、导入私钥明文、获取区块号、获取区块链信息、通过区块号获取区块信息、根据交易唯一值获取交易详情、根据交易唯一值获取交易回执、获取指定账户余额、发送原生交易和调用智能合约的常量方法。

将所有区块链的方法最大集合定义成规范保证了所有区块链的方法都能够完全覆盖，用户根据自身区块链的需求实现需要的方法，当前不需要的方法返回暂时不支持即可。所述接口模块能够支持跨链操作。

所述通信模块具体用于实现如下功能：在创建实例时传入通信类型和节点IP信息，请求时传入请求方法名称、请求参数、请求方式、请求参数格式和返回值变量。

这么定义能够支持TCP、HTTP两种通信方式，HTTP支持GET/POST请求，POST请求参数支持json格式、form表单格式，能够让该模块具备良好的扩展性。

所述账号模块具体用于实现如下功能：根据私钥明文和密码生成私钥密文、通过公钥得到地址和通过私钥密文和密码得到私钥密文和通过私钥获得公钥。

因为每个区块链的私钥管理方式都是不太一样的，比如比特币是将私钥直接存储在文件里，而以太坊是将私钥生成keystore的方式进行保管，所以需要根据每个区块链的不同而采用不同的实现方式；同理每个区块链的地址生成方式也是不太一样的。

所述ABI模块具体用于实现如下功能：定义规范传入每个合约方法相关规则、合约文件需要部署到区块链上的内容、调用合约方法名称、调用方法需要传入的参数信息统一类型和返回数据统一类型。

不同的区块链只需根据生成规则不同编写对应的实现即可，对调用方完全透明。因为每个区块链生成合约交易相关操作时生成参数规则不太一致，所以需要定义好规范然后根据不同区块链的规则实现该方法。

所述密钥管理模块管理账号时采用了BIP32、BIP39、BIP44的设计方案，以实现单个软件开发工具包能够安全及简单的管理多条链的密钥，并且能够对一条链的不同类型的账号非常方便的管理。

所述密钥管理模块支持多条链安全且便捷管理密钥实现方式：

定义树状层级的结构保存密钥路径：

m/purpose'/coin'/account'/change/address_index

m是固定的，Purpose也是固定的，值为44(或者0x8000002C)

Coin type这个代表的是币种，0代表比特币，1代表比特币测试链，60代表以太坊等等。

Account代表这个币的账户索引，从0开始

Change常量0用于外部(收款地址)，常量1用于内部(也称为找零地址)。外部用于在钱包外可见的地址(例如，用于接收付款)。内部链用于在钱包外部不可见的地址，用于返回交易变更。(所以一般使用0)

Address_index这是地址索引，从0开始，代表生成第几个地址。

通过这种方式可以非常安全且便捷生成和管理多币种密钥。

所述密钥算法模块具体用于实现如下功能：通过私钥获取公钥和签名。

因为每个区块链使用的密码算法都不太相同，比如比特币使用的密码算法是椭圆曲线secp256k1算法，而有的区块链可能采用国密算法，所以需要定义成规范然后根据每个区块链的不同分别去实现规范中的方法。

当前不同区块链都有各自的区块链SDK模块实现，不同区块链SDK无论从上层接口调用还是内部实现都有一定程度的差别。

本发明提出一种通用型区块链软件开发工具包。通过定义好区块链SDK各个模块的实现规范，基于该规范能快速实现一个新的区块链SDK的整体功能；通过该方法实现一个SDK能够集成多个区块链SDK的功能且安全便捷的管理各自链的密钥；通过该方法实现的SDK能够作为异构链跨链的桥

通过对各个模块通用功能进行抽象形成规范，不同区块链根据业务不同只需要按照规范实现相对应的业务逻辑即可完成不同模块之间的功能需求，每个模块调用方式是一致的，有了模块划分和模块之间相互配合的规范，就可快速实现区块链SDK的整体功能。

为便于进一步理解本发明提供的通用型区块链软件开发工具包。

以太坊区块链举例，如何采用本发明提供的通用型区块链软件开发工具包实现以太坊区块链软件开发：

1、接口模块，编写对外提供接口的模块部分；

创建一个SDK接口相关的实现类，实现规范定义的方法。

比如，导出私钥密文接口，实现时获得用户需要导出私钥密文的地址，然后调用以太坊密钥管理模块传入该地址，将获取到的私钥密文即keystore内容返回给用户即完成了该功能实现；

再例如，通过交易hash获取交易详情，实现时获得用户传入的交易hash，然后调用以太坊节点通信模块的请求方法，调用方法名称填写以太坊节点RPC服务接收根据交易hash获取交易详情的方法名称，根据参数传递规则及其交易hash封装请求参数，调用以太坊节点通信模块的请求方法后将返回值返回给上层调用方即实现该功能。

用户调用该SDK的方式；

用户根据钱包文件路径和密码创建一个钱包文件实例，根据和区块链节点通信类型和IP信息创建一个节点客户端实例，根据钱包文件实例和节点客户端实例创建SDK的API实例，之后用户使用该API实例调用其中的创建账号、发送交易等方法来满足用户的需求。

2、通信模块，编写和区块链节点通信相关的模块部分；

定义一个节点通信相关的实现类，以太坊节点rpc是采用http的请求方式，实现规范定义的创建实例对象和请求方法。

比如，请求节点获取最新区块高度方法，方法参数包括获取最新区块高度返回值对象指针、请求类型为POST请求方式、rpc服务参数为json序列化类型，方法名称为core_blocknumber，调用方法所需参数数据为空，根据方法传入的参数首先构造http请求对象及其设置参数，然后将请求数据发送给对应的区块链节点，接收节点返回数据，通过返回状态码判断请求是否成功，

如果不成功则返网络错误，如果请求成功则将返回数据字节码json反序列化获得返回数据对象返回给SDK的API接口层，完成区块链节点请求调用。其它方法的实现以此类推。

3、账号模块，编写账号相关的模块部分；

定义一个账号相关的实现类，实现规范定义的方法。比如通过私钥明文和密码生成私钥密文方法，根据以太坊生成keystore规则传入私钥明文和密码得到keystore内容返回给调用方；其它方法的实现以此类推。

密钥管理模块会根据用户的账号类型去调用该实现类中的方法，从而完成模块间的配合。

4、ABI模块，编写和区块链合约交易参数数据拼接相关的模块部分

定义一个以太坊合约交易参数数据拼接的实现类，根据规范实现参数数据拼接的方法。

方法参数有根据合约内容生成的json abi文件，合约内容字节码，调用合约的方法名称，合约方法所需参数的字符串动态数组。

例如拼接某个代币合约转账方法的合约交易参数数据，方法名称为transfer，参数有转账对方地址、转账金额，实现时通过json abi文件获取transfer方法的属性信息，然后根据传入参数的对方地址、转账金额拼接合约交易参数数据。

比如转账对方地址为"0x1ad2467b1dac6a00054e6285464ea83266e0fed5"，转账金额为"100000000"，则获取到的返回值16进制为"a9059cbb0000000000000000000000001ad2467b1dac6a00054e6285464ea83266e0fed50000000000000000000000000000000000000000000000000000000005f5e100"。

5、密钥管理模块，编写密钥管理模块部分

该模块可以采用通用的密钥管理模块，因为通用密钥管理模块已经能够支持多币种的密钥管理，在以太坊使用时只需在调用方法时传入对应的类型(以太坊币种类型为60)即可完成功能实现。

6、密钥算法模块，编写密码算法相关的模块部分

定义一个密码算法的实现类，根据以太坊采用的密码算法为secp256k1分别实现该模块规范定义的通过私钥获取公钥、对内容签名等方法。账号模块会根据该区块链密码算法类型去调用该实现类中的方法，从而完成模块间的配合。

通过以上的实施方式的描述，本领域的技术人员可以清楚地了解到上述实施例方法可借助软件加必需的通用硬件平台的方式来实现，当然也可以通过硬件，但很多情况下前者是更佳的实施方式。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分可以以软件产品的形式体现出来，该计算机软件产品存储在如上所述的一个计算机可读存储介质(如ROM/RAM、磁碟、光盘)中，包括若干指令用以使得一台终端设备进入本发明各个实施例所述的方法。

在本说明书的描述中，参考术语“一实施例”、“另一实施例”、“其他实施例”、或“第一实施例～第X实施例”等的描述意指结合该实施例或示例描述的具体特征、结构、材料或者特点包含于本发明的至少一个实施例或示例中。在本说明书中，对上述术语的示意性表述不一定指的是相同的实施例或示例。而且，描述的具体特征、结构、材料、方法步骤或者特点可以在任何的一个或多个实施例或示例中以合适的方式结合。

需要说明的是，在本文中，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者系统不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者系统所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括该要素的过程、方法、物品或者系统中还存在另外的相同要素。

上述本发明实施例序号仅仅为了描述，不代表实施例的优劣。

以上仅为本发明的优选实施例，并非因此限制本发明的专利范围，凡是利用本发明说明书及附图内容所作的等效结构或等效流程变换，或直接或间接运用在其他相关的技术领域，均同理包括在本发明的专利保护范围内。

Claims (7)

1.一种通用型区块链软件开发工具包，其特征在于，包括：

接口模块，所述接口模块用将软件开发需要实现的功能接口最大集合定义成规范；

通信模块，所述通信模块用于通过对区块链节点发起请求，然后获取对应返回结果数据；

账号模块，所述账号模块用于将和区块链账户相关的功能最大集合定义成规范；

ABI模块，所述ABI模块用于实现区块链智能合约相关操作时需要拼接额外的参数信息功能；

密钥管理模块，所述密钥管理模块用于创建账号、列出所有账号、导出私钥密文、导出私钥明文、导入私钥密文、导入私钥明文和获取指定地址的私钥；

密钥算法模块，所述密钥算法模块用于将和区块链密码算法相关的功能最大集合定义成规范。

2.如权利要求1所述的通用型区块链软件开发工具包，其特征在于，所述接口模块具体用于实现如下功能：创建账号、列出所有账号、导出私钥密文、导出私钥明文、导入私钥密文、导入私钥明文、获取区块号、获取区块链信息、通过区块号获取区块信息、根据交易唯一值获取交易详情、根据交易唯一值获取交易回执、获取指定账户余额、发送原生交易和调用智能合约的常量方法。

3.如权利要求1所述的通用型区块链软件开发工具包，其特征在于，所述通信模块具体用于实现如下功能：在创建实例时传入通信类型和节点IP信息，请求时传入请求方法名称、请求参数、请求方式、请求参数格式和返回值变量。

4.如权利要求1所述的通用型区块链软件开发工具包，其特征在于，所述账号模块具体用于实现如下功能：根据私钥明文和密码生成私钥密文、通过公钥得到地址和通过私钥密文和密码得到私钥密文和通过私钥获得公钥。

5.如权利要求1所述的通用型区块链软件开发工具包，其特征在于，所述ABI模块具体用于实现如下功能：定义规范传入每个合约方法相关规则、合约文件需要部署到区块链上的内容、调用合约方法名称、调用方法需要传入的参数信息统一类型和返回数据统一类型。

6.如权利要求1所述的通用型区块链软件开发工具包，其特征在于，所述密钥管理模块管理账号时采用了BIP32、BIP39、BIP44的设计方案，以实现单个软件开发工具包能够安全及简单的管理多条链的密钥，并且能够对一条链的不同类型的账号非常方便的管理。

7.如权利要求1所述的通用型区块链软件开发工具包，其特征在于，所述密钥算法模块具体用于实现如下功能：通过私钥获取公钥和签名。

Images