@nahmii/contracts-bedrock v3.2.1

Nahmii Smart Contracts (Bedrock)

This package contains the smart contracts that compose the on-chain component of Nahmii's upcoming Bedrock upgrade. We've tried to maintain 100% backwards compatibility with the existing system while also introducing new useful features. You can find detailed specifications for the contracts contained within this package here.

Contracts Overview

Contracts deployed to the base layer

Contracts deployed to the derived layer

Legacy and deprecated contracts

Installation

We export contract ABIs, contract source code, and contract deployment information for this package via npm:

npm install @nahmii/contracts-bedrock

Development

Dependencies

We work on this repository with a combination of Hardhat and Foundry.

1. Install Foundry by following the instructions located here.

2. Install node modules with yarn (v1) and Node.js (16+):

   yarn install

Build

yarn build

Tests

yarn test

Deployment

Configuration

1. Create or modify a file <network-name>.json inside of the deploy-config folder.
2. Fill out this file according to the deployConfigSpec located inside of the `hardhat.config.ts

Execution

1. Copy .env.example into .env
2. Fill out the L1_RPC and PRIVATE_KEY_DEPLOYER environment variables in .env
3. Run npx hardhat deploy --network <network-name> to deploy the L1 contracts
4. Run npx hardhat etherscan-verify --network <network-name> --sleep to verify contracts on Etherscan

Standards and Conventions

Style

Comments

We use Seaport-style comments with some minor modifications. Some basic rules:

• Always use @notice since it has the same general effect as @dev but avoids confusion about when to use one over the other.
• Include a newline between @notice and the first @param.
• Include a newline between @param and the first @return.
• Use a line-length of 100 characters.

We also have the following custom tags:

• @custom:proxied: Add to a contract whenever it's meant to live behind a proxy.
• @custom:upgradeable: Add to a contract whenever it's meant to be used in an upgradeable contract.
• @custom:semver: Add to a constructor to indicate the version of a contract.
• @custom:legacy: Add to an event or function when it only exists for legacy support.

Errors

• Use require statements when making simple assertions.
• Use revert if throwing an error where an assertion is not being made (no custom errors). See here for an example of this in practice.
• Error strings MUST have the format "{ContractName}: {message}" where message is a lower case string.

Function Parameters

• Function parameters should be prefixed with an underscore.

Event Parameters

• Event parameters should NOT be prefixed with an underscore.

Spacers

We use spacer variables to account for old storage slots that are no longer being used. The name of a spacer variable MUST be in the format spacer_<slot>_<offset>_<length> where <slot> is the original storage slot number, <offset> is the original offset position within the storage slot, and <length> is the original size of the variable. Spacers MUST be private.

Proxy by Default

All contracts should be assumed to live behind proxies (except in certain special circumstances). This means that new contracts MUST be built under the assumption of upgradeability. We use a minimal Proxy contract designed to be owned by a corresponding ProxyAdmin which follow the interfaces of OpenZeppelin's Proxy and ProxyAdmin contracts, respectively.

Unless explicitly discussed otherwise, you MUST include the following basic upgradeability pattern for each new implementation contract:

1. Extend OpenZeppelin's Initializable base contract.
2. Include a uint8 public constant VERSION = X at the TOP of your contract.
3. Include a function initialize with the modifier reinitializer(VERSION).
4. In the constructor, set any immutable variables and call the initialize function for setting mutables.

Versioning

All (non-library and non-abstract) contracts MUST extend the Semver base contract which exposes a version() function that returns a semver-compliant version string. During the Bedrock development process the Semver value for all contracts SHOULD return 0.0.1 (this is not particularly important, but it's an easy standard to follow). When the initial Bedrock upgrade is released, the Semver value MUST be updated to 1.0.0.

After the initial Bedrock upgrade, contracts MUST use the following versioning scheme:

• patch releases are to be used only for changes that do NOT modify contract bytecode (such as updating comments).
• minor releases are to be used for changes that modify bytecode OR changes that expand the contract ABI provided that these changes do NOT break the existing interface.
• major releases are to be used for changes that break the existing contract interface OR changes that modify the security model of a contract.

Exceptions

We have made an exception to the Semver rule for the WETH contract to avoid making changes to a well-known, simple, and recognizable contract.