Web3 Development

VS Code Corda ExtensionDeveloping CorDapps Inside Visual Studio Code

Build, test and run CorDapps on the Corda platform from Visual Studio Code. Features, setup and honest notes on project status.

Free Open source Windows: Unverified v0.1.0 Updated 25 May 2021
8 min read Last update 25 May 2021 github.com/corda/vscode-corda

The VS Code Corda extension is a free, open-source tool for developers who build CorDapps on the Corda platform and prefer to work from Visual Studio Code. It is aimed at blockchain engineers who need to compile a Corda project, run its tests and spin up a local network of nodes without leaving the editor and switching to the command line for every step.

Corda is a distributed ledger platform designed for businesses that need to share state with a limited set of counterparties rather than broadcast everything to every participant. Its applications, called CorDapps, are typically built with Gradle. This extension wraps the most common Gradle tasks in editor commands, so a developer can clean, build, test and run a project from the command palette and watch the results in one place.

02

What Is Corda and Why Developers Use It

Corda is a blockchain-inspired platform, but it departs from the public-chain model in important ways. Rather than replicating every transaction to every participant, Corda shares data only with the parties involved in a given agreement. This suits financial institutions and supply-chain partners that need privacy and legal clarity.

For a developer, this means the unit of work is a flow between specific nodes, not a global smart contract called by anyone. Understanding that model is the first step before any tooling makes sense.

03

Who This Extension Is For

The extension is most useful for developers who already have a Corda project and want a more integrated workflow. Typical users include:

  • Engineers building proof-of-concept CorDapps for a bank or consortium.
  • Teams that write most of their code in JavaScript or TypeScript tooling and want Corda tasks next to their other editor features.
  • Developers evaluating Corda who want to see flows run on a local mock network before investing in a full deployment.

If you mainly write Solidity for Ethereum-style chains, the tools in the related section are a better fit.

04

How the Development Loop Fits Together

A typical session follows a loop: clean the project, build and test, deploy a mock network, run the nodes, exercise your flows, then stop the nodes. The extension maps each of these steps to a command, which makes the loop easier to repeat dozens of times a day.

Keeping the nodes running while you edit is not always practical, since changes to a CorDapp usually require a rebuild and redeploy. Plan your session so that the node network is restarted after each significant change to avoid testing against stale code.

05

Understanding Mock Networks and Local Testing

A mock network lets you simulate several parties on one machine. This is valuable because most Corda bugs appear in the interaction between parties: a flow that works for the initiator may fail when the counterparty responds unexpectedly.

Use unit tests for the logic of individual contracts and flows, and use the deployed local nodes for end-to-end checks. Combining both catches different classes of errors and keeps debugging time under control.

06

Key features

Clean project

Removes build artifacts from earlier runs so the next build starts from a known state. Useful when a stale file or cached output is causing confusing errors.

Assemble project

Compiles the CorDapp without running the test suite. This is the quicker option when you only want to check that the code compiles after a change.

Build project

Builds and tests the CorDapp using the Gradle setup already present in the project. It is the command to run before committing or handing work to a teammate.

Run unit tests

Executes the unit tests of the CorDapp directly from the editor, so you can iterate on failing cases without leaving your code.

Deploy nodes

Creates a mock network from the project's Gradle file, generating the node configurations needed for local testing of flows between parties.

Run nodes

Starts the nodes of the deployed network so you can send transactions and observe how your flows behave across parties.

Stop running nodes

Shuts down nodes that are currently running. The command becomes available only while nodes are active, which keeps the menu uncluttered.

Show node explorer

Opens the node explorer view so you can inspect the state of the local network while developing and debugging.
07

How to install VS Code Corda extension on Windows

  1. 1

    Prepare your environment

    Install Visual Studio Code from the official website. Make sure your Corda project builds from the command line first, since the extension depends on the same Gradle setup. The extension documentation notes Windows as a supported environment, although the project itself lists Windows and Linux among its platforms.

  2. 2

    Get the extension

    Open the Extensions view in Visual Studio Code and search for the Corda extension. Install it from the marketplace or download the package from the project's GitHub repository at github.com/corda/vscode-corda, and install it from there. Only download from the official website or the official GitHub repository.

  3. 3

    Verify the download

    If you download a package manually, compare its SHA-256 checksum with the value published by the project before installing. This step protects you from tampered files.

  4. 4

    Open your CorDapp project

    Open the root folder of your Corda project in Visual Studio Code so that the Gradle files are visible to the extension.

  5. Confirm your Corda version

    If you use the dashboard feature, make sure your project uses Corda 4.3 or newer, since that is the version the dashboard requires.

08

System requirements

  • Windows, as listed among the supported platforms
  • Visual Studio Code, which hosts the extension
  • A Corda project with a working Gradle build
  • Corda 4.3 or newer for the dashboard display of node information
09

How to use VS Code Corda extension

Once the extension is installed and your project is open, you can run the full development cycle from the command palette. The commands are grouped under the Corda prefix, so typing that word is the quickest way to find them.

A practical workflow looks like this:

  1. Run the Clean project command to remove leftover build files from earlier sessions.
  2. Run Build project to compile the CorDapp and execute its tests. Fix any failures before moving on.
  3. Run Deploy nodes to generate the mock network from your Gradle configuration.
  4. Run Run nodes to bring the network online, then exercise your flows from the node shell or your client code.
  5. Open Show node explorer to inspect the state of each node while the flows execute.
  6. Run Stop running nodes when you are finished, so that ports and processes are released.

If you only need to confirm that code compiles, use Assemble project instead of the full build to save time.

10

Pros & cons

Pros
  • Free and open source, with the source code publicly available on GitHub
  • Brings the main Corda Gradle tasks into the editor
  • Covers the full loop from clean build to running nodes
  • Includes a node explorer for inspecting local networks
  • Lightweight compared with a full IDE setup
Cons
  • No code updates since 2021, so compatibility with newer Corda releases is uncertain
  • Windows support is described in documentation but has not been verified in current releases
  • Documentation and feature set are limited compared with mainstream IDE tooling
  • Depends on an existing Gradle-based project; it does not scaffold a new CorDapp from scratch
11

Is VS Code Corda extension safe?

The extension is an editor plugin rather than a wallet or miner, so it does not handle private keys or funds. Even so, download it only from the official Visual Studio Code marketplace listing or the project's GitHub repository. Verify the SHA-256 checksum of any manually downloaded package, and never enter a seed phrase or private key into any tool or website claiming to be a Corda helper.

Be aware that the project has not received code updates since May 2021. That does not make it malicious, but it means no recent security fixes or dependency updates should be expected. Review the source on GitHub if you intend to rely on it in a serious environment, and check the official website for the latest version before installing.

  • Official source only. Download from github.com/corda/vscode-corda. Ignore ads and lookalike domains.
  • Check the SHA-256. Compare the installer hash with the value the developer publishes before running it.
  • Never share your seed phrase. No developer, support agent or website — including CryptApps — will ever ask for it.
12

Alternatives

The VS Code Corda extension differs from general-purpose tools in its narrow scope. It is designed for Corda's Gradle workflow, while Remix Desktop and the Solidity extension for Visual Studio Code target Ethereum-style smart contracts written in Solidity. Foundry offers its own command-line toolkit for EVM development rather than a Corda-specific workflow.

If your work is purely about Corda, this extension saves steps that you would otherwise type by hand. If you need to debug transactions on a live network or monitor deployed contracts, Tenderly CLI is more relevant. For RPC testing, Postman with JSON-RPC support is a general option that does not depend on any specific platform.

13

Specifications

Price
Free
Type
Open source
License
—
Latest version
0.1.0
Last update
25 May 2021
Windows support
Unverified (Windows mentioned in docs)
Source code
github.com/corda/vscode-corda
14

Frequently asked questions

Yes. The extension is free and open source, and its source code is published on GitHub under the corda organization. You do not pay a license fee to use the commands it provides. Corda itself is a separate platform, and you may need to set up its tooling and dependencies independently.

The project lists Windows among its supported platforms, but the documentation support status is unverified for the current release. Test the commands on a non-critical project first. Since the extension depends on Gradle and a working Corda setup, the environment you prepare matters as much as the extension itself.

The dashboard feature, which displays node information, requires Corda 4.3 or newer. Other commands depend on your project's own Gradle configuration. Check your build file to confirm which Corda version your CorDapp targets before you start.

The extension focuses on building, testing and running existing projects. It works with the Gradle setup already in your project, so you need an existing CorDapp structure to begin. Creating the initial project is done with Corda's own project templates and tooling.

A mock network is a set of Corda nodes running on one machine that simulate several parties. You use it to test how your flows interact between participants without deploying to a real network. The Deploy nodes command generates this setup from your Gradle file.

Stale tooling can still be useful for learning or for working with older Corda versions, but it may not support newer releases or security practices. Read the source, test in an isolated environment, and consider whether the command set meets your needs before relying on it for production work.

Yes. The extension runs inside Visual Studio Code and uses the same Gradle tasks you would run from a terminal, so it can coexist with other editor plugins. Keep an eye on conflicting port usage when several tools try to start nodes at once.

15

Verdict

The VS Code Corda extension suits developers who already work with Corda and want its Gradle tasks and local node network inside Visual Studio Code. It is free and transparent, with the full source on GitHub. Its main drawback is age: the last code update came in 2021 and Windows support is not verified for current releases. Test it on a non-critical project and confirm compatibility with your Corda version before adopting it.

Download now