Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 3.27 KB

README.md

File metadata and controls

75 lines (45 loc) · 3.27 KB
Raw

Elrond IDE for Visual Studio Code

Build Status

This Visual Studio Code extension is under development: CHANGELOG

What is it?

Elrond IDE is an extension for Visual Studio Code that offers development support for Elrond Smart Contracts.

Elrond IDE supports the following programming languages:

  • Rust - recommended. For Rust, the IDE also provides a step-by-step debugging experience, via elrond-wasm-debug.
  • C / C++

Main features

  • Build Smart Contracts to WASM
  • Step-by-step debugging Rust smart contracts
  • Automatically download tools and dependencies
  • Rust debugger support for managed types - see the installation guide

How to get it

Elrond IDE can be installed from the Visual Studio Code Marketplace.

Requirements and dependencies

Operating system

  • Linux is supported
  • Windows is not supported yet
  • MacOS is supported

If you experience any issues, please let us know on Github or on Telegram.

erdpy

erdpy is the backend of the Visual Studio Code extension. erdpy is required by the Elrond IDE. In order to install it, please follow these steps.

Other dependencies

The extension, via erdpy, will automatically download its external dependencies, so you do not have to worry much about setting up the development environment. These automatically installed dependencies include:

  • RUST buildchain
  • VM Tools (e.g. Mandos framework)
  • LLVM (clang, llc, wasm-ld etc.)

Extension Commands

This extension contributes the following commands (Ctrl+Shift+P):

  • newFromTemplate
  • buildContract
  • cleanContract
  • runMandosTests
  • runContractSnippet

Installing the rust debugger pretty printer script

The rust debugger pretty printer script for LLDB allows proper viewing of managed types (BigUint, ManagedBuffer etc.) when debugging smart contract rust tests.

Prerequisites: First, make sure that the CodeLLDB extension is installed. This can be done directly from Visual Studio Code extensions menu.

Then, from Visual Studio Code open the command menu via Ctrl+Shift+P and run Elrond: Install the rust debugger pretty printer script. If this option isn't present, make sure you have the latest version of the Elrond Visual Studio Code extension.

You will be prompted for the repository, branch and path for the pretty printer script. Simply leave the options blank in order to install the latest version of the script from elrond-wasm-rs.

Contributors

How to publish an update of the extension

  1. Within a PR, bump version in package.json and package-lock.json, and update changelog.
  2. Open and merge the PR against the main (master) branch.
  3. Trigger the Github Workflow called Release. This will also publish the extension on the Visual Studio Marketplace.