├── Dockerfile ├── README.md ├── package.json ├── bin └── hlf ├── .gitignore ├── azure-pipelines.yml ├── index.js └── LICENSE /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:10 2 | 3 | # Add Tini 4 | ENV TINI_VERSION v0.18.0 5 | ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini 6 | RUN chmod +x /tini 7 | 8 | # Add hlf-cli 9 | ENV NODE_ENV=production 10 | USER node 11 | 12 | RUN mkdir -p /home/node/app 13 | WORKDIR /home/node/app 14 | 15 | COPY --chown=node:node package*.json ./ 16 | RUN npm install 17 | 18 | COPY --chown=node:node . . 19 | 20 | VOLUME /pwd 21 | WORKDIR /pwd 22 | ENTRYPOINT ["/tini", "--", "/home/node/app/bin/hlf" ] 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # hlf-cli 2 | 3 | [![Build Status](https://dev.azure.com/hyperledgendary/hlf-cli/_apis/build/status/hyperledgendary.hlf-cli?branchName=master)](https://dev.azure.com/hyperledgendary/hlf-cli/_build/latest?definitionId=1&branchName=master) 4 | 5 | Experimental Hyperledger Fabric CLI 6 | 7 | **Warning:** nothing is guaranteed stay the same, or to even work! 8 | 9 | ## Installation 10 | 11 | ``` 12 | npm install -g hlf-cli 13 | ``` 14 | 15 | ## Usage 16 | 17 | Type `hlf --help` to list the available commands. 18 | 19 | ## Example 20 | 21 | To list the files inside a package: 22 | 23 | ``` 24 | hlf package -x ./mysterious.cds | tar -tvf - 25 | ``` 26 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "hlf-cli", 3 | "version": "0.4.1", 4 | "description": "Hyperledger Fabric CLI", 5 | "main": "index.js", 6 | "files": [ 7 | "/bin/hlf", 8 | "/lib/*.js" 9 | ], 10 | "bin": { 11 | "hlf": "bin/hlf" 12 | }, 13 | "scripts": { 14 | "genversion": "genversion lib/version.js", 15 | "prepublish": "npm run genversion", 16 | "test": "echo \"Error: no test specified\" && exit 1" 17 | }, 18 | "repository": { 19 | "type": "git", 20 | "url": "git+https://github.com/hyperledgendary/hlf-cli.git" 21 | }, 22 | "keywords": [ 23 | "Hyperledger", 24 | "Fabric", 25 | "CLI" 26 | ], 27 | "author": "James Taylor", 28 | "license": "Apache-2.0", 29 | "bugs": { 30 | "url": "https://github.com/hyperledgendary/hlf-cli/issues" 31 | }, 32 | "homepage": "https://github.com/hyperledgendary/hlf-cli#readme", 33 | "dependencies": { 34 | "commander": "^2.19.0", 35 | "fabric-protos": "^2.0.0-snapshot.1" 36 | }, 37 | "devDependencies": { 38 | "genversion": "^2.1.1" 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /bin/hlf: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | // SPDX-License-Identifier: Apache-2.0 3 | 4 | const program = require('commander'); 5 | 6 | const hlf = require('../'); 7 | const version = require('../lib/version'); 8 | 9 | program 10 | .version(version, '-v, --version'); 11 | 12 | program 13 | .command('block ') 14 | .description('display block information') 15 | .action(async (file, options) => { 16 | await hlf.block(file); 17 | }); 18 | 19 | program 20 | .command('package ') 21 | .description('display package information') 22 | .alias('pkg') 23 | .option('-f, --extract-file ', 'extract code package to file') 24 | .option('-x, --extract', 'extract code package to stdout') 25 | .action(async (file, options) => { 26 | await hlf.package(file, options.extract, options.extractFile); 27 | }); 28 | 29 | // error on unknown commands 30 | program.on('command:*', function () { 31 | console.error('Invalid command: %s\nSee --help for a list of available commands.', program.args.join(' ')); 32 | process.exit(1); 33 | }); 34 | 35 | program 36 | .parse(process.argv); 37 | 38 | // default to showing help 39 | if (!process.argv.slice(2).length) { 40 | program.help(); 41 | } 42 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | # genversion file 64 | lib/version.js 65 | -------------------------------------------------------------------------------- /azure-pipelines.yml: -------------------------------------------------------------------------------- 1 | # Node.js 2 | # Build a general Node.js project with npm. 3 | # Add steps that analyze code, save build artifacts, deploy, and more: 4 | # https://docs.microsoft.com/azure/devops/pipelines/languages/javascript 5 | 6 | trigger: 7 | branches: 8 | include: 9 | - 'master' 10 | tags: 11 | include: 12 | - 'v*' 13 | 14 | pool: 15 | vmImage: 'ubuntu-latest' 16 | 17 | steps: 18 | - task: NodeTool@0 19 | inputs: 20 | versionSpec: '10.x' 21 | displayName: 'Install Node.js' 22 | 23 | - script: | 24 | npm ci 25 | displayName: 'npm ci' 26 | 27 | - script: | 28 | touch $(Agent.TempDirectory)/.npmrc 29 | echo '##vso[task.setvariable variable=NPM_CONFIG_USERCONFIG]$(Agent.TempDirectory)/.npmrc' 30 | displayName: 'create user .npmrc file' 31 | 32 | - script: | 33 | npm config set registry https://registry.npmjs.org/ 34 | npm config set always-auth true 35 | npm config ls 36 | cat $(Agent.TempDirectory)/.npmrc 37 | displayName: 'set npmjs registry' 38 | 39 | - task: npmAuthenticate@0 40 | inputs: 41 | workingFile: '$(Agent.TempDirectory)/.npmrc' 42 | customEndpoint: 'npmjs' 43 | 44 | - script: | 45 | npm whoami 46 | displayName: 'npm whoami' 47 | 48 | - script: | 49 | npm publish 50 | displayName: 'npm publish' 51 | condition: startsWith(variables['build.sourceBranch'], 'refs/tags/v') 52 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: Apache-2.0 2 | 3 | const fabricProtos = require('fabric-protos'); 4 | const fs = require('fs'); 5 | const path = require('path'); 6 | const util = require('util'); 7 | 8 | const readFile = util.promisify(fs.readFile); 9 | const writeFile = util.promisify(fs.writeFile); 10 | 11 | async function block(file) { 12 | let blockBuffer; 13 | let block; 14 | 15 | try { 16 | blockBuffer = await readFile(file); 17 | } catch (err) { 18 | console.error(`Unable to read block file ${file}`); 19 | } 20 | 21 | if (blockBuffer) { 22 | try { 23 | block = fabricProtos.common.Block.decode(blockBuffer); 24 | 25 | console.log(`Block number: ${block.header.number}`); 26 | console.log(`Previous hash: ${block.header.previous_hash.toString('utf8')}`); 27 | } catch (err) { 28 | console.error(`Unable to decode block file ${file}`); 29 | } 30 | } 31 | 32 | // TODO show something useful if it's the genesis block? 33 | } 34 | 35 | async function package(file, extract, extractFile) { 36 | let cdsBuffer; 37 | let cdsData; 38 | 39 | try { 40 | cdsBuffer = await readFile(file); 41 | } catch (err) { 42 | console.error(`Unable to read package file ${file}`); 43 | } 44 | 45 | if (cdsBuffer) { 46 | try { 47 | cdsData = fabricProtos.protos.ChaincodeDeploymentSpec.decode(cdsBuffer); 48 | } catch (err) { 49 | console.error(`Unable to decode package file ${file}`); 50 | } 51 | } 52 | 53 | if (cdsData) { 54 | if (extract || extractFile) { 55 | const codePackageBuffer = cdsData.code_package.toBuffer(); 56 | 57 | if (extract) { 58 | process.stdout.write(codePackageBuffer); 59 | } 60 | 61 | if (extractFile && extractFile.length > 0) { 62 | try { 63 | await writeFile(extractFile, codePackageBuffer); 64 | } catch (err) { 65 | console.error(`Unable to write code package file ${extractFile}`); 66 | } 67 | } 68 | } else { 69 | console.log(`Path: ${cdsData.chaincode_spec.chaincode_id.path}`); 70 | console.log(`Name: ${cdsData.chaincode_spec.chaincode_id.name}`); 71 | console.log(`Version: ${cdsData.chaincode_spec.chaincode_id.version}`); 72 | 73 | // TODO work out how to get the name of an enum out of protobufjs!!! 74 | console.log(`Type: ${cdsData.chaincode_spec.type}`); 75 | } 76 | } 77 | } 78 | 79 | module.exports = { 80 | block, 81 | package 82 | } 83 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------