Skip to content

Commit

Permalink
Merge pull request #56 from omahs/patch-1
Browse files Browse the repository at this point in the history
fix: typos
  • Loading branch information
jakim929 authored Nov 15, 2024
2 parents 2c4b1a5 + 5522345 commit 501ac98
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ pnpm contracts:deploy:token

#### Use Create2 to deploy SuperchainERC20

`Create2` ensures that the address is deterministically deterimined by the bytecode of the contract and the provided salt. This is crucial because in order for cross-chain transfers of `SuperchainERC20`s to work with interop, the tokens must be deployed at the same address across all chains.
`Create2` ensures that the address is deterministically determined by the bytecode of the contract and the provided salt. This is crucial because in order for cross-chain transfers of `SuperchainERC20`s to work with interop, the tokens must be deployed at the same address across all chains.

#### `crosschainMint` and `crosschainBurn` permissions

Expand Down Expand Up @@ -182,7 +182,7 @@ After completing these steps, you will have the following set up:
- `supersim` running in autorelay mode with two L2 chains
- The `L2NativeSuperchainERC20` token deployed on both chains

**2. Find the address and owner of the L2NativeSuperchainERC20 token was deployed.**
**2. Find the address and owner of the L2NativeSuperchainERC20 token that was deployed.**

The address that the token in step 1 was deployed to and the address of the owner of the token can be found in the [deployment.json](packages/contracts/deployment.json) file under the `"deployedAddress"` and `"ownerAddress"` fields. The `deployedAddress` address will be used for any token interactions in the next steps and the private key of the `ownerAddress` will need to be used for step 3 since minting requires owner privileges. In this example `deployment.json` file the token in step 1 was deployed at `0x5BCf71Ca0CE963373d917031aAFDd6D98B80B159` and the owner address is `0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266`:

Expand Down
2 changes: 1 addition & 1 deletion packages/contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This repository contains contracts and tooling for deploying and managing Superc

### src/

- `L2NativeSuperchainERC20.sol` - An simple SuperchainERC20 implementation that allows the owner to mint new tokens.
- `L2NativeSuperchainERC20.sol` - A simple SuperchainERC20 implementation that allows the owner to mint new tokens.

## Tests

Expand Down
4 changes: 2 additions & 2 deletions packages/contracts/test/L2NativeSuperchainERC20.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ contract L2NativeSuperchainERC20Test is Test {
assertEq(superchainERC20.balanceOf(alice), _amount);
}

/// @notice tests that an insufficent balance cannot be transferred.
/// @notice tests that an insufficient balance cannot be transferred.
function testFuzz_transferInsufficientBalance_reverts(address _to, uint256 _mintAmount, uint256 _sendAmount)
public
{
Expand All @@ -148,7 +148,7 @@ contract L2NativeSuperchainERC20Test is Test {
superchainERC20.transfer(_to, _sendAmount);
}

/// @notice tests that an insufficent allowance cannot be transferred.
/// @notice tests that an insufficient allowance cannot be transferred.
function testFuzz_transferFromInsufficientAllowance_reverts(
address _to,
address _from,
Expand Down

0 comments on commit 501ac98

Please sign in to comment.