-
Notifications
You must be signed in to change notification settings - Fork 75
fix[N08] Propose fixes to some naming issues #105
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
Conversation
Signed-off-by: chrismaree <christopher.maree@gmail.com>
Signed-off-by: chrismaree <christopher.maree@gmail.com>
Signed-off-by: chrismaree <christopher.maree@gmail.com>
|
Note that this PR requires a few others to go in first that it is dependent on to avoid conflicts. In particular: |
contracts/SpokePool.sol
Outdated
| WETH9 public weth; | ||
| // Address of wrappedNativeToken contract for this network. If an origin token matches this, then the caller can | ||
| // optionally instruct this contract to wrap native tokens when depositing (ie ETH->WETH or MATIC->WMATIC). | ||
| WETH9 public wrappedNativeToken; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this change is potentially contentious. I'm curious what you think.
|
|
||
| /******************************************************** | ||
| * ARBITRUM-SPECIFIC CROSS-CHAIN ADMIN FUNCTIONS * | ||
| * POLYGON-SPECIFIC CROSS-CHAIN ADMIN FUNCTIONS * |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
unrelated but saw this comment issue.
contracts/HubPool.sol
Outdated
| using SafeERC20 for IERC20; | ||
| using Address for address; | ||
|
|
||
| // A data worker can optimistically store several merkle roots on this contract by staking a bond and calling |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure why it shows this diff here...previous PR moved this around.
contracts/HubPool.sol
Outdated
| event RootBundleDisputed(address indexed disputer, uint256 requestTime, bytes disputedAncillaryData); | ||
|
|
||
| event RootBundleCanceled(address indexed disputer, uint256 requestTime, bytes disputedAncillaryData); | ||
| event RootBundleCanceled(address indexed disputer, uint256 requestTime, bytes ancillaryData); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can remove this change since ancillaryData is no longer included in this event following #114
nicholaspai
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks awesome but rebase master before you merge and check on any merge conflicts
* fix[N02} Move all structs to the same place Signed-off-by: chrismaree <christopher.maree@gmail.com> * fix[N03] Fixed inconsistant token metadata versioning Signed-off-by: chrismaree <christopher.maree@gmail.com> * nit Signed-off-by: chrismaree <christopher.maree@gmail.com> * nit Signed-off-by: chrismaree <christopher.maree@gmail.com> * fix[N08] Propose fixes to some naming issues Signed-off-by: chrismaree <christopher.maree@gmail.com>
) * improve: Update solc version to 8.13 * feat: Changes after running 8.13 wargames * Update Optimism_Adapter.json * Init commit: arbitrum rinkeby * finish arbitrum war games * fix[N06] Fix misleading comments (#104) * fix[N04] Add additional documentation Signed-off-by: chrismaree <christopher.maree@gmail.com> * nit Signed-off-by: chrismaree <christopher.maree@gmail.com> * fix[N06] Fix missleading comments Signed-off-by: chrismaree <christopher.maree@gmail.com> * Apply suggestions from code review Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com> * nit Signed-off-by: chrismaree <christopher.maree@gmail.com> Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com> * fix[N08] Propose fixes to some naming issues (#105) * fix[N02} Move all structs to the same place Signed-off-by: chrismaree <christopher.maree@gmail.com> * fix[N03] Fixed inconsistant token metadata versioning Signed-off-by: chrismaree <christopher.maree@gmail.com> * nit Signed-off-by: chrismaree <christopher.maree@gmail.com> * nit Signed-off-by: chrismaree <christopher.maree@gmail.com> * fix[N08] Propose fixes to some naming issues Signed-off-by: chrismaree <christopher.maree@gmail.com> * fix[L04] Enforce chainId requirements in PolygonTokenBridger (#115) * fix: Arbitrum Adapter needs to pay for L2 gas * Add helper scripts * Update Arbitrum_Adapter.sol Co-authored-by: Chris Maree <christopher.maree@gmail.com> Co-authored-by: Matt Rice <matthewcrice32@gmail.com>
Problem:
We have identified some areas of the code which could benefit from better naming:
renamed to l1Token to better match other functions in the interface, as well as the function's
implementation in HubPool.
that it ends the "challenge period". Consider renaming it to ChallengePeriodEndTimestamp or
similar.
the plural form, but when the event is emitted, all array parameters are named in the plural
form. Consider changing the event definition so that all array parameters are pluralized.
be. Consider renaming it to something like destinationTokenFromRoute to better match the
return value.
the weth variable in SpokePool.sol to wrapped_native_token to make it more generalizable.
SpokePools.
and should be renamed accordingly.
renamed to poolRebalanceLeafCount, since it's always the total number of leaves in the tree.
proposal is not necessarily disputed. It should just be ancillaryData.
its functionality.
destinationChainId to match the rest of the code base.
Solution:
all recommendations have been made.