Skip to content
[Mirror from https://github.com/hyperledger-labs/convector] Smart Contract Systems the easy way. Open source development framework.
TypeScript CSS HTML JavaScript Shell
Branch: develop
Clone or download
Pull request Compare This branch is even with hyperledger-labs:develop.
diestrin v1.3.8
Signed-off-by: Diego Barahona <diestrin@gmail.com>
Latest commit f5bae78 Sep 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github docs: add github templates Feb 24, 2019
@worldsibu v1.3.8 Sep 3, 2019
examples v1.3.8 Sep 3, 2019
gh-pages-theme/custom fontawesome 5 icons Feb 5, 2019
tutorials content updates and visual improvs Feb 5, 2019
.editorconfig migrate from tellus repo Nov 4, 2018
.gitignore feat: integrate with hurley for e2e tests Mar 18, 2019
.travis.yml feat: reuse event hub for multiple txs Aug 16, 2019
CHANGELOG.md feat: group packages and update package.json's Mar 14, 2019
CONTRIBUTING.md docs: add github templates Feb 24, 2019
LICENSE.txt add license Nov 4, 2018
README.md docs: more details and improvements Aug 6, 2019
_config.yml v2.0 of the docs Nov 9, 2018
bitbucket-pipelines.yml fix: update the build script (pull request hyperledger-labs#37) Nov 4, 2018
lerna.json v1.3.8 Sep 3, 2019
package-lock.json chore: update package lock Aug 29, 2019
package.json
tsconfig.json feat: Add documentation (pull request hyperledger-labs#28) Nov 4, 2018
tslint.json feat: refactor convector client implementation and add browser support Mar 6, 2019
typedoc.json v2.0 of the docs Nov 9, 2018

README.md

CONVECTOR SUITE

The Convector Suite is an Open Source Suite for Enterprise Blockchain Networks created and maintained by WorldSibu. It is composed of a group of Development tools for Hyperledger Fabric and aims to be an agnostic toolset.

WorldSibu is an enterprise development platform for private blockchain systems. Creators of the open source suite Convector, as well as the enterprise offering Forma, the blockchain infrastructure automation platform with multi-cloud capabilities.

The Convector Suite is targeted at beginners and experts alike. For newcomers to the blockchain world is the easiest and fastest way to create great code. For experts it's the means to efficiently create scalable and secure code. The Convector Suite follows modern coding paradigms and was built from the ground up to run in multiple ledger technologies.

The Convector Suite main components are:

  • Convector Smart Contracts - JavaScript-based Development Framework for Enterprise Smart Contract Systems
  • Hurley - the easiest way to quickly setup your Hyperledger development environment. Instead of learning all the config files required and navigating tons of yaml files, just do hurl new and focus on your smart contract.
  • Convector CLI - the fastest and easiest way to build a new Convector Smart Contracts project. It is fully integrated with Hurley as well.
  • Convector REST Server - a RESTful API generator from a Convector smart contract. One command and you can expose your smart contract to the world.

Some key links:

Have doubts, want to collaborate or just meet other Convector devs around the world? Join the Discord (Chat) Community

What is Convector Smart Contracts?

Issues Newsletter npm Discord

TypeScript License lerna

Convector is a JavaScript-based Development Framework for Enterprise Smart Contract Systems. Its goal is to make it easier for developers to create, test and deploy enterprise-grade blockchain-based systems by abstracting complexities that make it hard to get started, plus a collection of tools that speed up your go-to-market.

For now, we only support Hyperledger Fabric, so this documentation is for using Convector Smart Contracts on Hyperledger Fabric.

Model/Controller pattern. Convector is designed to help you write reusable pieces of code that describe the nature of what a developer can do in a blockchain. A blockchain, in the developer’s eyes, is no more than a data layer protected by a logic layer defining the rules of what the outside world can do in with the inner data. Thus, a really comfortable way of writing chaincode logic (smart contracts) is by having Models describing the shape of the data and Controllers describing the actions and rules that apply to the models.

Create your first blockchain project

Make sure you meet the pre-requisites.

npm i -g @worldsibu/convector-cli
conv new car
cd car
npm install

# Start your local blockchain network
npm run env:restart

# Install the smart contract
npm run cc:start -- car

# Send your first transaction to the blockchain - Wait a few seconds!
hurl invoke car car_create '{"id":"car1","name":"jetta", "created":1,"modified":1}'

# See your new record created in the blockchain by visiting: http://localhost:5084/_utils/#database/ch1_car/_all_docs

Then, you can visit the official Docs Site, automatically add a REST API, or build it and deploy it to an enterprise blockchain network.

Assumptions

This documentation assumes that you are familiar with JavaScript, TypeScript, and Hyperledger Fabric (at least the basics!).

Are you looking for an option to Hyperledger Composer?

Yes, we are also aware that Composer's development has experienced some changes and a lot of people are facing uncertainty. If you are one of the devs looking for a way to create smart contract systems with native chaincodes in JavaScript, you are in the right place. You may find this resource valuable on how to Migrate from Composer to Convector.

Support

You can’t perform that action at this time.