@layerzerolabs/lz-iotal1-sdk-v2 3.0.143

package/src/sdk.ts

@@ -0,0 +1,183 @@
+import { IotaClient } from '@iota/iota-sdk/client'
+
+import { Chain, Stage } from '@layerzerolabs/lz-definitions'
+
+import { ModuleManager } from './module-manager'
+import {
+    BlockedMessageLib,
+    BlockedMessageLibPtbBuilder,
+    Call,
+    Counter,
+    DVN,
+    DVNFeeLib,
+    DvnLayerZero,
+    DvnPtbBuilder,
+    Endpoint,
+    EndpointPtbBuilder,
+    Executor,
+    ExecutorFeeLib,
+    ExecutorLayerZero,
+    ExecutorPtbBuilder,
+    LayerZeroViews,
+    OApp,
+    PackageWhitelistValidator,
+    PriceFeed,
+    PtbBuilder,
+    SimpleMessageLib,
+    SimpleMessageLibPtbBuilder,
+    Treasury,
+    Uln302,
+    Uln302PtbBuilder,
+    Utils,
+    WorkerRegistry,
+    Zro,
+} from './modules'
+import { ResourceManager } from './resource'
+import { ModuleOptions, ObjectOptions, PackageOptions, SdkOptions } from './types'
+
+export * from './generated/addresses'
+
+/**
+ * The SDK class provides methods to interact with LayerZero on Iota.
+ * Uses ModuleManager for centralized module management.
+ */
+export class SDK {
+    public chain: Chain
+    public stage: Stage
+    public client: IotaClient
+    public packages: PackageOptions
+    public objects: ObjectOptions
+    private moduleManager: ModuleManager
+
+    /**
+     * Creates an instance of the SDK.
+     */
+    constructor(options: SdkOptions) {
+        this.chain = options.chain ?? Chain.IOTAL1
+        this.stage = options.stage ?? Stage.MAINNET
+        this.client = options.client
+
+        this.packages = ResourceManager.mergeDefaultPackageConfig(this.stage, options.packages)
+        this.objects = ResourceManager.mergeDefaultObjectConfig(this.stage, options.objects)
+
+        // Initialize all standard modules
+        this.moduleManager = new ModuleManager(this.packages, this.objects)
+        this.moduleManager.initializeCoreModules(this.packages, this.objects, this.client)
+    }
+
+    // === Core Module Getters (from ModuleManager) ===
+
+    getEndpoint(): Endpoint {
+        return this.moduleManager.getEndpoint()
+    }
+
+    getSimpleMessageLib(): SimpleMessageLib {
+        return this.moduleManager.getSimpleMessageLib()
+    }
+
+    getBlockedMessageLib(): BlockedMessageLib {
+        return this.moduleManager.getBlockedMessageLib()
+    }
+
+    getUln302(): Uln302 {
+        return this.moduleManager.getUln302()
+    }
+
+    getUtils(): Utils {
+        return this.moduleManager.getUtils()
+    }
+
+    getZro(): Zro {
+        return this.moduleManager.getZro()
+    }
+
+    getCall(): Call {
+        return this.moduleManager.getCall()
+    }
+
+    getPtbBuilder(): PtbBuilder {
+        return this.moduleManager.getPtbBuilder()
+    }
+
+    getTreasury(): Treasury {
+        return this.moduleManager.getTreasury()
+    }
+
+    getLayerZeroViews(): LayerZeroViews {
+        return this.moduleManager.getLayerZeroViews()
+    }
+
+    getOApp(callCapId: string, options?: ModuleOptions): OApp {
+        return this.moduleManager.getOApp(this.client, callCapId, options)
+    }
+
+    // === Non-Core Module Getters (created on-demand with caching) ===
+
+    getCounter(options?: ModuleOptions): Counter {
+        return this.moduleManager.getCounter(this.client, options)
+    }
+
+    getExecutor(options?: ModuleOptions): Executor {
+        return this.moduleManager.getExecutor(this.client, options)
+    }
+
+    getDvn(options?: ModuleOptions): DVN {
+        return this.moduleManager.getDvn(this.client, options)
+    }
+
+    getDvnFeeLib(options?: ModuleOptions): DVNFeeLib {
+        return this.moduleManager.getDvnFeeLib(this.client, options)
+    }
+
+    getExecutorFeeLib(options?: ModuleOptions): ExecutorFeeLib {
+        return this.moduleManager.getExecutorFeeLib(this.client, options)
+    }
+
+    getPriceFeed(options?: ModuleOptions): PriceFeed {
+        return this.moduleManager.getPriceFeed(this.client, options)
+    }
+
+    getDvnLayerZero(options?: ModuleOptions): DvnLayerZero {
+        return this.moduleManager.getDvnLayerZero(this.client, options)
+    }
+
+    getExecutorLayerZero(options?: ModuleOptions): ExecutorLayerZero {
+        return this.moduleManager.getExecutorLayerZero(this.client, options)
+    }
+
+    getDvnPtbBuilder(options?: ModuleOptions): DvnPtbBuilder {
+        return this.moduleManager.getDvnPtbBuilder(this.client, options)
+    }
+
+    getExecutorPtbBuilder(options?: ModuleOptions): ExecutorPtbBuilder {
+        return this.moduleManager.getExecutorPtbBuilder(this.client, options)
+    }
+
+    getPackageWhitelistValidator(options?: ModuleOptions): PackageWhitelistValidator {
+        return this.moduleManager.getPackageWhitelistValidator(this.client, options)
+    }
+
+    getUln302PtbBuilder(options?: ModuleOptions): Uln302PtbBuilder {
+        return this.moduleManager.getUln302PtbBuilder(this.client, options)
+    }
+
+    getEndpointPtbBuilder(options?: ModuleOptions): EndpointPtbBuilder {
+        return this.moduleManager.getEndpointPtbBuilder(this.client, options)
+    }
+
+    getSimpleMessageLibPtbBuilder(options?: ModuleOptions): SimpleMessageLibPtbBuilder {
+        return this.moduleManager.getSimpleMessageLibPtbBuilder(this.client, options)
+    }
+
+    getBlockedMessageLibPtbBuilder(options?: ModuleOptions): BlockedMessageLibPtbBuilder {
+        return this.moduleManager.getBlockedMessageLibPtbBuilder(this.client, options)
+    }
+
+    getWorkerRegistry(options?: ModuleOptions): WorkerRegistry {
+        return this.moduleManager.getWorkerRegistry(this.client, options)
+    }
+
+    getOrCreateModule<T>(moduleName: string, options: ModuleOptions | undefined, factory: () => T): T {
+        return this.moduleManager.getOrCreateModule(moduleName, options, factory)
+    }
+}

