✍🏻add: added diagram to Diamond.sol

sanjay-sol · Sep 15, 2024 · 79021a3 · 79021a3
1 parent 9fc3df2
commit 79021a3
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/contracts/Diamond.sol b/contracts/Diamond.sol
@@ -3,6 +3,25 @@ pragma solidity ^0.8.0;
 
 import { IDiamond } from "./interfaces/IDiamond.sol";
 
+/*
+
+    +------------------------------------+
+    |           Diamond.sol              |
+    +------------------------------------+
+                 /|\           
+                  | msg.sig (function selector)
+                  |
+        +---------+--------------------+-------------------------+
+        |                              |                         |
+  +----------------------+      +-------------------+   +--------------------+
+  | OwnershipFacet       |      | TokenFacet        |  | OtherFacet (future) |
+  +----------------------+      +-------------------+   +--------------------+
+  | - transferOwnership()|      | - mint()          |  | - someOtherFunc()   |
+  | - getOwner()         |      | - transfer()      |  | - etc...            |
+  +-----------------------+     | - balanceOf()     |  +---------------------+
+                                +-------------------+
+*/
+
 contract Diamond {
     // A mapping to store which facet handles which function selectors
     mapping(bytes4 => address) public facets;