[INT-295] Feature Move Oapp example move vm decoding

.changeset/purple-apes-yell.md

@@ -0,0 +1,21 @@
+---
+"@layerzerolabs/oft-adapter-aptos-move-example": patch
+"@layerzerolabs/mint-burn-oft-adapter-example": patch
+"@layerzerolabs/native-oft-adapter-example": patch
+"@layerzerolabs/oft-adapter-initia-example": patch
+"@layerzerolabs/oapp-aptos-example": patch
+"@layerzerolabs/oft-hyperliquid-example": patch
+"@layerzerolabs/oft-upgradeable-example": patch
+"@layerzerolabs/oft-aptos-move-example": patch
+"@layerzerolabs/onft721-zksync-example": patch
+"@layerzerolabs/oft-adapter-example": patch
+"@layerzerolabs/oft-initia-example": patch
+"@layerzerolabs/oft-solana-example": patch
+"@layerzerolabs/omni-call-example": patch
+"@layerzerolabs/oft-alt-example": patch
+"@layerzerolabs/onft721-example": patch
+"@layerzerolabs/oapp-example": patch
+"@layerzerolabs/oft-example": patch
+---
+
+Updating license from UNLICENSED to MIT.

.changeset/weak-crabs-chew.md

@@ -0,0 +1,5 @@
+---
+"@layerzerolabs/oapp-aptos-example": patch
+---
+
+Adding param encoding and decoding to Move OApp example.

examples/mint-burn-oft-adapter/contracts/MyMintBurnOFTAdapter.sol

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: UNLICENSED
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.22;
 
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";

examples/mint-burn-oft-adapter/contracts/MyOFT.sol

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: UNLICENSED
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.22;
 
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";

examples/native-oft-adapter/contracts/MyNativeOFTAdapter.sol

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: UNLICENSED
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.22;
 
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";

examples/native-oft-adapter/contracts/MyOFT.sol

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: UNLICENSED
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.22;
 
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";

examples/oapp-aptos-move/README.md

@@ -96,15 +96,19 @@ APTOS_PRIVATE_KEY=<your-aptos-private-key>
 
 Then run `source .env` in order for your values to be mapped.
 
-> **Important:** If using Aptos CLI version >= 6.1.0 (required for Aptos chain), you need to uncomment the following lines in Move.toml and remove the existing AptosFramework dependency:
+> **Important:** If using Aptos CLI version 3.5.0 (required for Movement chain), you need to uncomment the following lines in Move.toml and remove the existing AptosFramework dependency:
 >
 > ```
 > # [dependencies.AptosFramework]
-> # git = "https://github.com/aptos-labs/aptos-framework.git"
-> # rev = "mainnet"
-> # subdir = "aptos-framework"
+> # git = "https://github.com/movementlabsxyz/aptos-core.git"
+> # rev = "movement-cli-v3.5.0"
+> # subdir = "aptos-move/framework/aptos-framework"
 > ```
 
+## Contracts
+
+The starter OApp contracts are located in `./sources/oapp.move` and `./contracts/MyOApp.sol`. Feel free to adjust these based on the needs of you application. There are also some test scripts in `./scripts/` that allow you to test sending messages between your OApps.
+
 ## OApp Config Setup
 
 Before running the deploy and wire commands, first inside of `move.layerzero.config.ts`, set the delegate and owner address to your deployer account address. These can be changed in the future with commands shown later in this README, but for now they should be set to the address you will be running the commands from (deployer account address).
