/allegedly

A fast Solidity compiler for EVM simulations, written in TypeScript

Primary LanguageTypeScriptMIT LicenseMIT

Allegedly

A fast Solidity compiler for EVM simulations, written in TypeScript.

Overview

import { sol } from "allegedly";

const depositContract = "0x...";

const { abi, code } = sol(`
contract GetBalance {
  function run() external returns (uint256) {
    return address(${depositContract}).balance;  
  }
}
`);

solc

This project is not meant to replace solc. Instead, it is a smaller, faster, more modular alternative, that produces less efficient and less secure bytecode.

Supported Language Features

Functions

  • uint{size}()
  • int{size}()
  • bytes{size}()
  • keccak256()
  • abi.encode()
  • abi.encodePacked()

Variables

Types

  • address
  • uint{size}
  • int{size}
  • bytes{size}
  • string
  • bytes
  • bool
  • tuple
  • struct
  • enum
  • mapping
  • array
  • user-defined: type UserType is uint256;

Statements

  • if (x) { }
  • for (x; x < 10; x++) { }
  • while (x) {}
  • do { } while (x)
  • break
  • continue
  • return
  • unchecked { }

Expressions

  • x++ or ++x
  • x-- or --x
  • -x
  • delete x
  • !x
  • ~x
  • x + y
  • x - y
  • x * y
  • x / y
  • x % y
  • x ** y
  • x && y
  • x || y
  • x == y
  • x != y
  • x < y
  • x <= y
  • x > y
  • x >= y
  • x & y
  • x | y
  • x ^ y
  • x >> y
  • x << y
  • x ? y : z

Errors

Events

Data locations

  • memory
  • calldata
  • returndata
  • storage
  • transient storage

Directives

  • import "file.sol";
  • pragma solidity major.minor.patch;
  • // SPDX-License-Identifier: ...
  • using UserType for {type}

Yul

  • assembly { }

Inheritance

Miscellaneous

Architecture

graph TD
  A[source code]
  B[tokens]
  C[ast]
  D[type annotations]
  E[bytecode + abi]
  A -- lexer --> B
  B -- parser --> C
  C -- checker --> D
  C -- compiler --> E
  D -- compiler --> E
Loading