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

Use NatSpec for ITokenBridge events and errors #202

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

thedarkjester
Copy link
Collaborator

This PR implements issue(s) #

Checklist

  • I wrote new tests for my new core changes.
  • I have successfully ran tests, style checker and build against my new changes locally.
  • I have informed the team of any breaking changes if there are any.

@codecov-commenter
Copy link

codecov-commenter commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.69%. Comparing base (9fc7fa6) to head (fa4e7c5).

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #202   +/-   ##
=========================================
  Coverage     70.69%   70.69%           
  Complexity     1059     1059           
=========================================
  Files           291      291           
  Lines         11972    11972           
  Branches       1106     1106           
=========================================
  Hits           8464     8464           
  Misses         3031     3031           
  Partials        477      477           
Flag Coverage Δ
hardhat 98.69% <ø> (ø)
kotlin 68.36% <ø> (ø)
Files with missing lines Coverage Δ
contracts/contracts/ZkEvmV2.sol 100.00% <ø> (ø)
...ts/contracts/messageService/MessageServiceBase.sol 100.00% <ø> (ø)
...tracts/messageService/l2/v1/L2MessageServiceV1.sol 100.00% <ø> (ø)
...ts/contracts/messageService/lib/MessageHashing.sol 100.00% <ø> (ø)

event RemoteTokenBridgeSet(address indexed remoteTokenBridge, address indexed setBy);

/**
* @notice Emitted when the a token is set as deployed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove "the"

event TokenDeployed(address indexed token);

/**
* @notice Emitted when the a token deployment is confirmed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove "the"

event DeploymentConfirmed(address[] tokens, address indexed confirmedBy);

/**
* @notice Emitted when the a message service address is set.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove "a"

event MessageServiceUpdated(
address indexed newMessageService,
address indexed oldMessageService,
address indexed setBy
);

/**
* @dev Thrown when the attempting to bridge a reserved token.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove "the"

error RemoteTokenBridgeAlreadySet(address remoteTokenBridge);

/**
* @dev Thrown when the attempting to reserve an already bridged token.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove "the"

error NativeToBridgedTokenAlreadySet(address token);

/**
* @dev Thrown when trying to set a token is already either native, deployed or reserved.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Thrown when trying to set a token that is already"

@thedarkjester thedarkjester marked this pull request as ready for review October 18, 2024 15:04
@thedarkjester thedarkjester requested a review from a team as a code owner October 18, 2024 15:04
count-sum
count-sum previously approved these changes Oct 18, 2024
VGau
VGau previously approved these changes Oct 18, 2024
@thedarkjester thedarkjester dismissed stale reviews from VGau and count-sum via 85f0174 October 18, 2024 15:46
@thedarkjester thedarkjester deployed to docker-build-and-e2e October 18, 2024 15:54 — with GitHub Actions Active
@thedarkjester thedarkjester enabled auto-merge (squash) October 18, 2024 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants