Skip to content

Commit

Permalink
📝 update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Arn0d committed Dec 2, 2022
1 parent a9c6858 commit ca15586
Show file tree
Hide file tree
Showing 37 changed files with 10,947 additions and 7,376 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,14 @@ cairo-format -i src/**/*.cairo tests/**/**/*.cairo

- python environment (python >=3.9)
- [`mdutils`](https://pypi.org/project/mdutils/) dependency installed
- [`kapper-cli`](https://github.com/onlydustxyz/kaaper) installed
- [`kaaper-cli`](https://github.com/onlydustxyz/kaaper) installed
- [`thoth`](https://github.com/FuzzingLabs/thoth) installed

#### Generation

```bash
cd docs
kapper generate ../src ./data
kaaper generate ../src ./data
python build.py
callgraphs.sh
```
Expand Down
2 changes: 1 addition & 1 deletion docs/callgraphs.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ protostar build
mkdir -p $OUTPUT_DIR
for FILE in ./build/*.json
do
thoth -f $FILE -call -format svg -view False -output_callgraph_folder $OUTPUT_DIR
thoth local $FILE -call -format svg -view False -output_callgraph_folder $OUTPUT_DIR
done
2,408 changes: 1,204 additions & 1,204 deletions docs/callgraphs/CarbonableBadge.gv.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2,184 changes: 1,092 additions & 1,092 deletions docs/callgraphs/CarbonableMinter.gv.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
134 changes: 67 additions & 67 deletions docs/callgraphs/CarbonableOffseter.gv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,56 +69,56 @@ digraph CarbonableOffseter {
1040 [label="openzeppelin.security.reentrancyguard.library.ReentrancyGuard_entered.write" color="" fillcolor=lightcoral shape=oval style=filled]
1052 [label="openzeppelin.security.reentrancyguard.library.ReentrancyGuard.start" color="" fillcolor=lightcoral shape=oval style=filled]
1067 [label="openzeppelin.security.reentrancyguard.library.ReentrancyGuard.end" color="" fillcolor=lightcoral shape=oval style=filled]
1075 [label="src.farm.library.Offset.emit" color="" fillcolor=lightcoral shape=oval style=filled]
1102 [label="src.farm.library.Snapshot.emit" color="" fillcolor=lightcoral shape=oval style=filled]
1126 [label="src.farm.library.carbonable_project_address_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1131 [label="src.farm.library.carbonable_project_address_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1144 [label="src.farm.library.carbonable_project_address_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1156 [label="src.farm.library.start_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1161 [label="src.farm.library.start_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1174 [label="src.farm.library.start_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1186 [label="src.farm.library.unlocked_duration_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1191 [label="src.farm.library.unlocked_duration_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1204 [label="src.farm.library.unlocked_duration_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1216 [label="src.farm.library.period_duration_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1221 [label="src.farm.library.period_duration_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1234 [label="src.farm.library.period_duration_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1246 [label="src.farm.library.absorption_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1251 [label="src.farm.library.absorption_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1270 [label="src.farm.library.absorption_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1287 [label="src.farm.library.registration_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1304 [label="src.farm.library.registration_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1319 [label="src.farm.library.registration_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1333 [label="src.farm.library.total_offsetable_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1347 [label="src.farm.library.total_offsetable_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1367 [label="src.farm.library.total_offsetable_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1385 [label="src.farm.library.total_offseted_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1399 [label="src.farm.library.total_offseted_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1419 [label="src.farm.library.total_offseted_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1437 [label="src.farm.library.snapshoted_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1442 [label="src.farm.library.snapshoted_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1455 [label="src.farm.library.snapshoted_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1467 [label="src.farm.library.CarbonableFarmer.initializer" color="" fillcolor=lightcoral shape=oval style=filled]
1474 [label="src.farm.library.CarbonableFarmer.carbonable_project_address" color="" fillcolor=lightcoral shape=oval style=filled]
1480 [label="src.farm.library.CarbonableFarmer.get_start_time" color="" fillcolor=lightcoral shape=oval style=filled]
1486 [label="src.farm.library.CarbonableFarmer.get_lock_time" color="" fillcolor=lightcoral shape=oval style=filled]
1501 [label="src.farm.library.CarbonableFarmer.get_end_time" color="" fillcolor=lightcoral shape=oval style=filled]
1516 [label="src.farm.library.CarbonableFarmer.is_locked" color="" fillcolor=lightcoral shape=oval style=filled]
1551 [label="src.farm.library.CarbonableFarmer.total_locked" color="" fillcolor=lightcoral shape=oval style=filled]
1571 [label="src.farm.library.CarbonableFarmer.balance_of" color="" fillcolor=lightcoral shape=oval style=filled]
1580 [label="src.farm.library.CarbonableFarmer.registred_owner_of" color="" fillcolor=lightcoral shape=oval style=filled]
1609 [label="src.farm.library.CarbonableFarmer.total_offsetable" color="" fillcolor=lightcoral shape=oval style=filled]
1616 [label="src.farm.library.CarbonableFarmer.total_offseted" color="" fillcolor=lightcoral shape=oval style=filled]
1623 [label="src.farm.library.CarbonableFarmer.start_period" color="" fillcolor=lightcoral shape=oval style=filled]
1661 [label="src.farm.library.CarbonableFarmer.stop_period" color="" fillcolor=lightcoral shape=oval style=filled]
1697 [label="src.farm.library.CarbonableFarmer.deposit" color="" fillcolor=lightcoral shape=oval style=filled]
1752 [label="src.farm.library.CarbonableFarmer.withdraw" color="" fillcolor=lightcoral shape=oval style=filled]
1808 [label="src.farm.library.CarbonableFarmer.offset" color="" fillcolor=lightcoral shape=oval style=filled]
1877 [label="src.farm.library.CarbonableFarmer.snapshot" color="" fillcolor=lightcoral shape=oval style=filled]
1914 [label="src.farm.library.CarbonableFarmer._count" color="" fillcolor=lightcoral shape=oval style=filled]
1969 [label="src.farm.library.CarbonableFarmer._count_iter" color="" fillcolor=lightcoral shape=oval style=filled]
2034 [label="src.farm.library.CarbonableFarmer._snapshot" color="" fillcolor=lightcoral shape=oval style=filled]
2088 [label="src.farm.library.CarbonableFarmer._snapshot_iter" color="" fillcolor=lightcoral shape=oval style=filled]
1075 [label="src.offset.library.Offset.emit" color="" fillcolor=lightcoral shape=oval style=filled]
1102 [label="src.offset.library.Snapshot.emit" color="" fillcolor=lightcoral shape=oval style=filled]
1126 [label="src.offset.library.carbonable_project_address_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1131 [label="src.offset.library.carbonable_project_address_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1144 [label="src.offset.library.carbonable_project_address_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1156 [label="src.offset.library.start_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1161 [label="src.offset.library.start_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1174 [label="src.offset.library.start_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1186 [label="src.offset.library.unlocked_duration_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1191 [label="src.offset.library.unlocked_duration_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1204 [label="src.offset.library.unlocked_duration_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1216 [label="src.offset.library.period_duration_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1221 [label="src.offset.library.period_duration_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1234 [label="src.offset.library.period_duration_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1246 [label="src.offset.library.registration_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1263 [label="src.offset.library.registration_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1278 [label="src.offset.library.registration_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1292 [label="src.offset.library.absorption_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1297 [label="src.offset.library.absorption_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1316 [label="src.offset.library.absorption_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1333 [label="src.offset.library.total_offsetable_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1347 [label="src.offset.library.total_offsetable_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1367 [label="src.offset.library.total_offsetable_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1385 [label="src.offset.library.total_offseted_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1399 [label="src.offset.library.total_offseted_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1419 [label="src.offset.library.total_offseted_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1437 [label="src.offset.library.snapshoted_.addr" color="" fillcolor=lightcoral shape=oval style=filled]
1442 [label="src.offset.library.snapshoted_.read" color="" fillcolor=lightcoral shape=oval style=filled]
1455 [label="src.offset.library.snapshoted_.write" color="" fillcolor=lightcoral shape=oval style=filled]
1467 [label="src.offset.library.CarbonableOffseter.initializer" color="" fillcolor=lightcoral shape=oval style=filled]
1474 [label="src.offset.library.CarbonableOffseter.carbonable_project_address" color="" fillcolor=lightcoral shape=oval style=filled]
1480 [label="src.offset.library.CarbonableOffseter.get_start_time" color="" fillcolor=lightcoral shape=oval style=filled]
1486 [label="src.offset.library.CarbonableOffseter.get_lock_time" color="" fillcolor=lightcoral shape=oval style=filled]
1501 [label="src.offset.library.CarbonableOffseter.get_end_time" color="" fillcolor=lightcoral shape=oval style=filled]
1516 [label="src.offset.library.CarbonableOffseter.is_locked" color="" fillcolor=lightcoral shape=oval style=filled]
1551 [label="src.offset.library.CarbonableOffseter.total_locked" color="" fillcolor=lightcoral shape=oval style=filled]
1571 [label="src.offset.library.CarbonableOffseter.balance_of" color="" fillcolor=lightcoral shape=oval style=filled]
1580 [label="src.offset.library.CarbonableOffseter.registred_owner_of" color="" fillcolor=lightcoral shape=oval style=filled]
1609 [label="src.offset.library.CarbonableOffseter.total_offsetable" color="" fillcolor=lightcoral shape=oval style=filled]
1616 [label="src.offset.library.CarbonableOffseter.total_offseted" color="" fillcolor=lightcoral shape=oval style=filled]
1623 [label="src.offset.library.CarbonableOffseter.start_period" color="" fillcolor=lightcoral shape=oval style=filled]
1661 [label="src.offset.library.CarbonableOffseter.stop_period" color="" fillcolor=lightcoral shape=oval style=filled]
1697 [label="src.offset.library.CarbonableOffseter.deposit" color="" fillcolor=lightcoral shape=oval style=filled]
1752 [label="src.offset.library.CarbonableOffseter.withdraw" color="" fillcolor=lightcoral shape=oval style=filled]
1808 [label="src.offset.library.CarbonableOffseter.offset" color="" fillcolor=lightcoral shape=oval style=filled]
1877 [label="src.offset.library.CarbonableOffseter.snapshot" color="" fillcolor=lightcoral shape=oval style=filled]
1914 [label="src.offset.library.CarbonableOffseter._count" color="" fillcolor=lightcoral shape=oval style=filled]
1969 [label="src.offset.library.CarbonableOffseter._count_iter" color="" fillcolor=lightcoral shape=oval style=filled]
2034 [label="src.offset.library.CarbonableOffseter._snapshot" color="" fillcolor=lightcoral shape=oval style=filled]
2088 [label="src.offset.library.CarbonableOffseter._snapshot_iter" color="" fillcolor=lightcoral shape=oval style=filled]
2183 [label="__main__.initializer\l['external']" color="" fillcolor=lightgreen shape=oval style=filled]
2196 [label="__wrappers__.initializer\l['external']" color="" fillcolor=lightgreen shape=doubleoctagon style=filled]
2216 [label="__main__.getImplementationHash\l['view']" color="" fillcolor=orange shape=oval style=filled]
Expand Down Expand Up @@ -271,16 +271,16 @@ digraph CarbonableOffseter {
1221 -> 154
1234 -> 1216
1234 -> 162
1251 -> 1246
1251 -> 154 [label=2]
1270 -> 1246
1270 -> 162 [label=2]
1287 -> 3 [label=2]
1287 -> 81
1304 -> 1287
1304 -> 154
1319 -> 1287
1319 -> 162
1246 -> 3 [label=2]
1246 -> 81
1263 -> 1246
1263 -> 154
1278 -> 1246
1278 -> 162
1297 -> 1292
1297 -> 154 [label=2]
1316 -> 1292
1316 -> 162 [label=2]
1333 -> 3
1333 -> 81
1347 -> 1333
Expand Down Expand Up @@ -317,12 +317,12 @@ digraph CarbonableOffseter {
1580 -> 140
1580 -> 1131
1580 -> 930
1580 -> 1304
1580 -> 1263
1609 -> 1347
1616 -> 1399
1623 -> 14
1623 -> 18
1623 -> 1270
1623 -> 1316
1623 -> 147
1623 -> 1174
1623 -> 1234
Expand All @@ -343,12 +343,12 @@ digraph CarbonableOffseter {
1697 -> 140
1697 -> 954
1697 -> 930
1697 -> 1319
1697 -> 1278
1697 -> 1067
1752 -> 1052
1752 -> 1516
1752 -> 226
1752 -> 1319
1752 -> 1278
1752 -> 1131
1752 -> 140
1752 -> 133
Expand Down Expand Up @@ -376,7 +376,7 @@ digraph CarbonableOffseter {
1914 -> 879
1914 -> 1969
1969 -> 997
1969 -> 1304
1969 -> 1263
1969 -> 180
1969 -> 511
1969 -> 879
Expand All @@ -387,8 +387,8 @@ digraph CarbonableOffseter {
2034 -> 879
2034 -> 2088
2088 -> 997
2088 -> 1304
2088 -> 1251
2088 -> 1263
2088 -> 1297
2088 -> 386
2088 -> 1347
2088 -> 858
Expand Down
Loading

0 comments on commit ca15586

Please sign in to comment.