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

Restructure directories and contract content + README updates #52

Merged
merged 21 commits into from
Apr 26, 2024

Conversation

sisyphusSmiling
Copy link
Contributor

@sisyphusSmiling sisyphusSmiling commented Apr 26, 2024

Closes: #29 #47 #49 #50
Stacked on: #48

Description

  • Reorganizes the repo contents
  • Enables global pausing operations via FlowEVMBridgeConfig.Admin
  • Assigns ERC721 symbol values using the first 4 uppercase alphanumeric characters of an NFT contract name
  • Consolidates logic related to deploying EVM contracts
  • Moves EVMBridgedMetadata and URI views from CrossVMNFT to Metadata views
  • Updates README documentation

For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@sisyphusSmiling sisyphusSmiling self-assigned this Apr 26, 2024
@sisyphusSmiling sisyphusSmiling added Feature Breaking Change Documentation Improvements or additions to documentation EVM labels Apr 26, 2024
@codecov-commenter
Copy link

codecov-commenter commented Apr 26, 2024

Codecov Report

Attention: Patch coverage is 94.28571% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 85.56%. Comparing base (428634e) to head (36718c2).
Report is 38 commits behind head on main.

Files Patch % Lines
cadence/contracts/bridge/FlowEVMBridgeUtils.cdc 95.00% 3 Missing ⚠️
cadence/contracts/bridge/FlowEVMBridgeConfig.cdc 80.00% 2 Missing ⚠️
cadence/contracts/utils/SerializeMetadata.cdc 94.44% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #52      +/-   ##
==========================================
+ Coverage   82.88%   85.56%   +2.67%     
==========================================
  Files          18       19       +1     
  Lines         818      859      +41     
==========================================
+ Hits          678      735      +57     
+ Misses        140      124      -16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sisyphusSmiling sisyphusSmiling marked this pull request as ready for review April 26, 2024 16:57
@sisyphusSmiling sisyphusSmiling requested a review from a team as a code owner April 26, 2024 16:57
@sisyphusSmiling sisyphusSmiling changed the title Repo reorg Restructure directories and contract content + README updates Apr 26, 2024
Copy link
Member

@joshuahannan joshuahannan left a comment

Choose a reason for hiding this comment

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

Looks good! Just a few small comments

README.md Outdated Show resolved Hide resolved
Comment on lines +172 to +177
Similarly, Cadence contracts can implement the [`IBridgePermissions.cdc` contract
interface](./cadence/contracts/bridge/interfaces/IBridgePermissions.cdc). This contract has a single method
`allowsBridging()` with a default implementation returning `false`. Again, the bridge explicitly checks for the
implementation of `IBridgePermissions` and the value of `allowsBridging()` to validate that the contract has not opted
out of bridging. Should you later choose to enable bridging, you can simply override the default implementation and
return true.
Copy link
Member

Choose a reason for hiding this comment

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

It would be good to get this added to the V2 standards so we can show that every NFT contract needs to be cognizant about if they want to allow bridging or not. Can you make a PR to the v2 standard branch?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Definitely, I can follow up with a PR early next week

cadence/contracts/bridge/FlowEVMBridgeUtils.cdc Outdated Show resolved Hide resolved
cadence/contracts/bridge/FlowEVMBridgeUtils.cdc Outdated Show resolved Hide resolved
cadence/tests/flow_evm_bridge_tests.cdc Show resolved Hide resolved
cadence/transactions/bridge/admin/pause/pause_bridge.cdc Outdated Show resolved Hide resolved
Base automatically changed from consolidate-bridging-logic to main April 26, 2024 19:50
sisyphusSmiling and others added 2 commits April 26, 2024 14:54
Co-authored-by: Joshua Hannan <joshua.hannan@flowfoundation.org>
@sisyphusSmiling sisyphusSmiling merged commit 360536b into main Apr 26, 2024
2 checks passed
@sisyphusSmiling sisyphusSmiling deleted the repo-reorg branch April 26, 2024 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change Documentation Improvements or additions to documentation EVM Feature
Projects
Status: Done
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Dynamically assign an ERC721 symbol for bridged NFTs
3 participants