@layerzerolabs/protocol-stellar-v2 0.2.15 → 0.2.18

package/sdk/test/suites/constants.ts

@@ -1,6 +1,8 @@
 import { Asset, Keypair, Networks } from '@stellar/stellar-sdk';
 
-const CORE_URL = 'http://localhost:8000';
+import { Secp256k1KeyPair } from '../utils';
+
+const CORE_URL = 'http://localhost:8086';
 export const FRIENDBOT_URL = `${CORE_URL}/friendbot`;
 export const RPC_URL = `${CORE_URL}/rpc`;
 export const NETWORK_PASSPHRASE = Networks.STANDALONE;
@@ -10,8 +12,26 @@ export const DEFAULT_DEPLOYER = Keypair.fromSecret(
 export const ZRO_DISTRIBUTOR = Keypair.fromSecret(
     'SB6QAFXFRR2MXYHW4RRZ23JDGKHDCYCT5YTQEGG3WNT5VKZADJQFVNWG',
 );
-export const EID = 30111;
+// Use deterministic keypair for EXECUTOR_ADMIN to ensure consistency between globalSetup and test files
+// (globalSetup runs in a separate process, so Keypair.random() would generate different keys)
+export const EXECUTOR_ADMIN = Keypair.fromSecret(
+    'SACWJCNRT2AYRPBWW7IBRNI765EMZSWPXXAAHYN57UFQNOXMGET7HM5K',
+);
+
+// DVN secp256k1 signer for multisig (deterministic key for testing)
+// Private key is keccak256("dvn_test_signer") truncated to 32 bytes
+export const DVN_SIGNER = new Secp256k1KeyPair(
+    '0x8d3f8d5d8f1c7e2a5b4c3d6e9f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a',
+);
+
+// DVN configuration
+export const DVN_VID = 1;
+
+export const EID = 30400;
 export const NATIVE_TOKEN_ADDRESS = Asset.native().contractId(NETWORK_PASSPHRASE);
 export const ZRO_ASSET = new Asset('ZRO', DEFAULT_DEPLOYER.publicKey());
 export const ZRO_TOKEN_ADDRESS = ZRO_ASSET.contractId(NETWORK_PASSPHRASE);
 export const MSG_TYPE_VANILLA = 1;
+export const MSG_TYPE_COMPOSED = 2;
+export const MSG_TYPE_ABA = 3;
+export const MSG_TYPE_COMPOSED_ABA = 4;

package/sdk/test/suites/globalSetup.ts

@@ -0,0 +1,450 @@
+import path from 'path';
+import type { GlobalSetupContext } from 'vitest/node';
+
+import { getFullyQualifiedRepoRootPath } from '@layerzerolabs/common-node-utils';
+
+import { Client as DvnClient } from '../../src/generated/dvn';
+import { Client as DvnFeeLibClient } from '../../src/generated/dvn_fee_lib';
+import { Client as EndpointClient } from '../../src/generated/endpoint';
+import { Client as ExecutorClient } from '../../src/generated/executor';
+import { Client as ExecutorFeeLibClient } from '../../src/generated/executor_fee_lib';
+import { Client as ExecutorHelperClient } from '../../src/generated/executor_helper';
+import { Client as PriceFeedClient } from '../../src/generated/price_feed';
+import { Client as SMLClient } from '../../src/generated/sml';
+import { Client as TreasuryClient } from '../../src/generated/treasury';
+import { Client as Uln302Client } from '../../src/generated/uln302';
+import {
+    DEFAULT_DEPLOYER,
+    DVN_SIGNER,
+    DVN_VID,
+    EID,
+    EXECUTOR_ADMIN,
+    NATIVE_TOKEN_ADDRESS,
+    ZRO_TOKEN_ADDRESS,
+} from './constants';
+import { deployContract } from './deploy';
+import { startStellarLocalnet, stopStellarLocalnet } from './localnet';
+
+export interface ProtocolAddresses {
+    endpointV2: string;
+    uln302: string;
+    sml: string;
+    treasury: string;
+    executor: string;
+    executorHelper: string;
+    executorFeeLib: string;
+    priceFeed: string;
+    dvnFeeLib: string;
+    dvn: string;
+}
+
+export interface ProtocolClients {
+    endpointClient: EndpointClient;
+    uln302Client: Uln302Client;
+    smlClient: SMLClient;
+    treasuryClient: TreasuryClient;
+    executorClient: ExecutorClient;
+    executorHelperClient: ExecutorHelperClient;
+    executorFeeLibClient: ExecutorFeeLibClient;
+    priceFeedClient: PriceFeedClient;
+    dvnFeeLibClient: DvnFeeLibClient;
+    dvnClient: DvnClient;
+}
+
+// Declare the injection key type for vitest
+declare module 'vitest' {
+    export interface ProvidedContext {
+        protocolAddresses: ProtocolAddresses;
+    }
+}
+
+/**
+ * Deploy all protocol contracts and wire them together
+ * Returns the deployed contract addresses
+ */
+async function deployProtocolContracts(): Promise<{
+    addresses: ProtocolAddresses;
+    clients: ProtocolClients;
+}> {
+    const repoRoot = await getFullyQualifiedRepoRootPath();
+    const wasmDir = path.join(
+        repoRoot,
+        'contracts',
+        'protocol',
+        'stellar',
+        'target',
+        'wasm32v1-none',
+        'release',
+    );
+
+    const addresses: ProtocolAddresses = {
+        endpointV2: '',
+        uln302: '',
+        sml: '',
+        treasury: '',
+        executor: '',
+        executorHelper: '',
+        executorFeeLib: '',
+        priceFeed: '',
+        dvnFeeLib: '',
+        dvn: '',
+    };
+
+    // 1. Deploy Endpoint
+    console.log('🚀 Deploying Endpoint...');
+    const endpointClient = await deployContract<EndpointClient>(
+        EndpointClient,
+        path.join(wasmDir, 'endpoint_v2.wasm'),
+        {
+            eid: EID,
+            owner: DEFAULT_DEPLOYER.publicKey(),
+            native_token: NATIVE_TOKEN_ADDRESS,
+        },
+        DEFAULT_DEPLOYER,
+    );
+    addresses.endpointV2 = endpointClient.options.contractId;
+    console.log('✅ Endpoint deployed:', addresses.endpointV2);
+
+    // 2. Deploy Treasury
+    console.log('🚀 Deploying Treasury...');
+    const treasuryClient = await deployContract<TreasuryClient>(
+        TreasuryClient,
+        path.join(wasmDir, 'treasury.wasm'),
+        { owner: DEFAULT_DEPLOYER.publicKey() },
+        DEFAULT_DEPLOYER,
+    );
+    addresses.treasury = treasuryClient.options.contractId;
+    console.log('✅ Treasury deployed:', addresses.treasury);
+
+    // 3. Deploy ULN302
+    console.log('🚀 Deploying ULN302...');
+    const uln302Client = await deployContract<Uln302Client>(
+        Uln302Client,
+        path.join(wasmDir, 'uln302.wasm'),
+        {
+            owner: DEFAULT_DEPLOYER.publicKey(),
+            endpoint: addresses.endpointV2,
+            treasury: addresses.treasury,
+        },
+        DEFAULT_DEPLOYER,
+    );
+    addresses.uln302 = uln302Client.options.contractId;
+    console.log('✅ ULN302 deployed:', addresses.uln302);
+
+    // 4. Deploy SML (SimpleMessageLib)
+    console.log('🚀 Deploying SimpleMessageLib...');
+    const smlClient = await deployContract<SMLClient>(
+        SMLClient,
+        path.join(wasmDir, 'simple_message_lib.wasm'),
+        {
+            owner: DEFAULT_DEPLOYER.publicKey(),
+            endpoint: addresses.endpointV2,
+            fee_recipient: DEFAULT_DEPLOYER.publicKey(),
+        },
+        DEFAULT_DEPLOYER,
+    );
+    addresses.sml = smlClient.options.contractId;
+    console.log('✅ SimpleMessageLib deployed:', addresses.sml);
+
+    // 5. Deploy Price Feed
+    console.log('🚀 Deploying Price Feed...');
+    const priceFeedClient = await deployContract<PriceFeedClient>(
+        PriceFeedClient,
+        path.join(wasmDir, 'price_feed.wasm'),
+        {
+            owner: DEFAULT_DEPLOYER.publicKey(),
+            price_updater: DEFAULT_DEPLOYER.publicKey(),
+        },
+        DEFAULT_DEPLOYER,
+    );
+    addresses.priceFeed = priceFeedClient.options.contractId;
+    console.log('✅ Price Feed deployed:', addresses.priceFeed);
+
+    // 6. Deploy Executor Fee Lib
+    console.log('🚀 Deploying Executor Fee Lib...');
+    const executorFeeLibClient = await deployContract<ExecutorFeeLibClient>(
+        ExecutorFeeLibClient,
+        path.join(wasmDir, 'executor_fee_lib.wasm'),
+        { owner: DEFAULT_DEPLOYER.publicKey() },
+        DEFAULT_DEPLOYER,
+    );
+    addresses.executorFeeLib = executorFeeLibClient.options.contractId;
+    console.log('✅ Executor Fee Lib deployed:', addresses.executorFeeLib);
+
+    // 7. Deploy DVN Fee Lib
+    console.log('🚀 Deploying DVN Fee Lib...');
+    const dvnFeeLibClient = await deployContract<DvnFeeLibClient>(
+        DvnFeeLibClient,
+        path.join(wasmDir, 'dvn_fee_lib.wasm'),
+        { owner: DEFAULT_DEPLOYER.publicKey() },
+        DEFAULT_DEPLOYER,
+    );
+    addresses.dvnFeeLib = dvnFeeLibClient.options.contractId;
+    console.log('✅ DVN Fee Lib deployed:', addresses.dvnFeeLib);
+
+    // 8. Deploy DVN
+    console.log('🚀 Deploying DVN...');
+    const dvnClient = await deployContract<DvnClient>(
+        DvnClient,
+        path.join(wasmDir, 'dvn.wasm'),
+        {
+            vid: DVN_VID,
+            signers: [DVN_SIGNER.ethAddress],
+            threshold: 1,
+            admins: [DEFAULT_DEPLOYER.publicKey()],
+            supported_msglibs: [addresses.uln302],
+            price_feed: addresses.priceFeed,
+            default_multiplier_bps: 10000,
+            worker_fee_lib: addresses.dvnFeeLib,
+            deposit_address: DEFAULT_DEPLOYER.publicKey(),
+        },
+        DEFAULT_DEPLOYER,
+    );
+    addresses.dvn = dvnClient.options.contractId;
+    console.log('✅ DVN deployed:', addresses.dvn);
+
+    // 9. Deploy Executor Helper
+    console.log('🚀 Deploying Executor Helper...');
+    const executorHelperClient = await deployContract<ExecutorHelperClient>(
+        ExecutorHelperClient,
+        path.join(wasmDir, 'executor_helper.wasm'),
+        undefined,
+        DEFAULT_DEPLOYER,
+    );
+    addresses.executorHelper = executorHelperClient.options.contractId;
+    console.log('✅ Executor Helper deployed:', addresses.executorHelper);
+
+    // 10. Deploy Executor (supports both ULN302 and SML)
+    console.log('🚀 Deploying Executor...');
+    const whitelist = [
+        [addresses.executorHelper, 'native_drop_and_execute'],
+        [addresses.executorHelper, 'execute'],
+        [addresses.executorHelper, 'compose'],
+    ];
+    const executorClient = await deployContract<ExecutorClient>(
+        ExecutorClient,
+        path.join(wasmDir, 'executor.wasm'),
+        {
+            owner: DEFAULT_DEPLOYER.publicKey(),
+            endpoint: addresses.endpointV2,
+            whitelist,
+            admins: [EXECUTOR_ADMIN.publicKey(), DEFAULT_DEPLOYER.publicKey()],
+            message_libs: [addresses.uln302, addresses.sml],
+            price_feed: addresses.priceFeed,
+            default_multiplier_bps: 10000,
+            worker_fee_lib: addresses.executorFeeLib,
+            deposit_address: DEFAULT_DEPLOYER.publicKey(),
+        },
+        DEFAULT_DEPLOYER,
+    );
+    addresses.executor = executorClient.options.contractId;
+    console.log('✅ Executor deployed:', addresses.executor);
+
+    const clients: ProtocolClients = {
+        endpointClient,
+        uln302Client,
+        smlClient,
+        treasuryClient,
+        executorClient,
+        executorHelperClient,
+        executorFeeLibClient,
+        priceFeedClient,
+        dvnFeeLibClient,
+        dvnClient,
+    };
+
+    return { addresses, clients };
+}
+
+/**
+ * Wire protocol contracts (register libraries, set defaults, configure workers)
+ */
+async function wireProtocolContracts(
+    addresses: ProtocolAddresses,
+    clients: ProtocolClients,
+): Promise<void> {
+    const { endpointClient, uln302Client, priceFeedClient, executorClient, dvnClient } = clients;
+
+    console.log('🔗 Wiring protocol contracts...');
+
+    // Register libraries
+    await (await endpointClient.register_library({ new_lib: addresses.uln302 })).signAndSend();
+    await (await endpointClient.register_library({ new_lib: addresses.sml })).signAndSend();
+    console.log('✅ Libraries registered (ULN302 + SML)');
+
+    // Set ZRO token
+    await (await endpointClient.set_zro({ zro: ZRO_TOKEN_ADDRESS })).signAndSend();
+    console.log('✅ ZRO token set');
+
+    // Configure ULN302 executor config FIRST (so is_supported_eid returns true)
+    await (
+        await uln302Client.set_default_executor_configs({
+            params: [
+                {
+                    dst_eid: EID,
+                    config: { executor: addresses.executor, max_message_size: 10000 },
+                },
+            ],
+        })
+    ).signAndSend();
+    console.log('✅ ULN302 executor config set');
+
+    // Configure ULN302 send/receive configs
+    await (
+        await uln302Client.set_default_send_uln_configs({
+            params: [
+                {
+                    eid: EID,
+                    config: {
+                        confirmations: 1n,
+                        required_dvns: [addresses.dvn],
+                        optional_dvns: [],
+                        optional_dvn_threshold: 0,
+                    },
+                },
+            ],
+        })
+    ).signAndSend();
+
+    await (
+        await uln302Client.set_default_receive_uln_configs({
+            params: [
+                {
+                    eid: EID,
+                    config: {
+                        confirmations: 1n,
+                        required_dvns: [addresses.dvn],
+                        optional_dvns: [],
+                        optional_dvn_threshold: 0,
+                    },
+                },
+            ],
+        })
+    ).signAndSend();
+    console.log('✅ ULN302 send/receive configs set');
+
+    // NOW set default send/receive libraries to ULN302 (after configs are set)
+    await (
+        await endpointClient.set_default_send_library({ dst_eid: EID, new_lib: addresses.uln302 })
+    ).signAndSend();
+    await (
+        await endpointClient.set_default_receive_library({
+            src_eid: EID,
+            new_lib: addresses.uln302,
+            grace_period: 0n,
+        })
+    ).signAndSend();
+    console.log('✅ Default libraries set to ULN302');
+
+    // Configure Price Feed
+    await (
+        await priceFeedClient.set_price_ratio_denominator({ denominator: 100000000000000000000n })
+    ).signAndSend();
+    await (
+        await priceFeedClient.set_native_token_price_usd({
+            price_updater: DEFAULT_DEPLOYER.publicKey(),
+            native_token_price_usd: 1000000000000000000n,
+        })
+    ).signAndSend();
+
+    const NORMALIZED_EID = EID % 30000;
+    await (
+        await priceFeedClient.set_price({
+            price_updater: DEFAULT_DEPLOYER.publicKey(),
+            prices: [
+                {
+                    eid: NORMALIZED_EID,
+                    price: {
+                        gas_per_byte: 1,
+                        gas_price_in_unit: 1n,
+                        price_ratio: 100000000000000000000n,
+                    },
+                },
+            ],
+        })
+    ).signAndSend();
+    console.log('✅ Price Feed configured');
+
+    // Configure Executor
+    await (
+        await executorClient.set_dst_config({
+            admin: DEFAULT_DEPLOYER.publicKey(),
+            params: [
+                {
+                    dst_eid: EID,
+                    dst_config: {
+                        floor_margin_usd: 0n,
+                        lz_compose_base_gas: 50000n,
+                        lz_receive_base_gas: 100000n,
+                        multiplier_bps: 10000,
+                        native_cap: 1000000000000n,
+                    },
+                },
+            ],
+        })
+    ).signAndSend();
+    console.log('✅ Executor configured');
+
+    // Configure DVN
+    await (
+        await dvnClient.set_dst_config({
+            admin: DEFAULT_DEPLOYER.publicKey(),
+            params: [
+                {
+                    dst_eid: EID,
+                    config: {
+                        floor_margin_usd: 0n,
+                        gas: 100000n,
+                        multiplier_bps: 10000,
+                    },
+                },
+            ],
+        })
+    ).signAndSend();
+    console.log('✅ DVN configured');
+
+    console.log('🎉 Protocol wiring complete!');
+}
+
+/**
+ * Vitest Global Setup - runs ONCE before all test files
+ * Uses vitest's provide() to share data in memory with test files
+ */
+export default async function globalSetup({
+    provide,
+}: GlobalSetupContext): Promise<() => Promise<void>> {
+    console.log('\n========================================');
+    console.log('🌐 GLOBAL SETUP: Starting Stellar Localnet');
+    console.log('========================================\n');
+
+    await startStellarLocalnet();
+
+    console.log('\n========================================');
+    console.log('📦 GLOBAL SETUP: Deploying Protocol Contracts');
+    console.log('========================================\n');
+
+    const { addresses, clients } = await deployProtocolContracts();
+
+    console.log('\n========================================');
+    console.log('🔗 GLOBAL SETUP: Wiring Protocol Contracts');
+    console.log('========================================\n');
+
+    await wireProtocolContracts(addresses, clients);
+
+    // Provide addresses in memory for test files to access via inject()
+    provide('protocolAddresses', addresses);
+    console.log('\n✅ Protocol addresses provided to tests (in-memory)');
+
+    console.log('\n========================================');
+    console.log('✅ GLOBAL SETUP COMPLETE');
+    console.log('========================================\n');
+
+    // Return teardown function
+    return async () => {
+        console.log('\n========================================');
+        console.log('🛑 GLOBAL TEARDOWN: Stopping Stellar Localnet');
+        console.log('========================================\n');
+
+        await stopStellarLocalnet();
+    };
+}

package/sdk/test/suites/localnet.ts

@@ -1,25 +1,42 @@
 import axios from 'axios';
 import { $, sleep } from 'zx';
 
-import { DEFAULT_DEPLOYER, FRIENDBOT_URL, ZRO_DISTRIBUTOR } from './constants';
+import { DEFAULT_DEPLOYER, EXECUTOR_ADMIN, FRIENDBOT_URL, ZRO_DISTRIBUTOR } from './constants';
 import { deployNativeSac, deployZroToken } from './deploy';
 
+const CONTAINER_NAME = 'stellar-localnet';
+const QUICKSTART_IMAGE = 'stellar/quickstart';
+
 export async function startStellarLocalnet(): Promise<void> {
     console.log('🚀 Starting Stellar localnet...');
 
-    //TODO: pnpm localnet up --only stellar
-    await $`stellar container start local`;
+    // Remove any existing container first (ignore errors if not running)
+    await $`docker rm -f ${CONTAINER_NAME}`.nothrow();
+
+    // Pull image only if not available locally
+    const imageExists = await $`docker image inspect ${QUICKSTART_IMAGE}`.nothrow().quiet();
+    if (imageExists.exitCode !== 0) {
+        console.log(`📥 Pulling ${QUICKSTART_IMAGE}...`);
+        await $`docker pull ${QUICKSTART_IMAGE}`;
+    }
+
+    // Start the stellar/quickstart container directly (no Stellar CLI needed)
+    await $`docker run -d --name ${CONTAINER_NAME} -p 8086:8000 ${QUICKSTART_IMAGE} --local`;
 
     // Wait for Stellar to start
-    for (let i = 0; i < 60; i++) {
+    for (let i = 0; i < 180; i++) {
         try {
             // Ensure faucet service is started and fund the default deployer account
             await fundAccount(DEFAULT_DEPLOYER.publicKey());
-            await fundAccount(ZRO_DISTRIBUTOR.publicKey());
             console.log(`✅ Account ${DEFAULT_DEPLOYER.publicKey()} funded`);
+            await fundAccount(ZRO_DISTRIBUTOR.publicKey());
+            console.log(`✅ Account ${ZRO_DISTRIBUTOR.publicKey()} funded`);
+            await fundAccount(EXECUTOR_ADMIN.publicKey());
+            console.log(`✅ Account ${EXECUTOR_ADMIN.publicKey()} funded`);
             console.log('✅ Stellar localnet started');
             break;
         } catch (_e) {
+            console.error(`❌ Failed to fund account ${_e}`);
             await sleep(1000);
             console.log('⏳ Waiting for Stellar localnet to start...');
         }
@@ -37,6 +54,6 @@ export async function fundAccount(publicKey: string): Promise<void> {
 }
 
 export async function stopStellarLocalnet(): Promise<void> {
-    await $`stellar container stop`;
+    await $`docker rm -f ${CONTAINER_NAME}`;
     console.log('✅ Stellar localnet stopped');
 }

package/sdk/test/upgrader.test.ts

@@ -3,18 +3,17 @@ import { assembleTransaction } from '@stellar/stellar-sdk/rpc';
 import * as rpc from '@stellar/stellar-sdk/rpc';
 import { readFileSync } from 'fs';
 import path from 'path';
-import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { describe, expect, it } from 'vitest';
 
 import { getFullyQualifiedRepoRootPath } from '@layerzerolabs/common-node-utils';
 
 import { Client as UpgraderClient } from '../src/generated/upgrader';
 import { DEFAULT_DEPLOYER, NETWORK_PASSPHRASE, RPC_URL } from './suites/constants';
 import { deployContract, uploadWasm } from './suites/deploy';
-import { startStellarLocalnet, stopStellarLocalnet } from './suites/localnet';
-import { Client as TestUpgradeableContractClient } from './suites/testUpgradeable';
+import { Client as DummyContractClient } from './suites/dummyContractClient';
 
 let upgraderClient: UpgraderClient;
-let testContractClient: TestUpgradeableContractClient;
+let dummyContractClient: DummyContractClient;
 let testContractAddress: string;
 
 // Test data paths
@@ -48,14 +47,6 @@ describe('Upgrader Contract Testing', async () => {
     TEST_CONTRACT_V1_WASM_PATH = path.join(testDataDir, 'test_upgradeable_contract1.wasm');
     TEST_CONTRACT_V2_WASM_PATH = path.join(testDataDir, 'test_upgradeable_contract2.wasm');
 
-    beforeAll(async () => {
-        await startStellarLocalnet();
-    }, 120000); // 2 minute timeout for setup
-
-    afterAll(async () => {
-        await stopStellarLocalnet();
-    });
-
     describe('Contract Deployments', () => {
         it('Deploy Upgrader Contract', async () => {
             // Deploy upgrader contract using the helper (no constructor args needed)
@@ -138,7 +129,7 @@ describe('Upgrader Contract Testing', async () => {
             );
 
             // Create client for the deployed contract
-            testContractClient = new TestUpgradeableContractClient({
+            dummyContractClient = new DummyContractClient({
                 contractId: testContractAddress,
                 publicKey: DEFAULT_DEPLOYER.publicKey(),
                 signTransaction: async (tx: string) => {
@@ -160,7 +151,7 @@ describe('Upgrader Contract Testing', async () => {
 
         it('Verify Test Contract V1 Counter', async () => {
             // Call counter() on V1 contract, should return 1
-            const { result } = await testContractClient.counter();
+            const { result } = await dummyContractClient.counter();
             console.log('✅ Test Contract V1 counter value:', result);
             expect(result).toBe(1);
         });
@@ -294,14 +285,14 @@ describe('Upgrader Contract Testing', async () => {
 
         it('Verify Test Contract V2 Counter2 After Upgrade', async () => {
             // After upgrade, the contract should have counter2() function that returns 2
-            const { result } = await testContractClient.counter2();
+            const { result } = await dummyContractClient.counter2();
             console.log('✅ Test Contract V2 counter2 value:', result);
             expect(result).toBe(2);
         });
 
         it('Verify Test Contract V1 Counter Still Works After Upgrade', async () => {
             // The original counter() should still be accessible and return 1
-            const { result } = await testContractClient.counter();
+            const { result } = await dummyContractClient.counter();
             console.log('✅ Test Contract V2 counter value (from V1):', result);
             expect(result).toBe(1);
         });