Biconomy Solidity Style Guide

Biconomy Solidity Style Guide 🍊

Introduction

Purpose and Scope

This guide is designed to provide coding conventions for writing Solidity code, ensuring consistency and readability. It is an evolving document that will adapt over time as new conventions are established and old ones become obsolete.

Note

This guide is intended to extend, not replace, the official Solidity style guide, covering additional important aspects not addressed by the existing guidelines .

Evolution of the Guide

As Solidity and its ecosystem evolve, so too will this style guide. It will incorporate new best practices, discard outdated ones, and adapt to the changing needs of the community.

Tip

💡 Regular updates ensure that the guide remains relevant and continues to promote the latest best practices in Solidity development .

Consistency over Correctness

The primary goal of this guide is consistency, not necessarily correctness or the best way to write Solidity code. Consistency helps improve the readability and maintainability of codebases.

Important

"A foolish consistency is the hobgoblin of little minds." Consistency with this guide is important, but consistency within a project or module is even more crucial. Use your best judgment and adapt as necessary .

This introductory section sets the stage for a comprehensive style guide, emphasizing the importance of adaptability, consistency, and extending existing best practices in Solidity coding.

General Coding Conventions

Indentation and Spacing

Indentation Rules

Use 4 spaces per indentation level.

Tip

💡 Consistent indentation enhances code readability and structure, making it easier to follow and maintain.

Tabs or Spaces

Spaces are the preferred indentation method. Avoid mixing tabs and spaces.

Warning

⚠️ Mixing tabs and spaces can lead to hard-to-debug errors. Stick to spaces for consistency.

Blank Lines

Surround top-level declarations in Solidity with two blank lines.
Use a single blank line to separate function definitions within a contract.

✅ Yes:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.4.0 <0.9.0;

contract A {
    // ...
}

contract B {
    // ...
}

contract C {
    // ...
}

❌ No:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.4.0 <0.9.0;

contract A {
    // ...
}
contract B {
    // ...
}

contract C {
    // ...
}

Within a contract, surround function declarations with a single blank line. Blank lines may be omitted between groups of related one-liners (such as stub functions for an abstract contract).

✅ Yes:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.6.0 <0.9.0;

abstract contract A {
    function spam() public virtual pure;
    function ham() public virtual pure;
}

contract B is A {
    function spam() public pure override {
        // ...
    }

    function ham() public pure override {
        // ...
    }
}

❌ No:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.6.0 <0.9.0;

abstract contract A {
    function spam() virtual pure public;
    function ham() public virtual pure;
}

contract B is A {
    function spam() public pure override {
        // ...
    }
    function ham() public pure override {
        // ...
    }
}

Important

Proper spacing helps visually separate different sections of your code, making it easier to read and understand.

Maximum Line Length

Limit lines to a maximum of 120 characters. For long lines, follow these wrapping guidelines:

Place the first argument on a new line.
Use a single indentation level.
Place each argument on its own line.
Place the closing element on a new line.

Function Calls

✅ Yes:

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3
);

❌ No:

thisFunctionCallIsReallyLong(longArgument1,
                              longArgument2,
                              longArgument3
);

thisFunctionCallIsReallyLong(longArgument1,
    longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1, longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3);

Assignment Statements

✅ Yes:

thisIsALongNestedMapping[being][set][toSomeValue] = someFunction(
    argument1,
    argument2,
    argument3,
    argument4
);

❌ No:

thisIsALongNestedMapping[being][set][toSomeValue] = someFunction(argument1,
                                                                   argument2,
                                                                   argument3,
                                                                   argument4);

Event Definitions and Event Emitters

✅ Yes:

event LongAndLotsOfArgs(
    address sender,
    address recipient,
    uint256 publicKey,
    uint256 amount,
    bytes32[] options
);

emit LongAndLotsOfArgs(
    sender,
    recipient,
    publicKey,
    amount,
    options
);

❌ No:

event LongAndLotsOfArgs(address sender,
                        address recipient,
                        uint256 publicKey,
                        uint256 amount,
                        bytes32[] options);

emit LongAndLotsOfArgs(sender,
                  recipient,
                  publicKey,
                  amount,
                  options);

Caution

🚨 Long lines can be difficult to read and understand. Breaking them up improves clarity.

Source File Encoding

Use UTF-8 or ASCII encoding for Solidity files.

Note

Consistent file encoding ensures compatibility and prevents encoding-related issues across different environments and tools.

Tip

💡 UTF-8 should be preferred over ASCII as it supports a wider range of characters.

Use the Latest Version of Solidity

Rule: Always use the latest stable version of Solidity. This version includes the most recent fixes, gas optimizations, and security improvements, ensuring your smart contracts are up-to-date with the best practices and latest advancements. This recommendation comes directly from the maintainers of the Solidity repository, who are responsible for the ongoing development and improvement of the language. While some tools like Slither might suggest using older versions, using the latest version is crucial for maximizing security and performance.

Tip

💡 Regularly check for updates and migrate your code to the latest stable version to take advantage of new features and enhancements in Solidity.

Imports

Import statements should always be placed at the top of the file.

A. Placing Imports

Organize imports clearly at the top of the file to make dependencies easier to manage and understand.

✅ Yes:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.4.0 <0.9.0;

import "./Owned.sol";

contract A {
    // ...
}

contract B is Owned {
    // ...
}

❌ No:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.4.0 <0.9.0;

contract A {
    // ...
}

import "./Owned.sol";

contract B is Owned {
    // ...
}

Note

Organizing imports clearly at the top of the file makes dependencies easier to manage and understand.

B. Use Named Imports

Named imports or Selective Imports help readers understand what is being used and where it is declared.

