Skip to content
This repository has been archived by the owner on Nov 20, 2024. It is now read-only.

Deprecate extension, in favor of "sc-meta" #88

Merged
merged 1 commit into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 9 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,17 @@
# MultiversX IDE for Visual Studio Code

![Build Status](https://github.com/multiversx/mx-ide-vscode/actions/workflows/build.yml/badge.svg)
----

## What is it?
> **Warning**
> # This extension is no longer maintained.

**MultiversX IDE** is an extension for Visual Studio Code that offers development support for MultiversX Smart Contracts written in Rust.
-----

## Main features
MultiversX IDE was an extension for Visual Studio Code that offered development support for MultiversX Smart Contracts written in Rust.

- 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](#installing-the-rust-debugger-pretty-printer-script)
**Instead, developers are recommended to directly use [`sc-meta`](https://docs.multiversx.com/developers/meta/sc-meta-cli)** - tool of the [**SpaceCraft**](https://github.com/multiversx/mx-sdk-rs) Rust framework - in order to build and test smart contracts.

## How to get it
Additionally, for writing and debugging Smart Contracts written in Rust, the following extensions are recommended:

MultiversX 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](https://github.com/multiversx/mx-ide-vscode/issues), on [Discord](http://discord.gg/MultiversXBuilders) or [on Telegram](https://t.me/MultiversXDevelopers).

### [mxpy](https://github.com/multiversx/mx-sdk-py-cli)

**mxpy** is the backend of the Visual Studio Code extension. **mxpy** is **required** by the MultiversX IDE. In order to install it, please follow [these steps](https://docs.multiversx.com/sdk-and-tools/sdk-py/installing-mxpy).

### Other dependencies

The extension, via `mxpy`, 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. tests / scenarios framework)

## Extension Commands

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

* `newFromTemplate`
* `buildContract`
* `cleanContract`
* `runScenarios`

## 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](https://github.com/vadimcn/vscode-lldb) 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 `MultiversX: Install the rust debugger pretty printer script`. If this option isn't present, make sure you have the latest version of the `MultiversX` 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 mx-sdk-rs.

## Contributors

### How to publish an update of the extension

1. Within a PR, bump the version in `package.json` and `package-lock.json`.
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.
- [Rust Analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
- [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb)
85 changes: 59 additions & 26 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "vscode-elrond-ide",
"displayName": "MultiversX IDE",
"description": "MultiversX IDE for developing Smart Contracts",
"version": "0.21.1",
"version": "0.22.0",
"publisher": "Elrond",
"repository": {
"type": "git",
Expand Down
Loading