sujithsomraaj / lifi-stargate-v2-audit

3 Day Review [10 Jun 2024 - 13 Jun 2024]
0 stars 0 forks source link

Incosistent natspec usage in `ReceiverStargateV2.sol` #9

Open sujithsomraaj opened 3 months ago

sujithsomraaj commented 3 months ago

Context: Periphery/ReceiverStargateV2.sol#L19

Description: The interface ILayerZeroComposer in the ReceiverStargateV2 contract has a natspec format that varies from the usual LI.FI format.

Recommendation: If it's an external contract, consider moving it to a different file / updating the natspec to align with LI.FI's usual way to improve code quality.

-    /**
-     * @notice Composes a LayerZero message from an OApp.
-     * @param _from The address initiating the composition, typically the OApp where the lzReceive was called.
-     * @param _guid The unique identifier for the corresponding LayerZero src/dst tx.
-     * @param _message The composed message payload in bytes. NOT necessarily the same payload passed via lzReceive.
-     * @param _executor The address of the executor for the composed message.
-     * @param _extraData Additional arbitrary data in bytes passed by the entity who executes the lzCompose.
-     */
+    /// @notice Composes a LayerZero message from an OApp.
+    /// @param _from The address initiating the composition, typically the OApp where the lzReceive was called.
+    /// @param _guid The unique identifier for the corresponding LayerZero src/dst tx.
+    /// @param _message The composed message payload in bytes. NOT necessarily the same payload passed via lzReceive.
+    /// @param _executor The address of the executor for the composed message.
+    /// @param _extraData Additional arbitrary data in bytes passed by the entity who executes the lzCompose.

LI.FI:

Researcher:

0xDEnYO commented 3 months ago

updated