Skip to content
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

Merged
merged 3 commits into from
Jun 12, 2024
Merged

remove CrossChainApplications examples #394

merged 3 commits into from
Jun 12, 2024

Conversation

feuGeneA
Copy link
Contributor

@feuGeneA feuGeneA commented Jun 5, 2024

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.

Copy link

openzeppelin-code bot commented Jun 5, 2024

remove CrossChainApplications examples

Generated at commit: e6fed71fffd2edcdc087d42409c80ccf37259eff

🚨 Report Summary

Severity Level Results
Contracts Critical
High
Medium
Low
Note
Total
0
0
0
2
11
13
Dependencies Critical
High
Medium
Low
Note
Total
0
0
0
0
0
0

For more details view the full report in OpenZeppelin Code Inspector

@feuGeneA feuGeneA force-pushed the feuGeneA/rm-examples branch 3 times, most recently from cad72b9 to f1e5e44 Compare June 6, 2024 01:43
geoff-vball
geoff-vball previously approved these changes Jun 10, 2024
Copy link
Collaborator

@michaelkaplan13 michaelkaplan13 left a 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?

@cam-schultz
Copy link
Contributor

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

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]>
Copy link
Contributor

@bernard-avalabs bernard-avalabs left a 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @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.
Copy link
Contributor

@bernard-avalabs bernard-avalabs Jun 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* messages cross chain.
* messages across chains.

@feuGeneA feuGeneA merged commit 25cd118 into main Jun 12, 2024
14 checks passed
@michaelkaplan13 michaelkaplan13 deleted the feuGeneA/rm-examples branch June 14, 2024 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Migrate example contracts to avalanche-starter-kit
5 participants