epociask/stylus-dependency-verifier

Quickly determine if a third-party dependency can be used in your Arbitrum Stylus smart contract.

Stylus Library Validator

About

The Stylus Library Validator is a tool that validates if a third party library is compatible with Stylus. It is a command line tool that takes a library as input and outputs an assessment (PASS/FAIL) of the validation process.

Currently this tool only works for rust dependencies. The implementation was also written very quickly and therefore lacks proper testing, documentation, and extensibility. This could be improved in the future.

Usage

Prerequisites

• Rust
• Cargo
• Rust-Stylus
• Python3

Installation

1. Clone this repository
2. Run pip3 install -r requirements.txt to install the required python packages

Running

Run python3 rust_verify.py -r "<GIT_REPO>" -d "<DEPENDENCY_NAME> -v "<DEPENDENCY_VERSION>" to run the stylus package validator. - <GIT_REPO> is the git repository of the dependency - <DEPENDENCY_NAME> is the name of the dependency - <DEPENDENCY_VERSION> is the version of the dependency

Batch

The batch.py script can be used to process all rust crates exposed by crates.io API. It will output a csv file with the results of the validation process. This is useful to get a general idea of the compatibility of the rust ecosystem with Stylus as well as to identify which crates are compatible and which are not.

Future Work

• Add support for more languages
• Add more tests
• Add more documentation