✅ Yes:

import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";

❌ No:

import "@openzeppelin/contracts/access/Ownable.sol";

Note

Named imports provide clarity on what is being imported, reducing potential confusion and making code review easier.

C. Order Imports by Path Length

Order imports by the length of their paths, from shortest to longest, to maintain a clean and organized structure.

✅ Yes:

import {Math} from "./Math.sol";

import {Ownable} from "../access/Ownable.sol";
import {ERC20} from "../../token/ERC20.sol";

❌ No:

import {Ownable} from "../access/Ownable.sol";
import {ERC20} from "../../token/ERC20.sol";
import {Math} from "./Math.sol";

Tip

💡 Ordering imports by path length improves readability by maintaining a consistent structure, making it easier to locate and manage dependencies.

D. Group Imports by External and Internal

Separate external and internal imports with a blank line and sort each group by path length.

✅ Yes:

import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {SafeMath} from "@openzeppelin/contracts/math/SafeMath.sol";

import {Math} from "./Math.sol";
import {MyHelper} from "./helpers/MyHelper.sol";

❌ No:

import {Math} from "./Math.sol";
import {MyHelper} from "./helpers/MyHelper.sol";
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
import {SafeMath} from "@openzeppelin/contracts/math/SafeMath.sol";

Tip

💡 Grouping and sorting imports by their origin (external vs. internal) and path length keeps the codebase clean and well-organized, facilitating easier dependency management.

Code Structure

Code Layout

Maintain a consistent code layout to improve readability and organization. Structure your code with clear separations between different sections and use proper indentation and spacing.

Tip

💡 A well-organized layout helps developers quickly understand the structure and flow of the code.

Order of Functions

Ordering helps readers identify which functions they can call and to find the constructor and fallback definitions easier.

Functions should be grouped according to their visibility and ordered:

constructor
receive function (if exists)
fallback function (if exists)
external
public
internal
private

Within a grouping, place the view and pure functions last.

✅ Yes:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.0 <0.9.0;

contract A {
    constructor() {
        // ...
    }

    receive() external payable {
        // ...
    }

    fallback() external {
        // ...
    }

    // External functions
    // ...

    // External functions that are view
    // ...

    // External functions that are pure
    // ...

    // Public functions
    // ...

    // Internal functions
    // ...

    // Private functions
    // ...
}

❌ No:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.0 <0.9.0;

contract A {

    // External functions
    // ...

    fallback() external {
        // ...
    }
    receive() external payable {
        // ...
    }

    // Private functions
    // ...

    // Public functions
    // ...

    constructor() {
        // ...
    }

    // Internal functions
    // ...
}

Tip

💡 Grouping functions by visibility and type helps maintain a clear and organized contract structure.

Order of Layout Elements

Arrange elements in the following order within contracts, libraries, or interfaces:

Pragma statements
Import statements
Events
Errors
Interfaces
Libraries
Contracts

Note

This ordering helps readers identify the structure and dependencies of the code more easily.

Inside each contract, library, or interface, use the following order:

Type declarations
State variables
Events
Errors
Modifiers
Functions

Note

It might be clearer to declare types close to their use in events or state variables.

✅ Yes:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.8.4 <0.9.0;

abstract contract Math {
    error DivideByZero();
    function divide(int256 numerator, int256 denominator) public virtual returns (uint256);
}

❌ No:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.8.4 <0.9.0;

abstract contract Math {
    function divide(int256 numerator, int256 denominator) public virtual returns (uint256);
    error DivideByZero();
}

Single Contract or Interface Per File

Each Solidity file should contain only one contract or interface to simplify navigation and improve readability.

Tip

💡 Keeping a single contract or interface per file enhances maintainability and reduces complexity.

Naming Conventions

Naming conventions are powerful when adopted and used broadly. The use of different conventions can convey significant meta information that would otherwise not be immediately available.

The naming recommendations given here are intended to improve readability, and thus they are not rules, but rather guidelines to try and help convey the most information through the names of things.

Lastly, consistency within a codebase should always supersede any conventions outlined in this document.

Naming Styles

Use consistent naming styles to convey the purpose and scope of variables and functions:

b (single lowercase letter)
B (single uppercase letter)
lowercase
UPPERCASE
SNAKE_UPPER_CASE
PascalCase
camelCase

Note

Consistent naming styles improve readability and help convey meta-information.

Note

When using initialisms in PascalCase, capitalize all the letters of the initialisms. Thus HTTPServerError is better than HttpServerError. When using initialisms in camelCase, capitalize all the letters of the initialisms, except keep the first one lowercase if it is the beginning of the name. Thus xmlHTTPRequest is better than XMLHTTPRequest.

Names to Avoid

Avoid using names that are easily confused with each other or with numerals, such as l, O, and I.

Note

Using ambiguous names can lead to confusion and errors.

Caution

🚨 Never use any of these for single letter variable names. They are often indistinguishable from the numerals one and zero.

Contract and Library Names

Contracts and libraries should be named using the PascalCase style. Examples: SimpleToken, SmartBank, CertificateHashRepository, Player, Congress, Owned.
Contract and library names should also match their filenames.
If a contract file includes multiple contracts and/or libraries, then the filename should match the core contract. This is not recommended however if it can be avoided.

✅ Yes:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.0 <0.9.0;

// Owned.sol
contract Owned {
    address public owner;

    modifier onlyOwner {
        require(msg.sender == owner);
        _;
    }

    constructor() {
        owner = msg.sender;
    }

    function transferOwnership(address newOwner) public onlyOwner {
        owner = newOwner;
    }
}

and in Congress.sol:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.4.0 <0.9.0;

import "./Owned.sol";

contract Congress is Owned, TokenRecipient {
    //...
}

❌ No:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.0 <0.9.0;

// owned.sol
contract owned {
    address public owner;

    modifier onlyOwner {
        require(msg.sender == owner);
        _;
    }

    constructor() {
        owner = msg.sender;
    }

    function transferOwnership(address newOwner) public onlyOwner {
        owner = newOwner;
    }
}

and in Congress.sol:

// SPDX-License-Identifier: GPL-3.0
pragma solidity ^0.7.0;

import "./owned.sol";

contract Congress is owned, tokenRecipient {
    //...
}

Tip

💡 Clear and consistent naming of contracts and libraries aids in project organization and readability.

Naming Interfaces

Rule: Interfaces should be named in a way that starts with I followed by the name of the contract it interfaces for, or you can use ContractNameInterface. Whichever naming convention you choose, you should stick to it.

Note

Consistent naming of interfaces improves readability and helps in distinguishing between contracts and interfaces. This practice makes the code more intuitive and easier to navigate, especially in larger codebases.

Example:

✅ Yes:

interface IToken {
    function transfer(address recipient, uint256 amount) external returns (bool);
}

or

interface TokenInterface {
    function transfer(address recipient, uint256 amount) external returns (bool);
}

❌ No:

interface token {
    function transfer(address recipient, uint256 amount) external returns (bool);
}

Defining Contract Types in Interfaces

Rule: Define all events, errors, structs, and optionally function names within interfaces for better modular organization and clarity.

Tip

💡 Grouping related types within interfaces enhances modularity and clarity, making it easier to manage and understand the structure of contracts.

Example:

✅ Yes:

interface IToken {
    struct TokenData {
        address issuer;
        uint256 value;
    }
    error Unauthorized();
    event TokenIssued(address indexed issuer, uint256 value);
}

// Usage in contract
contract Token is IToken {
    // Implementation details
}

❌ No:

contract Token {
    struct TokenData {
        address issuer;
        uint256 value;
    }
    error Unauthorized();
    event TokenIssued(address indexed issuer, uint256 value);
}

Struct Names

Structs should be named using PascalCase to distinguish them from variables and functions.

Examples: MyCoin, Position, PositionXY.

Event Names

Events should be named using PascalCase and should convey the past tense of an action. Examples: ContractUpgraded, FundsDeposited.TransferCompleted.

Note

Clear event names improve the understanding of emitted logs.

Function Names

Functions should use camelCase. Examples: getBalance, transfer, verifyOwner, addMember, changeOwner.

Variable Names

Variable names should use camelCase and be descriptive to convey their purpose.

Examples: totalSupply, remainingSupply, balancesOf, creatorAddress, isPreSale, tokenExchangeRate.

Tip

💡 Descriptive names help in understanding the code without needing extensive comments.

Function Argument Names

Function arguments should use camelCase. Examples: initialSupply, account, recipientAddress, senderAddress, newOwner.

When writing library functions that operate on a custom struct, the struct should be the first argument and should always be named self.

Constants

Name constants using all uppercase letters with underscores separating words, e.g., MAX_SUPPLY. If a constant is private, prefix it with an underscore.

Examples of public constants:

MAX_BLOCKS
TOKEN_NAME
TOKEN_TICKER
CONTRACT_VERSION

Examples of private constants:

_MAX_BLOCKS
_TOKEN_NAME
_TOKEN_TICKER
_CONTRACT_VERSION

Important

Consistent naming of constants using SNAKE_UPPER_CASE helps in quickly identifying them and prevents accidental modification. This practice enhances code readability and maintainability.

Tip

💡 Prefixing private constants with an underscore _ clarifies their visibility and scope, aiding in code organization and readability.

Modifier Names

Modifiers should use camelCase and clearly describe the condition they enforce, e.g., onlyOwner.

Enums

Enums should be named using PascalCase and clearly describe their purpose, e.g., UserRole.

Avoiding Naming Collisions

Use a single trailing underscore to avoid naming collisions with existing variables, functions, or reserved keywords, e.g., variable_.

Note

Avoiding naming collisions reduces confusion and potential errors.

Tip

💡 Trailing underscores should be used primarily for parameters or variables that might otherwise collide with reserved keywords, functions, or other variables.

Underscore Prefix for Non-external Functions and Variables

Prefix non-external functions and variables with a single underscore to indicate they are internal or private, e.g., _internalFunction.

Important

Using an underscore prefix helps differentiate internal/private functions and variables from external ones, improving code clarity.

_singleLeadingUnderscore: This convention is used for non-external functions and state variables (private or internal). State variables without specified visibility are internal by default.

When designing a smart contract, consider the public-facing API (functions callable by any account). Leading underscores help recognize the intent of non-external functions and variables. If you change a function from non-external to external (including public) and rename it, this forces a review of every call site, helping prevent unintended external functions and common security vulnerabilities.

Tip

💡 These conventions aim to create a consistent and readable codebase, making it easier to maintain and understand.

Code Formatting

Whitespace in Expressions

Avoid extraneous whitespace in the following situations:

Immediately inside parentheses, brackets, or braces, with the exception of single-line function declarations.

✅ Yes:

spam(ham[1], Coin({name: "ham"}));

❌ No:

spam( ham[ 1 ], Coin( { name: "ham" } ) );

Exception:

function singleLine() public { spam(); }

Immediately before a comma, semicolon:

✅ Yes:

function spam(uint i, Coin coin) public;

❌ No:

function spam(uint i , Coin coin) public ;

More than one space around an assignment or other operator to align with another:

✅ Yes:

x = 1;
y = 2;
longVariable = 3;

❌ No:

x            = 1;
y            = 2;
longVariable = 3;