@@ -207,6 +211,48 @@ If `--only-calldata <true>` is specified, only the calldata is generated and not
 pnpm run lz:sdk:move:wire --oapp-config move.layerzero.config.ts
 ```
 
+### Testing Send
+
+This OApp example includes several test scripts in `./scripts`. **Before running any script, you must manually update the values inside each file with your deployed contract addresses and configuration.**
+
+For EVM scripts (`evm-send.ts`, `evm-get-message.ts`), update the following values inside the files:
+
+- `contractAddress` with your deployed EVM contract address
+- RPC URL in the `JsonRpcProvider` with your EVM chain's RPC endpoint
+- Set `EVM_PRIVATE_KEY` environment variable for sending transactions
+
+For Aptos/Movement scripts (`aptos-move-send.ts`, `aptos-get-receive-values.ts`), update the following values inside the files:
+
+- `OAPP_ADDRESS` or `oappAddress` with your deployed Aptos/Movement contract address
+- Set `APTOS_PRIVATE_KEY` and `ACCOUNT_ADDRESS` environment variables for sending transactions
+- Adjust the `Network` configuration if needed (TESTNET/MAINNET)
+
+To test sending from your EVM deployment to your deployed OApp on Aptos or Movement, run:
+
+```bash
+ts-node scripts/evm-send.ts
+```
+
+For demonstration purposes, we have added encoding and decoding of some useful parameters in `oapp.move` and `evm-send.ts`. These are for demonstration purposes only and should be adjusted based on the needs of your application.
+
+To confirm your values have been sent to your Aptos or Movement OApp, run:
+
+```bash
+ts-node scripts/aptos-get-received-values.ts
+```
+
+To send a test value from your Aptos/Movement OApp to your EVM OApp, run:
+
+```bash
+ts-node scripts/aptos-move-send.ts
+```
+
+To check that your message has been registered in your EVM OApp, run:
+
+```bash
+ts-node scripts/evm-get-received-message.ts
+```
+
 ### Transferring Ownership of your Move OApp
 
 There are three steps to transferring ownership of your Move OApp:

examples/oapp-aptos-move/contracts/MyOApp.sol

@@ -1,34 +1,31 @@
 // SPDX-License-Identifier: MIT
-
 pragma solidity ^0.8.22;
 
-import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
-import { OApp, MessagingFee, Origin } from "@layerzerolabs/oapp-evm/contracts/oapp/OApp.sol";
-import { MessagingReceipt } from "@layerzerolabs/oapp-evm/contracts/oapp/OAppSender.sol";
+import { OApp, Origin, MessagingFee } from "@layerzerolabs/oapp-evm/contracts/oapp/OApp.sol";
 import { OAppOptionsType3 } from "@layerzerolabs/oapp-evm/contracts/oapp/libs/OAppOptionsType3.sol";
+import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 
 contract MyOApp is OApp, OAppOptionsType3 {
-    constructor(address _endpoint, address _delegate) OApp(_endpoint, _delegate) Ownable(_delegate) {}
+    /// @notice Last string received from any remote chain
+    address public address1;
+    address public address2;
+    uint256 public num;
 
-    string public data = "Nothing received yet.";
-    uint256 public counter = 0;
+    /// @notice The only Message Type in use for this OApp: sending an arbitrary string.
+    /// Different message types can be assigned different enforced options per destination endpoint ID.
+    uint16 public constant SEND = 1;
 
-    /**
-     * @notice Sends a message from the source chain to a destination chain.
-     * @param _dstEid The endpoint ID of the destination chain.
-     * @param _message The message string to be sent.
-     * @param _options Additional options for message execution.
-     * @dev Encodes the message as bytes and sends it using the `_lzSend` internal function.
-     * @return receipt A `MessagingReceipt` struct containing details of the message sent.
-     */
-    function send(
-        uint32 _dstEid,
-        string memory _message,
-        bytes calldata _options
-    ) external payable returns (MessagingReceipt memory receipt) {
-        bytes memory _payload = abi.encode(_message);
-        receipt = _lzSend(_dstEid, _payload, _options, MessagingFee(msg.value, 0), payable(msg.sender));
-    }
+    /// @notice Initialize with Endpoint V2 and owner address
+    /// @param _endpoint The local chain's LayerZero Endpoint V2 address
+    /// @param _owner    The address permitted to configure this OApp
+    constructor(address _endpoint, address _owner) OApp(_endpoint, _owner) Ownable(_owner) {}
+
+    // ──────────────────────────────────────────────────────────────────────────────
+    // 0. (Optional) Quote business logic
+    //
+    // Example: Get a quote from the Endpoint for a cost estimate of sending a message.
+    // Replace this to mirror your own send business logic.
+    // ──────────────────────────────────────────────────────────────────────────────
 
     /**
      * @notice Quotes the gas needed to pay for the full omnichain transaction in native gas or ZRO token.
@@ -38,35 +35,87 @@ contract MyOApp is OApp, OAppOptionsType3 {
      * @param _payInLzToken Whether to return fee in ZRO token.
      * @return fee A `MessagingFee` struct containing the calculated gas fee in either the native token or ZRO token.
      */
-    function quote(
+    function quoteSend(
         uint32 _dstEid,
-        string memory _message,
-        bytes memory _options,
+        string calldata _message,
+        bytes calldata _options,
         bool _payInLzToken
     ) public view returns (MessagingFee memory fee) {
-        bytes memory payload = abi.encode(_message);
-        fee = _quote(_dstEid, payload, _options, _payInLzToken);
+        bytes memory _message = abi.encode(_message);
+        // combineOptions (from OAppOptionsType3) merges enforced options set by the contract owner
+        // with any additional execution options provided by the caller
+        fee = _quote(_dstEid, _message, combineOptions(_dstEid, SEND, _options), _payInLzToken);
     }
 
-    /**
-     * @dev Internal function override to handle incoming messages from another chain.
-     * @dev _origin A struct containing information about the message sender.
-     * @dev _guid A unique global packet identifier for the message.
-     * @dev payload The encoded message payload being received.
-     *
-     * @dev The following params are unused in the current implementation of the OApp.
-     * @dev _executor The address of the Executor responsible for processing the message.
-     * @dev _extraData Arbitrary data appended by the Executor to the message.
-     *
-     * Increments the counter.
-     */
+    // ──────────────────────────────────────────────────────────────────────────────
+    // 1. Send business logic
+    //
+    // Example: send a simple string to a remote chain. Replace this with your
+    // own state-update logic, then encode whatever data your application needs.
+    // ──────────────────────────────────────────────────────────────────────────────
+
+    /// @notice Send a string to a remote OApp on another chain
+    /// @param _dstEid   Destination Endpoint ID (uint32)
+    /// @param _message  The string to send
+    /// @param _options  Execution options for gas on the destination (bytes)
+    function send(uint32 _dstEid, string calldata _message, bytes calldata _options) external payable {
+        // 1. (Optional) Update any local state here.
+        //    e.g., record that a message was "sent":
+        //    sentCount += 1;
+
+        // 2. Encode any data structures you wish to send into bytes
+        //    You can use abi.encode, abi.encodePacked, or directly splice bytes
+        //    if you know the format of your data structures
+        bytes memory _message = abi.encode(_message);
+
+        // 3. Call OAppSender._lzSend to package and dispatch the cross-chain message
+        //    - _dstEid:   remote chain's Endpoint ID
+        //    - _message:  ABI-encoded string
+        //    - _options:  combined execution options (enforced + caller-provided)
+        //    - MessagingFee(msg.value, 0): pay all gas as native token; no ZRO
+        //    - payable(msg.sender): refund excess gas to caller
+        //
+        //    combineOptions (from OAppOptionsType3) merges enforced options set by the contract owner
+        //    with any additional execution options provided by the caller
+        _lzSend(
+            _dstEid,
+            _message,
+            combineOptions(_dstEid, SEND, _options),
+            MessagingFee(msg.value, 0),
+            payable(msg.sender)
+        );
+    }
+
+    // ──────────────────────────────────────────────────────────────────────────────
+    // 2. Receive business logic
+    //
+    // Override _lzReceive to decode the incoming bytes and apply your logic.
+    // The base OAppReceiver.lzReceive ensures:
+    //   • Only the LayerZero Endpoint can call this method
+    //   • The sender is a registered peer (peers[srcEid] == origin.sender)
+    // ──────────────────────────────────────────────────────────────────────────────
+
+    /// @notice Invoked by OAppReceiver when EndpointV2.lzReceive is called
+    /// @dev   _origin    Metadata (source chain, sender address, nonce)
+    /// @dev   _guid      Global unique ID for tracking this message
+    /// @param _message   ABI-encoded bytes (the string we sent earlier)
+    /// @dev   _executor  Executor address that delivered the message
+    /// @dev   _extraData Additional data from the Executor (unused by the LayerZero executor)
     function _lzReceive(
         Origin calldata /*_origin*/,
         bytes32 /*_guid*/,
-        bytes calldata /*payload*/,
+        bytes calldata _message,
         address /*_executor*/,
         bytes calldata /*_extraData*/
     ) internal override {
-        counter += 1;
+        // 1. Decode the incoming bytes into a string
+        //    You can use abi.decode, abi.decodePacked, or directly splice bytes
+        //    if you know the format of your data structures
+        (address1, address2, num) = abi.decode(_message, (address, address, uint256));
+
+        // 2. Apply your custom logic. In this example, store it in `lastMessage`.
+        // 3. (Optional) Trigger further on-chain actions.
+        //    e.g., emit an event, mint tokens, call another contract, etc.
+        //    emit MessageReceived(_origin.srcEid, _message);
     }
 }

examples/oapp-aptos-move/move.layerzero.config.ts

@@ -74,7 +74,7 @@ const config: OAppOmniGraphHardhat = {
                     },
                     ulnConfig: {
                         // The number of block confirmations to wait on Aptos before emitting the message from the source chain.
-                        confirmations: BigInt(260),
+                        confirmations: BigInt(10),
                         // The address of the DVNs you will pay to verify a sent message on the source chain.
                         // The destination tx will wait until ALL `requiredDVNs` verify the message.
                         requiredDVNs: ['0x756f8ab056688d22687740f4a9aeec3b361170b28d08b719e28c4d38eed1043e'],
@@ -143,7 +143,7 @@ const config: OAppOmniGraphHardhat = {
                 },
                 receiveConfig: {
                     ulnConfig: {
-                        confirmations: BigInt(260),
+                        confirmations: BigInt(10),
                         requiredDVNs: ['0x0eE552262f7B562eFcED6DD4A7e2878AB897d405'],
                         optionalDVNThreshold: 0,
                     },

examples/oapp-aptos-move/scripts/aptos-get-received-values.ts

@@ -0,0 +1,57 @@
+import { Aptos, AptosConfig, Network } from '@aptos-labs/ts-sdk'
+
+/**
+ * A utility script to verify cross-chain message delivery by checking the last received values.
+ * The values are updated each time a message is successfully received by the OApp,
+ * providing a simple way to confirm that cross-chain communication is working as expected.
+ */
+async function main() {
+    const config = new AptosConfig({ network: Network.TESTNET })
+    const aptos = new Aptos(config)
+    const oappAddress = '<your-oapp-address>'
+
+    console.log('Fetching receive values...')
+    console.log('---')
+
+    const [counterResult, address1Result, address2Result, numberResult, rawMessageResult] = await Promise.all([
+        aptos.view({
+            payload: {
+                function: `${oappAddress}::oapp::get_counter_value`,
+                typeArguments: [],
+            },
+        }),
+        aptos.view({
+            payload: {
+                function: `${oappAddress}::oapp::get_decoded_address1`,
+                typeArguments: [],
+            },
+        }),
+        aptos.view({
+            payload: {
+                function: `${oappAddress}::oapp::get_decoded_address2`,
+                typeArguments: [],
+            },
+        }),
+        aptos.view({
+            payload: {
+                function: `${oappAddress}::oapp::get_decoded_number`,
+                typeArguments: [],
+            },
+        }),
+        aptos.view({
+            payload: {
+                function: `${oappAddress}::oapp::get_raw_message`,
+                typeArguments: [],
+            },
+        }),
+    ])
+
+    console.log('- Counter:', counterResult[0])
+    console.log('- Address 1:', address1Result[0])
+    console.log('- Address 2:', address2Result[0])
+    console.log('- Number:', numberResult[0])
+    console.log('- Raw Message:', rawMessageResult[0])
+    console.log('---')
+}
+
+main().catch(console.error)