Diamond pattern (EIP-2535) in Blockchain / Solidity

Introduction

The Diamond pattern helps build big smart contracts by splitting them into smaller parts. It keeps code organized and easy to update.

When your smart contract is too large and complex to manage as one piece.

When you want to add new features to a contract without redeploying everything.

When you want to fix bugs or improve parts of a contract without affecting others.

When you want to share code between multiple contracts safely.

When you want to save gas by reusing code modules.

Syntax

Blockchain / Solidity

contract Diamond {
    // Holds addresses of facets (modules)
    mapping(bytes4 => address) public facets;

    // Fallback function to delegate calls to facets
    fallback() external payable {
        address facet = facets[msg.sig];
        require(facet != address(0), "Function does not exist");
        assembly {
            calldatacopy(0, 0, calldatasize())
            let result := delegatecall(gas(), facet, 0, calldatasize(), 0, 0)
            returndatacopy(0, 0, returndatasize())
            switch result
            case 0 { revert(0, returndatasize()) }
            default { return(0, returndatasize()) }
        }
    }
}

The Diamond contract holds references to smaller contracts called facets.

Calls to functions are forwarded to the right facet using delegatecall.

Examples

This is the core Diamond contract that forwards calls to facets.

Blockchain / Solidity

contract Diamond {
    mapping(bytes4 => address) public facets;

    fallback() external payable {
        address facet = facets[msg.sig];
        require(facet != address(0), "Function does not exist");
        assembly {
            calldatacopy(0, 0, calldatasize())
            let result := delegatecall(gas(), facet, 0, calldatasize(), 0, 0)
            returndatacopy(0, 0, returndatasize())
            switch result
            case 0 { revert(0, returndatasize()) }
            default { return(0, returndatasize()) }
        }
    }
}

A simple facet contract with one function.

Blockchain / Solidity

contract FacetA {
    function greet() external pure returns (string memory) {
        return "Hello from Facet A!";
    }
}

Maps the function selector of greet() to the FacetA address.

Blockchain / Solidity

// Adding a facet to the diamond
facets[bytes4(keccak256("greet()"))] = address(facetA);

Sample Program

This program shows a Diamond contract that forwards the greet() call to FacetA. When you call greet() on Diamond, it returns the greeting from FacetA.

Blockchain / Solidity

pragma solidity ^0.8.0;

contract FacetA {
    function greet() external pure returns (string memory) {
        return "Hello from Facet A!";
    }
}

contract Diamond {
    mapping(bytes4 => address) public facets;

    constructor(address _facetA) {
        facets[bytes4(keccak256("greet()"))] = _facetA;
    }

    fallback() external payable {
        address facet = facets[msg.sig];
        require(facet != address(0), "Function does not exist");
        assembly {
            calldatacopy(0, 0, calldatasize())
            let result := delegatecall(gas(), facet, 0, calldatasize(), 0, 0)
            returndatacopy(0, 0, returndatasize())
            switch result
            case 0 { revert(0, returndatasize()) }
            default { return(0, returndatasize()) }
        }
    }
}

Important Notes

Diamond pattern uses delegatecall to run code in the context of the main contract.

Function selectors (first 4 bytes of function signature hash) are used to route calls.

Updating facets lets you add or fix features without redeploying the whole contract.

Summary

The Diamond pattern splits big contracts into smaller parts called facets.

It forwards function calls to the right facet using delegatecall and function selectors.

This makes contracts easier to manage, update, and save gas.

Practice

1.

What is the main purpose of the Diamond pattern (EIP-2535) in blockchain smart contracts?

easy

A. To split a large contract into smaller, manageable facets

B. To increase the gas cost of contract deployment

C. To prevent any contract upgrades

D. To combine multiple unrelated contracts into one

Solution

1. Step 1: Understand the Diamond pattern concept

   The Diamond pattern divides a big contract into smaller parts called facets to organize code better.

2. Step 2: Identify the main benefit

   This splitting allows easier upgrades and management of smart contracts.

3. Final Answer:

   To split a large contract into smaller, manageable facets -> Option A

4. Quick Check:

   Diamond pattern = splitting contract into facets [OK]

Hint: Remember: Diamond pattern breaks big contracts into smaller parts [OK]

Common Mistakes:

• Thinking it prevents upgrades
• Assuming it increases deployment cost
• Confusing it with contract merging

2.

Which of the following is the correct Solidity syntax to declare a facet interface in the Diamond pattern?

interface IFacet {
    function myFunction() external;
}

easy

A. contract IFacet { function myFunction() public {} }

B. interface IFacet { function myFunction() external; }

C. library IFacet { function myFunction() internal; }

D. struct IFacet { function myFunction() external; }

Solution

1. Step 1: Identify correct Solidity declaration for interface

   Interfaces use the keyword interface and declare functions without bodies.

2. Step 2: Match function visibility and syntax

   Function in interface must be external and end with a semicolon, no body.

3. Final Answer:

   interface IFacet { function myFunction() external; } -> Option B

4. Quick Check:

   Interface syntax = interface IFacet { function myFunction() external; } [OK]

Hint: Interfaces have no function bodies and use 'external' functions [OK]

Common Mistakes:

• Using contract instead of interface
• Adding function bodies in interface
• Using wrong visibility like public or internal

3.

Given the following Solidity snippet using the Diamond pattern, what will be the output when calling diamond.facetFunction()?

contract FacetA {
    function facetFunction() external pure returns (string memory) {
        return "Facet A called";
    }
}

contract Diamond {
    FacetA facetA;
    constructor() {
        facetA = new FacetA();
    }
    function facetFunction() external view returns (string memory) {
        return facetA.facetFunction();
    }
}

medium

A. "Facet A called"

B. Compilation error due to missing function

C. "Diamond called"

D. Runtime error: function not found

Solution

1. Step 1: Understand contract interaction

   The Diamond contract creates an instance of FacetA and calls its facetFunction.

2. Step 2: Trace the function call and return value

   Calling diamond.facetFunction() returns the string from FacetA: "Facet A called".

3. Final Answer:

   "Facet A called" -> Option A

4. Quick Check:

   Diamond calls FacetA function = "Facet A called" [OK]

Hint: Diamond delegates calls to facets returning their outputs [OK]

Common Mistakes:

• Assuming Diamond returns its own string
• Expecting compilation error due to delegation
• Confusing runtime errors with correct delegation

4.

Identify the error in this simplified Diamond pattern Solidity code snippet:

contract Diamond {
    mapping(bytes4 => address) public facets;

    function addFacet(bytes4 selector, address facetAddress) public {
        facets[selector] = facetAddress;
    }

    fallback() external {
        address facet = facets[msg.sig];
        (bool success, ) = facet.delegatecall(msg.data);
        require(success, "Delegatecall failed");
    }
}

medium

A. Using delegatecall instead of call

B. Fallback function must be external payable

C. Mapping key type should be bytes32, not bytes4

D. Missing return statement in fallback function

Solution

1. Step 1: Analyze fallback function behavior

   The fallback uses delegatecall but does not return data to the caller.

2. Step 2: Identify missing return data forwarding

   Delegatecall returns data that must be returned by fallback to preserve call behavior.

3. Final Answer:

   Missing return statement in fallback function -> Option D

4. Quick Check:

   Fallback must return delegatecall data [OK]

Hint: Fallback must return delegatecall results to caller [OK]

Common Mistakes:

• Ignoring return data in fallback
• Confusing delegatecall with call
• Assuming payable is mandatory for fallback

5.

You want to upgrade a Diamond contract by adding a new facet with a function selector that already exists in another facet. What will happen if you do not remove the old selector before adding the new one?

hard

A. The Diamond will route calls to the new facet for that selector

B. The Diamond will have two facets for the same selector causing ambiguity

C. The old facet's function will still be called, ignoring the new one

D. The contract will fail to compile due to duplicate selectors

Solution

1. Step 1: Understand selector uniqueness in Diamond pattern

   Each function selector maps to exactly one facet address in the Diamond.

2. Step 2: Analyze what happens when adding duplicate selectors

   If you add a selector without removing the old one, the mapping still points to the old facet, so calls route there.

3. Final Answer:

   The old facet's function will still be called, ignoring the new one -> Option C

4. Quick Check:

   Duplicate selector without removal = old facet called [OK]

Hint: Remove old selector before adding new to update facet [OK]

Common Mistakes:

• Assuming Diamond supports multiple facets per selector
• Expecting compile-time errors for duplicates
• Thinking new facet automatically overrides old without removal