package/src/types/dvn.ts

@@ -0,0 +1,20 @@
+// DVN configuration interfaces
+export interface DvnDstConfig {
+    gas: bigint
+    multiplierBps: number
+    floorMarginUsd: bigint
+}
+
+// DVN event interfaces
+export interface VerifierFeePaid {
+    dvn: string
+    fee: bigint
+}
+
+export interface SetDstConfigEvent {
+    dvn: string
+    dstEid: number
+    gas: bigint
+    multiplierBps: number
+    floorMarginUsd: bigint
+}

package/src/types/endpoint.ts

@@ -0,0 +1,16 @@
+export interface MessagingFee {
+    nativeFee: bigint
+    zroFee: bigint
+}
+
+export interface Timeout {
+    expiry: bigint
+    fallbackLib: string
+}
+/**
+ * LayerZero protocol version constants
+ */
+
+export const OAppInfoVersion = { VERSION_1: 1, VERSION_2: 2 } as const
+export const LzReceiveVersion = { VERSION_1: 1 } as const
+export const LzComposeVersion = { VERSION_1: 1 } as const

package/src/types/errors.ts

@@ -0,0 +1,10 @@
+// SDK Error classes
+export class MoveAbortError extends Error {
+    readonly abortCode: number
+    constructor(abortCode: number, rawMsg: string) {
+        super(`Move abort with code: ${abortCode}. Raw error message: ${rawMsg}`)
+        this.abortCode = abortCode
+    }
+}
+
+export class UnclassifiedError extends Error {}

package/src/types/executor.ts

@@ -0,0 +1,23 @@
+// Type definitions for Executor configurations
+export interface DstConfig {
+    lzReceiveBaseGas: bigint
+    lzComposeBaseGas: bigint
+    multiplierBps: number
+    floorMarginUsd: bigint
+    nativeCap: bigint
+}
+
+export interface NativeDropParams {
+    receiver: string
+    amount: bigint
+}
+
+// refer to packages/layerzero-v2/iota/contracts/workers/executors/executor-fee-lib/sources/types/executor_option.move
+export const ExecutorOptionType = {
+    LZRECEIVE: 1,
+    NATIVE_DROP: 2,
+    LZCOMPOSE: 3,
+    ORDERED_EXECUTION: 4,
+} as const
+
+export const ALL_EXECUTOR_OPTION_TYPES = Object.values(ExecutorOptionType)

package/src/types/index.ts

@@ -0,0 +1,13 @@
+// Unified exports for all types
+export * from './options'
+export * from './modules'
+export * from './simulation'
+export * from './dvn'
+export * from './errors'
+export * from './executor'
+export * from './ptb-builder'
+export * from './price-feed'
+export * from './message-lib'
+export * from './move-types'
+export * from './layerzero-views'
+export * from './endpoint'

package/src/types/layerzero-views.ts

@@ -0,0 +1,59 @@
+// Endpoint execution states
+export const EndpointExecutionState = {
+    STATE_NOT_EXECUTABLE: 0,
+    STATE_VERIFIED_BUT_NOT_EXECUTABLE: 1,
+    STATE_EXECUTABLE: 2,
+    STATE_EXECUTED: 3,
+} as const
+
+// ULN verification states
+export const UlnVerificationState = {
+    STATE_VERIFYING: 0,
+    STATE_VERIFIABLE: 1,
+    STATE_VERIFIED: 2,
+    STATE_NOT_INITIALIZABLE: 3,
+} as const
+
+export type EndpointExecutionStateType = (typeof EndpointExecutionState)[keyof typeof EndpointExecutionState]
+export type UlnVerificationStateType = (typeof UlnVerificationState)[keyof typeof UlnVerificationState]
+
+import { TransactionArgument } from '@iota/iota-sdk/transactions'
+
+/**
+ * Parameters for checking message executability
+ */
+export interface ExecutableParams {
+    messagingChannel: string | TransactionArgument
+    srcEid: number | TransactionArgument
+    sender: Uint8Array | TransactionArgument
+    nonce: bigint | TransactionArgument
+}
+
+/**
+ * Parameters for checking message initializability
+ */
+export interface InitializableParams {
+    messagingChannel: string | TransactionArgument
+    srcEid: number | TransactionArgument
+    sender: Uint8Array | TransactionArgument
+}
+
+/**
+ * Parameters for checking message verifiability by endpoint
+ */
+export interface VerifiableParams {
+    messagingChannel: string | TransactionArgument
+    srcEid: number | TransactionArgument
+    sender: Uint8Array | TransactionArgument
+    nonce: bigint | TransactionArgument
+}
+
+/**
+ * Parameters for checking ULN verification state
+ */
+export interface UlnVerifiableParams {
+    verification: string | TransactionArgument
+    messagingChannel: string | TransactionArgument
+    packetHeaderBytes: Uint8Array | TransactionArgument
+    payloadHash: Uint8Array | TransactionArgument
+}

package/src/types/message-lib.ts

