Tweaks to AbstractTBTCDepositor contract
#779
Merged
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
Integrators may be interested in adding more fees to the deposit amount. For this reqson it may be cleanest to calculate im based on the initial deposit amount. By returning the value here they will avoid reading from the storage again.
By changing these functions to public the mock contract can be used by integrators to tweak the contracts to their expectations.
The fee being configurable may be useful for integrators using the stub contract in tests.
Using the value set in the transaction gives integrator a flexibility to test with different deposit values than 10 BTC.
New return parameter was covered in the mock to test the value.
Update calculations of amounts to match the changes made in the mock contracts. The biggest difference is that the funding transaction is no longer hardcoded in the MockBridge contract, but the value in the fixture transaction is used.
The file helps with switching expected node version between the workspaces. lts/hydrogen is node v18, which is the highest node version suported by this module.
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/tbtc-v2/actions/runs/7743108653 check. |
Result of running `yarn format:fix` command.
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/tbtc-v2/actions/runs/7743179668 check. |
| @@ -204,6 +211,8 @@ abstract contract TBTCDepositorProxy { | |||
| // slither-disable-next-line reentrancy-no-eth | |||
| delete pendingDeposits[depositKey]; | |||
|
|
|||
| initialDepositAmount = deposit.amount * SATOSHI_MULTIPLIER; | |||
There was a problem hiding this comment.
Let's update the usage example from the contract's docstring accordingly. Right now, there is an obsolete version with _finalizeDeposit returning two parameters.
lukasz-zimnoch
changed the title
TBTCDepositorProxy contractAbstractTBTCDepositor contract
…bstract-depositor-proxy-addons
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/tbtc-v2/actions/runs/7745366725 check. |
lukasz-zimnoch
approved these changes
Feb 2, 2024
|
Solidity API documentation preview available in the artifacts of the https://github.com/keep-network/tbtc-v2/actions/runs/7753096823 check. |
nkuba
added a commit
that referenced
this pull request
Feb 2, 2024
Here we remove the rule we added to exclude test contracts from published NPM package. In #779 we prepared a `TestTBTCDepositor` contract to be used by the integrators in tests for mocking the tBTC Bridge contracts. It is useful to include this file in the package, so the integrators can leverage it.
lukasz-zimnoch
added a commit
that referenced
this pull request
Feb 2, 2024
Here we remove the rule we added to exclude test contracts from published NPM package. In #779 we prepared a `TestTBTCDepositor` contract to be used by the integrators in tests for mocking the tBTC Bridge contracts. It is useful to include this file in the package, so the integrators can leverage it.
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.
Refs: #750
In this PR I propose some modifications to the initial implementation of
AbstractTBTCDepositorcontract (#778).Return initial deposit amount from _initializeDeposit function
Integrators may be interested in adding more fees to the deposit amount. For this reason, it may be cleanest to calculate it based on the initial deposit amount. By returning the value here they will avoid the need to read the funding deposit amount from the storage again.
Mock contracts tweaks
I added modifications to the MockBridge and MockTBTCVault contracts, that were useful in tests of the integrator's implementation (thesis/acre#91).