chore: Add IOmniSDK base interface for all SDKs

LayerZero-Labs · Dec 11, 2023 · a0f5f36 · a0f5f36
1 parent 9e4cb71
commit a0f5f36
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 6 deletions.
diff --git a/packages/protocol-utils/src/endpoint/types.ts b/packages/protocol-utils/src/endpoint/types.ts
@@ -1,7 +1,7 @@
-import type { Address, OmniGraph, OmniPointBasedFactory, OmniTransaction } from '@layerzerolabs/utils'
+import type { Address, OmniGraph, OmniPointBasedFactory, OmniTransaction, IOmniSDK } from '@layerzerolabs/utils'
 import type { EndpointId } from '@layerzerolabs/lz-definitions'
 
-export interface IEndpoint {
+export interface IEndpoint extends IOmniSDK {
     getDefaultReceiveLibrary(eid: EndpointId): Promise<Address | undefined>
     setDefaultReceiveLibrary(
         eid: EndpointId,

diff --git a/packages/protocol-utils/src/uln302/types.ts b/packages/protocol-utils/src/uln302/types.ts
@@ -1,7 +1,7 @@
-import type { Address, OmniGraph, OmniPointBasedFactory, OmniTransaction } from '@layerzerolabs/utils'
+import type { Address, OmniGraph, OmniPointBasedFactory, OmniTransaction, IOmniSDK } from '@layerzerolabs/utils'
 import type { EndpointId } from '@layerzerolabs/lz-definitions'
 
-export interface IUln302 {
+export interface IUln302 extends IOmniSDK {
     getUlnConfig(eid: EndpointId, address?: Address | null | undefined): Promise<Uln302UlnConfig>
     getExecutorConfig(eid: EndpointId, address?: Address | null | undefined): Promise<Uln302ExecutorConfig>
     setDefaultExecutorConfig(eid: EndpointId, config: Uln302ExecutorConfig): Promise<OmniTransaction>

diff --git a/packages/ua-utils/src/oapp/types.ts b/packages/ua-utils/src/oapp/types.ts
@@ -1,10 +1,10 @@
 import type { EndpointId } from '@layerzerolabs/lz-definitions'
 import type { IEndpoint } from '@layerzerolabs/protocol-utils'
-import type { Address, OmniGraph, OmniTransaction } from '@layerzerolabs/utils'
+import type { Address, OmniGraph, OmniTransaction, IOmniSDK } from '@layerzerolabs/utils'
 import type { Bytes32 } from '@layerzerolabs/utils'
 import type { OmniPointBasedFactory } from '@layerzerolabs/utils'
 
-export interface IOApp {
+export interface IOApp extends IOmniSDK {
     getEndpoint(): Promise<IEndpoint>
     getPeer(eid: EndpointId): Promise<Bytes32 | undefined>
     hasPeer(eid: EndpointId, address: Bytes32 | Address | null | undefined): Promise<boolean>

diff --git a/packages/utils/src/omnigraph/types.ts b/packages/utils/src/omnigraph/types.ts
@@ -68,3 +68,10 @@ export type OmniPointBasedFactory<TValue> = (point: OmniPoint) => TValue | Promi
  * Helper type that adds eid property to an underlying type
  */
 export type WithEid<TValue> = TValue & { eid: EndpointId }
+
+/**
+ * Base interface for all SDKs
+ */
+export interface IOmniSDK {
+    point: OmniPoint
+}