Incubation Notice¶
This project is a Hyperledger project in Incubation. It was proposed to the community and documented here. Information on what Incubation entails can be found in the Hyperledger Project Lifecycle document.
Hyperledger Fabric¶
The Fabric is an implementation of blockchain technology, leveraging familiar and proven technologies. It is a modular architecture allowing pluggable implementations of various function. It features powerful container technology to host any mainstream language for smart contracts development.
Releases¶
The Fabric releases are documented here. We released our second release under the governance of the Hyperledger Project - v0.6-preview in October, 2016.
If you are seeking a stable version of the Hyperledger Fabric on which to develop applications or explore the technology, we strongly recommend that you use the v0.6 Starter Kit while the v1.0 architectural refactoring is in development.
If you’d like a taste of what the Fabric v1.0 architecture has in store, we invite you to read the preview here. Finally, if you are adventurous, we invite you to explore the current state of development with the caveat that it is not yet completely stable.
Contributing to the project¶
We welcome contributions to the Hyperledger Project in many forms. There’s always plenty to do! Full details of how to contribute to this project are documented in the Fabric developer’s guide below.
Maintainers¶
The project’s maintainers are responsible for reviewing and merging all patches submitted for review and they guide the over-all technical direction of the project within the guidelines established by the Hyperledger Project’s Technical Steering Committee (TSC).
Communication ¶
We use Hyperledger Slack for communication and Google Hangouts™ for screen sharing between developers. Our development planning and prioritization is done in JIRA, and we take longer running discussions/decisions to the mailing list.
Still Have Questions?¶
We try to maintain a comprehensive set of documentation (see below) for various audiences. However, we realize that often there are questions that remain unanswered. For any technical questions relating to the Hyperledger Fabric project not answered in this documentation, please use StackOverflow. If you need help finding things, please don’t hesitate to send a note to the mailing list, or ask on Slack.
Hyperledger Fabric Documentation¶
The Hyperledger Fabric is an implementation of blockchain technology, that has been collaboratively developed under the Linux Foundation’s Hyperledger Project. It leverages familiar and proven technologies, and offers a modular architecture that allows pluggable implementations of various function including membership services, consensus, and smart contracts (Chaincode) execution. It features powerful container technology to host any mainstream language for smart contracts development.
Table of Contents¶
Below, you’ll find the following sections:
Read all about it¶
If you are new to the project, you might want to familiarize yourself with some of the basics before diving into either developing applications using the Hyperledger Fabric, or collaborating with us on our journey to continuously extend and improve its capabilities.
- Canonical use cases
- Glossary: to understand the terminology that we use throughout the Fabric project’s documentation.
- Fabric FAQs
Developer guides¶
There are two distinct types of developers for which we have authored this documentation: 1) application developers building applications and solutions using the Hyperledger Fabric 2) developers who want to engage in the development of the Hyperledger Fabric itself. We distinguish these two personas because the development setup for the Hyperledger Fabric developer is much more involved as they need to be able to build the software and there are additional prerequisites that need to be installed that are largely unnecessary for developers building applications.
Application developer guide¶
- CLI: working with the command-line interface.
- Node.js SDK: working with the Node.js SDK.
- Java SDK (coming soon).
- Python SDK (coming soon).
- Writing, Building, and Running Chaincode: a step-by-step guide to developing and testing Chaincode.
- Chaincode FAQ: a FAQ for all of your burning questions relating to Chaincode.
Fabric developer guide¶
- Making code contributions: First, you’ll want to familiarize yourself with the project’s contribution guidelines.
- Setting up the development environment: after that, you will want to set up your development environment.
- Building the Fabric core: next, try building the project in your local development environment to ensure that everything is set up correctly.
- Building outside of Vagrant: for the adventurous, you might try to build outside of the standard Vagrant development environment.
- Logging control: describes how to tweak the logging levels of various components within the Fabric.
- License header: every source file must include this license header modified to include a copyright statement for the principle author(s).
Operations guide¶
(coming soon)
Note: if you are looking for instructions to operate the fabric for a POC, we recommend that you use the more stable v0.6 Starter Kit
License ¶
The Hyperledger Project uses the Apache License Version 2.0 software license.