[LAU-03C] Repetitive Value Literal

[dkuppitz]

LAU-03C: Repetitive Value Literal

Type	Severity	Location
Code Style		LzAppUpgradeable.sol:L265, L268

Description:

The linked value literal is repeated across the codebase multiple times.

Example:

require(_adapterParams.length >= 34, "LzApp: invalid adapterParams");

Recommendation:

We advise it to be set to a constant variable instead optimizing the legibility of the codebase.

[dkuppitz]

Thank you for pointing out the repeated value literals in the codebase as highlighted in audit item LAU-03C. Your suggestion to replace these literals with constant variables would indeed improve code legibility and is in line with good Solidity coding practices.

Additionally, using custom errors instead of require statements with string literals would not only save gas but also provide clearer and more concise error handling – a practice we value and implement where possible.

However, the contracts in question are designed to remain as close as possible to LayerZero's original implementations. This decision is guided by the following considerations:

1. Ease of Update and Maintainability: By minimizing deviations from the original code, we can more easily track updates and patches from LayerZero and integrate them into our upgradeable versions without extensive refactoring.

2. Developer Familiarity: Developers who are already familiar with the LayerZero codebase can work with our contracts without having to adjust to new patterns or practices that have been introduced.

3. Review and Verification: Staying aligned with the original source allows for easier verification and review against the known and audited LayerZero contracts, which adds a layer of trust and security for users and developers alike.

We understand the importance of following best coding practices and the potential benefits they bring. Rest assured, should there be any changes to LayerZero's original implementation concerning these literals, or should we develop new contracts outside of this context, we will certainly implement constants and custom errors as per best practices.

Your recommendations are invaluable, and while we choose to adhere closely to LayerZero's conventions in this instance, we are dedicated to continuous improvement and will keep these suggestions in mind for future contract development.