chore: update documenatation

subsquid · Nov 22, 2024 · 0df020f · 0df020f · github-actions · Nov 22, 2024
1 parent 542f92e
commit 0df020f
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/packages/contracts/DEPLOY_TO_MAINNET.md b/packages/contracts/DEPLOY_TO_MAINNET.md
@@ -0,0 +1,10 @@
+Re-deploy a single contract to the mainnet
+
+Network controller
+```bash
+forge create src/NetworkController.sol:NetworkController \
+  --private-key=$(op read "op://Shared/SQD Contract deployer/password") \
+  -r https://arb1.arbitrum.io/rpc \
+  --verify \
+  --constructor-args 100 19810800 0 100000000000000000000000 "[0x36E2B147Db67E76aB67a4d07C293670EbeFcAE4E,0x237Abf43bc51fd5c50d0D598A1A4c26E56a8A2A0,0xB31a0D39D2C69Ed4B28d96E12cbf52C5f9Ac9a51,0x8A90A1cE5fa8Cf71De9e6f76B7d3c0B72feB8c4b]"
+```
diff --git a/packages/contracts/README.md b/packages/contracts/README.md
@@ -55,12 +55,13 @@ pnpm run test
 |------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
 | **SQD**                            | [0x1337420dED5ADb9980CFc35f8f2B054ea86f8aB1](https://arbiscan.io/token/0x1337420dED5ADb9980CFc35f8f2B054ea86f8aB1)   |
 | **Router**                         | [0x67F56D27dab93eEb07f6372274aCa277F49dA941](https://arbiscan.io/address/0x67F56D27dab93eEb07f6372274aCa277F49dA941) |
-| **NetworkController**              | [0x4cf58097d790b193d22ed633bf8b15c9bc4f0da7](https://arbiscan.io/address/0x4cf58097d790b193d22ed633bf8b15c9bc4f0da7) |
+| **NetworkController**              | [0xf5462EF65Ca8a9Cca789c912Bc8ada80b582d68d](https://arbiscan.io/address/0xf5462EF65Ca8a9Cca789c912Bc8ada80b582d68d) |
 | **Staking**                        | [0xb31a0d39d2c69ed4b28d96e12cbf52c5f9ac9a51](https://arbiscan.io/address/0xb31a0d39d2c69ed4b28d96e12cbf52c5f9ac9a51) |
 | **WorkerRegistration**             | [0x36e2b147db67e76ab67a4d07c293670ebefcae4e](https://arbiscan.io/address/0x36e2b147db67e76ab67a4d07c293670ebefcae4e) |
 | **RewardTreasury**                 | [0x237abf43bc51fd5c50d0d598a1a4c26e56a8a2a0](https://arbiscan.io/address/0x237abf43bc51fd5c50d0d598a1a4c26e56a8a2a0) |
 | **DistributedRewardsDistribution** | [0xab690da5815659fe94f08f73e870d91a4d376d8f](https://arbiscan.io/address/0xab690da5815659fe94f08f73e870d91a4d376d8f) |
 | **GatewayRegistry**                | [0x8a90a1ce5fa8cf71de9e6f76b7d3c0b72feb8c4b](https://arbiscan.io/address/0x8a90a1ce5fa8cf71de9e6f76b7d3c0b72feb8c4b) |
+| **RewardCalculation**              | [0xd3D2C185a30484641C07b60e7d952d7B85516eB5](https://arbiscan.io/address/0xd3D2C185a30484641C07b60e7d952d7B85516eB5) |
 | **SoftCap**                        | [0xde29d5215c28036ce56091ea91038c94c84c87d0](https://arbiscan.io/address/0xde29d5215c28036ce56091ea91038c94c84c87d0) |
 | **EqualStrategy**                  | [0xa604f84c9c59e223b12c831b35723aa0d7277f8b](https://arbiscan.io/address/0xa604f84c9c59e223b12c831b35723aa0d7277f8b) |
 | **SubequalStrategy**               | [0xf197094d96f45325ee8bd2c43c5d25c05d66ab62](https://arbiscan.io/address/0xf197094d96f45325ee8bd2c43c5d25c05d66ab62) |

diff --git a/packages/contracts/src/NetworkController.sol b/packages/contracts/src/NetworkController.sol
@@ -13,7 +13,7 @@ import "./interfaces/INetworkController.sol";
 contract NetworkController is AccessControl, INetworkController {
   uint256 internal constant ONE_BASIS_POINT = 10_000;
 
-  /// @notice deprecated
+  /// @notice deprecated used ONLY for worker bond and delegation lock period
   uint128 public epochLength;
 
   uint128 public workerEpochLength;

diff --git a/packages/contracts/src/WorkerRegistration.sol b/packages/contracts/src/WorkerRegistration.sol
@@ -256,7 +256,10 @@ contract WorkerRegistration is AccessControlledPausable, IWorkerRegistration {
     return router.networkController().bondAmount();
   }
 
-  /// @dev Get current epoch length in blocks
+  /*
+  * @dev Get current epoch length in blocks
+  * @deprecated
+  */
   function epochLength() public view returns (uint128) {
     return router.networkController().epochLength();
   }