Merge pull request #148 from valory-xyz/finalize_docs

doc: readme-s
valory-xyz · May 23, 2024 · a2231b3 · a2231b3
2 parents 65a47eb + c3f6f79
commit a2231b3
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -6,13 +6,14 @@ This repository contains the tokenomics part of Autonolas onchain-protocol contr
 
 A graphical overview is available here:
 
-![architecture](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/docs/On-chain_architecture_v5.png?raw=true)
+![architecture](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/docs/On-chain_architecture_v5.png)
 
-An overview of the Autonolas tokenomics model, a high-level description of smart contacts, and a full set of smart contract
-specifications are provided [here](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/docs/Autonolas_tokenomics_audit.pdf?raw=true).
+An overview of the Autonolas tokenomics model is provided [here](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/docs/Autonolas_tokenomics_audit.pdf). A description of the tokenomics contracts related to Olas staking is provided [here](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/docs/StakingSmartContracts.pdf).
+
+Details on tokenomics model and Olas Staking can be found [here](https://olas.network/documents/whitepaper/Autonolas_Tokenomics_Core_Technical_Document.pdf) and [here](https://staking.olas.network/poaa-whitepaper.pdf).
 
 The Depository and Treasury contracts are inspired by OlympusDAO concepts. The Tokenomics contract implements the brunt of the reward logic
-for component and agent owners, and the logic that regulates the discount factor for bonds.
+for component and agent owners, the logic that regulates the discount factor for bonds, and Olas staking emissions.
 The Tokenomics contract is deployed via the proxy contract, such that it is possible to update the current Tokenomics implementation.
 
 - Core contracts:
@@ -21,6 +22,22 @@ The Tokenomics contract is deployed via the proxy contract, such that it is poss
   - [Tokenomics](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/Tokenomics.sol)
   - [TokenomicsProxy](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/TokenomicsProxy.sol)
   - [Treasury](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/Treasury.sol)
+
+- Staking related contracts:
+  - [DefaultDepositProcessorL1](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/DefaultDepositProcessorL1.sol)
+  - [DefaultTargetDispenserL2](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/DefaultTargetDispenserL2.sol)
+  - [EthereumDepositProcessor.sol](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/EthereumDepositProcessor.sol.sol)
+  - [ArbitrumDepositProcessorL1](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/ArbitrumDepositProcessorL1.sol)
+  - [ArbitrumTargetDispenserL2](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/ArbitrumTargetDispenserL2.sol)
+  - [GnosisDepositProcessorL1](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/GnosisDepositProcessorL1.sol)
+  - [GnosisTargetDispenserL2](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/GnosisTargetDispenserL2.sol)
+  - [OptimismDepositProcessorL1](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/OptimismDepositProcessorL1.sol)
+  - [OptimismTargetDispenserL2](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/OptimismTargetDispenserL2.sol)
+  - [PolygonDepositProcessorL1](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/PolygonDepositProcessorL1.sol)
+  - [PolygonTargetDispenserL2](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/PolygonTargetDispenserL2.sol)
+  - [WormholeDepositProcessorL1](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/WormholeDepositProcessorL1.sol)
+  - [WormholeTargetDispenserL2](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/staking/WormholeTargetDispenserL2.sol)
+
 - Auxiliary contracts:
   - [DonatorBlacklist](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/DonatorBlacklist.sol)
   - [GenericBondCalculator](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/contracts/GenericBondCalculator.sol)
@@ -66,7 +83,7 @@ forge test --hh -vv
 
 ### Audits
 The audit is provided as development matures. The latest audit reports can be found here: [audits](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/audits).
-A list of known vulnerabilities can be found here: [Vulnerabilities list tokenomics](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/docs/Vulnerabilities_list_tokenomics.pdf?raw=true).
+A list of known vulnerabilities can be found here: [Vulnerabilities list tokenomics](https://github.com/valory-xyz/autonolas-tokenomics/blob/main/docs/Vulnerabilities_list_tokenomics.pdf).
 
 ### Linters
 - [`ESLint`](https://eslint.org) is used for JS code.

diff --git a/docs/StakingSmartContracts.pdf b/docs/StakingSmartContracts.pdf
diff --git a/docs/Vulnerabilities_list_tokenomics.pdf b/docs/Vulnerabilities_list_tokenomics.pdf
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/solmate b/lib/solmate
diff --git a/scripts/analyzers/README.md b/scripts/analyzers/README.md
@@ -1,13 +1,13 @@
 # Code analyzer script
-- [analyzeContracts.js script](https://github.com/valory-xyz/autonolas-tokenomucs/blob/main/scripts/analyzers/analyzeContracts.js) provides a report of solidity code lines for some contracts. This script can be run as follows:
-
+- [analyzeContracts script](https://github.com/valory-xyz/autonolas-tokenomucs/blob/main/scripts/analyzers/analyzeContracts.js)
+provides a report of solidity code lines for some contracts. This script can be run as follows:
 ```
 node scripts/analyzers/analyzeContracts.js
 ```
 
-- [analyzeContractInterface.js script](https://github.com/valory-xyz/autonolas-tokenomucs/blob/main/scripts/analyzers/analyzeContractInterface.js) provides a report of solidity files interfacs for some contracts. This script can be run as follows:
-
+- [analyzeContractInterface.sh script](https://github.com/valory-xyz/autonolas-tokenomucs/blob/main/scripts/analyzers/analyzeContractInterface.js)
+provides a report of solidity files interfaces for some contracts. This script can be run as follows:
 ```
-./scripts/analyzers/analyzeContractInterface.js
+./scripts/analyzers/analyzeContractInterface.sh
 ```
 
diff --git a/scripts/analyzers/code_line_report.txt b/scripts/analyzers/code_line_report.txt
@@ -1,22 +1,23 @@
       | Contract                                                                                                                 |   CodeLine |
 ----------------------------------------------------------------------------------------------------------------------------------------------
-    1 | contracts/staking/ArbitrumDepositProcessorL1.sol                                                                         |         89 |
-    2 | contracts/staking/ArbitrumTargetDispenserL2.sol                                                                          |         25 |
-    3 | contracts/staking/DefaultDepositProcessorL1.sol                                                                          |         91 |
-    4 | contracts/staking/DefaultTargetDispenserL2.sol                                                                           |        180 |
-    5 | contracts/staking/GnosisDepositProcessorL1.sol                                                                           |         32 |
-    6 | contracts/staking/GnosisTargetDispenserL2.sol                                                                            |         24 |
-    7 | contracts/staking/OptimismDepositProcessorL1.sol                                                                         |         67 |
-    8 | contracts/staking/OptimismTargetDispenserL2.sol                                                                          |         31 |
-    9 | contracts/staking/PolygonDepositProcessorL1.sol                                                                          |         45 |
-   10 | contracts/staking/PolygonTargetDispenserL2.sol                                                                           |         24 |
-   11 | contracts/staking/WormholeDepositProcessorL1.sol                                                                         |         64 |
-   12 | contracts/staking/WormholeTargetDispenserL2.sol                                                                          |         75 |
-   13 | contracts/TokenomicsConstants.sol                                                                                        |         59 |
-   14 | contracts/Tokenomics.sol                                                                                                 |        702 |
-   15 | contracts/Dispenser.sol                                                                                                  |        357 |
-   16 | contracts/interfaces/IDonatorBlacklist.sol                                                                               |          4 |
-   17 | contracts/interfaces/IErrorsTokenomics.sol                                                                               |         31 |
-   18 | contracts/interfaces/IBridgeErrors.sol                                                                                   |          0 |
+    1 | contracts/staking/ArbitrumDepositProcessorL1.sol                                                                         |         98 |
+    2 | contracts/staking/ArbitrumTargetDispenserL2.sol                                                                          |         33 |
+    3 | contracts/staking/DefaultDepositProcessorL1.sol                                                                          |        112 |
+    4 | contracts/staking/DefaultTargetDispenserL2.sol                                                                           |        253 |
+    5 | contracts/staking/EthereumDepositProcessor.sol                                                                           |         87 |
+    6 | contracts/staking/GnosisDepositProcessorL1.sol                                                                           |         48 |
+    7 | contracts/staking/GnosisTargetDispenserL2.sol                                                                            |         50 |
+    8 | contracts/staking/OptimismDepositProcessorL1.sol                                                                         |         69 |
+    9 | contracts/staking/OptimismTargetDispenserL2.sol                                                                          |         45 |
+   10 | contracts/staking/PolygonDepositProcessorL1.sol                                                                          |         58 |
+   11 | contracts/staking/PolygonTargetDispenserL2.sol                                                                           |         34 |
+   12 | contracts/staking/WormholeDepositProcessorL1.sol                                                                         |         78 |
+   13 | contracts/staking/WormholeTargetDispenserL2.sol                                                                          |         88 |
+   14 | contracts/TokenomicsConstants.sol                                                                                        |         60 |
+   15 | contracts/Tokenomics.sol                                                                                                 |        733 |
+   16 | contracts/Dispenser.sol                                                                                                  |        641 |
+   17 | contracts/interfaces/IDonatorBlacklist.sol                                                                               |          4 |
+   18 | contracts/interfaces/IErrorsTokenomics.sol                                                                               |         31 |
+   19 | contracts/interfaces/IBridgeErrors.sol                                                                                   |         23 |
 ----------------------------------------------------------------------------------------------------------------------------------------------
-   18 | All Tokenomics contract                                                                                                  |       1900 |
+   19 | All Tokenomics contract                                                                                                  |       2545 |
+0 −1		.gitattributes
+12 −6		.github/workflows/ci.yml
+1 −3		.github/workflows/sync.yml
+3 −0		.gitmodules
+1 −1		README.md
+3 −3		foundry.toml
+1 −0		lib/ds-test
+1 −1		package.json
+0 −635		scripts/vm.py
+225 −518		src/StdAssertions.sol
+9 −17		src/StdChains.sol
+2 −2		src/StdCheats.sol
+3 −9		src/StdInvariant.sol
+11 −7		src/StdJson.sol
+106 −201		src/StdStorage.sol
+0 −179		src/StdToml.sol
+33 −61		src/StdUtils.sol
+4 −4		src/Test.sol
+462 −1,445		src/Vm.sol
+0 −234		src/mocks/MockERC20.sol
+0 −231		src/mocks/MockERC721.sol
+909 −39		test/StdAssertions.t.sol
+26 −33		test/StdChains.t.sol
+11 −19		test/StdCheats.t.sol
+1 −3		test/StdError.t.sol
+0 −49		test/StdJson.t.sol
+8 −8		test/StdMath.t.sol
+11 −159		test/StdStorage.t.sol
+0 −49		test/StdToml.t.sol
+20 −20		test/StdUtils.t.sol
+3 −3		test/Vm.t.sol
+0 −8		test/fixtures/test.json
+0 −6		test/fixtures/test.toml
+0 −441		test/mocks/MockERC20.t.sol
+0 −721		test/mocks/MockERC721.t.sol