Language Grammar

grammar SolidityParser

Solidity is a statically typed, contract-oriented, high-level language for implementing smart contracts on the Ethereum platform.

source-unit

On top level, Solidity allows pragmas, import directives, and definitions of contracts, interfaces, libraries, structs, enums and constants.

import-directive

Import directives import identifiers from different files.

path

Path of a file to be imported.

symbol-aliases

List of aliases for symbols to be imported.

contract-definition

Top-level definition of a contract.

interface-definition

Top-level definition of an interface.

library-definition

Top-level definition of a library.

inheritance-specifier

Inheritance specifier for contracts and interfaces. Can optionally supply base constructor arguments.

contract-body-element

Declarations that can be used in contracts, interfaces and libraries.

Note that interfaces and libraries may not contain constructors, interfaces may not contain state variables and libraries may not contain fallback, receive functions nor non-constant state variables.

call-argument-list

Arguments when calling a function or a similar callable object. The arguments are either given as comma separated list or as map of named arguments.

identifier-path

Qualified name.

modifier-invocation

Call to a modifier. If the modifier takes no arguments, the argument list can be skipped entirely (including opening and closing parentheses).

visibility

Visibility for functions and function types.

parameter-list

A list of parameters, such as function arguments or return values.

constructor-definition

Definition of a constructor. Must always supply an implementation. Note that specifying internal or public visibility is deprecated.

state-mutability

State mutability for function types. The default mutability ‘non-payable’ is assumed if no mutability is specified.

override-specifier

An override specifier used for functions, modifiers or state variables. In cases where there are ambiguous declarations in several base contracts being overridden, a complete list of base contracts has to be given.

function-definition

The definition of contract, library, interface or free functions. Depending on the context in which the function is defined, further restrictions may apply, e.g. functions in interfaces have to be unimplemented, i.e. may not contain a body block.

modifier-definition

The definition of a modifier. Note that within the body block of a modifier, the underscore cannot be used as identifier, but is used as placeholder statement for the body of a function to which the modifier is applied.

fallback-function-definition

Definition of the special fallback function.

receive-function-definition

Definition of the special receive function.

struct-definition

Definition of a struct. Can occur at top-level within a source unit or within a contract, library or interface.

struct-member

The declaration of a named struct member.

enum-definition

Definition of an enum. Can occur at top-level within a source unit or within a contract, library or interface.

user-defined-value-type-definition

Definition of a user defined value type. Can occur at top-level within a source unit or within a contract, library or interface.

state-variable-declaration

The declaration of a state variable.

constant-variable-declaration

The declaration of a constant variable.

event-parameter

Parameter of an event.

event-definition

Definition of an event. Can occur in contracts, libraries or interfaces.

error-parameter

Parameter of an error.

error-definition

Definition of an error.

user-definable-operator

Operators that users are allowed to implement for some types with using for.

using-directive

Using directive to attach library functions and free functions to types. Can occur within contracts and libraries and at the file level.

using-aliases

type-name

A type name can be an elementary type, a function type, a mapping type, a user-defined type (e.g. a contract or struct) or an array type.

elementary-type-name

function-type-name

variable-declaration

The declaration of a single variable.

data-location

expression

Complex expression. Can be an index access, an index range access, a member access, a function call (with optional function call options), a type conversion, an unary or binary expression, a comparison or assignment, a ternary expression, a new-expression (i.e. a contract creation or the allocation of a dynamic memory array), a tuple, an inline array or a primary expression (i.e. an identifier, literal or type name).

tuple-expression

inline-array-expression

An inline array expression denotes a statically sized array of the common type of the contained expressions.

identifier

Besides regular non-keyword Identifiers, some keywords like ‘from’ and ‘error’ can also be used as identifiers.

literal

literal-with-sub-denomination

boolean-literal

string-literal

A full string literal consists of either one or several consecutive quoted strings.

hex-string-literal

A full hex string literal that consists of either one or several consecutive hex strings.

unicode-string-literal

A full unicode string literal that consists of either one or several consecutive unicode strings.

number-literal

Number literals can be decimal or hexadecimal numbers with an optional unit.

block

A curly-braced block of statements. Opens its own scope.

