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
Please visit the Visual Studio Code Marketplace for installation and more details.
You will need the following installed in order to use the extension:
- Windows 10, Linux, or Mac OS are currently the supported operating systems.
- VS Code version 1.32 or greater
- Node v8.x or greater and npm v5.x or greater
- Docker version v17.06.2-ce or greater
- Docker Compose v1.14.0 or greater
- Go version v1.12 or greater for developing Go contracts
If you are using Windows, you must also ensure the following:
- 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:
Smart Contract Development Lifecycle
Please note that all commands contributed by this extension are accesible 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:
- Creating and packaging a smart contract
- Connecting to an instance of Hyperledger Fabric
- Running and debugging a smart contract
- Submitting transactions and generating functional-level smart contract tests
Create and Develop a Fabric smart contract project
A smart contract project is a directory containing all the relevant contract and metadata files that define a smart contract. Use the
Package a smart contract project
To package a project you have open in your workspace, run the
Package a Smart Contract Package command. Packages are listed in the
Smart Contract Packages panel. The
Blockchain output channel lists what files have been packaged during this action. Alternatively run the
Import Package command to import a pre-existing .cds package to be used within VS Code.
Operate the local_fabric runtime
The extension contains a pre-configured local instance of Hyperledger Fabric named
local_fabric, which the extension will automatically pull and use the correct Docker images for. It is a pre-configured network with one organization, one peer and one channel. It can be enabled and operated under the
Local Fabric Ops panel. The first time it is started, Fabric images will be installed and an admin identity created in the
local_fabric management tasks such as restart and teardown, see the
Local Fabric Ops panel burger menu.
Install and Instantiate smart contract packages
Deploying a smart contract package is a two step process: install the package on a peer and instantiate it on a channel. Run the
Install Smart Contract command, followed by the
Instantiate Smart Contract command to deploy your smart contract package on the
local_fabric runtime. The deployed smart contracts are listed in the
Local Fabric Ops panel.
Debugging a smart contract
Debugging your smart contract allows you to run through the smart contract transactions with breakpoints and output, to ensure your transaction works as intended.
To debug your smart contract follow these steps:
- Ensure you are connected to the
local_fabricruntime and that the
local_fabricpeer is in development mode. Development mode is indicated by an infinity symbol on a peer, under
Local Fabric Opspanel. To toggle development mode, right-click the peer and select
Toggle Development Mode. By toggling development mode, transactions will now have a large timeout value.
- Open your smart contract project in your workspace.
- Open the debug view in Visual Studio Code using the left-hand navigation bar.
- Select the
Debug Smart Contractconfiguration by using the dropdown in the upper-left and click the play button on the debug toolbar.
Instantiate Smart Contractfrom the blockchain icon on the debug toolbar. This action will package, install and instantiate a debug version of the selected smart contract. If there is a version of the selected smart contract already instantiated, select
Upgrade Smart Contract.
- Add breakpoints to the smart contract by clicking on the relevant line numbers in your smart contract files.
- To submit or evaluate a transaction, click the blockchain icon on the debug toolbar. Alternatively, in the
Fabric Gatewayspanel, you can right click on transactions to submit or evaluate them. Execution will be paused on any breakpoints you've defined.
To make iterative changes to your smart contract while debugging, after making your changes click the restart button. You can also stop the debugging session, make futher changes and start debugging again, without needing to upgrade your smart contract. Please note, as this stores the smart contract in local memory, for many changes to large smart contracts, you may need to reinstantiate the smart contract. If you restart the
local_fabric runtime after stopping a debugging session, you must select
Upgrade Smart Contract by clicking the blockchain icon on the debug toolbar. This will install a new
vscode-debug-XXXXXXX version of your smart contract, which then allows you to continue submitting and debugging transactions.
Add a gateway for connecting to your own Hyperledger Fabric instance
To connect to our own Hyperledger Fabric instance, it must be running Hyperledger Fabric v1.4.1 or later.
Add your gateway by providing a name and connection profile via the
Add Gateway command; it will be listed in the
Fabric Gateways panel. Add a file system wallet to connect to your gateway with via the
Add Wallet command.
Connect to a gateway and discover its resources
Connect by clicking on a gateway in the
Fabric Gateways panel, and expand the navigation tree to explore its resources. Instantiated Smart Contracts are listed under the channel and from here you can generate functional-level test files on single or multiple smart contracts. Submit or evaluate individual transactions listed under the instantiated smart contracts, with the result displayed in the
Blockchain output channel.
The extension creates a
local_fabric_wallet file system wallet when it is installed, which is used to connect to the
local_fabric runtime instance and is automatically associated with that gateway. When
local_fabric is started, an admin identity is added to the
local_fabric_wallet and cannot be deleted unless the
local_fabric runtime is torn down.
Add Identity to Wallet command will ask for a name, MSPID and a method to add an identity. These methods include providing a certificate and private key, or a gateway, enrollment id and secret.
For wallets associated with other remote Fabric gateways, the
Edit Wallet ,
Export Wallet and
Remove Wallet commands are available in the
Fabric Wallets panel for wallet management.
The IBM Blockchain Platform extension provides an explorer and commands accessible from the Command Palette, for developing smart contracts quickly:
|Add Gateway||Add a Hyperledger Fabric instance gateway|
|Add Identity To Wallet||Add an identity into a wallet to be used when connecting to a Hyperledger Fabric gateway|
|Add Wallet||Add a wallet containing identities to be used when connecting to a gateway|
|Associate A Wallet||Associate a wallet with a gateway to be used when connecting|
|Connect Via Gateway||Connect to a Hyperledger Fabric instance using a gateway|
|Create Smart Contract Project||Create a new smart contract project|
|Create Identity (register and enroll)||Create, register and enroll a new identity from the local_fabric runtime certificate authority|
|Debug||Debug a Smart Contract|
|Delete Identity||Delete an identity from a wallet|
|Delete Gateway||Delete a Hyperledger Fabric instance gateway|
|Delete Package||Delete a smart contract package|
|Disassociate A Wallet||Remove the association between a wallet and a gateway|
|Disconnect From Gateway||Disconnect from the blockchain gateway you're currently connected to|
|Edit Gateway||Edit connection profile for connecting to a blockchain gateway|
|Edit Wallet||Edit wallet containing identities used for connecting to a blockchain gateway|
|Evaluate Transaction||Evaluate a smart contract transaction|
|Export Connection Profile||Export connection profile for the local_fabric gateway|
|Export Package||Export a smart contract package to use outside VS Code|
|Export Wallet||Export a wallet to use outside VS Code|
|Generate Smart Contract Tests||Create functional level test files for single or multiple contracts|
|Import Package||Import a smart contract package|
|Install Smart Contract||Install a smart contract package onto a local_fabric runtime peer|
|Instantiate Smart Contract||Instantiate an installed smart contract package onto a channel|
|Open New Terminal||Open a new terminal on a specified Fabric node (peer, orderer, and fabric-ca-client CLIs)|
|Package a Smart Contract Project||Create a new smart contract package from a project in the Explorer|
|Remove Wallet||Remove a wallet from the Fabric Wallets view|
|Restart Fabric Runtime||Restart the local_fabric instance|
|Start Fabric Runtime||Start the local_fabric instance|
|Stop Fabric Runtime||Stop the local_fabric instance|
|Submit Transaction||Submit a transaction to a smart contract|
|Teardown Fabric Runtime||Teardown the local_fabric runtime (hard reset)|
|Toggle Development Mode||Toggle the local_fabric instance development mode|
|Upgrade Smart Contract||Upgrade an instantiated smart contract|
|View Homepage||View the extensions homepage|
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