Skip to content

addExecutorLzReadOption doesnt exist in OptionsBuilder.sol #201

@bimkon144

Description

@bimkon144

Title

addExecutorLzReadOption is referenced in docs but does not exist in OptionsBuilder.sol


Description

While integrating lzRead according to the official documentation, I ran into an inconsistency between the docs and the actual Solidity libraries.

In the lzRead usage guide, the following method is referenced and shown as part of the expected workflow:

https://docs.layerzero.network/v2/developers/evm/lzread/overview#execution-options-for-lzread

Specifically, the docs mention using:

addExecutorLzReadOption(...)

which is implied to be available in OptionsBuilder.sol.

However, after checking the codebase, this method does not exist in OptionsBuilder.sol.


Documentation mismatch

The lzRead guide also points developers to read more details here:

https://docs.layerzero.network/v2/developers/evm/configuration/options

But in that section, there is no mention of lzRead at all, nor any executor option related to lzRead usage.

This makes it unclear:

  • how lzRead options are supposed to be configured,
  • where addExecutorLzReadOption is expected to come from,
  • or whether the docs are outdated or incomplete.

What I found

The only place where I could find a similar method is in OptionsUtil, where an addExecutorLzReadOption-like helper exists, but it appears to be:

  • used only for tests,
  • not part of the public builder (OptionsBuilder.sol) that the documentation suggests developers should use.

Questions / Requested clarification

Could you please clarify one of the following:

  1. Should addExecutorLzReadOption be added to OptionsBuilder.sol as a public API?
  2. Or is there a different, recommended way to configure executor options for lzRead that is not currently documented?
  3. Alternatively, are the lzRead docs outdated and need to be updated to reflect the current API?

Right now, following the official docs leads to a dead end, so some clarification or alignment between the docs and the code would be really helpful.


Thanks in advance, and appreciate all the work on LayerZero 🙌

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions