@lungchen/typescriptllvm v0.0.1

What is typescriptllvm?

typescriptllvm is a TypeScript frontend written in TypeScript for LLVM IR generation. For now, this work is mainly used for blockchain smart contract verification. Before we transpile Node.js code in Typescript into Javascript artifacts, Typescriptllvm combined with other backend analysis tools provides a powerful framework to search for vulnerabilities and security issues as smart contract developers would not realize while writing such smart contracts.

Design idea

Typescriptllvm extracts information on Abstract Syntax Tree (AST) generated with Typescript Compiler API by visiting each node, and create instructions accordingly with LLVM Typescript bindings to achieve the final IR generation.

For more detail, go to wiki pages

Install

npm install @lungchen/typescriptllvm

Note that in order to install this package from my private registry, you have to be a collaborator of mine on npm.

Usage

typescriptllvm can be run as a command as you normally would. Just type the following command to see more options on your favorite terminal.

typescriptllvm -h

Development

For those who would like to develop this project together, please check out below.

Prerequisite

Follow the steps to build the source code in LLVM project. I highly recommend using the build tool Ninja as it is fast and simple. Below are a few steps you could start from.

1. Clone the LLVM project repository and enter the project directory via git clone https://github.com/llvm/llvm-project.git and cd llvm-project
2. Choose a tag from the list and check out into a branch by running git tag -l and git checkout tags/<tag> (Replace <tag> for with your tag choice)
3. Generate Ninja build files with cmake -S llvm -B build -G Ninja
4. cmake --build build to start building your LLVM from the Ninja build files (This may take a while)

Note that we use LLVM 11.0.0 (llvmorg-11.0.0) to convert Typescript to LLVM Intermediate Representation in this project so you might want to build this LLVM version for compatibility purposes.

After it is successfully built, the final step is to run the following simple command to download all the dependencies, and you are good to contribute.

npm install

Code Style

This project is developed generally with Typescript style guide to attain better maintainability and readability.

References

A list of resources regarding LLVM and Typescript Compiler API documentation is provided below so that you can get started with this project to contribute if you will.

• https://github.com/microsoft/TypeScript/blob/d8e830d132a464ec63fd122ec50b1bb1781d16b7/doc/spec-ARCHIVED.md
• https://releases.llvm.org/11.0.0/docs/LangRef.html
• https://ts-ast-viewer.com/#
• https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
• https://github.com/emlai/ts-llvm

Disclaimer

By using this project, you agree that we as developers of typescriptllvm have no legal obligations in any form to your usage.