@@ -0,0 +1,38 @@
+export enum MessageLibType {
+    Send = 0,
+    Receive = 1,
+    SendAndReceive = 2,
+}
+
+// Configuration type constants
+export const CONFIG_TYPE = {
+    EXECUTOR: 1,
+    SEND_ULN: 2,
+    RECEIVE_ULN: 3,
+} as const
+
+// Type definitions for ULN configurations
+export interface ExecutorConfig {
+    maxMessageSize: number
+    executor: string
+}
+
+export interface UlnConfig {
+    confirmations: bigint
+    requiredDvns: string[]
+    optionalDvns: string[]
+    optionalDvnThreshold: number
+}
+
+export interface OAppUlnConfig {
+    useDefaultConfirmations: boolean
+    useDefaultRequiredDvns: boolean
+    useDefaultOptionalDvns: boolean
+    ulnConfig: UlnConfig
+}
+
+export interface VersionInfo {
+    major: bigint
+    minor: number
+    endpointVersion: number
+}

package/src/types/modules.ts

@@ -0,0 +1,36 @@
+/**
+ * Enum containing all available SDK modules
+ * Keys are capitalized, values match the actual module names used in the system
+ */
+export enum Modules {
+    // Core modules
+    Endpoint = 'endpoint',
+    SimpleMessageLib = 'simpleMessageLib',
+    BlockedMessageLib = 'blockedMessageLib',
+    Uln302 = 'uln302',
+    Utils = 'utils',
+    Zro = 'zro',
+    Call = 'call',
+    Treasury = 'treasury',
+    LayerZeroViews = 'layerZeroViews',
+    PtbBuilder = 'ptbBuilder',
+    EndpointPtbBuilder = 'endpointPtbBuilder',
+    SimpleMessageLibPtbBuilder = 'simpleMessageLibPtbBuilder',
+    BlockedMessageLibPtbBuilder = 'blockedMessageLibPtbBuilder',
+    Uln302PtbBuilder = 'uln302PtbBuilder',
+
+    // Non-core modules
+    Oapp = 'oapp',
+    Dvn = 'dvn',
+    DvnFeeLib = 'dvnFeeLib',
+    DvnLayerZero = 'dvnLayerZero',
+    Executor = 'executor',
+    ExecutorFeeLib = 'executorFeeLib',
+    ExecutorLayerZero = 'executorLayerZero',
+    PackageWhitelistValidator = 'packageWhitelistValidator',
+    PriceFeed = 'priceFeed',
+    Counter = 'counter',
+    DvnPtbBuilder = 'dvnPtbBuilder',
+    ExecutorPtbBuilder = 'executorPtbBuilder',
+    WorkerRegistry = 'workerRegistry',
+}

package/src/types/move-types.ts

@@ -0,0 +1,24 @@
+export enum LzTypeName {
+    EndpointQuoteParam = 'EndpointQuoteParam',
+    EndpointSendParam = 'EndpointSendParam',
+    MessageLibQuoteParam = 'MessageLibQuoteParam',
+    MessageLibSendParam = 'MessageLibSendParam',
+    MessageLibSetConfigParam = 'MessageLibSetConfigParam',
+    MessagingFee = 'MessagingFee',
+    MessagingReceipt = 'MessagingReceipt',
+    MoveCall = 'MoveCall',
+    EndpointLzReceiveParam = 'EndpointLzReceiveParam',
+    EndpointLzComposeParam = 'EndpointLzComposeParam',
+    CallVoid = 'CallVoid',
+    MessageLibSendResult = 'MessageLibSendResult',
+}
+
+export enum CallTypeName {
+    EndpointQuoteCall = 'EndpointQuoteCall',
+    EndpointSendCall = 'EndpointSendCall',
+    MessageLibSendCall = 'MessageLibSendCall',
+    MessageLibQuoteCall = 'MessageLibQuoteCall',
+    MessageLibSetConfigCall = 'MessageLibSetConfigCall',
+    EndpointLzReceiveCall = 'EndpointLzReceiveCall',
+    EndpointLzComposeCall = 'EndpointLzComposeCall',
+}

package/src/types/oapp.ts

@@ -0,0 +1,6 @@
+export interface OAppInfoV1 {
+    oapp_object: string
+    next_nonce_info: number[]
+    lz_receive_info: number[]
+    extra_info: number[]
+}