@layerzerolabs/lz-sui-sdk-v2 3.0.136 → 3.0.137-sui.0

package/src/modules/oapps/oapp.ts

@@ -64,17 +64,11 @@ export class OApp {
         this.objects = objects
     }
 
-    // setOAppInfo(oappInfo: OAppInfoV1): void {
-    //     this.oappInfo = oappInfo
-    // }
-
     // === Set Functions ===
 
     /**
      * Set enforced options for OApp messaging
      * @param tx - The transaction to add the move call to
-     * @param oapp - The OApp object ID or transaction argument
-     * @param adminCap - The admin capability object ID or transaction argument
      * @param eid - Endpoint ID or transaction argument
      * @param msgType - Message type or transaction argument
      * @param options - Enforced options as bytes or transaction argument
@@ -102,8 +96,6 @@ export class OApp {
     /**
      * Set peer OApp on another chain
      * @param tx - The transaction to add the move call to
-     * @param oapp - The OApp object ID or transaction argument
-     * @param adminCap - The admin capability object ID or transaction argument
      * @param eid - Peer endpoint ID or transaction argument
      * @param peer - Peer OApp address as bytes or transaction argument
      */
@@ -161,7 +153,6 @@ export class OApp {
     /**
      * Get OApp CallCap identifier
      * @param tx - The transaction to add the move call to
-     * @param oapp - The OApp object ID or transaction argument
      * @returns Transaction result containing the OApp CallCap identifier
      */
     async getOAppCapIdMoveCall(tx: Transaction): Promise<TransactionResult> {
@@ -174,7 +165,6 @@ export class OApp {
 
     /**
      * Get OApp CallCap identifier
-     * @param oapp - The OApp object ID (optional, uses configured oapp if not provided)
      * @returns Promise<string> - The OApp CallCap identifier
      */
     async getOAppCapId(): Promise<string> {
@@ -190,7 +180,6 @@ export class OApp {
     /**
      * Combine enforced options with extra options for message execution
      * @param tx - The transaction to add the move call to
-     * @param oapp - The OApp object ID or transaction argument
      * @param eid - Destination endpoint ID or transaction argument
      * @param msgType - Message type or transaction argument
      * @param extraOptions - Extra options to combine with enforced options or transaction argument
@@ -216,7 +205,6 @@ export class OApp {
 
     /**
      * Combine enforced options with extra options for message execution
-     * @param oapp - The OApp object ID
      * @param eid - Destination endpoint ID
      * @param msgType - Message type
      * @param extraOptions - Extra options to combine with enforced options
@@ -235,7 +223,6 @@ export class OApp {
     /**
      * Get enforced options for a specific destination and message type
      * @param tx - The transaction to add the move call to
-     * @param oapp - The OApp object ID or transaction argument
      * @param eid - Destination endpoint ID or transaction argument
      * @param msgType - Message type or transaction argument
      * @returns Transaction result containing enforced options
@@ -254,7 +241,6 @@ export class OApp {
 
     /**
      * Get enforced options for a specific destination and message type
-     * @param oapp - The OApp object ID
      * @param eid - Destination endpoint ID
      * @param msgType - Message type
      * @returns Promise<Uint8Array> - Enforced options as bytes
@@ -272,7 +258,6 @@ export class OApp {
     /**
      * Check if a peer is configured for a specific destination chain
      * @param tx - The transaction to add the move call to
-     * @param oapp - The OApp object ID or transaction argument
      * @param dstEid - Destination endpoint ID or transaction argument
      * @returns Transaction result containing boolean result
      */
@@ -286,7 +271,6 @@ export class OApp {
 
     /**
      * Check if a peer is configured for a specific destination chain
-     * @param oapp - The OApp object ID
      * @param dstEid - Destination endpoint ID
      * @returns Promise<boolean> - True if peer is configured, false otherwise
      */
@@ -303,7 +287,6 @@ export class OApp {
     /**
      * Get the configured peer address for a specific destination chain
      * @param tx - The transaction to add the move call to
-     * @param oapp - The OApp object ID or transaction argument
      * @param dstEid - Destination endpoint ID or transaction argument
      * @returns Transaction result containing peer address
      */
@@ -317,7 +300,6 @@ export class OApp {
 
     /**
      * Get the configured peer address for a specific destination chain
-     * @param oapp - The OApp object ID
      * @param dstEid - Destination endpoint ID
      * @returns Promise<Uint8Array> - Peer address as bytes32
      */
@@ -333,15 +315,24 @@ export class OApp {
         )
     }
 
+    /**
+     * Get OApp information V1 structure
+     * @param tx - The transaction to add the move call to
+     * @returns Transaction result containing the OApp information V1
+     */
     getOAppInfoV1MoveCall(tx: Transaction): TransactionResult {
         const endpoint = this.moduleManager.getEndpoint()
         const oappInfoRaw = endpoint.getOappInfoMoveCall(tx, this.oappCallCapId) // the new OAppInfo used to be named as lz_receive_info
         return tx.moveCall({
-            target: `${this.packageId}::oapp_info_v1::decode`,
+            target: this.#target('decode', 'oapp_info_v1'),
             arguments: [oappInfoRaw],
         })
     }
 
+    /**
+     * Get OApp information V1 structure
+     * @returns Promise<OAppInfoV1> - The OApp information V1
+     */
     async getOAppInfoV1(): Promise<OAppInfoV1> {
         return executeSimulate(
             this.client,
@@ -354,16 +345,25 @@ export class OApp {
         )
     }
 
+    getOAppInfoV1ExtraInfoMoveCall(tx: Transaction, oappInfo: string | TransactionArgument): TransactionResult {
+        return tx.moveCall({
+            target: this.#target('extra_info', 'oapp_info_v1'),
+            arguments: [asObject(tx, oappInfo)],
+        })
+    }
+
     // === Endpoint Call Functions ===
 
     /**
      * Register OApp with the endpoint
      * @param tx - The transaction to add the move call to
+     * @param oappObjectId - The OApp object ID
      * @param oappInfo - OApp information as bytes (optional)
      * @returns Transaction result containing the messaging channel address
      */
     async registerOAppMoveCall(
         tx: Transaction,
+        oappObjectId: string,
         oappInfo?: Uint8Array | TransactionArgument
     ): Promise<TransactionResult> {
         let oappInfoArg: TransactionArgument
@@ -376,13 +376,11 @@ export class OApp {
             // For None
             oappInfoArg = tx.pure.option('vector<u8>', null)
         }
-
-        const oappInfoObj = await this.#oappInfo()
-        const adminCap = await this.getAdminCap(oappInfoObj.oapp_object)
+        const adminCap = await this.getAdminCap(oappObjectId)
         return tx.moveCall({
             target: this.#target('register_oapp', 'endpoint_calls'),
             arguments: [
-                asObject(tx, oappInfoObj.oapp_object),
+                asObject(tx, oappObjectId),
                 asObject(tx, adminCap),
                 asObject(tx, this.objects.endpointV2),
                 oappInfoArg,
@@ -413,14 +411,22 @@ export class OApp {
      * Set OApp information in the endpoint
      * @param tx - The transaction to add the move call to
      * @param oappInfo - OApp information as bytes
+     * @param oappObjectId - Optional OApp object ID (uses configured oapp if not provided)
      */
-    async setOAppInfoMoveCall(tx: Transaction, oappInfo: Uint8Array | TransactionArgument): Promise<void> {
-        const oappInfoObj = await this.#oappInfo()
-        const adminCap = await this.getAdminCap(oappInfoObj.oapp_object)
+    async setOAppInfoMoveCall(
+        tx: Transaction,
+        oappInfo: Uint8Array | TransactionArgument,
+        oappObjectId?: string
+    ): Promise<void> {
+        if (oappObjectId === undefined) {
+            const oappInfoObj = await this.#oappInfo()
+            oappObjectId = oappInfoObj.oapp_object
+        }
+        const adminCap = await this.getAdminCap(oappObjectId)
         tx.moveCall({
             target: this.#target('set_oapp_info', 'endpoint_calls'),
             arguments: [
-                asObject(tx, oappInfoObj.oapp_object),
+                asObject(tx, oappObjectId),
                 asObject(tx, adminCap),
                 asObject(tx, this.objects.endpointV2),
                 asBytes(tx, oappInfo),
@@ -703,6 +709,14 @@ export class OApp {
         })
     }
 
+    /**
+     * Refresh the cached OApp information by fetching the latest data
+     * @returns Promise<void> - Completes when the OApp info is refreshed
+     */
+    async refreshOAppInfo(): Promise<void> {
+        this.oappInfo = await this.getOAppInfoV1()
+    }
+
     // === Private Functions ===
 
     /**