Skip to main content

Solidity Contract Layout

Best practice layout for Solidity contracts.

// SPDX-License-Identifier: MIT

// Layout of Contract:
// version
// imports
// interfaces, libraries, contracts
// errors
// Type declarations
// State variables
// Events
// Modifiers
// Functions

// Layout of Functions:
// constructor
// receive function (if exists)
// fallback function (if exists)
// external
// public
// internal
// private
// view & pure functions

Questions

Which engineering decision related to this topic has the highest switching cost once made — and how do you make it well with incomplete information?

At what scale or complexity level does the right answer to this topic change significantly?
How does the introduction of AI-native workflows change the conventional wisdom about this technology?
Which anti-pattern in this area is most commonly introduced by developers who know enough to be dangerous but not enough to know what they don't know?

Questions