unchecked-block

statement

if-statement

If statement with optional else part.

for-statement

For statement with optional init, condition and post-loop part.

while-statement

do-while-statement

continue-statement

A continue statement. Only allowed inside for, while or do-while loops.

break-statement

A break statement. Only allowed inside for, while or do-while loops.

try-statement

A try statement. The contained expression needs to be an external function call or a contract creation.

catch-clause

The catch clause of a try statement.

return-statement

emit-statement

An emit statement. The contained expression needs to refer to an event.

revert-statement

A revert statement. The contained expression needs to refer to an error.

assembly-statement

An inline assembly block. The contents of an inline assembly block use a separate scanner/lexer, i.e. the set of keywords and allowed identifiers is different inside an inline assembly block.

assembly-flags

Assembly flags. Comma-separated list of double-quoted strings as flags.

variable-declaration-tuple

A tuple of variable names to be used in variable declarations. May contain empty fields.

variable-declaration-statement

A variable declaration statement. A single variable may be declared without initial value, whereas a tuple of variables can only be declared with initial value.

expression-statement

mapping-type

mapping-key-type

Only elementary types or user defined types are viable as mapping keys.

yul-statement

A Yul statement within an inline assembly block. continue and break statements are only valid within for loops. leave statements are only valid within function bodies.

yul-block

yul-variable-declaration

The declaration of one or more Yul variables with optional initial value. If multiple variables are declared, only a function call is a valid initial value.

yul-assignment

Any expression can be assigned to a single Yul variable, whereas multi-assignments require a function call on the right-hand side.

yul-if-statement

yul-for-statement

yul-switch-statement

A Yul switch statement can consist of only a default-case (deprecated) or one or more non-default cases optionally followed by a default-case.

yul-function-definition

yul-path

While only identifiers without dots can be declared within inline assembly, paths containing dots can refer to declarations outside the inline assembly block.

yul-function-call

A call to a function with return values can only occur as right-hand side of an assignment or a variable declaration.

yul-boolean

yul-literal

yul-expression

grammar SolidityLexer

fixed-bytes

Bytes types of fixed length.

sub-denomination

Unit denomination for numbers.

signed-integer-type

Sized signed integer types. int is an alias of int256.

unsigned-integer-type

Sized unsigned integer types. uint is an alias of uint256.

non-empty-string-literal

A non-empty quoted string literal restricted to printable characters.

empty-string-literal

An empty string literal

single-quoted-printable

Any printable character except single quote or back slash.

double-quoted-printable

Any printable character except double quote or back slash.

escape-sequence

Escape sequence. Apart from common single character escape sequences, line breaks can be escaped as well as four hex digit unicode escapes \uXXXX and two digit hex escape sequences \xXX are allowed.

unicode-string-literal

A single quoted string literal allowing arbitrary unicode characters.

hex-string

Hex strings need to consist of an even number of hex digits that may be grouped using underscores.

hex-number

Hex numbers consist of a prefix and an arbitrary number of hex digits that may be delimited by underscores.

decimal-number

A decimal number literal consists of decimal digits that may be delimited by underscores and an optional positive or negative exponent. If the digits contain a decimal point, the literal has fixed point type.

identifier

An identifier in solidity has to start with a letter, a dollar-sign or an underscore and may additionally contain numbers after the first symbol.

yul-evm-builtin

Builtin functions in the EVM Yul dialect.

yul-identifier

Yul identifiers consist of letters, dollar signs, underscores and numbers, but may not start with a number. In inline assembly there cannot be dots in user-defined identifiers. Instead see yulPath for expressions consisting of identifiers with dots.

yul-hex-number

Hex literals in Yul consist of a prefix and one or more hexadecimal digits.

yul-decimal-number

Decimal literals in Yul may be zero or any sequence of decimal digits without leading zeroes.

yul-string-literal

String literals in Yul consist of one or more double-quoted or single-quoted strings that may contain escape sequences and printable characters except unescaped line breaks or unescaped double-quotes or single-quotes, respectively.

pragma-token

Pragma token. Can contain any kind of symbol except a semicolon. Note that currently the solidity parser only allows a subset of this.