Everscale TON Solidity support for Visual Studio code

Files must have .tsol extension

Everscale TON Solidity is the language used in Everscale project to create smart contracts. This extension use extended Solidity language and provides:

• Syntax highlighting
• Own extension .tsol that allows working with Solidity code and Everscale TON Solidity language extension
• The extension can be associated with .sol files. Also exist "toggle file extension" command to migrate between .sol to .tsol and vice versa
• Snippets
• Compilation into build folder for quick deployment and migration processes
• Additional information by hover event
• Code completion for all contracts / libraries in the current file and all referenced imports
• Code completion for all variables, functions, global parameters and unique types for TVM
• Linting using Solhint or Solium
• Covered all extension for Everscale TON compiler accordance with https://github.com/tonlabs/TON-Solidity-Compiler/blob/master/API.md
• Built-in compiler with auto compilation tvc + abi.json files

Instructions

Code completion

Autocomplete is generally supported across for smart contracts, structs, functions, events, variables, using, inheritance. Autocomplete should happen automatically or press Ctrl+Space or Command+Space in areas like "import".

Auto compilation and error highlighting

Auto compilation of files and error highlighting can be enabled or disabled using user settings. Also a default delay is implemented for all the validations (compilation and linting) as ton-solidity compilation can be slow when you have many dependencies.

"tonsolidity.enabledAsYouTypeCompilationErrorCheck": true,
"tonsolidity.validationDelay": 1500

For auto compilation process this extenstion will create .temp folder in the root where is placed contracts folder. By save command the output files will be placed into build folder. From where they can be deployed quickly. This extension generates .tvc, abi.json and .base64 files. It is possible to use locklift developer tool for quick deployment process.

Additional information by hover event

If hover on a variable with some TVM functions that pop up with the information about property will be shown.

Linting

There are two linters included with the extension, solhint and solium / ethlint. You can chose your preferred linter using this setting, or disable it by typing ''

Solhint

To lint ton solidity code you can use the Solhint linter https://github.com/protofire/solhint, the linter can be configured it using the following user settings:

"tonsolidity.linter": "solhint",
"tonsolidity.solhintRules": {
  "avoid-sha3": "warn"
}

This extension supports .solhint.json configuration file. It must be placed to project root directory. After any changes in .solhint.json it will be synchronized with current IDE configuration.

This is the default linter now.

NOTE: Solhint plugins are not supported yet.

Solium / Ethlint

Solium is also supported by the extension https://github.com/duaraghav8/Solium, you can configure it using the following user settings:

"tonsolidity.linter": "solium",
"tonsolidity.soliumRules": {
    "quotes": ["error", "double"],
    "indentation": ["error", 4]
},

It can be used to fix some common issue automatically by running command "TON Solidity: Fix document rules using Solium"

Toggle file extenstion

Due to fact that need to use .tsol file extension, that is not recognized by Github syntax module, etc. you can find the command "TON Solidity: Toggle file extension" usefull for quick solution such issue before publication. This command will change the file extension from .sol to .tsol and vice versa. To use this feature need to open the menu on any folder in your project explorer. Then choice "TON Solidity: Toggle file extension"

Alternative solution

Create .gitattributes in the project root and add this content:

*.tsol linguist-language=Solidity

Updating/checking compiler version

If you need to change compiler version by manually then you need to install everdev by this instruction https://github.com/tonlabs/everdev#installation

To check the compiler version:

everdev sol version

To update the compiler and linker to the latest version:

everdev sol update

To set the compiler and linker to some specific version:

everdev sol set --compiler 0.38.0 --linker 0.23.54

More information you can find here https://github.com/tonlabs/everdev#version

Legacy compatibility with .sol file extension

For compatibility with legacy code base you can select the parser for .sol extension, that can be used instead Solidity language extension. By this fact you can comfortably work with the same file extension.

Known issues

• Sometimes the compiler can't be installed by automatically.

If you note that the auto compilation is not working. Please, try to install it by manually. Install everdev by this instruction https://github.com/tonlabs/everdev#installation Then install all needs for compiler:

everdev sol set

• Sometimes the compiler can't be installed by automatically.

If your antivirus show "checking security window" after any changing, then need to add folder C:\Users\__yourusername__\.everdev to the exclusions list.

Contributing / Issues / Requests

For ideas, issues, additions, modifications please raise an issue or a pull request at https://github.com/mytonwallet/vscode-tonsolidity-extension

Requested features

• [ ] Formatter
• [x] Show hovers
• [ ] Help with function and method signatures
• [ ] Possible actions on errors or warnings
• [ ] Incrementally format code as the user types
• [ ] Cut out parser, linter and other packages and create new separated