Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Aniket-Engg/sol-profiler-vscode
Visual Code Extension to Generate & Store Smart Contract Methods Profile
https://github.com/Aniket-Engg/sol-profiler-vscode
smart-contracts sol-profiler solidity vscode vscode-extension
Last synced: about 5 hours ago
JSON representation
Visual Code Extension to Generate & Store Smart Contract Methods Profile
- Host: GitHub
- URL: https://github.com/Aniket-Engg/sol-profiler-vscode
- Owner: Aniket-Engg
- License: mit
- Created: 2019-02-21T05:53:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T13:52:35.000Z (almost 2 years ago)
- Last Synced: 2024-11-02T06:53:39.865Z (6 days ago)
- Topics: smart-contracts, sol-profiler, solidity, vscode, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 109 KB
- Stars: 13
- Watchers: 2
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-solidity - sol-profiler-vscode - Visual Code Extension to generate & store smart contract methods profile. (Editor Plugins)
- awesome-solidity - sol-profiler-vscode - Visual Code Extension to generate & store smart contract methods profile. (Editor Plugins)
- awesome-solidity - sol-profiler-vscode - Visual Code Extension to generate & store smart contract methods profile. (Editor Plugins)
README
[](https://travis-ci.com/Aniket-Engg/sol-profiler-vscode)
[](https://marketplace.visualstudio.com/items?itemName=Aniket-Engg.sol-profiler-vscode)
[](https://marketplace.visualstudio.com/items?itemName=Aniket-Engg.sol-profiler-vscode)
[](https://marketplace.visualstudio.com/items?itemName=Aniket-Engg.sol-profiler-vscode)
[](https://marketplace.visualstudio.com/items?itemName=Aniket-Engg.sol-profiler-vscode)
[](https://github.com/Aniket-Engg/sol-profiler-vscode/blob/master/LICENSE)
# sol-profiler-vscode
[sol-profiler-vscode](https://marketplace.visualstudio.com/items?itemName=Aniket-Engg.sol-profiler-vscode) extension generates & stores Solidity smart contract methods profile. Contract file should be opened in editor. Generated profile helps to get knowledge of method attributes any time later at one glance.
**Note:** sol-profiler-vscode extension does not ensure/guarantee any kind of security or correctness of any smart-contract.
## Features
* Generates & stores profile in a folder named `profiles` in a .txt file named with suffix `_Profile`
* Supports file import from relative path and `node_modules`(like openzeppelin-solidity etc.) both
* Explicitly marks `abstract` and `fallback` functions
* Explicitly marks `library` and `interface` contracts
* Since Solidity release [v0.5.0](https://github.com/ethereum/solidity/releases/tag/v0.5.0), Explicit data location for all variables of struct, array or mapping types is now mandatory, so profile also include the storage location of parameters defined explicitly.
## How to use
* Install extension by searching `sol-profiler` in extensions section of VSCode
* Open contract file (`.sol`) in editor whose profile you want to generate
* Open `View -> Command Palette` (Keyboard Shortcut: `CTRL + SHIFT + P`)
* Type `sol-profiler`. You will see a text in dropdown as `sol-profiler: generate profile`. Click on it & you're done. (As result, success/failure message will be shown as notification)
## Demo
For CLI version, see https://www.npmjs.com/package/sol-profiler
## License
[MIT](https://github.com/Aniket-Engg/sol-profiler-vscode/blob/master/LICENSE)