Skip to content

Commit 970b424

Browse files
Mani BrarMani Brar
authored andcommitted
chore: update natspec comments
1 parent a97d590 commit 970b424

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

contracts/src/arbitrumToEth/VeaInboxArbToEth.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ contract VeaInboxArbToEth is IVeaInbox {
7070
/// Amortized cost is constant.
7171
/// Note: See docs for details how inbox manages merkle tree state.
7272
/// @param _to The address of the contract on the receiving chain which receives the calldata.
73-
/// @param _data The message calldata, abi.encodeWithSelector(fnSelector, param1, param2, ...)
73+
/// @param _data The message data for the receiving gateway.
7474
/// @return msgId The zero based index of the message in the inbox.
7575
function sendMessage(address _to, bytes calldata _data) external override returns (uint64) {
7676
uint64 oldCount = count;

contracts/src/arbitrumToEth/VeaOutboxArbToEth.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ contract VeaOutboxArbToEth is IVeaOutboxOnL1 {
357357
/// @param _msgId The zero based index of the message in the inbox.
358358
/// @param _to The address of the contract on Ethereum to call.
359359
/// @param _from The address of the contract on Arbitrum that sent the message.
360-
/// @param _message The message in the vea inbox as abi.encodeWithSelector(fnSelector, param1, param2, ...)
360+
/// @param _message The message in the vea inbox.
361361
function sendMessage(
362362
bytes32[] calldata _proof,
363363
uint64 _msgId,

contracts/src/arbitrumToGnosis/VeaInboxArbToGnosis.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ contract VeaInboxArbToGnosis is IVeaInbox {
6969
/// `O(log(count))` where count is the number of messages already sent.
7070
/// Amortized cost is constant.
7171
/// Note: See docs for details how inbox manages merkle tree state.
72-
/// @param _to The address of the contract on the receiving chain which receives the calldata.
73-
/// @param _data The message calldata, abi.encodeWithSelector(fnSelector, param1, param2, ...)
72+
/// @param _to The address of the contract on the receiving chain which receives the message.
73+
/// @param _data The message data for the receiving gateway.
7474
/// @return msgId The zero based index of the message in the inbox.
7575
function sendMessage(address _to, bytes calldata _data) external override returns (uint64) {
7676
uint64 oldCount = count;

contracts/src/arbitrumToGnosis/VeaOutboxArbToGnosis.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ contract VeaOutboxArbToGnosis is IVeaOutboxOnL1, ISequencerDelayUpdatable {
301301
/// @param _msgId The zero based index of the message in the inbox.
302302
/// @param _to The address of the contract on Gnosis to call.
303303
/// @param _from The address of the contract on Arbitrum that sent the message.
304-
/// @param _message The message in the vea inbox as abi.encodeWithSelector(fnSelector, param1, param2, ...)
304+
/// @param _message The message in the vea inbox
305305
function sendMessage(
306306
bytes32[] calldata _proof,
307307
uint64 _msgId,

contracts/src/gnosisToArbitrum/VeaInboxGnosisToArb.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ contract VeaInboxGnosisToArb is IVeaInbox {
7070
/// `O(log(count))` where count is the number of messages already sent.
7171
/// Amortized cost is constant.
7272
/// Note: See docs for details how inbox manages merkle tree state.
73-
/// @param _to The address of the contract on the receiving chain which receives the calldata.
74-
/// @param _data The message calldata, abi.encodeWithSelector(fnSelector, param1, param2, ...)
73+
/// @param _to The address of the contract on the receiving chain which receives the message.
74+
/// @param _data The message data for the receiving gateway.
7575
/// @return msgId The zero based index of the message in the inbox.
7676
function sendMessage(address _to, bytes calldata _data) external override returns (uint64) {
7777
uint64 oldCount = count;

contracts/src/gnosisToArbitrum/VeaOutboxGnosisToArb.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ contract VeaOutboxGnosisToArb is IVeaOutboxOnL2 {
287287
/// @param _msgId The zero based index of the message in the inbox.
288288
/// @param _to The address of the contract on Arbitrum to call.
289289
/// @param _from The address of the message sender
290-
/// @param _message The message in the vea inbox as abi.encodeWithSelector(fnSelector, param1, param2, ...)
290+
/// @param _message The message in the vea inbox
291291
function sendMessage(
292292
bytes32[] memory _proof,
293293
uint64 _msgId,

contracts/src/interfaces/inboxes/IVeaInbox.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ pragma solidity ^0.8.24;
1111
interface IVeaInbox {
1212
/// @dev Sends an arbitrary message to receiving chain.
1313
/// Note: Calls authenticated by receiving gateway checking the sender argument.
14-
/// @param _to The cross-domain contract address which receives the calldata.
15-
/// @param _data The message calldata, abi.encodeWithSelector(...)
14+
/// @param _to The cross-domain contract address which receives the message.
15+
/// @param _data The message data.
1616
/// @return msgId The index of the message in the inbox, as a message Id, needed to relay the message.
1717
function sendMessage(address _to, bytes calldata _data) external returns (uint64 msgId);
1818

0 commit comments

Comments
 (0)