IBM Blockchain Platform Extension for VS Code
The IBM Blockchain Platform extension helps developers to create, test and debug smart contracts, connect to Hyperledger Fabric environments, and build applications that transact on your blockchain network.
For a step-by-step guide on getting started with the extension's features, access our Beginner Tutorial via our integrated Home page. Alternatively, explore, clone and open the Hyperledger Fabric samples, all without leaving VS Code. For more comprehensive documentation, follow this link
Want to learn more about the IBM Blockchain Platform?
Join us for the IBM Blockchain Platform User Series where product and technical experts share their expertise and educate on a specific feature, function or capability of the IBM Blockchain Platform. Get the answers to your questions and engage live with the experts, while ensuring you're leveraging all that the IBM Blockchain Platform has to offer.
Please visit the Visual Studio Code Marketplace for installation and more details.
The first time you install this extension, it will check your system for the prequisites, and guide you to install any that you are missing.
Windows 10, Linux, or Mac OS are currently the supported operating systems. Each of these operating systems have their own additional requirements.
For the full list of requirements that the extension will check for, please refer to the 'Dependency Installation' section at the end of the README.
Smart Contract Development Lifecycle
Please note that all commands contributed by this extension are accessible via the VS Code Command Palette. The commands outlined below are available from burger menus located on the panel headers, or by right-clicking tree items, in the extension's side bar view.
The expected smart contract development lifecycle follows several broad points, all possible entirely within VS Code using this extension:
Common tasks and how to complete them
Once you have installed the IBM Blockchain Platform VS Code extension, it is possible to access a large set of tutorials using the
The tutorial gallery is best place to start once you have installed the extension and will teach you mostly everything that you need to know!
Some information on how to complete other undocumented tasks can be found here.
The IBM Blockchain Platform extension provides an explorer and commands accessible from the Command Palette, for developing smart contracts quickly:
Click to view installation instructions
The following dependencies are required on all operating systems:
The following dependencies are optional:
If installing Node and npm using a manager such as 'nvm' or 'nodenv', you will need to set the default/global version and restart VS Code for the version to be detected by the Prerequisites page.
Additional requirements for Windows
1 Org Local Fabric functionality
This extension can use Docker to run a simple pre-configured local Hyperledger Fabric network on your machine. By default this feature is enabled as we highly recommend using it, however you may disable this feature if required.
You will need the following:
Additional requirements for Windows
For more information see the 1 Org Local Fabric section.
To open the Prerequisites page manually, run the
Please note: the extension doesn't currently work with the VSCode Remote Development feature, we plan to make this work in the future, follow progress here.
If you have find any problems or want to make suggestions for future features please create issues and suggestions on Github.
Just so you know
The extension uses telemetry reporting to track usage data and help improve future extension versions. Disabling VS Code telemetry reporting also disables the extension's telemetry reporting. For instructions on how to disable telemetry reporting, please visit the Visual Studio Code FAQ
The source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file.
This software uses the IBM Plex Sans font licensed under the SIL Open Font License, Version 1.1. Copyright © 2017 IBM Corp. with Reserved Font Name "Plex"
This Font Software is licensed under the SIL Open Font License, Version 1.1. This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL