Generate UML class diagram for contracts (#41)

iExecBlockchainComputing · Aug 22, 2024 · 07d15fc · 07d15fc
2 parents 190cdcd + c0c8cec
commit 07d15fc
Show file tree

Hide file tree

Showing 7 changed files with 1,916 additions and 15 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,3 +17,4 @@ node_modules
 /deployments/localhost
 
 /contracts/hardhat-dependency-compiler
+build/flatten.sol
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Changelog
 
 ## vNEXT
+- Generate UML class diagram for contracts. (#41)
 - Generate Solidity documentation. (#40)
 - Add Bellecour poco address to config and harmonize deployment artifacts. (#39)
 - Revert always explicit message on failed transfers. (#38)

diff --git a/README.md b/README.md
@@ -6,7 +6,12 @@ Contracts of iExec Voucher project.
 
 ### API Documentation
 
-The the API documentation can be found in [docs/](./docs/index.md).
+The API documentation can be found in [docs/](./docs/index.md).
+
+### UML diagram
+
+UML class diagram for voucher contracts can be found [here](./docs/class-diagram.svg).
+Raw version is available [here](./docs/class-diagram.svg?raw=true) for better readability.
 
 ### How to deploy?
 

diff --git a/docs/class-diagram.svg b/docs/class-diagram.svg
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,3 +17,4 @@ node_modules
		/deployments/localhost

		/contracts/hardhat-dependency-compiler
		build/flatten.sol