Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rocky/solidity-language-server


https://github.com/rocky/solidity-language-server

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        

**Table of Contents**



- [Prerequisites...](#prerequisites)

    - [Dependency hell](#dependency-hell)

- [How to run code in this github repository](#how-to-run-code-in-this-github-repository)

    - [Running](#running)

    - [Debugging](#debugging)

- [See also:](#see-also)



Perhaps you want to help work on this awesome project? Or run from the github repository?



# Prerequisites...



You need to have installed



* [nodejs](https://nodejs.org/en/)

* [npm](https://www.npmjs.com/get-npm)



There are a number of nodejs packages are needed, like [typescript](https://www.typescriptlang.org/), but you can get those via `npm`,

which is described in a below [section](#how-to-run-code-in-this-github-repository).



Having VSCode around is useful since it can show using the client and server together

(duh). Download [here](https://code.visualstudio.com/download).



## Dependency hell



This code is known to work with:



* (Microsoft) code 1.34.2

* nodejs 10 works, but version 12 has problems with building keccak

* typescript 3.5.1



To be able to have several nodejs versions around, there is [nvm](https://github.com/creationix/nvm).



# How to run code in this github repository



Clone the repository:



```console

$ git clone https://github.com/rocky/solidity-language-server

Cloning into 'solidity-language-server...

remote: Enumerating objects: 169, done.

...

$ cd solidity-language-server

$

```



Install dependent npm packages:



```console

$ npm install

```



Now just run from inside the `solidity-language-server` folder



```

$ code .

```



## Running



If you just want to run the code, on the top there is a "Debug" menu item and under that, the second item is "Start Without Debugging", which is also bound the key sequence `Ctrl`-`F5`.



After that, the VSCode window should turn from blue to orange and another window will pop up. In this window you will have the vscode extension installed and enabled.



If you edit a solidity file, which is a file ending in `.sol` and looks like this:



```solidity

/*

 * @source: http://blockchain.unica.it/projects/ethereum-survey/attacks.html#simpledao

 * @author: Atzei N., Bartoletti M., Cimoli T

 * Modified by Josselin Feist

 */

pragma solidity 0.4.25;



contract SimpleDAO {

  mapping (address => uint) public credit;



  function donate(address to) payable public{

    credit[to] += msg.value;

  }



  function withdraw(uint amount) public{

    if (credit[msg.sender]>= amount) {

      require(msg.sender.call.value(amount)());

      credit[msg.sender]-=amount;

    }

  }



  function queryCredit(address to) view public returns(uint){

    return credit[to];

  }

}

```



This when rendered inside be colorized, for example the tokens "pragma", "solidity" and "0.4.25" may appear in a different color. If the all appear in the same color then the language extension mechanism is not working and there is probably something wrong in the extension. Look in the other VSCode window with the orange frame for what might be wrong.



But if everything is good, enter `Ctrl`-`Shift`-`P` and a list of commands will pop up. If you type "Solidity", you should see those specific to this extension.



## Debugging



You may want to extend this code of may find a problem and want to debug what is going wrong. For this, you start off from the "Debug" menu using the first item on the list "Start Debugging" which is also bound to the function key `F5`. As before the window will go orange a popup menu bar will appear at the top.



__NOTE__: It may happen that after the window goes orange, another and VSCode window with the blue, the "play button" may go from a the parallel bars to "pause" back to "play". When that happens you may also be stopped in `bootstrap-fork.js` at some nonsensical like like line 9 which has no code on it. If this happens (and it may happen several times for each solidity file loaded) just hit the play button to make sure it goes back to the parallel bars. You have 10 seconds from the time this button goes from "Pause" to "Play" to hit the "Play" button. Otherwise in the other VSCode you will get a popup message that reads:



> Extension host did not start in 10 seconds, it might be stopped on the first line and needs a debugger to continue.



# See also:



* [Extension API](https://code.visualstudio.com/api)

* [Your First Extension](https://code.visualstudio.com/api/get-started/your-first-extension)