@theledger/fabric-chaincode-utils

Utilities for working with and testing hyperledger Fabric nodejs chaincode

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@theledger/fabric-chaincode-utils
5.1.04 years ago6 years agoMinified + gzip package size for @theledger/fabric-chaincode-utils in KB

Readme

Build Status npm version codecov
fabric-node-chaincode-utils
A Nodejs module that helps you build your Hyperledger Fabric nodejs chaincode. Testing is done using the fabric-mock-stub.

Table of contents

Version matching

| Fabric node SDK | Chaincode utils | | ------------- |:-------------:| | v1.3.X | v4.X.X | | v1.2.X | v3.X.X | | V1.1.X | v2.1.0 |

Installation

yarn add @theledger/fabric-chaincode-utils

Changes

v2.0.0 - BREAKING

  • Objects parsed as multiple arguments, should now only be passed as a JSON object in 1 argument.

before
["function","prop1","prop2"]

const verifiedArgs = await Helpers.checkArgs<{ prop1: string, prop2: string }>(args, Yup.object()
            .shape({
                prop1: Yup.string().required(),
                prop2: Yup.string().required(),
            }));

after
["function","{\"prop1\":\"prop1\",\"prop2\":\"prop2\"}"]

const verifiedArgs = await Helpers.checkArgs<{ prop1: string, prop2: string }>(args[0], Yup.object()
            .shape({
                prop1: Yup.string().required(),
                prop2: Yup.string().required(),
            }));

Contributing

  1. Fork it! 🍴
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request 😁 🎉

Credits

License

The MIT License (MIT)
Copyright (c) 2018 TheLedger
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.