Skip to content

Commit 89b3f3a

Browse files
authored
chore: Rename contracts to remove CS prefix (#639)
## Description Remove CS prefix from all contracts but `CSModule.sol` ## Checklist - [x] Appropriate PR labels applied - [x] Test coverage maintained (`just coverage`) - [x] No need to add/update tests - [ ] Tests are added/updated - [x] Documentation maintained - [ ] No need to update - [x] Updated
1 parent 9963782 commit 89b3f3a

File tree

246 files changed

+7431
-5633
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

246 files changed

+7431
-5633
lines changed

GAS.md

Lines changed: 0 additions & 250 deletions
This file was deleted.

Justfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,11 +190,11 @@ oz-upgrades:
190190

191191
npx @openzeppelin/upgrades-core validate --contract=CSModule --reference=v1:CSModule --referenceBuildInfoDirs=out/v1 \
192192
--unsafeAllowLinkedLibraries --unsafeAllow=constructor,state-variable-immutable || true
193-
npx @openzeppelin/upgrades-core validate --contract=CSAccounting --reference=v1:CSAccounting --referenceBuildInfoDirs=out/v1 \
193+
npx @openzeppelin/upgrades-core validate --contract=Accounting --reference=v1:Accounting --referenceBuildInfoDirs=out/v1 \
194194
--unsafeAllowLinkedLibraries --unsafeAllow=constructor,state-variable-immutable || true
195-
npx @openzeppelin/upgrades-core validate --contract=CSFeeOracle --reference=v1:CSFeeOracle --referenceBuildInfoDirs=out/v1 \
195+
npx @openzeppelin/upgrades-core validate --contract=FeeOracle --reference=v1:FeeOracle --referenceBuildInfoDirs=out/v1 \
196196
--unsafeAllowLinkedLibraries --unsafeAllow=constructor,state-variable-immutable || true
197-
npx @openzeppelin/upgrades-core validate --contract=CSFeeDistributor --reference=v1:CSFeeDistributor --referenceBuildInfoDirs=out/v1 \
197+
npx @openzeppelin/upgrades-core validate --contract=FeeDistributor --reference=v1:FeeDistributor --referenceBuildInfoDirs=out/v1 \
198198
--unsafeAllowLinkedLibraries --unsafeAllow=constructor,state-variable-immutable || true
199199

200200
rm -rf "$TMP_DIR"

docs/src/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img src="logo.png" width="120" alt="CSM Logo"/>
2+
<img src="logo.png" width="240" alt="CSM Logo"/>
33
</p>
44
<h1 align="center"> Lido Community Staking Module </h1>
55

docs/src/SUMMARY.md

Lines changed: 62 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,43 +3,53 @@
33
# src
44
- [❱ abstract](src/abstract/README.md)
55
- [AssetRecoverer](src/abstract/AssetRecoverer.sol/abstract.AssetRecoverer.md)
6-
- [CSBondCore](src/abstract/CSBondCore.sol/abstract.CSBondCore.md)
7-
- [CSBondCurve](src/abstract/CSBondCurve.sol/abstract.CSBondCurve.md)
8-
- [CSBondLock](src/abstract/CSBondLock.sol/abstract.CSBondLock.md)
6+
- [BondCore](src/abstract/BondCore.sol/abstract.BondCore.md)
7+
- [BondCurve](src/abstract/BondCurve.sol/abstract.BondCurve.md)
8+
- [BondLock](src/abstract/BondLock.sol/abstract.BondLock.md)
99
- [ExitTypes](src/abstract/ExitTypes.sol/abstract.ExitTypes.md)
1010
- [❱ interfaces](src/interfaces/README.md)
1111
- [IACL](src/interfaces/IACL.sol/interface.IACL.md)
12+
- [IAccounting](src/interfaces/IAccounting.sol/interface.IAccounting.md)
13+
- [IBondCore](src/interfaces/IBondCore.sol/interface.IBondCore.md)
14+
- [IBondCurve](src/interfaces/IBondCurve.sol/interface.IBondCurve.md)
15+
- [IBondLock](src/interfaces/IBondLock.sol/interface.IBondLock.md)
1216
- [IBurner](src/interfaces/IBurner.sol/interface.IBurner.md)
13-
- [ICSAccounting](src/interfaces/ICSAccounting.sol/interface.ICSAccounting.md)
14-
- [ICSBondCore](src/interfaces/ICSBondCore.sol/interface.ICSBondCore.md)
15-
- [ICSBondCurve](src/interfaces/ICSBondCurve.sol/interface.ICSBondCurve.md)
16-
- [ICSBondLock](src/interfaces/ICSBondLock.sol/interface.ICSBondLock.md)
17-
- [ICSEjector](src/interfaces/ICSEjector.sol/interface.ICSEjector.md)
18-
- [MarkedUint248](src/interfaces/ICSExitPenalties.sol/struct.MarkedUint248.md)
19-
- [ExitPenaltyInfo](src/interfaces/ICSExitPenalties.sol/struct.ExitPenaltyInfo.md)
20-
- [ICSExitPenalties](src/interfaces/ICSExitPenalties.sol/interface.ICSExitPenalties.md)
21-
- [ICSFeeDistributor](src/interfaces/ICSFeeDistributor.sol/interface.ICSFeeDistributor.md)
22-
- [ICSFeeOracle](src/interfaces/ICSFeeOracle.sol/interface.ICSFeeOracle.md)
2317
- [NodeOperator](src/interfaces/ICSModule.sol/struct.NodeOperator.md)
2418
- [NodeOperatorManagementProperties](src/interfaces/ICSModule.sol/struct.NodeOperatorManagementProperties.md)
25-
- [ValidatorWithdrawalInfo](src/interfaces/ICSModule.sol/struct.ValidatorWithdrawalInfo.md)
19+
- [WithdrawnValidatorInfo](src/interfaces/ICSModule.sol/struct.WithdrawnValidatorInfo.md)
2620
- [ICSModule](src/interfaces/ICSModule.sol/interface.ICSModule.md)
27-
- [ICSParametersRegistry](src/interfaces/ICSParametersRegistry.sol/interface.ICSParametersRegistry.md)
28-
- [ICSStrikes](src/interfaces/ICSStrikes.sol/interface.ICSStrikes.md)
29-
- [ICSVerifier](src/interfaces/ICSVerifier.sol/interface.ICSVerifier.md)
21+
- [ICuratedGate](src/interfaces/ICuratedGate.sol/interface.ICuratedGate.md)
22+
- [ICuratedGateFactory](src/interfaces/ICuratedGateFactory.sol/interface.ICuratedGateFactory.md)
23+
- [ICuratedModule](src/interfaces/ICuratedModule.sol/interface.ICuratedModule.md)
24+
- [IERC20Permit](src/interfaces/IERC20Permit.sol/interface.IERC20Permit.md)
25+
- [IERC2612](src/interfaces/IERC2612.sol/interface.IERC2612.md)
26+
- [IEjector](src/interfaces/IEjector.sol/interface.IEjector.md)
27+
- [MarkedUint248](src/interfaces/IExitPenalties.sol/struct.MarkedUint248.md)
28+
- [ExitPenaltyInfo](src/interfaces/IExitPenalties.sol/struct.ExitPenaltyInfo.md)
29+
- [IExitPenalties](src/interfaces/IExitPenalties.sol/interface.IExitPenalties.md)
3030
- [IExitTypes](src/interfaces/IExitTypes.sol/interface.IExitTypes.md)
31+
- [IFeeDistributor](src/interfaces/IFeeDistributor.sol/interface.IFeeDistributor.md)
32+
- [IFeeOracle](src/interfaces/IFeeOracle.sol/interface.IFeeOracle.md)
3133
- [IGateSeal](src/interfaces/IGateSeal.sol/interface.IGateSeal.md)
3234
- [IGateSealFactory](src/interfaces/IGateSealFactory.sol/interface.IGateSealFactory.md)
3335
- [IKernel](src/interfaces/IKernel.sol/interface.IKernel.md)
3436
- [ILido](src/interfaces/ILido.sol/interface.ILido.md)
3537
- [ILidoLocator](src/interfaces/ILidoLocator.sol/interface.ILidoLocator.md)
38+
- [IMerkleGate](src/interfaces/IMerkleGate.sol/interface.IMerkleGate.md)
39+
- [INodeOperatorOwner](src/interfaces/INodeOperatorOwner.sol/interface.INodeOperatorOwner.md)
40+
- [IOneShotCurveSetup](src/interfaces/IOneShotCurveSetup.sol/interface.IOneShotCurveSetup.md)
41+
- [OperatorInfo](src/interfaces/IOperatorsData.sol/struct.OperatorInfo.md)
42+
- [IOperatorsData](src/interfaces/IOperatorsData.sol/interface.IOperatorsData.md)
43+
- [IParametersRegistry](src/interfaces/IParametersRegistry.sol/interface.IParametersRegistry.md)
3644
- [IPermissionlessGate](src/interfaces/IPermissionlessGate.sol/interface.IPermissionlessGate.md)
3745
- [IStETH](src/interfaces/IStETH.sol/interface.IStETH.md)
3846
- [IStakingModule](src/interfaces/IStakingModule.sol/interface.IStakingModule.md)
3947
- [IStakingRouter](src/interfaces/IStakingRouter.sol/interface.IStakingRouter.md)
4048
- [ValidatorData](src/interfaces/ITriggerableWithdrawalsGateway.sol/struct.ValidatorData.md)
4149
- [ITriggerableWithdrawalsGateway](src/interfaces/ITriggerableWithdrawalsGateway.sol/interface.ITriggerableWithdrawalsGateway.md)
4250
- [IVEBO](src/interfaces/IVEBO.sol/interface.IVEBO.md)
51+
- [IValidatorStrikes](src/interfaces/IValidatorStrikes.sol/interface.IValidatorStrikes.md)
52+
- [IVerifier](src/interfaces/IVerifier.sol/interface.IVerifier.md)
4353
- [IVettedGate](src/interfaces/IVettedGate.sol/interface.IVettedGate.md)
4454
- [IVettedGateFactory](src/interfaces/IVettedGateFactory.sol/interface.IVettedGateFactory.md)
4555
- [IWithdrawalQueue](src/interfaces/IWithdrawalQueue.sol/interface.IWithdrawalQueue.md)
@@ -60,31 +70,37 @@
6070
- [Versioned](src/lib/utils/Versioned.sol/contract.Versioned.md)
6171
- [IAssetRecovererLib](src/lib/AssetRecovererLib.sol/interface.IAssetRecovererLib.md)
6272
- [AssetRecovererLib](src/lib/AssetRecovererLib.sol/library.AssetRecovererLib.md)
73+
- [IBondCurves](src/lib/BondCurves.sol/interface.IBondCurves.md)
74+
- [BondCurves](src/lib/BondCurves.sol/library.BondCurves.md)
75+
- [IFeeSplits](src/lib/FeeSplits.sol/interface.IFeeSplits.md)
76+
- [FeeSplits](src/lib/FeeSplits.sol/library.FeeSplits.md)
6377
- [GIndex](src/lib/GIndex.sol/type.GIndex.md)
6478
- [IndexOutOfRange](src/lib/GIndex.sol/error.IndexOutOfRange.md)
79+
- [isRoot](src/lib/GIndex.sol/function.isRoot.md)
6580
- [fls](src/lib/GIndex.sol/function.fls.md)
66-
- [shl](src/lib/GIndex.sol/function.shl.md)
81+
- [width](src/lib/GIndex.sol/function.width.md)
82+
- [pow](src/lib/GIndex.sol/function.pow.md)
83+
- [concat](src/lib/GIndex.sol/function.concat.md)
6784
- [index](src/lib/GIndex.sol/function.index.md)
6885
- [shr](src/lib/GIndex.sol/function.shr.md)
69-
- [isRoot](src/lib/GIndex.sol/function.isRoot.md)
7086
- [pack](src/lib/GIndex.sol/function.pack.md)
71-
- [concat](src/lib/GIndex.sol/function.concat.md)
87+
- [shl](src/lib/GIndex.sol/function.shl.md)
7288
- [unwrap](src/lib/GIndex.sol/function.unwrap.md)
73-
- [pow](src/lib/GIndex.sol/function.pow.md)
74-
- [width](src/lib/GIndex.sol/function.width.md)
89+
- [IGeneralPenalty](src/lib/GeneralPenaltyLib.sol/interface.IGeneralPenalty.md)
90+
- [GeneralPenalty](src/lib/GeneralPenaltyLib.sol/library.GeneralPenalty.md)
7591
- [INOAddresses](src/lib/NOAddresses.sol/interface.INOAddresses.md)
7692
- [NOAddresses](src/lib/NOAddresses.sol/library.NOAddresses.md)
7793
- [Batch](src/lib/QueueLib.sol/type.Batch.md)
7894
- [IQueueLib](src/lib/QueueLib.sol/interface.IQueueLib.md)
7995
- [QueueLib](src/lib/QueueLib.sol/library.QueueLib.md)
80-
- [setKeys](src/lib/QueueLib.sol/function.setKeys.md)
81-
- [createBatch](src/lib/QueueLib.sol/function.createBatch.md)
82-
- [isNil](src/lib/QueueLib.sol/function.isNil.md)
8396
- [noId](src/lib/QueueLib.sol/function.noId.md)
84-
- [next](src/lib/QueueLib.sol/function.next.md)
8597
- [unwrap](src/lib/QueueLib.sol/function.unwrap.md)
86-
- [setNext](src/lib/QueueLib.sol/function.setNext.md)
98+
- [next](src/lib/QueueLib.sol/function.next.md)
99+
- [isNil](src/lib/QueueLib.sol/function.isNil.md)
100+
- [createBatch](src/lib/QueueLib.sol/function.createBatch.md)
87101
- [keys](src/lib/QueueLib.sol/function.keys.md)
102+
- [setKeys](src/lib/QueueLib.sol/function.setKeys.md)
103+
- [setNext](src/lib/QueueLib.sol/function.setNext.md)
88104
- [SSZ](src/lib/SSZ.sol/library.SSZ.md)
89105
- [SigningKeys](src/lib/SigningKeys.sol/library.SigningKeys.md)
90106
- [TransientUintUintMap](src/lib/TransientUintUintMapLib.sol/type.TransientUintUintMap.md)
@@ -93,22 +109,30 @@
93109
- [Withdrawal](src/lib/Types.sol/struct.Withdrawal.md)
94110
- [Validator](src/lib/Types.sol/struct.Validator.md)
95111
- [BeaconBlockHeader](src/lib/Types.sol/struct.BeaconBlockHeader.md)
112+
- [PendingConsolidation](src/lib/Types.sol/struct.PendingConsolidation.md)
113+
- [lt](src/lib/Types.sol/function.lt.md)
96114
- [unwrap](src/lib/Types.sol/function.unwrap.md)
97115
- [gt](src/lib/Types.sol/function.gt.md)
98-
- [lt](src/lib/Types.sol/function.lt.md)
99116
- [UnstructuredStorage](src/lib/UnstructuredStorage.sol/library.UnstructuredStorage.md)
100117
- [ValidatorCountsReport](src/lib/ValidatorCountsReport.sol/library.ValidatorCountsReport.md)
101-
- [CSAccounting](src/CSAccounting.sol/contract.CSAccounting.md)
102-
- [CSEjector](src/CSEjector.sol/contract.CSEjector.md)
103-
- [CSExitPenalties](src/CSExitPenalties.sol/contract.CSExitPenalties.md)
104-
- [CSFeeDistributor](src/CSFeeDistributor.sol/contract.CSFeeDistributor.md)
105-
- [CSFeeOracle](src/CSFeeOracle.sol/contract.CSFeeOracle.md)
118+
- [WithdrawnValidatorLib](src/lib/WithdrawnValidatorLib.sol/library.WithdrawnValidatorLib.md)
119+
- [❱ utils](src/utils/README.md)
120+
- [OneShotCurveSetup](src/utils/OneShotCurveSetup.sol/contract.OneShotCurveSetup.md)
121+
- [Accounting](src/Accounting.sol/contract.Accounting.md)
106122
- [CSModule](src/CSModule.sol/contract.CSModule.md)
107-
- [CSParametersRegistry](src/CSParametersRegistry.sol/contract.CSParametersRegistry.md)
108-
- [CSStrikes](src/CSStrikes.sol/contract.CSStrikes.md)
109-
- [CSVerifier](src/CSVerifier.sol/contract.CSVerifier.md)
110-
- [gweiToWei](src/CSVerifier.sol/function.gweiToWei.md)
111-
- [amountWei](src/CSVerifier.sol/function.amountWei.md)
123+
- [CuratedGate](src/CuratedGate.sol/contract.CuratedGate.md)
124+
- [CuratedGateFactory](src/CuratedGateFactory.sol/contract.CuratedGateFactory.md)
125+
- [CuratedModule](src/CuratedModule.sol/contract.CuratedModule.md)
126+
- [Ejector](src/Ejector.sol/contract.Ejector.md)
127+
- [ExitPenalties](src/ExitPenalties.sol/contract.ExitPenalties.md)
128+
- [FeeDistributor](src/FeeDistributor.sol/contract.FeeDistributor.md)
129+
- [FeeOracle](src/FeeOracle.sol/contract.FeeOracle.md)
130+
- [OperatorsData](src/OperatorsData.sol/contract.OperatorsData.md)
131+
- [ParametersRegistry](src/ParametersRegistry.sol/contract.ParametersRegistry.md)
112132
- [PermissionlessGate](src/PermissionlessGate.sol/contract.PermissionlessGate.md)
133+
- [ValidatorStrikes](src/ValidatorStrikes.sol/contract.ValidatorStrikes.md)
134+
- [Verifier](src/Verifier.sol/contract.Verifier.md)
135+
- [gweiToWei](src/Verifier.sol/function.gweiToWei.md)
136+
- [amountWei](src/Verifier.sol/function.amountWei.md)
113137
- [VettedGate](src/VettedGate.sol/contract.VettedGate.md)
114138
- [VettedGateFactory](src/VettedGateFactory.sol/contract.VettedGateFactory.md)

0 commit comments

Comments
 (0)