Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: typos in documentation files #146

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<h1 align="center">Obol Splits</h1>

This repo contains Obol Splits smart contracts. This suite of smart contracts and associated tests are intended to serve as a public good to to enable the safe and secure creation of Distributed Validators for Ethereum Consensus-based networks.
This repo contains Obol Splits smart contracts. This suite of smart contracts and associated tests are intended to serve as a public good to enable the safe and secure creation of Distributed Validators for Ethereum Consensus-based networks.

### Disclaimer

Expand Down
4 changes: 2 additions & 2 deletions script/DeployOTWRAndSplit.s.sol
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ contract DeployOTWRAndSplit is Script, SplitterConfiguration {
string memory objKey = vm.toString(i);

vm.serializeAddress(objKey, "splitAddress", split);
string memory repsonse = vm.serializeAddress(objKey, "OTWRAddress", otwrAddress);
string memory response = vm.serializeAddress(objKey, "OTWRAddress", otwrAddress);

finalJSON = vm.serializeString(jsonKey, objKey, repsonse);
finalJSON = vm.serializeString(jsonKey, objKey, response);
}

vm.writeJson(finalJSON, "./otwr-split.json");
Expand Down
6 changes: 3 additions & 3 deletions script/ObolLidoSetupScript.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {SplitterConfiguration} from "./SplitterConfiguration.sol";

/// @title ObolLidoScript
/// @author Obol
/// @notice Creates Split and ObolLidoSplit Adddresses
/// @notice Creates Split and ObolLidoSplit Addresses
///
/// @dev Takes a json file following the format defined at ./data/lido-data-sample.json
/// and deploys split and ObolLido split contracts.
Expand Down Expand Up @@ -68,9 +68,9 @@ contract ObolLidoSetupScript is Script, SplitterConfiguration {
vm.stopBroadcast();

vm.serializeAddress(objKey, "splitAddress", split);
string memory repsonse = vm.serializeAddress(objKey, "obolLidoSplitAddress", obolLidoSplitAdress);
string memory response = vm.serializeAddress(objKey, "obolLidoSplitAddress", obolLidoSplitAdress);

finalJSON = vm.serializeString(jsonKey, objKey, repsonse);
finalJSON = vm.serializeString(jsonKey, objKey, response);
}

vm.writeJson(finalJSON, "./result.json");
Expand Down
2 changes: 1 addition & 1 deletion src/base/BaseSplit.sol
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ abstract contract BaseSplit is Clone {
return _getArgAddress(WITHDRAWAL_ADDRESS_OFFSET);
}

/// Token addresss
/// Token address
/// @dev equivalent to address public immutable token
function token() public pure virtual returns (address) {
return _getArgAddress(TOKEN_ADDRESS_OFFSET);
Expand Down
6 changes: 3 additions & 3 deletions src/controllers/ImmutableSplitController.sol
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ contract ImmutableSplitController is Clone {
// onwer (address, 20 bytes)
// 2; third item
uint256 internal constant OWNER_OFFSET = 24;
// recipeints size (uint8, 1 byte )
// recipients size (uint8, 1 byte )
// 3; third item
uint256 internal constant RECIPIENTS_SIZE_OFFSET = 44;
// recipients data ()
Expand Down Expand Up @@ -118,7 +118,7 @@ contract ImmutableSplitController is Clone {
}
}

/// Number of recipeints
/// Number of recipients
/// @dev equivalent to address internal immutable _recipientsSize;
function _recipientsSize() internal pure returns (uint256) {
return _getArgUint8(RECIPIENTS_SIZE_OFFSET);
Expand All @@ -132,4 +132,4 @@ contract ImmutableSplitController is Clone {
return _getArgUint256(RECIPIENTS_OFFSET + (i * ONE_WORD));
}
}
}
}
2 changes: 1 addition & 1 deletion src/eigenlayer/ObolEigenLayerPodController.sol
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ contract ObolEigenLayerPodController {
/// @dev contract already initialized
error AlreadyInitialized();

/// @dev Emiited on intialize
/// @dev Emitted on initialize
event Initialized(address eigenPod, address owner);

/// -----------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion src/etherfi/ObolEtherfiSplitFactory.sol
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ contract ObolEtherfiSplitFactory is BaseSplitFactory {
/// @dev Create a new collector
/// @dev address(0) is used to represent ETH
/// @param withdrawalAddress Address of the splitWallet to transfer weETH to
/// @return collector Address of the wrappper split
/// @return collector Address of the wrapper split
function createCollector(address, address withdrawalAddress) external override returns (address collector) {
if (withdrawalAddress == address(0)) revert Invalid_Address();

Expand Down
2 changes: 1 addition & 1 deletion src/test/collector/ObolCollector.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ contract ObolCollectorTest is Test {
function test_token() public {
assertEq(collectorWithFee.token(), address(mERC20), "invalid token");

assertEq(ethCollectorWithFee.token(), address(0), "ivnalid token eth");
assertEq(ethCollectorWithFee.token(), address(0), "invalid token eth");
}

function test_DistributeERC20WithFee() public {
Expand Down
2 changes: 1 addition & 1 deletion src/test/controllers/IMSCFactory.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ contract IMSCFactory is Test {
);
}

function test_RevertIfRecipeintSizeTooMany() public {
function test_RevertIfRecipientSizeTooMany() public {
bytes32 deploymentSalt = keccak256(abi.encodePacked(uint256(1102)));

uint256 size = 400;
Expand Down
2 changes: 1 addition & 1 deletion src/test/eigenlayer/OELPCFactory.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ contract ObolEigenLayerPodControllerFactoryTest is EigenLayerTestBase {
new ObolEigenLayerPodControllerFactory(feeRecipient, feeShare, address(0), POD_MANAGER_GOERLI, DELAY_ROUTER_GOERLI);
}

function test_RevertIfInvalidPodManger() external {
function test_RevertIfInvalidPodManager() external {
vm.expectRevert(Invalid_EigenPodManaager.selector);
new ObolEigenLayerPodControllerFactory(
feeRecipient, feeShare, DELEGATION_MANAGER_GOERLI, address(0), DELAY_ROUTER_GOERLI
Expand Down