feat: update function and event naming for backwards compatibility #805
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Chris Maree <[email protected]>
Signed-off-by: Chris Maree <[email protected]>
Signed-off-by: Chris Maree <[email protected]>
Signed-off-by: Chris Maree <[email protected]>
nicholaspai
reviewed
Dec 18, 2024
chrismaree
commented
Jan 7, 2025
| uint256 inputAmount; | ||
| uint256 outputAmount; | ||
| uint256 originChainId; | ||
| uint256 depositId; |
Signed-off-by: Chris Maree <[email protected]>
chrismaree
commented
Jan 7, 2025
contracts/SpokePool.sol
Outdated
| @@ -633,8 +633,8 @@ abstract contract SpokePool is | |||
| uint32 fillDeadline, | |||
| uint32 exclusivityParameter, | |||
| bytes calldata message | |||
| ) public payable { | |||
| unsafeDepositV3( | |||
| ) public payable override { | |||
There was a problem hiding this comment.
this did not have override, so I've added it to the interface.
chrismaree
commented
Jan 7, 2025
| @@ -766,8 +766,8 @@ abstract contract SpokePool is | |||
| uint32 fillDeadlineOffset, | |||
| uint32 exclusivityPeriod, | |||
| bytes calldata message | |||
| ) external payable { | |||
| depositV3( | |||
| ) external payable override { | |||
There was a problem hiding this comment.
was also missing from interface.
chrismaree
commented
Jan 7, 2025
| @@ -827,7 +827,7 @@ abstract contract SpokePool is | |||
| uint32 fillDeadlineOffset, | |||
| uint32 exclusivityPeriod, | |||
| bytes calldata message | |||
| ) external payable { | |||
| ) external payable override { | |||
There was a problem hiding this comment.
was also missing from interface.
chrismaree
commented
Jan 7, 2025
| @@ -109,22 +109,3 @@ export const sampleRateModel = { | |||
| R1: toWei(0.07).toString(), | |||
| R2: toWei(0.75).toString(), | |||
| }; | |||
|
|
|||
| export const SpokePoolFuncs = { | |||
There was a problem hiding this comment.
no more loverload. yay!
Signed-off-by: Chris Maree <[email protected]>
Signed-off-by: Chris Maree <[email protected]>
Signed-off-by: Chris Maree <[email protected]>
Signed-off-by: Chris Maree <[email protected]>
chrismaree
commented
Jan 8, 2025
contracts/SpokePoolVerifier.sol
Outdated
| @@ -42,7 +42,7 @@ contract SpokePoolVerifier { | |||
| * to 0 if exclusiveRelayer is set to 0x0, and vice versa. | |||
| * @param fillDeadline Timestamp after which this deposit can no longer be filled. | |||
| */ | |||
| function deposit( | |||
| function depositV3Bytes32( | |||
Signed-off-by: Matt Rice <[email protected]>
Signed-off-by: Matt Rice <[email protected]>
Signed-off-by: Matt Rice <[email protected]>
Signed-off-by: Matt Rice <[email protected]>
Signed-off-by: Matt Rice <[email protected]>
Signed-off-by: Matt Rice <[email protected]>
Signed-off-by: Matt Rice <[email protected]>
Signed-off-by: Matt Rice <[email protected]>
Signed-off-by: Matt Rice <[email protected]>
mrice32
changed the title
Signed-off-by: Chris Maree <[email protected]>
Signed-off-by: Chris Maree <[email protected]>
Signed-off-by: Chris Maree <[email protected]>
Signed-off-by: Chris Maree <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes a single functional change: it adds back the previous
fillV3Relayinterface that existed prior to this audit. This method forwards tofillRelayThe rest of the PR is entirely renaming to make it an easier upgrade for integrators:
depositfunction has been removed and replaced with the colliding function namedepositDeprecated_5947912356. Note: this means that anyone who fails to update their code will not be broken. However, it means that we are able to reuse the deposit name without function overloading.bytes32overload ofdepositV3has been renamed to justdeposit.unsafeDepositand only thebytes32version was kept.bytes32overload ofdepositV3Nowwas renamed todepositNow.bytes32overload ofspeedUpV3Depositwas renamed tospeedUpDeposit.bytes32version offillV3Relaywas renamed tofillRelay.V3FundsDeposited,RequestedSpeedUpV3Deposit,FilledV3Relay,RequestedV3SlowFill:bytes32version, theV3was dropped from the name.V3was added back to the interface, so that it persists in the ABI to make migration easier.