OAPP-2067 fix(ua-devtools): skip already-pinned libraries with areBytes32Equal

.changeset/library-samevalue-idempotency.md

@@ -0,0 +1,14 @@
+---
+"@layerzerolabs/ua-devtools": patch
+---
+
+Fix library wire skip checks with chain-aware address equality
+
+`configureSendLibraries` / `configureReceiveLibraries` (and read-library equivalents)
+previously compared addresses with `toLowerCase()` or strict `===`. Checksum or
+padding mismatches caused already-pinned libraries to be re-proposed, which reverts
+on-chain with `LZ_SameValue`. Comparisons now use
+`areBytes32Equal(normalizePeer(…, localEid), …)` so EVM checksum/padding and Solana
+base58 both compare correctly. Bare `areBytes32Equal` on raw library strings is not
+enough — it throws on base58. Keeps the existing "lock defaults" behavior when the
+OApp is still on the endpoint default.

packages/ua-devtools/src/oapp-read/config.ts

@@ -1,9 +1,11 @@
 import {
     type Bytes,
+    areBytes32Equal,
     type OmniTransaction,
     formatOmniPoint,
     createConfigureMultiple,
     createConfigureNodes,
+    normalizePeer,
 } from '@layerzerolabs/devtools'
 import type { OAppReadConfigurator, OAppReadEnforcedOption } from './types'
 import { createModuleLogger, createWithAsyncLogger, printBoolean } from '@layerzerolabs/io-devtools'
