🪚 OmniGraph™ Fix types & README (#64)

LayerZero-Labs · Dec 6, 2023 · 8c641a8 · 8c641a8
1 parent 2c06f48
commit 8c641a8
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 12 deletions.
diff --git a/packages/ua-utils-evm-hardhat-test/README.md b/packages/ua-utils-evm-hardhat-test/README.md
@@ -4,10 +4,10 @@
   </a>
 </p>
 
-<h1 align="center">@layerzerolabs/utils-evm-hardhat-test</h1>
+<h1 align="center">@layerzerolabs/ua-utils-evm-hardhat-test</h1>
 
 ## Development
 
-This package provides integration tests for `@layerzerolabs/utils-evm-hardhat` executed within a containerized setup. These tests are dependent on two networks that are bootstrapped in the root `docker-compose.yaml` and will only run when executed within that environment.
+This package provides integration tests for `@layerzerolabs/ua-utils-evm-hardhat` executed within a containerized setup. These tests are dependent on two networks that are bootstrapped in the root `docker-compose.yaml` and will only run when executed within that environment.
 
 Please see the root [`README.md`](../../README.md) for more information.
diff --git a/packages/utils-evm-hardhat/src/omnigraph/builder.ts b/packages/utils-evm-hardhat/src/omnigraph/builder.ts
@@ -1,5 +1,5 @@
 import type { OmniEdge, OmniNode } from '@layerzerolabs/utils'
-import type { OmniContractFactory, OmniGraphHardhat } from './types'
+import type { OmniContractFactoryHardhat, OmniGraphHardhat } from './types'
 import { OmniGraphBuilder } from '@layerzerolabs/utils'
 import { omniContractToPoint } from '@layerzerolabs/utils-evm'
 import assert from 'assert'
@@ -12,7 +12,7 @@ import assert from 'assert'
 export class OmniGraphBuilderHardhat {
     static async fromConfig<TNodeConfig, TEdgeConfig>(
         graph: OmniGraphHardhat<TNodeConfig, TEdgeConfig>,
-        contractFactory: OmniContractFactory
+        contractFactory: OmniContractFactoryHardhat
     ): Promise<OmniGraphBuilder<TNodeConfig, TEdgeConfig>> {
         const builder = new OmniGraphBuilder<TNodeConfig, TEdgeConfig>()
 

diff --git a/packages/utils-evm-hardhat/src/omnigraph/contracts.ts b/packages/utils-evm-hardhat/src/omnigraph/contracts.ts
@@ -1,13 +1,13 @@
 import pMemoize from 'p-memoize'
 import { ProviderFactory, connectOmniContract } from '@layerzerolabs/utils-evm'
 import { createContractFactory } from '@/omnigraph/coordinates'
-import type { OmniContractFactory } from '@/omnigraph/types'
+import type { OmniContractFactoryHardhat } from '@/omnigraph/types'
 import { createProviderFactory } from '@/provider'
 
 export const createConnectedContractFactory = (
-    contractFactory: OmniContractFactory = createContractFactory(),
+    contractFactory: OmniContractFactoryHardhat = createContractFactory(),
     providerFactory: ProviderFactory = createProviderFactory()
-): OmniContractFactory =>
+): OmniContractFactoryHardhat =>
     pMemoize(async (point) => {
         const contract = await contractFactory(point)
         const provider = await providerFactory(point.eid)

diff --git a/packages/utils-evm-hardhat/src/omnigraph/coordinates.ts b/packages/utils-evm-hardhat/src/omnigraph/coordinates.ts
@@ -6,7 +6,7 @@ import pMemoize from 'p-memoize'
 import { OmniContract } from '@layerzerolabs/utils-evm'
 import { Contract } from '@ethersproject/contracts'
 import assert from 'assert'
-import { OmniContractFactory } from './types'
+import { OmniContractFactoryHardhat } from './types'
 import { createNetworkEnvironmentFactory, getDefaultRuntimeEnvironment } from '@/runtime'
 import { assertHardhatDeploy } from '@/internal/assertions'
 
@@ -25,7 +25,7 @@ export const omniDeploymentToContract = ({ eid, deployment }): OmniContract => (
 export const createContractFactory = (
     hre: HardhatRuntimeEnvironment = getDefaultRuntimeEnvironment(),
     environmentFactory = createNetworkEnvironmentFactory(hre)
-): OmniContractFactory => {
+): OmniContractFactoryHardhat => {
     return pMemoize(async ({ eid, address, contractName }) => {
         const env = await environmentFactory(eid)
         assertHardhatDeploy(env)

diff --git a/packages/utils-evm-hardhat/src/omnigraph/types.ts b/packages/utils-evm-hardhat/src/omnigraph/types.ts
@@ -24,4 +24,4 @@ export interface OmniGraphHardhat<TNodeConfig = unknown, TEdgeConfig = unknown>
     connections: OmniEdgeHardhat<TEdgeConfig>[]
 }
 
-export type OmniContractFactory = (point: OmniPointHardhat) => OmniContract | Promise<OmniContract>
+export type OmniContractFactoryHardhat = (point: OmniPointHardhat) => OmniContract | Promise<OmniContract>
diff --git a/packages/utils-evm/src/omnigraph/types.ts b/packages/utils-evm/src/omnigraph/types.ts
@@ -1,7 +1,10 @@
-import { Contract } from '@ethersproject/contracts'
-import { EndpointId } from '@layerzerolabs/lz-definitions'
+import type { Contract } from '@ethersproject/contracts'
+import type { EndpointId } from '@layerzerolabs/lz-definitions'
+import type { OmniPoint } from '@layerzerolabs/utils'
 
 export interface OmniContract<TContract extends Contract = Contract> {
     eid: EndpointId
     contract: TContract
 }
+
+export type OmniContractFactory = (point: OmniPoint) => OmniContract | Promise<OmniContract>