Smart Contract Processing Tool-kit

Dependencies

npm == 8.5.0
node.js == v16.14.2
solidity-parser-antlr == ^0.4.11

General Introduction for the Whole Framework

• visitor.js: A kind of structural-based traversal method similar to SBT.
• visitor_sbt.js: A kind of SBT method adapted to smart contracts.
• visitor_sbt_struct.js: A kind of SBT method with only "type" to represent only structure semantic of code, which is also applicable to smart contract, adapted from Hu et al..
• visitor_xml.js: Transform a piece of smart contract code snippet to xml format Abstract Sybtax Tree(AST).
• tokenizer.py: Tokenize source code for smart contracts.
• testcode.js: Some sample code for testing above methods.
• test_visitor.js: If you want to run a sample code by above visitor_* method, use this function.
• parse_SCs.js: Run above visitor_* methods in batch.
• main.js: Main function.

Welcome to Cite!

• The tool-kit is provided and applied in the paper, if you find it useful and would like to cite it, the following would be appropriate:

@misc{yang2021multimodal,
      title={A Multi-Modal Transformer-based Code Summarization Approach for Smart Contracts}, 
      author={Zhen Yang and Jacky Keung and Xiao Yu and Xiaodong Gu and Zhengyuan Wei and Xiaoxue Ma and Miao Zhang},
      year={2021},
      eprint={2103.07164},
      archivePrefix={arXiv},
      primaryClass={cs.SE}
}