chore: add optional gas params

St0rmBr3w · St0rmBr3w · commit fba883055c0a · 2025-07-02T11:04:54.000+02:00
diff --git a/examples/oft/tasks/sendEvm.ts b/examples/oft/tasks/sendEvm.ts
@@ -1,13 +1,13 @@
+import path from 'path'
+
 import { BigNumber, ContractTransaction } from 'ethers'
 import { parseUnits } from 'ethers/lib/utils'
 import { HardhatRuntimeEnvironment } from 'hardhat/types'
 
-import { createGetHreByEid } from '@layerzerolabs/devtools-evm-hardhat'
+import { OmniPointHardhat, createGetHreByEid } from '@layerzerolabs/devtools-evm-hardhat'
 import { createLogger } from '@layerzerolabs/io-devtools'
 import { ChainType, endpointIdToChainType, endpointIdToNetwork } from '@layerzerolabs/lz-definitions'
-import { addressToBytes32 } from '@layerzerolabs/lz-v2-utilities'
-
-import layerzeroConfig from '../layerzero.config'
+import { Options, addressToBytes32 } from '@layerzerolabs/lz-v2-utilities'
 
 import { SendResult } from './types'
 import { DebugLogger, KnownErrors, getLayerZeroScanLink } from './utils'
@@ -19,14 +19,29 @@ export interface EvmArgs {
     dstEid: number
     amount: string
     to: string
+    oappConfig: string
     minAmount?: string
-    extraOptions?: string
+    extraLzReceiveOptions?: string[]
+    extraLzComposeOptions?: string[]
+    extraNativeDropOptions?: string[]
     composeMsg?: string
     oftAddress?: string
 }
 
 export async function sendEvm(
-    { srcEid, dstEid, amount, to, minAmount, extraOptions, composeMsg, oftAddress }: EvmArgs,
+    {
+        srcEid,
+        dstEid,
+        amount,
+        to,
+        oappConfig,
+        minAmount,
+        extraLzReceiveOptions,
+        extraLzComposeOptions,
+        extraNativeDropOptions,
+        composeMsg,
+        oftAddress,
+    }: EvmArgs,
     hre: HardhatRuntimeEnvironment
 ): Promise<SendResult> {
     if (endpointIdToChainType(srcEid) !== ChainType.EVM) {
@@ -51,12 +66,13 @@ export async function sendEvm(
     if (oftAddress) {
         wrapperAddress = oftAddress
     } else {
-        const { contracts } = typeof layerzeroConfig === 'function' ? await layerzeroConfig() : layerzeroConfig
-        const wrapper = contracts.find((c) => c.contract.eid === srcEid)
+        const layerZeroConfig = (await import(path.resolve('./', oappConfig))).default
+        const { contracts } = typeof layerZeroConfig === 'function' ? await layerZeroConfig() : layerZeroConfig
+        const wrapper = contracts.find((c: { contract: OmniPointHardhat }) => c.contract.eid === srcEid)
         if (!wrapper) throw new Error(`No config for EID ${srcEid}`)
         wrapperAddress = wrapper.contract.contractName
             ? (await srcEidHre.deployments.get(wrapper.contract.contractName)).address
-            : wrapper.contract.address!
+            : wrapper.contract.address || ''
     }
 
     // 2️⃣ load IOFT ABI, extend it with token()
@@ -78,18 +94,95 @@ export async function sendEvm(
     // hex string → Uint8Array → zero-pad to 32 bytes
     const toBytes = addressToBytes32(to)
 
-    // 6️⃣ build sendParam and dispatch
+    // 6️⃣ Build options dynamically using Options.newOptions()
+    let options = Options.newOptions()
+
+    // Add lzReceive options
+    if (extraLzReceiveOptions && extraLzReceiveOptions.length > 0) {
+        // Handle case where Hardhat's CSV parsing splits "gas,value" into separate elements
+        if (extraLzReceiveOptions.length % 2 !== 0) {
+            throw new Error(
+                `Invalid lzReceive options: received ${extraLzReceiveOptions.length} values, but expected pairs of gas,value`
+            )
+        }
+
+        for (let i = 0; i < extraLzReceiveOptions.length; i += 2) {
+            const gas = Number(extraLzReceiveOptions[i])
+            const value = Number(extraLzReceiveOptions[i + 1]) || 0
+            options = options.addExecutorLzReceiveOption(gas, value)
+            logger.info(`Added lzReceive option: ${gas} gas, ${value} value`)
+        }
+    }
+
+    // Add lzCompose options
+    if (extraLzComposeOptions && extraLzComposeOptions.length > 0) {
+        // Handle case where Hardhat's CSV parsing splits "index,gas,value" into separate elements
+        if (extraLzComposeOptions.length % 3 !== 0) {
+            throw new Error(
+                `Invalid lzCompose options: received ${extraLzComposeOptions.length} values, but expected triplets of index,gas,value`
+            )
+        }
+
+        for (let i = 0; i < extraLzComposeOptions.length; i += 3) {
+            const index = Number(extraLzComposeOptions[i])
+            const gas = Number(extraLzComposeOptions[i + 1])
+            const value = Number(extraLzComposeOptions[i + 2]) || 0
+            options = options.addExecutorComposeOption(index, gas, value)
+            logger.info(`Added lzCompose option: index ${index}, ${gas} gas, ${value} value`)
+        }
+    }
+
+    // Add native drop options
+    if (extraNativeDropOptions && extraNativeDropOptions.length > 0) {
+        // Handle case where Hardhat's CSV parsing splits "amount,recipient" into separate elements
+        if (extraNativeDropOptions.length % 2 !== 0) {
+            throw new Error(
+                `Invalid native drop options: received ${extraNativeDropOptions.length} values, but expected pairs of amount,recipient`
+            )
+        }
+
+        for (let i = 0; i < extraNativeDropOptions.length; i += 2) {
+            const amountStr = extraNativeDropOptions[i]
+            const recipient = extraNativeDropOptions[i + 1]
+
+            if (!amountStr || !recipient) {
+                throw new Error(
+                    `Invalid native drop option: Both amount and recipient must be provided. Got amount="${amountStr}", recipient="${recipient}"`
+                )
+            }
+
+            try {
+                options = options.addExecutorNativeDropOption(amountStr.trim(), recipient.trim())
+                logger.info(`Added native drop option: ${amountStr.trim()} wei to ${recipient.trim()}`)
+            } catch (error) {
+                // Provide helpful context if the amount exceeds protocol limits
+                const maxUint128 = BigInt('340282366920938463463374607431768211455') // 2^128 - 1
+                const maxUint128Ether = Number(maxUint128) / 1e18 // Convert to ETH for readability
+
+                throw new Error(
+                    `Failed to add native drop option with amount ${amountStr.trim()} wei. ` +
+                        `LayerZero protocol constrains native drop amounts to uint128 maximum ` +
+                        `(${maxUint128.toString()} wei ≈ ${maxUint128Ether.toFixed(2)} ETH). ` +
+                        `Original error: ${error instanceof Error ? error.message : String(error)}`
+                )
+            }
+        }
+    }
+
+    const extraOptions = options.toHex()
+
+    // 7️⃣ build sendParam and dispatch
     const sendParam = {
         dstEid,
         to: toBytes,
         amountLD: amountUnits.toString(),
         minAmountLD: minAmount ? parseUnits(minAmount, decimals).toString() : amountUnits.toString(),
-        extraOptions: extraOptions ? extraOptions.toString() : '0x',
+        extraOptions: extraOptions,
         composeMsg: composeMsg ? composeMsg.toString() : '0x',
         oftCmd: '0x',
     }
 
-    // 6️⃣ Quote (MessagingFee = { nativeFee, lzTokenFee })
+    // 8️⃣ Quote (MessagingFee = { nativeFee, lzTokenFee })
     logger.info('Quoting the native gas cost for the send transaction...')
     let msgFee: { nativeFee: BigNumber; lzTokenFee: BigNumber }
     try {
diff --git a/examples/oft/tasks/sendOFT.ts b/examples/oft/tasks/sendOFT.ts
@@ -1,6 +1,7 @@
 import { task, types } from 'hardhat/config'
 import { HardhatRuntimeEnvironment } from 'hardhat/types'
 
+import { types as cliTypes } from '@layerzerolabs/devtools-evm-hardhat'
 import { ChainType, endpointIdToChainType, endpointIdToNetwork } from '@layerzerolabs/lz-definitions'
 
 import { EvmArgs, sendEvm } from './sendEvm'
@@ -12,10 +13,15 @@ interface MasterArgs {
     dstEid: number
     amount: string
     to: string
+    oappConfig: string
     /** Minimum amount to receive in case of custom slippage or fees (human readable units, e.g. "1.5") */
     minAmount?: string
-    /** Extra options for sending additional gas units to lzReceive, lzCompose, or receiver address */
-    extraOptions?: string
+    /** Array of lzReceive options as comma-separated values "gas,value" - e.g. --extra-lz-receive-options "200000,0" */
+    extraLzReceiveOptions?: string[]
+    /** Array of lzCompose options as comma-separated values "index,gas,value" - e.g. --extra-lz-compose-options "0,500000,0" */
+    extraLzComposeOptions?: string[]
+    /** Array of native drop options as comma-separated values "amount,recipient" - e.g. --extra-native-drop-options "1000000000000000000,0x1234..." */
+    extraNativeDropOptions?: string[]
     /** Arbitrary bytes message to deliver alongside the OFT */
     composeMsg?: string
     /** EVM: 20-byte hex address */
@@ -27,18 +33,32 @@ task('lz:oft:send', 'Sends OFT tokens cross‐chain from EVM chains')
     .addParam('dstEid', 'Destination endpoint ID', undefined, types.int)
     .addParam('amount', 'Amount to send (human readable units, e.g. "1.5")', undefined, types.string)
     .addParam('to', 'Recipient address (20-byte hex for EVM)', undefined, types.string)
+    .addOptionalParam('oappConfig', 'Path to the LayerZero config file', 'layerzero.config.ts', types.string)
     .addOptionalParam(
         'minAmount',
         'Minimum amount to receive in case of custom slippage or fees (human readable units, e.g. "1.5")',
         undefined,
         types.string
     )
     .addOptionalParam(
-        'extraOptions',
-        'Extra options for sending additional gas units to lzReceive, lzCompose, or receiver address',
+        'extraLzReceiveOptions',
+        'Array of extra lzReceive options in format "gas,value" (e.g. ["200000,0", "100000,1000000000000000000"])',
         undefined,
-        types.string
+        cliTypes.csv
+    )
+    .addOptionalParam(
+        'extraLzComposeOptions',
+        'Array of extra lzCompose options in format "index,gas,value" (e.g. ["0,500000,0", "1,300000,1000000000000000000"])',
+        undefined,
+        cliTypes.csv
+    )
+    .addOptionalParam(
+        'extraNativeDropOptions',
+        'Array of extra native drop options in format "amount,recipient" (e.g. ["1000000000000000000,0x1234..."])',
+        undefined,
+        cliTypes.csv
     )
+    .addOptionalParam('composeMsg', 'Arbitrary bytes message to deliver alongside the OFT', undefined, types.string)
     .addOptionalParam(
         'oftAddress',
         'Override the source local deployment OFT address (20-byte hex for EVM)',
