The IBM Blockchain Platform extension has been created to assist users in developing, testing, and deploying smart contracts; including connecting to Hyperledger Fabric environments.
⚠ Please note: this extension is available for early experimentation. There are many features and improvements to come before the v1.0 release. Please bear this in mind, and if you find something you'd like to see added, let the team know by raising a GitHub issue or suggestion (see "Contact Us" below).
If you have find any problems or want to make suggestions for future features please create issues and suggestions on Github
Install the IBM Blockchain Platform extension here
Or visit the Visual Studio Code Marketplace for more details
You will need the following installed in order to use the extension:
- Node v8.x or greater and npm v5.x or greater
- Yeoman (yo) v2.x
- Docker version v17.06.2-ce or greater
- Docker Compose v1.14.0 or greater
If you are using Windows, you must also ensure the following:
- Your version of Windows supports Hyper-V and Docker:
- Windows 10 Enterprise, Pro, or Education with 1607 Anniversary Update or later
- Docker for Windows is configured to use Linux containers (this is the default)
- You have installed the C++ Build Tools for Windows from windows-build-tools
- You have installed OpenSSL v1.0.2 from Win32 OpenSSL
- Install the normal version, not the version marked as "light"
- Install the Win32 version into
C:\OpenSSL-Win32on 32-bit systems - Install the Win64 version into
C:\OpenSSL-Win64on 64-bit systems
You can check your installed versions by running the following commands from a terminal:
node --versionnpm --versionyo --versiondocker --versiondocker-compose --version
The IBM Blockchain Platform extension provides an explorer and commands accessible from the Command Palette, for developing smart contracts quickly:
| Command | Description |
|---|---|
| Add Connection | Add a Hyperledger Fabric instance connection |
| Add Identity To Connection | Add an identity to be used when connecting to a Hyperledger Fabric instance |
| Connect To Blockchain | Connect to a Hyperledger Fabric blockchain using a blockchain connection |
| Create Smart Contract Project | Create a new JavaScript or TypeScript smart contract project |
| Delete Connection | Delete a Hyperledger Fabric instance connection |
| Delete Package | Delete a smart contract package |
| Edit Connection | Edit connection to a blockchain |
| Export Package | Export an already-packaged smart contract package to use outside VSCode |
| Disconnect From Blockchain | Disconnect from the blockchain you're currently connected to |
| Install Smart Contract | Install a smart contract package onto a peer |
| Instantiate / Upgrade Smart Contract | Instantiate / upgrade an installed smart contract package onto a channel *Note: This currently doesn't work with IBM Blockchain Platform Enterprise plan - Coming soon! |
| Package a Smart Contract Project | Create a new smart contract package from a project in the Explorer |
| Refresh Blockchain Connections | Refresh the Blockchain Connections view |
| Refresh Smart Contract Packages | Refresh the Smart Contract Packages view |
| Restart Fabric Runtime | Restart a Hyperledger Fabric instance |
| Start Fabric Runtime | Start a Hyperledger Fabric instance |
| Teardown Fabric Runtime | Teardown the local_fabric runtime (hard reset) |
| Toggle Development Mode | Toggle the Hyperledger Fabric instance development mode |
Please note that all operations shown are also possible using the commands in the table above, issued at the VSCode command-prompt.
Use the Create Smart Contract Project command to start a new project. Select from the available smart contract programming languages. Choose a directory to store the project (or create a new one). A skeleton project will be generated with a very basic smart contract, unit tests, a package.json and other useful files.
You'll find the smart contract file in the lib directory of a newly generated project.
To package a project you have open in your workspace, run the Package a Smart Contract Package command. Packages will be added to the Smart Contract Packages panel in the explorer view.
Alternatively, navigate to the explorer view (click the IBM Blockchain Platform icon in the left-navigation) then click the add icon (this will again package up the project you have open in your workspace).
Right-click a package and select the Export Package option. You can select where the package is exported to. Use this to take the packages you have made and deploy them somewhere else.
The local_fabric runtime can be enabled by left-clicking it in the Blockchain Connections panel. The first time you enable it, Fabric images will be installed.
Left-click to connect to local_fabric when it is enabled. Right-click the connection for management options (including start/stop, teardown and toggle dev mode).
When you start/stop the local_fabric, all data will be maintained. To completely teardown the runtime and start over, right-click local_fabric in the Blockchain Connections view and choose Teardown Fabric Runtime (you must then confirm this action).
Left-click a connection to activate connect to the blockchain runtime it represents. Expand the sections in the navigation tree to explore its resources. When you're done, use the "back" icon in the section's header-bar to disconnect.
Smart contract packages are installed on Fabric peers. Find a peer by connecting to a blockchain network, then right-click and select Install Smart Contract.
Smart contract packages are instantiated on Fabric channels. Find a channel by connecting to a blockchain network, then right-click and select Instantiate / Upgrade Smart Contract. You will be offered a list of the smart contracts that are installed on peers in the channel.
It is useful to think of installing on peers as the first step and instantiating on a channel as the second step of deploying a smart contract package.
Connections can be edited by right-clicking and selecting Edit Connection. This will open User Settings, with the connection available for editing.
Using this extension, you can connect to a pre-configured local instance of Hyperledger Fabric named local_fabric, or you can connect to your own Hyperledger Fabric instance. If you choose to connect to your own Hyperledger Fabric instance, it must be running Hyperledger Fabric v1.3.0 or later.
When using the pre-configured local instance of Hyperledger Fabric named local_fabric, the extension will automatically pull and use the correct Docker images.
If you want to start and connect to your own Hyperledger Fabric instance, ensure that you are using Hyperledger Fabric v1.3.0 or later by following the Fabric documentation here:
https://hyperledger-fabric.readthedocs.io/en/release-1.3/install.html
Linux, Mac OS, and Windows are currently the only supported operating systems for use with the extension.
The extension uses telemetry reporting to track usage data and help improve future extension versions.
For instructions on how to disable telemetry reporting, please visit the visit the Visual Studio Code FAQ.
To track the projects future features, visit GitHub Issues.
The source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file.