-
Notifications
You must be signed in to change notification settings - Fork 24
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
remove CrossChainApplications examples #394
Conversation
remove CrossChainApplications examples
🚨 Report Summary
For more details view the full report in OpenZeppelin Code Inspector |
cad72b9
to
f1e5e44
Compare
f1e5e44
to
e6fed71
Compare
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.
Can you add a prominent reference to the starter kit repo from the top level README for people looking to learn how to build applications on top of Teleporter?
This should be an accurate view of the e2e contract code coverage (at least when comparing before/after), since we only ever interact with the contracts via the ABI bindings in the tests. |
Signed-off-by: F. Eugene Aumson <[email protected]>
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.
LGTM. Just pointed out some minor typos.
@@ -17,10 +17,10 @@ import {ReentrancyGuard} from "@openzeppelin/[email protected]/security/Reentrancy | |||
*/ | |||
|
|||
/** | |||
* @dev ExampleCrossChainMessenger is an example contract that demonstrates how to send and receive | |||
* @dev TestMessenger is test fixture contract that exercises sending and receiving |
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.
* @dev TestMessenger is test fixture contract that exercises sending and receiving | |
* @dev TestMessenger is a test fixture contract that exercises sending and receiving |
@@ -17,10 +17,10 @@ import {ReentrancyGuard} from "@openzeppelin/[email protected]/security/Reentrancy | |||
*/ | |||
|
|||
/** | |||
* @dev ExampleCrossChainMessenger is an example contract that demonstrates how to send and receive | |||
* @dev TestMessenger is test fixture contract that exercises sending and receiving | |||
* messages cross chain. |
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.
* messages cross chain. | |
* messages across chains. |
Why this should be merged
Fixes #381
The actual migration of any of these examples, into the avalanche-starter-kit, as specified by ava-labs/avalanche-starter-kit#5, can happen independently of this removal.
How this was tested
I found that you can enable a go coverage report for Ginkgo test runs. Of course it doesn't provide any coverage for the contracts themselves, but I was able to focus the coverage report on just the contracts' ABI bindings. I found that the coverage report was identical before and after the removal of these tests. Therefore, I think removing these tests likely has no impact on test coverage.