miden-client-integration-tests 0.17.5

use std::path::{Path, PathBuf};

use anyhow::{Context, Result};
use miden_client::account::{AccountFile, AccountId};
use miden_client::keystore::Keystore;
use miden_client::testing::common::TestClient;

use crate::ClientConfig;
use crate::fee_funding::AccountLock;

pub mod agglayer_bridge_in_out;
mod agglayer_test_utils;
pub mod ger;
pub mod note_reader;

/// Env var naming the directory the pre-deployed agglayer account files are read from.
const ACCOUNTS_DIR_ENV: &str = "AGGLAYER_ACCOUNTS_DIR";

// AGGLAYER CONFIG
// ================================================================================================

/// The pre-deployed agglayer accounts the tests transact with.
///
/// Loaded from `.mac` files in the directory named by [`ACCOUNTS_DIR_ENV`]. Account IDs and keys
/// are read from the files, but the account state is fetched from the network so repeated runs
/// against the same chain stay idempotent.
pub struct AgglayerConfig {
    pub bridge_admin: AccountFile,
    pub ger_manager: AccountFile,
    pub bridge: AccountFile,
    pub faucet: AccountFile,
}

impl AgglayerConfig {
    /// File names matching the gen-genesis output (see the test-node-genesis crate).
    const BRIDGE_ADMIN_FILE: &str = "bridge_admin.mac";
    const GER_MANAGER_FILE: &str = "ger_manager.mac";
    const BRIDGE_FILE: &str = "bridge.mac";
    const FAUCET_FILE: &str = "agglayer_faucet.mac";

    /// Loads the agglayer accounts from the directory named by [`ACCOUNTS_DIR_ENV`].
    pub fn from_env() -> Result<Self> {
        let dir = std::env::var(ACCOUNTS_DIR_ENV).map(PathBuf::from).with_context(|| {
            format!(
                "the agglayer accounts cannot be created by a test, so {ACCOUNTS_DIR_ENV} has to \
                 name the directory holding the `.mac` files of the ones deployed on this chain"
            )
        })?;

        Ok(Self {
            bridge_admin: Self::load_account_file(&dir, Self::BRIDGE_ADMIN_FILE)?,
            ger_manager: Self::load_account_file(&dir, Self::GER_MANAGER_FILE)?,
            bridge: Self::load_account_file(&dir, Self::BRIDGE_FILE)?,
            faucet: Self::load_account_file(&dir, Self::FAUCET_FILE)?,
        })
    }

    /// Claims the agglayer accounts for the calling test, waiting for whichever test holds them.
    ///
    /// Every agglayer test drives the same four accounts, so two at once would build transactions
    /// from the same nonce. One lock keyed on the bridge covers all four, where a lock per account
    /// could deadlock. The guard must stay alive for the whole test.
    pub fn claim(&self) -> Result<AccountLock> {
        AccountLock::acquire(self.bridge_id())
    }

    pub fn bridge_admin_id(&self) -> AccountId {
        self.bridge_admin.account().id()
    }

    pub fn ger_manager_id(&self) -> AccountId {
        self.ger_manager.account().id()
    }

    pub fn bridge_id(&self) -> AccountId {
        self.bridge.account().id()
    }

    pub fn faucet_id(&self) -> AccountId {
        self.faucet.account().id()
    }

    /// Imports a single account (by ID) into the given client and its keystore. Fetches the latest
    /// state from the network. Adds any matching secret keys.
    pub async fn import_account(
        &self,
        account_id: AccountId,
        client: &mut TestClient,
    ) -> Result<()> {
        let account_file = [&self.bridge_admin, &self.ger_manager, &self.bridge, &self.faucet]
            .into_iter()
            .find(|f| f.account().id() == account_id)
            .with_context(|| format!("account {account_id} not found in agglayer config"))?;

        client
            .import_account_by_id(account_id)
            .await
            .with_context(|| format!("failed to import account {account_id} from network"))?;

        for secret_key in account_file.auth_secret_keys() {
            client.keystore().add_key(secret_key, account_id).await.with_context(|| {
                format!("failed to add key for account {account_id} to keystore")
            })?;
        }
        Ok(())
    }

    fn load_account_file(dir: &Path, filename: &str) -> Result<AccountFile> {
        let path = dir.join(filename);
        let bytes =
            std::fs::read(&path).with_context(|| format!("failed to read {}", path.display()))?;
        AccountFile::try_from_bytes(&bytes)
            .with_context(|| format!("failed to deserialize {}", path.display()))
    }
}

// SHARED TEST SETUP
// ================================================================================================

/// Account IDs produced by the core setup: `(bridge_admin_id, ger_manager_id, bridge_id)`.
pub type CoreAccountIds = (AccountId, AccountId, AccountId);

/// Creates three clients sharing the same RPC endpoint, for bridge admin, GER manager, and user.
pub async fn create_agglayer_clients(
    client_config: &ClientConfig,
) -> Result<(TestClient, TestClient, TestClient)> {
    let mut bridge_admin = client_config.clone().into_client().await?;
    bridge_admin.wait_for_node().await;
    bridge_admin.sync_state().await?;
    println!("[setup] Bridge admin client initialized");

    let ger_manager = client_config.clone().into_client().await?;
    println!("[setup] GER manager client initialized");

    let user = client_config.clone().into_client().await?;
    println!("[setup] User client initialized");

    Ok((bridge_admin, ger_manager, user))
}

/// Imports the core agglayer accounts (bridge admin, GER manager, bridge) into the three clients.
///
/// The bridge goes into all three so each can build transactions that reference it. The bridge
/// admin and the GER manager go only into the client that signs for them.
pub async fn setup_core_accounts(
    config: &AgglayerConfig,
    bridge_admin: &mut TestClient,
    ger_manager: &mut TestClient,
    user: &mut TestClient,
) -> Result<CoreAccountIds> {
    println!("[setup] Loading core accounts");
    println!("[setup]   bridge admin:  {}", config.bridge_admin_id());
    println!("[setup]   GER manager:   {}", config.ger_manager_id());
    println!("[setup]   bridge:        {}", config.bridge_id());

    config.import_account(config.bridge_admin_id(), bridge_admin).await?;
    config.import_account(config.ger_manager_id(), ger_manager).await?;

    for client in [&mut *bridge_admin, &mut *ger_manager, &mut *user] {
        config.import_account(config.bridge_id(), client).await?;
    }

    Ok((config.bridge_admin_id(), config.ger_manager_id(), config.bridge_id()))
}