@@ -106,7 +108,15 @@ export const configureReadLibraries: OAppReadConfigurator = withOAppReadLogger(
                     const isDefaultSendLibrary = await endpointSdk.isDefaultSendLibrary(point.address, channelId)
                     const currentSendLibrary = await endpointSdk.getSendLibrary(point.address, channelId)
 
-                    if (!isDefaultSendLibrary && currentSendLibrary === readLibrary) {
+                    // Keep !isDefault* so we still lock a matching resolved default into OApp storage.
+                    // Compare via normalizePeer(local eid) so EVM checksum/padding and Solana base58 both work.
+                    if (
+                        !isDefaultSendLibrary &&
+                        areBytes32Equal(
+                            normalizePeer(currentSendLibrary, point.eid),
+                            normalizePeer(readLibrary, point.eid)
+                        )
+                    ) {
                         logger.verbose(
                             `Current sendlibrary of channelId ${channelId} is already set to ${readLibrary} for ${label}, skipping`
                         )
@@ -120,7 +130,13 @@ export const configureReadLibraries: OAppReadConfigurator = withOAppReadLogger(
                         channelId
                     )
 
-                    if (!isDefaultReceiveLibrary && currentReceiveLibrary === readLibrary) {
+                    if (
+                        !isDefaultReceiveLibrary &&
+                        areBytes32Equal(
+                            normalizePeer(currentReceiveLibrary, point.eid),
+                            normalizePeer(readLibrary, point.eid)
+                        )
+                    ) {
                         logger.verbose(
                             `Current receiveLibrary of channelId ${channelId} is already set to ${readLibrary} for ${label}, skipping`
                         )

packages/ua-devtools/src/oapp/config.ts

@@ -1,5 +1,6 @@
 import {
     type Bytes,
+    areBytes32Equal,
     formatOmniVector,
     isDeepEqual,
     type OmniAddress,
@@ -9,6 +10,7 @@ import {
     createConfigureMultiple,
     createConfigureNodes,
     createConfigureEdges,
+    normalizePeer,
 } from '@layerzerolabs/devtools'
 import type { OAppConfigurator, OAppEnforcedOption, OAppEnforcedOptionParam, OAppFactory } from './types'
 import { createModuleLogger, createWithAsyncLogger, printBoolean } from '@layerzerolabs/io-devtools'
@@ -137,7 +139,15 @@ export const configureSendLibraries: OAppConfigurator = withOAppLogger(
                     )
                 }
 
-                if (!isDefaultLibrary && currentSendLibrary?.toLowerCase() === config.sendLibrary.toLowerCase()) {
+                // Keep !isDefaultLibrary so we still "lock" a matching resolved default into OApp storage.
+                // Compare via normalizePeer(local eid) so EVM checksum/padding and Solana base58 both work.
+                if (
+                    !isDefaultLibrary &&
+                    areBytes32Equal(
+                        normalizePeer(currentSendLibrary, from.eid),
+                        normalizePeer(config.sendLibrary, from.eid)
+                    )
+                ) {
                     logger.verbose(
                         `Current sendLibrary is not default library and is already set to ${config.sendLibrary} for ${formatOmniVector({ from, to })}, skipping`
                     )
@@ -212,7 +222,15 @@ export const configureReceiveLibraries: OAppConfigurator = withOAppLogger(
                     )
                 }
 
-                if (!isDefaultLibrary && currentReceiveLibrary === config.receiveLibraryConfig.receiveLibrary) {
+                // Keep !isDefaultLibrary so we still "lock" a matching resolved default into OApp storage.
+                // Compare via normalizePeer(local eid) so EVM checksum/padding and Solana base58 both work.
+                if (
+                    !isDefaultLibrary &&
+                    areBytes32Equal(
+                        normalizePeer(currentReceiveLibrary, from.eid),
+                        normalizePeer(config.receiveLibraryConfig.receiveLibrary, from.eid)
+                    )
+                ) {
                     logger.verbose(
                         `Current recieveLibrary is not default and is already set to ${config.receiveLibraryConfig.receiveLibrary} for ${formatOmniVector({ from, to })}, skipping`
                     )

tests/ua-devtools-evm-hardhat-test/test/oapp-read/config.test.ts

@@ -6,7 +6,13 @@ import {
     OmniContractFactoryHardhat,
 } from '@layerzerolabs/devtools-evm-hardhat'
 import { createOAppReadFactory } from '@layerzerolabs/ua-devtools-evm'
-import { configureOAppRead, IOAppRead, OAppReadFactory, OAppReadOmniGraph } from '@layerzerolabs/ua-devtools'
+import {
+    configureOAppRead,
+    configureReadLibraries,
+    IOAppRead,
+    OAppReadFactory,
+    OAppReadOmniGraph,
+} from '@layerzerolabs/ua-devtools'
 import { OmniContract, omniContractToPoint } from '@layerzerolabs/devtools-evm'
 import {
     setupDefaultEndpointV2,
@@ -392,6 +398,57 @@ describe('oapp-read/config', () => {
             })
         })
 
+        describe('configureReadLibraries address equality idempotency', () => {
+            it('should skip when already pinned even if config uses lowercase addresses', async () => {
+                const ethReadLibrary = await getLibraryAddress(ethReadLib_Opt2)
+                const avaxReadLibrary = await getLibraryAddress(avaxReadLib_Opt2)
+                const [registerErrors] = await signAndSend([
+                    await ethEndpointV2Sdk.registerLibrary(ethReadLibrary),
+                    await avaxEndpointV2Sdk.registerLibrary(avaxReadLibrary),
+                ])
+                expect(registerErrors).toEqual([])
+
+                const channelId = ChannelId.READ_CHANNEL_1.valueOf()
+                const [setErrors] = await signAndSend([
+                    await ethEndpointV2Sdk.setSendLibrary(ethPoint.address, channelId, ethReadLibrary),
+                    await ethEndpointV2Sdk.setReceiveLibrary(ethPoint.address, channelId, ethReadLibrary, BigInt(0)),
+                    await avaxEndpointV2Sdk.setSendLibrary(avaxPoint.address, channelId, avaxReadLibrary),
+                    await avaxEndpointV2Sdk.setReceiveLibrary(avaxPoint.address, channelId, avaxReadLibrary, BigInt(0)),
+                ])
+                expect(setErrors).toEqual([])
+
+                const graph: OAppReadOmniGraph = {
+                    contracts: [
+                        {
+                            point: ethPoint,
+                            config: {
+                                readChannelConfigs: [
+                                    {
+                                        channelId: ChannelId.READ_CHANNEL_1,
+                                        readLibrary: ethReadLibrary.toLowerCase(),
+                                    },
+                                ],
+                            },
+                        },
+                        {
+                            point: avaxPoint,
+                            config: {
+                                readChannelConfigs: [
+                                    {
+                                        channelId: ChannelId.READ_CHANNEL_1,
+                                        readLibrary: avaxReadLibrary.toLowerCase(),
+                                    },
+                                ],
+                            },
+                        },
+                    ],
+                    connections: [],
+                }
+
+                expect(await configureReadLibraries(graph, oappSdkFactory)).toEqual([])
+            })
+        })
+
         describe('configureConfig configureReadConfig', () => {
             beforeEach(async () => {
                 // Before we configure the OApp, we'll set some peers

tests/ua-devtools-evm-hardhat-test/test/oapp/config.test.ts

@@ -11,6 +11,8 @@ import {
     configureOApp,
     configureOAppDelegates,
     configureCallerBpsCap,
+    configureReceiveLibraries,
+    configureSendLibraries,
     IOApp,
     OAppFactory,
     OAppOmniGraph,
@@ -416,6 +418,40 @@ describe('oapp/config', () => {
             })
         })
 
+        describe('configureSendLibraries address equality idempotency', () => {
+            it('should skip when already pinned even if config uses lowercase addresses', async () => {
+                const ethSendLibrary = await getLibraryAddress(ethSendUln2_Opt2)
+                const avaxSendLibrary = await getLibraryAddress(avaxSendUln2_Opt2)
+                const [registerErrors] = await signAndSend([
+                    await ethEndpointV2Sdk.registerLibrary(ethSendLibrary),
+                    await avaxEndpointV2Sdk.registerLibrary(avaxSendLibrary),
+                ])
+                expect(registerErrors).toEqual([])
+
+                const [setErrors] = await signAndSend([
+                    await ethEndpointV2Sdk.setSendLibrary(ethPoint.address, avaxPoint.eid, ethSendLibrary),
+                    await avaxEndpointV2Sdk.setSendLibrary(avaxPoint.address, ethPoint.eid, avaxSendLibrary),
+                ])
+                expect(setErrors).toEqual([])
+
+                const graph: OAppOmniGraph = {
+                    contracts: [{ point: ethPoint }, { point: avaxPoint }],
+                    connections: [
+                        {
+                            vector: { from: ethPoint, to: avaxPoint },
+                            config: { sendLibrary: ethSendLibrary.toLowerCase() },
+                        },
+                        {
+                            vector: { from: avaxPoint, to: ethPoint },
+                            config: { sendLibrary: avaxSendLibrary.toLowerCase() },
+                        },
+                    ],
+                }
+
+                expect(await configureSendLibraries(graph, oappSdkFactory)).toEqual([])
+            })
+        })
+
         describe('configureReceiveLibraries lock defaults', () => {
             let ethReceiveLibrary: string, avaxReceiveLibrary: string, graph: OAppOmniGraph
             beforeEach(async () => {
@@ -576,6 +612,60 @@ describe('oapp/config', () => {
             })
         })
 
+        describe('configureReceiveLibraries address equality idempotency', () => {
+            it('should skip when already pinned even if config uses lowercase addresses', async () => {
+                const ethReceiveLibrary = await getLibraryAddress(ethReceiveUln2_Opt2)
+                const avaxReceiveLibrary = await getLibraryAddress(avaxReceiveUln2_Opt2)
+                const [registerErrors] = await signAndSend([
+                    await ethEndpointV2Sdk.registerLibrary(ethReceiveLibrary),
+                    await avaxEndpointV2Sdk.registerLibrary(avaxReceiveLibrary),
+                ])
+                expect(registerErrors).toEqual([])
+
+                const [setErrors] = await signAndSend([
+                    await ethEndpointV2Sdk.setReceiveLibrary(
+                        ethPoint.address,
+                        avaxPoint.eid,
+                        ethReceiveLibrary,
+                        BigInt(0)
+                    ),
+                    await avaxEndpointV2Sdk.setReceiveLibrary(
+                        avaxPoint.address,
+                        ethPoint.eid,
+                        avaxReceiveLibrary,
+                        BigInt(0)
+                    ),
+                ])
+                expect(setErrors).toEqual([])
+
+                const graph: OAppOmniGraph = {
+                    contracts: [{ point: ethPoint }, { point: avaxPoint }],
+                    connections: [
+                        {
+                            vector: { from: ethPoint, to: avaxPoint },
+                            config: {
+                                receiveLibraryConfig: {
+                                    receiveLibrary: ethReceiveLibrary.toLowerCase(),
+                                    gracePeriod: BigInt(0),
+                                },
+                            },
+                        },
+                        {
+                            vector: { from: avaxPoint, to: ethPoint },
+                            config: {
+                                receiveLibraryConfig: {
+                                    receiveLibrary: avaxReceiveLibrary.toLowerCase(),
+                                    gracePeriod: BigInt(0),
+                                },
+                            },
+                        },
+                    ],
+                }
+
+                expect(await configureReceiveLibraries(graph, oappSdkFactory)).toEqual([])
+            })
+        })
+
         describe('configureReceiveLibraryTimeouts', () => {
             let ethDefaultReceiveLibrary: string,
                 ethReceiveLibrary_Opt2: string,