🧹 update build lz options README.md with warning information (#360)

Signed-off-by: Ryan Goulding <[email protected]>
LayerZero-Labs · Feb 7, 2024 · 23f376c · 23f376c
1 parent be21702
commit 23f376c
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/.changeset/wild-brooms-tell.md b/.changeset/wild-brooms-tell.md
@@ -0,0 +1,5 @@
+---
+"build-lz-options": patch
+---
+
+Update build-lz-options README.md with warning information
diff --git a/packages/build-lz-options/README.md b/packages/build-lz-options/README.md
@@ -29,3 +29,12 @@ pnpm build-lz-options
 # or
 bunx build-lz-options
 ```
+
+## Warnings
+
+### :warning: Warning: Options do not specify any lzReceive gas
+
+The default LayerZero ExecutorFeeLib requires the sum of lzReceive gas for all Options for a message is a positive
+integer. This is classified as a warning and not an error, as `build-lz-options` tool is not aware of the context in
+which the generated Options are used. For example, Options may be combined elsewhere in the application, perhaps with
+OApp Enforced Options, and the result will have a positive lzReceive gas sum.