Do not include whitespace in the receive and fallback functions:

✅ Yes:

receive() external payable {
    ...
}

fallback() external {
    ...
}

❌ No:

receive () external payable {
    ...
}

fallback () external {
    ...
}

Important

Avoiding unnecessary whitespace in expressions helps maintain clean and readable code.

Control Structures

Place the opening brace { on the same line as the control structure.
Close the brace } on its own line.
Use a single space between the control structure keyword and the parenthesis.

✅ Yes:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.4.0 <0.9.0;

contract Coin {
    struct Bank {
        address owner;
        uint balance;
    }
}

❌ No:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.4.0 <0.9.0;

contract Coin
{
    struct Bank {
        address owner;
        uint balance;
    }
}

The same recommendations apply to the control structures if, else, while, and for.

Additionally, there should be a single space between the control structures if, while, and for and the parenthetic block representing the conditional, as well as a single space between the conditional parenthetic block and the opening brace.

✅ Yes:

if (...) {
    ...
}

for (...) {
    ...
}

❌ No:

if (...)
{
    ...
}

while(...){
}

for (...) {
    ...;}

For control structures whose body contains a single statement, omitting the braces is okay if the statement is contained on a single line.

✅ Yes:

if (x < 10)
    x += 1;

❌ No:

if (x < 10)
    someArray.push(Coin({
        name: 'spam',
        value: 42
    }));

For if blocks that have an else or else if clause, the else should be placed on the same line as the if's closing brace. This is an exception compared to the rules of other block-like structures.

✅ Yes:

if (x < 3) {
    x += 1;
} else if (x > 7) {
    x -= 1;
} else {
    x = 5;
}

if (x < 3)
    x += 1;
else
    x -= 1;

❌ No:

if (x < 3) {
    x += 1;
}
else {
    x -= 1;
}

Tip

💡 Consistent formatting of control structures improves readability and helps prevent errors.

Function Declarations

For short functions, place the opening brace on the same line as the declaration.
For long functions, break each parameter onto a new line.
Use the order: visibility, mutability, virtual, override, and custom modifiers.

✅ Yes:

function increment(uint x) public pure returns (uint) {
    return x + 1;
}

function increment(uint x) public pure onlyOwner returns (uint) {
    return x + 1;
}

❌ No:

function increment(uint x) public pure returns (uint)
{
    return x + 1;
}

function increment(uint x) public pure returns (uint){
    return x + 1;
}

function increment(uint x) public pure returns (uint) {
    return x + 1;
    }

function increment(uint x) public pure returns (uint) {
    return x + 1;}

The modifier order for a function should be:

Visibility
Mutability
Virtual
Override
Custom modifiers

✅ Yes:

function balance(uint from) public view override returns (uint) {
    return balanceOf[from];
}

function increment(uint x) public pure onlyOwner returns (uint) {
    return x + 1;
}

❌ No:

function balance(uint from) public override view returns (uint) {
    return balanceOf[from];
}

function increment(uint x) onlyOwner public pure returns (uint) {
    return x + 1;
}

For long function declarations, it is recommended to drop each argument onto its own line at the same indentation level as the function body. The closing parenthesis and opening bracket should be placed on their own line as well at the same indentation level as the function declaration.

✅ Yes:

function thisFunctionHasLotsOfArguments(
    address a,
    address b,
    address c,
    address d,
    address e,
    address f
)
    public
{
    doSomething();
}

❌ No:

function thisFunctionHasLotsOfArguments(address a, address b, address c,
    address d, address e, address f) public {
    doSomething();
}

function thisFunctionHasLotsOfArguments(address a,
                                        address b,
                                        address c,
                                        address d,
                                        address e,
                                        address f) public {
    doSomething();
}

function thisFunctionHasLotsOfArguments(
    address a,
    address b,
    address c,
    address d,
    address e,
    address f) public {
    doSomething();
}

If a long function declaration has modifiers, then each modifier should be dropped to its own line.

✅ Yes:

function thisFunctionNameIsReallyLong(address x, address y, address z)
    public
    onlyOwner
    priced
    returns (address)
{
    doSomething();
}

function thisFunctionNameIsReallyLong(
    address x,
    address y,
    address z
)
    public
    onlyOwner
    priced
    returns (address)
{
    doSomething();
}

❌ No:

function thisFunctionNameIsReallyLong(address x, address y, address z)
                                      public
                                      onlyOwner
                                      priced
                                      returns (address) {
    doSomething();
}

function thisFunctionNameIsReallyLong(address x, address y, address z)
    public onlyOwner priced returns (address)
{
    doSomething();
}

function thisFunctionNameIsReallyLong(address x, address y, address z)
    public
    onlyOwner
    priced
    returns (address) {
    doSomething();
}

Multiline output parameters and return statements should follow the same style recommended for wrapping long lines found in the maximum line length section.

✅ Yes:

function thisFunctionNameIsReallyLong(
    address a,
    address b,
    address c
)
    public
    returns (
        address someAddressName,
        uint256 LongArgument,
        uint256 Argument
    )
{
    doSomething();

    return (
        veryLongReturnArg1,
        veryLongReturnArg2,
        veryLongReturnArg3
    );
}

❌ No:

function thisFunctionNameIsReallyLong(
    address a,
    address b,
    address c
)
    public
    returns (address someAddressName,
             uint256 LongArgument,
             uint256 Argument)
{
    doSomething();

    return (veryLongReturnArg1,
            veryLongReturnArg1,
            veryLongReturnArg1);
}

For constructor functions on inherited contracts whose bases require arguments, it is recommended to drop the base constructors onto new lines in the same manner as modifiers if the function declaration is long or hard to read.

✅ Yes:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.0 <0.9.0;
// Base contracts just to make this compile
contract B {
    constructor(uint) {}
}

contract C {
    constructor(uint, uint) {}
}

contract D {
    constructor(uint) {}
}

contract A is B, C, D {
    uint x;

    constructor(uint param1, uint param2, uint param3, uint param4, uint param5)
        B(param1)
        C(param2, param3)
        D(param4)
    {
        // do something with param5
        x = param5;
    }
}

❌ No:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.0 <0.9.0;

// Base contracts just to make this compile
contract B {
    constructor(uint) {}
}

contract C {
    constructor(uint, uint) {}
}

contract D {
    constructor(uint) {}
}

contract A is B, C, D {
    uint x;

    constructor(uint param1, uint param2, uint param3, uint param4, uint param5)
    B(param1)
    C(param2, param3)
    D(param4) {
        x = param5;
    }
}

contract X is B, C, D {
    uint x;

    constructor(uint param1, uint param2, uint param3, uint param4, uint param5)
        B(param1)
        C(param2, param3)
        D(param4) {
            x = param5;
        }
}

When declaring short functions with a single statement, it is permissible to do it on a single line.

Permissible:

function shortFunction() public { doSomething(); }

Tip

💡 These guidelines for function declarations are intended to improve readability. Authors should use their best judgment as this guide does not try to cover all possible permutations for function declarations.

Mappings

Do not separate the mapping keyword from its type with a space.

✅ Yes:

mapping(uint => uint) map;
mapping(address => bool) registeredAddresses;
mapping(uint => mapping(bool => Data[])) public data;
mapping(uint => mapping(uint => s)) data;

❌ No:

mapping (uint => uint) map;
mapping( address => bool ) registeredAddresses;
mapping (uint => mapping (bool => Data[])) public data;
mapping(uint => mapping (uint => s)) data;

Note

Keeping mapping keywords without spaces ensures consistent formatting and readability.

Variable Declarations

Do not add a space between the type and the brackets for array variables.

✅ Yes:

uint[] x;

❌ No:

uint [] x;

Tip

💡 Consistent formatting of variable declarations helps in maintaining readability and avoids confusion.

Tip

💡 Consistent variable declarations prevent confusion and improve readability.

Strings

Strings should be quoted with double-quotes instead of single-quotes.

✅ Yes:

string public greeting = "Hello, World!";

❌ No:

string public greeting = 'Hello, World!';

Note

Using double quotes for strings ensures consistency and aligns with common programming practices.

Operators

Surround operators with a single space on either side.

✅ Yes:

x = 3;
x = 100 / 10;
x += 3 + 4;
x |= y && z;

❌ No:

x=3;
x = 100/10;
x += 3+4;
x |= y&&z;

Operators with a higher priority than others can exclude surrounding whitespace in order to denote precedence. This is meant to allow for improved readability for complex statements. You should always use the same amount of whitespace on either side of an operator:

✅ Yes:

x = 2**3 + 5;
x = 2*y + 3*z;
x = (a+b) * (a-b);

❌ No:

x = 2** 3 + 5;
x = y+z;
x +=1;

Tip

💡 Consistent spacing around operators enhances readability and ensures that code is easy to understand.

Documentation

NatSpec Documentation

