uraeus

Crates.iouraeus
lib.rsuraeus
version0.1.2
sourcesrc
created_at2022-05-13 15:15:11.27847
updated_at2022-05-16 15:59:28.632043
descriptionCommand line utilities to check StarkNet contracts written in Cairo.
homepagehttps://github.com/onlydustxyz/uraeus
repositoryhttps://github.com/onlydustxyz/uraeus
max_upload_size
id585927
size75,148
A₿del ∞/21M (AbdelStark)

documentation

README

Uræus

Command line utilities to check StarkNet contracts written in Cairo.

⚠️ WARNING! ⚠️

This repo contains highly experimental code. Expect rapid iteration.

Prerequisites

📦 Installation

🧱 From crates.io

cargo install uraeus

🔧 From source

cargo install --path .

🔬 Usage

Verify

Verify checks if a source code matches a deployed contract.

uraeus-verify 
verify source code of deployed smart contracts

USAGE:
    uraeus verify [OPTIONS] <address>

ARGS:
    <address>    Address of the smart contract

OPTIONS:
    -b, --builddir <BUILD_DIR>        Build directory [default: ]
    -h, --help                        Print help information
    -n, --name <CONTRACT_NAME>        Contract name [default: main]
    -p, --projectdir <PROJECT_DIR>    Project root directory [default: ]

Example:

uraeus verify 0x0253db1872f5b9ad73ad17461fbbf0e987a23ea05d34c120311301bddb092dc8

Example verify

📗 Logging

Change log level using RUST_LOG environment variable.

Example:

RUST_LOG=debug cargo run -- verify 0x4bfedc224c8360eaa16969c5db2944d19c32dbabdb4fc0d93bb3ea759c7198c

🌡️ Testing

cargo test --verbose

🏄‍♂️ Test coverage

sh scripts/test_coverage.sh

🛠️ Development

Install git hooks

sh scripts/install_git_hooks.sh

📄 License

uraeus is released under the MIT.

Commit count: 51

cargo fmt