Skip to content

Commit f81f1db

Browse files
authored
fix natspec comments (to silence foundry errors) (#1446)
1 parent b57f0d0 commit f81f1db

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

docs/RelayFacet.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ The methods listed above take a variable labeled `_relayData`. This data is spec
2828
/// @dev Relay specific parameters
2929
/// @param requestId Realy API request ID
3030
/// @param nonEVMReceiver set only if bridging to non-EVM chain
31-
/// @params receivingAssetId address of receiving asset
32-
/// @params callData calldata provided by Relay API
33-
/// @params signature attestation signature provided by the Relay solver
31+
/// @param receivingAssetId address of receiving asset
32+
/// @param callData calldata provided by Relay API
33+
/// @param signature attestation signature provided by the Relay solver
3434
struct RelayData {
3535
bytes32 requestId;
3636
bytes32 nonEVMReceiver;

src/Facets/RelayFacet.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ contract RelayFacet is
3939
/// @dev Relay specific parameters
4040
/// @param requestId Relay API request ID
4141
/// @param nonEVMReceiver set only if bridging to non-EVM chain
42-
/// @params receivingAssetId address of receiving asset
43-
/// @params signature attestation signature provided by the Relay solver
42+
/// @param receivingAssetId address of receiving asset
43+
/// @param signature attestation signature provided by the Relay solver
4444
struct RelayData {
4545
bytes32 requestId;
4646
bytes32 nonEVMReceiver;

src/Interfaces/IConnextHandler.sol

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ pragma solidity ^0.8.17;
77
interface IConnextHandler {
88
/// @notice These are the call parameters that will remain constant between the
99
/// two chains. They are supplied on `xcall` and should be asserted on `execute`
10-
/// @property to - The account that receives funds, in the event of a crosschain call,
11-
/// will receive funds if the call fails.
12-
/// @param to - The address you are sending funds (and potentially data) to
10+
/// @param to - The address that will receive funds/refunds
1311
/// @param callData - The data to execute on the receiving chain. If no crosschain call is needed, then leave empty.
1412
/// @param originDomain - The originating domain (i.e. where `xcall` is called). Must match nomad domain schema
1513
/// @param destinationDomain - The final domain (i.e. where `execute` / `reconcile` are called).

0 commit comments

Comments
 (0)