Solidity contracts can also contain NatSpec comments. They are written with a triple slash (///) or a double asterisk block (/** ... */) and they should be used directly above function declarations or statements.

Example:

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.4.16 <0.9.0;

/// @author The Solidity Team
/// @title A simple storage example
contract SimpleStorage {
    uint storedData;

    /// Store `x`.
    /// @param x the new value to store
    /// @dev stores the number in the state variable `storedData`
    function set(uint x) public {
        storedData = x;
    }

    /// Return the stored value.
    /// @dev retrieves the value of the state variable `storedData`
    /// @return the stored value
    function get() public view returns (uint) {
        return storedData;
    }
}

It is recommended that Solidity contracts are fully annotated using NatSpec for all public interfaces (everything in the ABI).

Tip

💡 Proper documentation using NatSpec improves code maintainability and usability, especially for public APIs.

Note

NatSpec should not be used only for public interfaces but also for any function that might be used by other developers, including internal APIs (functions).

Best Practices

Using Custom Errors Over Require

Rule: Utilize custom errors instead of require statements for clearer and more gas-efficient error handling. Solidity 0.8.26 supports the use of custom errors with require.

Example:

error InsufficientFunds(uint256 requested, uint256 available);

function withdraw(uint256 amount) public {
    if (amount > balance) {
        revert InsufficientFunds(amount, balance);
    }
    balance -= amount;
}

Tip

💡 Custom errors save gas and provide more detailed error messages compared to traditional require strings.

Require with Custom Error (Solidity 0.8.26+)

Rule: Use the new require(condition, error) syntax to include custom errors in require statements, available in Solidity 0.8.26 and later.

Example:

error InsufficientFunds(uint256 requested, uint256 available);

function withdraw(uint256 amount) public {
    require(amount <= balance, InsufficientFunds(amount, balance));
    balance -= amount;
}

Important

This new syntax provides a more efficient way to handle errors directly within require statements, enhancing both readability and gas efficiency.

Limit Require Messages

Rule: Prefer using custom errors over require with strings for better efficiency. If you must use require with a string message, keep it under 32 bytes to reduce gas costs.

Important

Custom errors are more gas-efficient and provide clearer error handling. Whenever possible, use them instead of require with a string message.

✅ Yes:

require(balance >= amount, "Insufficient funds");

Caution

🚨 Keeping require messages concise (under 32 bytes) minimizes additional gas costs and improves efficiency.

❌ No:

require(balance >= amount, "The balance is insufficient for the withdrawal amount requested.");

Warning

⚠️ Longer messages significantly increase gas costs. Avoid using verbose messages in require statements.

Calldata for Read-Only Function Parameters

Rule: Using calldata can significantly reduce gas costs for external functions. It is beneficial for any external function, not just view functions, as long as the parameters are read-only.

✅ Yes:

function totalBalance(address[] calldata accounts) external view returns (uint256 total) {
    for (uint i = 0; i < accounts.length; i++) {
        total += balances[accounts[i]];
    }
}

❌ No:

function totalBalance(address[] memory accounts) external view returns (uint256 total) {
    for (uint i = 0; i < accounts.length; i++) {
        total += balances[accounts[i]];
    }
}

Tip

💡 Using calldata can significantly reduce gas costs for external functions. It is beneficial for any external function, not just view functions, as long as the parameters are read-only.

Optimize Length in Loops

Rule: Cache the length of arrays when used in loop conditions to minimize gas cost.

✅ Yes:

uint length = myArray.length;
for (uint i = 0; i < length; i++) {
    // Some logic
}

❌ No:

for (uint i = 0; i < myArray.length; i++) {
    // Some logic
}

Caution

🚨 Accessing array length multiple times in a loop increases gas costs. Caching the length improves efficiency.

Prefer Named Return

Rule: Use named return arguments for gas efficiency and clarity, especially in functions with multiple return values.

✅ Yes:

function calculate(uint256 a, uint256 b) public pure returns (uint256 sum, uint256 product) {
    sum = a + b;
    product = a * b;
}

❌ No:

function calculate(uint256 a, uint256 b) public pure returns (uint256, uint256) {
    uint256 sum = a + b;
    uint256 product = a * b;
    return (sum, product);
}

Tip

💡 Named return variables save gas by avoiding redundant return statements and making the code more readable.

Prefer Named Arguments

Rule: Use named arguments for function calls, events, and errors to improve clarity.

Example:

✅ Yes:

pow({base: x, exponent: y, scalar: v});

❌ No:

pow(x, y, v);

Important

Explicitly naming arguments improves readability and reduces the chance of errors.

Prefer Named Parameters in Mapping Types

Rule: Explicitly name parameters in mapping types for clarity, especially when nesting is used.

✅ Yes:

mapping(address account => mapping(address asset => uint256 amount)) public balances;

❌ No:

mapping(uint256 => mapping(address => uint256)) public balances;

Tip

💡 Named parameters in mappings make the purpose and usage of the mappings clearer.

Enforcing Explicit Types

Rule: Always declare explicit types for all variable and function return declarations. Avoid using ambiguous types.

✅ Yes:

uint256 public balance;
function getBalance() external view returns (uint256) {}

❌ No:

uint balance = 256;  // Use explicit uint256
function getBalance() external view returns (uint) {}  // Use explicit uint256

Tip

💡 Using explicit types prevents ambiguity and ensures clarity in your code.

Internal Function Naming

Rule: Internal functions in a library should not have an underscore prefix.

Example:

✅ Yes:

library MathLib {
    function add(uint256 a, uint256 b) internal pure returns (uint) {
        return a + b;
    }
}

using MathLib for uint256;
uint256 result = x.add(y);

❌ No:

library MathLib {
    function _add(uint a, uint b) internal pure returns (uint) {
        return a + b;
    }
}

using MathLib for uint;
uint256 result = x._add(y);

Important

Internal functions within libraries should be easy to read and follow, avoiding unnecessary prefixes.

Contract Interactions Through Interfaces

Rule: Whenever possible, interact with external contracts through well-defined interfaces. Direct contract calls should be avoided unless they offer specific benefits. If using call, prefer abi.encodeWithSelector to avoid issues.

Important

Using interfaces for external contract interactions enhances security by ensuring that only defined and expected methods are called, reducing the risk of unexpected behavior. This approach also makes the code more modular and easier to test.

Example:

✅ Yes:

interface IERC20 {
    function transfer(address recipient, uint256 amount) external returns (bool);
}

contract MyContract {
    IERC20 private _token;

    constructor(address tokenAddress) {
        _token = IERC20(tokenAddress);
    }

    function transferToken(address recipient, uint256 amount) public {
        _token.transfer(recipient, amount);
    }
}

❌ No:

contract MyContract {
    address private _tokenAddress;

    function transferToken(address recipient, uint256 amount) public {
        (bool success, ) = _tokenAddress.call(abi.encodeWithSignature("transfer(address,uint256)", recipient, amount));
        require(success, "Transfer failed.");
    }
}

Better Approach:

contract MyContract {
    address private _tokenAddress;

    function transferToken(address recipient, uint256 amount) public {
        (bool success, ) = _tokenAddress.call(abi.encodeWithSelector(IERC20.transfer.selector, recipient, amount));
        require(success, "Transfer failed.");
    }
}

Errors

Rule: Prefer custom errors over traditional error messages for better efficiency and clarity.

Naming Convention: Custom error names should follow PascalCase.

Example:

error InsufficientBalance(uint256 requested, uint256 available);

Tip

💡 Use custom errors to save gas and make error handling more descriptive.

Events

Rule: Event names should be in past tense and follow the SubjectVerb format.

Example:

✅ Yes:

event OwnerUpdated(address newOwner);

❌ No:

event OwnerUpdate(address newOwner);
event UpdatedOwner(address newOwner);

Note

Consistent event naming helps understand contract behavior by reading the emitted events.

Struct, Event and Error Definitions

Rule: Declare structs, events and errors within their scope. If a struct or error is used across many files, define them in their own file. Multiple structs and errors can be defined together in one file.

Tip

💡 Centralize common structures, events and errors to improve maintainability and clarity.

Upgradability

Rule: Prefer the ERC-7201 "Namespaced Storage Layout" convention to avoid storage collisions.

Avoid Unnecessary Version Pragma Constraints

Rule: Avoid unnecessary version pragma constraints. While main contracts should specify a single Solidity version, supporting contracts and libraries should have as open a pragma as possible.

✅ Yes:

pragma solidity ^0.8.0;

❌ No:

pragma solidity ^0.8.0 ^0.9.0;

Tip

💡 Use open pragmas for supporting contracts and libraries to enhance compatibility and flexibility.

Avoid Using Assembly

Rule: Use inline assembly with extreme care. Ensure that it is well-documented with inline comments explaining what the assembly code does. Avoid using assembly unless it adds significant value and there are no better alternatives.

Example:

function add(uint x, uint y) public pure returns (uint result) {
    assembly {
        // Add x and y and store the result in the `result` variable
        result := add(x, y)
    }
}

Warning

⚠️ Assembly code is hard to read and audit, increasing the risk of errors and vulnerabilities. Use it only when necessary and ensure thorough documentation to maintain code clarity and security.

Caution

🚨 Avoid using assembly if it does not provide significant performance or functional benefits. Always prefer high-level Solidity when possible.

Prefer Composition Over Inheritance

Rule: Prefer defining functions as part of a larger contract rather than creating many small contracts.

Note

Inheritance is useful but should be used judiciously, especially when building on existing, trusted contracts like Ownable from OpenZeppelin.

Testing (Foundry Specific)

Test Structure

Foundry provides a flexible and efficient framework for structuring your tests. Here are the recommended structures:

Unit Tests

Organize by contract or functionality:
- Treat contracts as describe blocks: e.g., contract Add, contract Supply.
- Have a test contract per contract-under-test: e.g., contract MyContractTest.
Example:

contract Add {
    function test_add_AddsTwoNumbers() public {
        // Test code
    }
}

contract MyContractTest {
    function test_add_AddsTwoNumbers() public {
        // Test code
    }

    function test_supply_UsersCanSupplyTokens() public {
        // Test code
    }
}

Integration Tests
- Place in the same test directory.
- Clear naming convention to distinguish from unit tests.

Tip

💡 Organizing tests logically improves maintainability and makes it easier to identify and fix issues.

Unit Tests

Test Coverage

Ensure all functionalities are covered.
Use test_Description for standard tests.
Use testFuzz_Description for fuzz tests.
Example:

function test_transfer() public {
    // Test code
}

function testFuzz_transfer(uint amount) public {
    // Test code
}

Test Naming Conventions

Consistent naming helps in filtering and identifying tests quickly.
Example:

function test_RevertIf_Condition() public {
    // Test code expecting revert
}

function testForkFuzz_RevertIf_Condition() public {
    // Fuzz test with fork expecting revert
}

Note

Consistent naming aids in test management and improves readability.

Test Fixtures

Use fixtures to set up common test scenarios.
Avoid making assertions in the setUp function. Instead, use a dedicated test like test_SetUpState.

Important

Isolating setup logic from assertions ensures clarity and reduces potential errors.

Mocking and Stubbing

Utilize mocking and stubbing to simulate complex interactions and dependencies.

Example:

contract MockContract {
    function mockedFunction() public returns (bool) {
        return true;
    }
}

Tip

💡 Mocking and stubbing help in testing functionalities in isolation.

Property-Based Testing

Foundry supports property-based testing to ensure that your contracts hold certain properties over a wide range of inputs.

Example:

function test_property(uint x) public {
    assert(x < 1000);
}

Gas Usage Testing

Monitor and optimize gas usage by incorporating gas usage tests.

Example:

function testGasUsage() public {
    uint gasStart = gasleft();
    // Function call
    uint gasUsed = gasStart - gasleft();
    emit log_named_uint("Gas used: ", gasUsed);
}

Caution

🚨 Regular gas usage tests help in optimizing smart contract efficiency.

Foundry Tools and Utilities

Fuzz Testing
- Foundry's fuzz testing tools help in identifying edge cases and potential issues.
- Example:
```
function testFuzz(uint x) public {
    // Fuzz test code
}
```
Debugging with Foundry
- Utilize Foundry's debugging tools to trace and fix issues.
- Example:
```
function testDebug() public {
    // Debug test code
}
```

Tip

💡 Leveraging Foundry's tools and utilities enhances test coverage and debugging capabilities.

General Test Guidance

File Naming: For MyContract.sol, the test file should be MyContract.t.sol.
Splitting Large Contracts: Group logically, e.g., MyContract.owner.t.sol, MyContract.deposits.t.sol.
Assertions: Avoid assertions in setUp; use dedicated tests.
Test Contracts: Organize unit tests logically within contracts.

Note

Consistent file naming and structure make it easier to locate and manage tests.

These practices and tools ensure comprehensive and efficient testing, leveraging Foundry's capabilities to maintain robust and reliable smart contracts.

Performance and Security

Gas Optimization

Optimizing gas usage is crucial for efficient and cost-effective smart contracts. Here are some best practices:

Minimize Storage Operations: Storage operations (SSTORE and SLOAD) are expensive. Minimize their usage by:
- Caching storage variables in memory.
- Using calldata for function parameters.
Use Immutable and Constant: Mark variables as immutable or constant where possible to save gas.
Optimize Loops: Cache array lengths and avoid unnecessary computations within loops.
Prefer uint256: Using uint256 over smaller types like uint8 or uint32 can be more gas efficient due to padding.

Example:

uint immutable public value; // Immutable variable
uint[] public data;

function optimizedFunction(uint[] calldata input) external {
    uint length = input.length; // Cache array length
    for (uint i = 0; i < length; i++) {
        data.push(input[i]);
    }
}

Security Best Practices

Security is paramount in smart contract development. Adhere to the following best practices to mitigate common vulnerabilities:

Reentrancy

Reentrancy attacks occur when a contract calls an external contract before updating its state, allowing the external contract to call back into the original contract and manipulate its state. Prevent reentrancy by:

Using Checks-Effects-Interactions Pattern: Perform all state changes before calling external contracts.
Reentrancy Guard: Use a mutex or a reentrancy guard.

Example:

bool private locked;

modifier noReentrant() {
    require(!locked, "Reentrant call");
    locked = true;
    _;
    locked = false;
}

function withdraw(uint amount) external noReentrant {
    require(balances[msg.sender] >= amount, "Insufficient balance");
    balances[msg.sender] -= amount;
    (bool success, ) = msg.sender.call{value: amount}("");
    require(success, "Transfer failed");
}

Warning

⚠️ Always perform state updates before calling external contracts to prevent reentrancy attacks.

Access Control

Ensure proper access control mechanisms are in place:

Use onlyOwner Modifiers: Restrict critical functions to the contract owner or specific roles.
Role-Based Access Control: Implement role-based access control (RBAC) for fine-grained permissions.

Example:

address public owner;
mapping(address => bool) public admins;

modifier onlyOwner() {
    require(msg.sender == owner, "Not owner");
    _;
}

modifier onlyAdmin() {
    require(admins[msg.sender], "Not admin");
    _;
}

function addAdmin(address admin) external onlyOwner {
    admins[admin] = true;
}

Tip

💡 Use libraries like OpenZeppelin's Access Control for robust access management.

Integer Overflow and Underflow

Prevent integer overflow and underflow by:

Using SafeMath Library: Use OpenZeppelin's SafeMath library for safe arithmetic operations.
Solidity 0.8+: Solidity 0.8 and later versions have built-in overflow and underflow checks.

Example:

using SafeMath for uint256;

function safeAdd(uint256 a, uint256 b) public pure returns (uint256) {
    return a.add(b);
}

Caution

🚨 Always use safe arithmetic operations to prevent unexpected overflows and underflows.

Handling Ether Transfers

Handle Ether transfers securely by:

Using call instead of transfer or send: call provides more flexibility and forwards all available gas.
Check Transfer Success: Always check the return value of call.

Example:

function safeTransfer(address payable recipient, uint256 amount) internal {
    (bool success, ) = recipient.call{value: amount}("");
    require(success, "Transfer failed");
}

Important

Properly handle Ether transfers to avoid vulnerabilities related to gas limits and failed transfers.

Code Reviews and Audits

Regular code reviews and security audits are essential for identifying and mitigating potential vulnerabilities:

Internal Code Reviews: Conduct regular internal reviews to catch issues early.
External Audits: Engage reputable auditing firms for comprehensive security audits.
Automated Tools: Use automated security analysis tools like MythX or Slither to scan for vulnerabilities.

Tip

💡 Regularly update and audit your contracts, especially after significant changes or before deployment.

By following these best practices, you can enhance the performance, security, and robustness of your Solidity smart contracts.

Conclusion

This Solidity Style Guide aims to enhance existing guidelines by providing additional, comprehensive information to ensure consistency, readability, and maintainability in your Solidity code. It draws inspiration from several valuable resources, which you can explore for further insights:

Solidity Official Style Guide
Foundry Best Practices
RareSkills Solidity Style Guide
Coinbase Solidity Style Guide

This guide is not intended to replace any existing style guides but to supplement them with additional best practices and recommendations.

Feel free to contribute or make suggestions to this guide. Any pull requests or contributions are welcomed to help us continually improve.

Twitter
GitHub

Thank you for using this guide, and happy coding!

Files

README.md

Latest commit

History

README.md

File metadata and controls

Biconomy Solidity Style Guide

Introduction

Purpose and Scope

Evolution of the Guide

Consistency over Correctness

General Coding Conventions

Indentation and Spacing

Indentation Rules

Tabs or Spaces

Blank Lines

Maximum Line Length

Source File Encoding

Use the Latest Version of Solidity

Imports

Code Structure

Code Layout

Order of Functions

Order of Layout Elements

Single Contract or Interface Per File

Naming Conventions

Naming Styles

Names to Avoid

Contract and Library Names

Naming Interfaces

Defining Contract Types in Interfaces

Struct Names

Event Names

Function Names

Variable Names

Function Argument Names

Constants

Modifier Names

Enums

Avoiding Naming Collisions

Underscore Prefix for Non-external Functions and Variables

Code Formatting

Whitespace in Expressions

Control Structures

Function Declarations

Mappings

Variable Declarations

Strings

Operators

Documentation

NatSpec Documentation

Best Practices

Using Custom Errors Over Require

Require with Custom Error (Solidity 0.8.26+)

Limit Require Messages

Calldata for Read-Only Function Parameters

Optimize Length in Loops

Prefer Named Return

Prefer Named Arguments

Prefer Named Parameters in Mapping Types

Enforcing Explicit Types

Internal Function Naming

Contract Interactions Through Interfaces

Errors

Events

Struct, Event and Error Definitions

Upgradability

Avoid Unnecessary Version Pragma Constraints

Avoid Using Assembly

Prefer Composition Over Inheritance

Testing (Foundry Specific)

Test Structure

Unit Tests

Test Fixtures

Mocking and Stubbing

Property-Based Testing

Gas Usage Testing

Foundry Tools and Utilities

General Test Guidance

Performance and Security