2 Star 1 Fork 3

向彪 / fiscobcos-demo

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-1.0

fiscobcos-demo

fisco-bcos maven版java sdk

介绍

因为本人的项目不是gradle构建的,所以修改了官方的demo为maven版本

该项目是基于Web3SDK的spring boot版本的示例项目。提供FISCO BCOS区块链应用开发的基本框架和基本的测试案例,帮助开发者基于FISCO BCOS区块链快速进行应用开发。此版本只支持FISCO BCOS 2.0+。

快速启动 前置条件 搭建FISCO BCOS区块链,具体步骤参考这里。

获取源码 $ git clone https://github.com/FISCO-BCOS/spring-boot-starter.git 节点证书配置 将节点所在目录nodes/${ip}/sdk下的ca.crt、sdk.crt和sdk.key文件拷贝到项目的src/main/resources目录下供SDK使用(FISCO BCOS 2.1以前,证书为ca.crt、node.crt和node.key`)。

配置文件设置 spring boot项目的配置文件application.yml如下图所示,其中加了注释的内容根据区块链节点配置做相应修改。

encrypt-type: # 0:普通, 1:国密 encrypt-type: 0

group-channel-connections-config: all-channel-connections:

  • group-id: 1 # 群组ID connections-str: - 127.0.0.1:20200 # 节点,listen_ip:channel_listen_port - 127.0.0.1:20201
  • group-id: 2
    connections-str: - 127.0.0.1:20202 # 节点,listen_ip:channel_listen_port - 127.0.0.1:20203

channel-service: group-id: 1 # sdk实际连接的群组 agency-name: fisco # 机构名称

accounts: pem-file: 0xcdcce60801c0a2e6bb534322c32ae528b9dec8d2.pem # PEM 格式账户文件 p12-file: 0x98333491efac02f8ce109b0c499074d47e7779a6.p12 # PKCS12 格式账户文件 password: 123456 # PKCS12 格式账户密码 项目中关于SDK配置的详细说明请参考这里。

运行 编译并运行测试案例,在项目根目录下运行:

$ cd spring-boot-starter $ ./gradlew build $ ./gradlew test 当所有测试案例运行成功,则代表区块链运行正常,该项目通过SDK连接区块链正常。开发者可以基于该项目进行具体应用开发。

注:如果在IntelliJ IDEA或Eclipse中运行该demo工程,则使用gradle wrapper模式,此外IntelliJ IDEA需要在设置中开启Annotation Processors功能。

测试案例介绍 该示例项目提供的测试案例,供开发者参考使用。测试案例主要分为对Web3j API,Precompiled Serveice API、Solidity合约文件转Java合约文件、部署和调用合约的测试。

Web3j API测试 提供Web3jApiTest测试类测试Web3j API。示例测试如下:

@Test public void getBlockNumber() throws IOException { BigInteger blockNumber = web3j.getBlockNumber().send().getBlockNumber(); System.out.println(blockNumber); assertTrue(blockNumber.compareTo(new BigInteger("0"))>= 0); } 温馨提示: Application类初始化了web3j对象,在业务代码需要的地方可用注解的方式直接使用,使用方式如下:

@Autowired private Web3j web3j Precompiled Service API测试 提供PrecompiledServiceApiTest测试类测试Precompiled Service API。示例测试如下:

@Test public void testSystemConfigService() throws Exception { SystemConfigSerivce systemConfigSerivce = new SystemConfigSerivce(web3j, credentials); systemConfigSerivce.setValueByKey("tx_count_limit", "2000"); String value = web3j.getSystemConfigByKey("tx_count_limit").send().getSystemConfigByKey(); System.out.println(value); assertTrue("2000".equals(value)); } Solidity合约文件转Java合约文件测试 提供SolidityFunctionWrapperGeneratorTest测试类测试Solidity合约文件转Java合约文件。示例测试如下:

@Test public void compileSolFilesToJavaTest() throws IOException { File solFileList = new File("src/test/resources/contract"); File[] solFiles = solFileList.listFiles();

for (File solFile : solFiles) {

    SolidityCompiler.Result res = SolidityCompiler.compile(solFile, true, ABI, BIN, INTERFACE, METADATA);
    System.out.println("Out: '" + res.output + "'");
    System.out.println("Err: '" + res.errors + "'");
    CompilationResult result = CompilationResult.parse(res.output);
    System.out.println("contractname  " + solFile.getName());
    Path source = Paths.get(solFile.getPath());
    String contractname = solFile.getName().split("\\.")[0];
    CompilationResult.ContractMetadata a = result.getContract(solFile.getName().split("\\.")[0]);
    System.out.println("abi   " + a.abi);
    System.out.println("bin   " + a.bin);
    FileUtils.writeStringToFile(new File("src/test/resources/solidity/" + contractname + ".abi"), a.abi);
    FileUtils.writeStringToFile(new File("src/test/resources/solidity/" + contractname + ".bin"), a.bin);
    String binFile;
    String abiFile;
    String tempDirPath = new File("src/test/java/").getAbsolutePath();
    String packageName = "org.fisco.bcos.temp";
    String filename = contractname;
    abiFile = "src/test/resources/solidity/" + filename + ".abi";
    binFile = "src/test/resources/solidity/" + filename + ".bin";
    SolidityFunctionWrapperGenerator.main(Arrays.asList(
            "-a", abiFile,
            "-b", binFile,
            "-p", packageName,
            "-o", tempDirPath
    ).toArray(new String[0]));
}
System.out.println("generate successfully");

} 该测试案例将src/test/resources/contract目录下的所有Solidity合约文件(默认提供HelloWorld合约)均转为相应的abi和bin文件,保存在src/test/resources/solidity目录下。然后将abi文件和对应的bin文件组合转换为Java合约文件,保存在src/test/java/org/fisco/bcos/temp目录下。SDK将利用Java合约文件进行合约部署与调用。

部署和调用合约测试 提供ContractTest测试类测试部署和调用合约。示例测试如下:

@Test public void deployAndCallHelloWorld() throws Exception { //deploy contract HelloWorld helloWorld = HelloWorld.deploy(web3j, credentials, new StaticGasProvider(gasPrice, gasLimit)).send(); if (helloWorld != null) { System.out.println("HelloWorld address is: " + helloWorld.getContractAddress()); //call set function helloWorld.set("Hello, World!").send(); //call get function String result = helloWorld.get().send(); System.out.println(result); assertTrue( "Hello, World!".equals(result)); } }

木兰宽松许可证, 第1版 木兰宽松许可证, 第1版 2019年8月 http://license.coscl.org.cn/MulanPSL 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第1版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的一方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括仅因您或他人修改“贡献”或其他结合而将必然会侵犯到的专利权利要求。如您或您的“关联实体”直接或间接地(包括通过代理、专利被许可人或受让人),就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 条款结束。 如何将木兰宽松许可证,第1版,应用到您的软件 如果您希望将木兰宽松许可证,第1版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [2019] [name of copyright holder] [Software Name] is licensed under the Mulan PSL v1. You can use this software according to the terms and conditions of the Mulan PSL v1. You may obtain a copy of Mulan PSL v1 at: http://license.coscl.org.cn/MulanPSL THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v1 for more details. Mulan Permissive Software License,Version 1 Mulan Permissive Software License,Version 1 (Mulan PSL v1) August 2019 http://license.coscl.org.cn/MulanPSL Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v1 (this License) with following terms and conditions: 0. Definition Software means the program and related documents which are comprised of those Contribution and licensed under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, or are controlled by, or are under common control with a party to this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. Contribution means the copyrightable work licensed by a particular Contributor under this License. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed, excluding of any patent claims solely be infringed by your or others’ modification or other combinations. If you or your Affiliates directly or indirectly (including through an agent, patent licensee or assignee), institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability The Software and Contribution in it are provided without warranties of any kind, either express or implied. In no event shall any Contributor or copyright holder be liable to you for any damages, including, but not limited to any direct, or indirect, special or consequential damages arising from your use or inability to use the Software or the Contribution in it, no matter how it’s caused or based on which legal theory, even if advised of the possibility of such damages. End of the Terms and Conditions How to apply the Mulan Permissive Software License,Version 1 (Mulan PSL v1) to your software To apply the Mulan PSL v1 to your work, for easy identification by recipients, you are suggested to complete following three steps: i. Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii. Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii. Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [2019] [name of copyright holder] [Software Name] is licensed under the Mulan PSL v1. You can use this software according to the terms and conditions of the Mulan PSL v1. You may obtain a copy of Mulan PSL v1 at: http://license.coscl.org.cn/MulanPSL THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v1 for more details.

简介

fisco-bcos maven版java sdk 区块链 展开 收起
Java
MulanPSL-1.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/bckj_1/fiscobcos-demo.git
git@gitee.com:bckj_1/fiscobcos-demo.git
bckj_1
fiscobcos-demo
fiscobcos-demo
master

搜索帮助