🚧 adding getOAppConfig

packages/protocol-utils-evm/src/endpoint/sdk.ts

@@ -10,6 +10,14 @@ export class Endpoint implements IEndpoint {
         return ignoreZero(await this.contract.contract.defaultReceiveLibrary(eid))
     }
 
+    async getSendLibrary(sender: Address, dstEid: EndpointId): Promise<string | undefined> {
+        return ignoreZero(await this.contract.contract.getSendLibrary(sender, dstEid))
+    }
+
+    async getReceiveLibrary(receiver: Address, srcEid: EndpointId): Promise<[string | undefined, boolean]> {
+        return await this.contract.contract.getReceiveLibrary(receiver, srcEid)
+    }
+
     async setDefaultReceiveLibrary(
         eid: EndpointId,
         lib: string | null | undefined,

packages/ua-utils-evm-hardhat-test/test/task/getDefaultConfig.test.ts

@@ -11,14 +11,12 @@ describe('task: getDefaultConfig', () => {
         const networks = Object.keys(hre.userConfig.networks ?? {})
         const getDefaultConfigTask = await hre.run('getDefaultConfig', { networks: networks.toString() })
         const contractFactory = createContractFactory()
-
         for (const localNetwork of networks) {
             const localEid = getEidForNetworkName(localNetwork)
-
             for (const remoteNetwork of networks) {
                 if (localNetwork === remoteNetwork) continue
-
                 const defaultConfig = getDefaultConfigTask[localNetwork][remoteNetwork]
+
                 const sendUln302 = await contractFactory({ contractName: 'SendUln302', eid: localEid })
                 const receiveUln302 = await contractFactory({ contractName: 'ReceiveUln302', eid: localEid })
 

packages/ua-utils-evm-hardhat-test/test/task/getOAppConfig.test.ts

@@ -0,0 +1,61 @@
+import { describe } from 'mocha'
+import { defaultExecutorConfig, defaultUlnConfig, setupDefaultEndpoint } from '../__utils__/endpoint'
+import { createContractFactory, getEidForNetworkName } from '@layerzerolabs/utils-evm-hardhat'
+import hre from 'hardhat'
+import { expect, assert } from 'chai'
+import { AddressZero } from '@ethersproject/constants'
+
+describe('task: getOAppConfig', () => {
+    beforeEach(async () => {
+        await setupDefaultEndpoint()
+    })
+
+    it('should return app default configurations when addresses are not oapps', async () => {
+        const networks = Object.keys(hre.userConfig.networks ?? {})
+        const addresses = new Array(networks.length).fill(AddressZero).toString()
+        const getDefaultConfigTask = await hre.run('getOAppConfig', {
+            networks: networks.toString(),
+            addresses: addresses.toString(),
+        })
+        const contractFactory = createContractFactory()
+
+        for (const localNetwork of networks) {
+            const localEid = getEidForNetworkName(localNetwork)
+            for (const remoteNetwork of networks) {
+                if (localNetwork === remoteNetwork) continue
+
+                const defaultConfig = getDefaultConfigTask[localNetwork][remoteNetwork]
+                const sendUln302 = await contractFactory({ contractName: 'SendUln302', eid: localEid })
+                const receiveUln302 = await contractFactory({ contractName: 'ReceiveUln302', eid: localEid })
+
+                // verify defaultSendLibrary & defaultReceiveLibrary
+                expect(defaultConfig.defaultSendLibrary).to.eql(sendUln302.contract.address)
+                expect(defaultConfig.defaultReceiveLibrary).to.eql(receiveUln302.contract.address)
+
+                // verify sendUln
+                expect(defaultConfig.sendExecutorConfig.maxMessageSize).to.eql(defaultExecutorConfig.maxMessageSize)
+                expect(defaultConfig.sendExecutorConfig.executor).to.eql(defaultExecutorConfig.executor)
+                expect(defaultConfig.sendUlnConfig.confirmations.toString()).to.eql(
+                    defaultUlnConfig.confirmations.toString()
+                )
+                expect(defaultConfig.sendUlnConfig.optionalDVNThreshold).to.eql(defaultUlnConfig.optionalDVNThreshold)
+                expect(defaultConfig.sendUlnConfig.requiredDVNs).to.eql(defaultUlnConfig.requiredDVNs)
+                expect(defaultConfig.sendUlnConfig.optionalDVNs).to.eql(defaultUlnConfig.optionalDVNs)
+
+                // verify receiveUln
+                expect(defaultConfig.receiveUlnConfig.confirmations.toString()).to.eql(
+                    defaultUlnConfig.confirmations.toString()
+                )
+                expect(defaultConfig.receiveUlnConfig.optionalDVNThreshold).to.eql(
+                    defaultUlnConfig.optionalDVNThreshold
+                )
+                expect(defaultConfig.receiveUlnConfig.requiredDVNs).to.eql(defaultUlnConfig.requiredDVNs)
+                expect(defaultConfig.receiveUlnConfig.optionalDVNs).to.eql(defaultUlnConfig.optionalDVNs)
+            }
+        }
+    })
+
+    // TODO - app specific configuration testing
+    // it('should return app specific configurations', async () => {
+    // })
+})

packages/ua-utils-evm-hardhat/src/tasks/getDefaultConfig.ts

@@ -1,48 +1,27 @@
 import { ActionType } from 'hardhat/types'
 import { task } from 'hardhat/config'
-import { createConnectedContractFactory, getEidForNetworkName } from '@layerzerolabs/utils-evm-hardhat'
-import { Endpoint, Uln302 } from '@layerzerolabs/protocol-utils-evm'
+import { getReceiveConfig, getSendConfig, printConsoleTable } from '@/utils/taskHelpers'
 
 interface TaskArgs {
     networks: string
 }
 
 export const getDefaultConfig: ActionType<TaskArgs> = async (taskArgs) => {
     const networks = new Set(taskArgs.networks.split(','))
-    const contractFactory = createConnectedContractFactory()
     const configs: Record<string, Record<string, unknown>> = {}
-
     for (const localNetworkName of networks) {
-        const localEid = getEidForNetworkName(localNetworkName)
-        const localEndpointSDK = new Endpoint(await contractFactory({ eid: localEid, contractName: 'EndpointV2' }))
-
         configs[localNetworkName] = {}
-
         for (const remoteNetworkName of networks) {
             if (remoteNetworkName === localNetworkName) continue
-
-            const remoteEid = getEidForNetworkName(remoteNetworkName)
-
-            // First we get the SDK for the local send library
-            const defaultSendLibrary = await localEndpointSDK.defaultSendLibrary(remoteEid)
-            const localSendUlnSDK = new Uln302(
-                await contractFactory({ eid: localEid, contractName: 'SendUln302', address: defaultSendLibrary })
-            )
-
-            // Then we get the SDK for the local receive library
-            const defaultReceiveLibrary = await localEndpointSDK.defaultReceiveLibrary(remoteEid)
-            const localReceiveUlnSDK = new Uln302(
-                await contractFactory({ eid: localEid, contractName: 'ReceiveUln302', address: defaultReceiveLibrary })
+            const [sendLibrary, sendUlnConfig, sendExecutorConfig] = await getSendConfig(
+                localNetworkName,
+                remoteNetworkName
             )
-
-            // Now let's get the configs
-            const sendUlnConfig = await localSendUlnSDK.getUlnConfig(remoteEid)
-            const sendExecutorConfig = await localSendUlnSDK.getExecutorConfig(remoteEid)
-            const receiveUlnConfig = await localReceiveUlnSDK.getUlnConfig(remoteEid)
+            const [receiveLibrary, receiveUlnConfig] = await getReceiveConfig(localNetworkName, remoteNetworkName)
 
             configs[localNetworkName][remoteNetworkName] = {
-                defaultSendLibrary: defaultSendLibrary,
-                defaultReceiveLibrary: defaultReceiveLibrary,
+                defaultSendLibrary: sendLibrary,
+                defaultReceiveLibrary: receiveLibrary,
                 sendUlnConfig,
                 sendExecutorConfig,
                 receiveUlnConfig,
@@ -51,8 +30,8 @@ export const getDefaultConfig: ActionType<TaskArgs> = async (taskArgs) => {
             printConsoleTable(
                 localNetworkName,
                 remoteNetworkName,
-                defaultSendLibrary,
-                defaultReceiveLibrary,
+                sendLibrary,
+                receiveLibrary,
                 sendUlnConfig,
                 sendExecutorConfig,
                 receiveUlnConfig
@@ -68,51 +47,3 @@ task(
 )
     .addParam('networks', 'comma separated list of networks')
     .setAction(getDefaultConfig)
-
-const printConsoleTable = (
-    localNetworkName: string,
-    remoteNetworkName: string,
-    defaultSendLibrary: string,
-    defaultReceiveLibrary: string,
-    sendUlnConfig: Record<any, any>,
-    sendExecutorConfig: Record<any, any>,
-    receiveUlnConfig: Record<any, any>
-) => {
-    const defaultLibraryTable = {
-        network: localNetworkName,
-        remoteNetwork: remoteNetworkName,
-        defaultSendLibrary: defaultSendLibrary,
-        defaultReceiveLibrary: defaultReceiveLibrary,
-    }
-
-    const sendUln = {
-        maxMessageSize: sendExecutorConfig.maxMessageSize,
-        executor: sendExecutorConfig.executor,
-        confirmations: parseInt(sendUlnConfig.confirmations.toString()),
-        optionalDVNThreshold: sendUlnConfig.optionalDVNThreshold,
-        requiredDVNs: sendUlnConfig.requiredDVNs,
-        optionalDVNs: sendUlnConfig.optionalDVNs,
-    }
-
-    const receiveUln = {
-        confirmations: parseInt(receiveUlnConfig.confirmations.toString()),
-        optionalDVNThreshold: receiveUlnConfig.optionalDVNThreshold,
-        requiredDVNs: receiveUlnConfig.requiredDVNs,
-        optionalDVNs: receiveUlnConfig.optionalDVNs,
-    }
-
-    const sendUlnConfigTable = {
-        sendUln: sendUln,
-    }
-
-    const receiveUlnConfigTable = {
-        receiveUln: receiveUln,
-    }
-
-    console.log(`************************************************`)
-    console.log(`${localNetworkName.toUpperCase()}`)
-    console.log(`************************************************`)
-    console.table(defaultLibraryTable)
-    console.table(sendUlnConfigTable)
-    console.table(receiveUlnConfigTable)
-}

packages/ua-utils-evm-hardhat/src/tasks/getOAppConfig.ts

@@ -0,0 +1,60 @@
+import { ActionType } from 'hardhat/types'
+import { task } from 'hardhat/config'
+import { getReceiveConfig, getSendConfig, printConsoleTable } from '@/utils/taskHelpers'
+import assert from 'assert'
+
+interface TaskArgs {
+    networks: string
+    addresses: string
+}
+
+export const getOAppConfig: ActionType<TaskArgs> = async (taskArgs, ...args) => {
+    const networks = taskArgs.networks.split(',')
+    const addresses = taskArgs.addresses.split(',')
+    assert(networks.length === addresses.length, 'Passed in networks must match length of passed in addresses.')
+    const configs: Record<string, Record<string, unknown>> = {}
+
+    for (const [index, localNetworkName] of networks.entries()) {
+        configs[localNetworkName] = {}
+        for (const remoteNetworkName of networks) {
+            if (remoteNetworkName === localNetworkName) continue
+            const [sendLibrary, sendUlnConfig, sendExecutorConfig] = await getSendConfig(
+                localNetworkName,
+                remoteNetworkName,
+                addresses[index]
+            )
+            const [receiveLibrary, receiveUlnConfig] = await getReceiveConfig(
+                localNetworkName,
+                remoteNetworkName,
+                addresses[index]
+            )
+
+            configs[localNetworkName][remoteNetworkName] = {
+                defaultSendLibrary: sendLibrary,
+                defaultReceiveLibrary: receiveLibrary,
+                sendUlnConfig,
+                sendExecutorConfig,
+                receiveUlnConfig,
+            }
+
+            printConsoleTable(
+                localNetworkName,
+                remoteNetworkName,
+                sendLibrary,
+                receiveLibrary,
+                sendUlnConfig,
+                sendExecutorConfig,
+                receiveUlnConfig
+            )
+        }
+    }
+    return configs
+}
+
+task(
+    'getOAppConfig',
+    'outputs the default Send and Receive Messaging Library versions and the default application config'
+)
+    .addParam('networks', 'comma separated list of networks')
+    .addParam('addresses', 'comma separated list of addresses')
+    .setAction(getOAppConfig)

packages/ua-utils-evm-hardhat/src/tasks/index.ts

@@ -1 +1,2 @@
 import './getDefaultConfig'
+import './getOAppConfig'