self_agent_sdk/

agent.rs

// SPDX-FileCopyrightText: 2025-2026 Social Connect Labs, Inc.
// SPDX-License-Identifier: BUSL-1.1
// NOTE: Converts to Apache-2.0 on 2029-06-11 per LICENSE.

use alloy::primitives::{keccak256, Address, B256, FixedBytes, U256};
use alloy::providers::ProviderBuilder;
use alloy::signers::local::PrivateKeySigner;
use alloy::signers::Signer;
use reqwest::{Client, Method, RequestBuilder, Response};
use std::collections::HashMap;
use std::time::{SystemTime, UNIX_EPOCH};

use crate::agent_card::{
    Erc8004AgentDocument, AgentSkill, CardCredentials, SelfProtocolExtension, TrustModel,
    Erc8004Service, AgentInterface,
    get_provider_label,
};
use crate::constants::{
    headers, network_config, IAgentRegistry, IHumanProofProvider, NetworkName, DEFAULT_NETWORK,
};
use crate::registration_flow::{
    DeregistrationRequest, DeregistrationSession, RegistrationError, RegistrationRequest,
    RegistrationSession, DEFAULT_API_BASE,
};

/// Configuration for creating a [`SelfAgent`].
#[derive(Debug, Clone)]
pub struct SelfAgentConfig {
    /// Agent's private key (hex, with or without 0x prefix).
    pub private_key: String,
    /// Network to use: Mainnet (default) or Testnet.
    pub network: Option<NetworkName>,
    /// Override: custom registry address (takes precedence over network).
    pub registry_address: Option<Address>,
    /// Override: custom RPC URL (takes precedence over network).
    pub rpc_url: Option<String>,
}

/// Full agent info from the registry.
#[derive(Debug, Clone)]
pub struct AgentInfo {
    pub address: Address,
    pub agent_key: B256,
    pub agent_id: U256,
    pub is_verified: bool,
    pub nullifier: U256,
    pub agent_count: U256,
}

/// Agent-side SDK for Self Agent ID.
///
/// The agent's on-chain identity is its Ethereum address, zero-padded to bytes32.
/// For off-chain authentication, the agent signs each request with its private key.
pub struct SelfAgent {
    signer: PrivateKeySigner,
    private_key: String,
    network_name: NetworkName,
    registry_address: Address,
    rpc_url: String,
    agent_key: B256,
    http_client: Client,
}

impl SelfAgent {
    /// Create a new agent instance.
    pub fn new(config: SelfAgentConfig) -> Result<Self, crate::Error> {
        let network_name = config.network.unwrap_or(DEFAULT_NETWORK);
        let net = network_config(network_name);
        let signer: PrivateKeySigner = config
            .private_key
            .parse()
            .map_err(|_| crate::Error::InvalidPrivateKey)?;
        let agent_key = address_to_agent_key(signer.address());

        Ok(Self {
            signer,
            private_key: config.private_key,
            network_name,
            registry_address: config.registry_address.unwrap_or(net.registry_address),
            rpc_url: config.rpc_url.unwrap_or_else(|| net.rpc_url.to_string()),
            agent_key,
            http_client: Client::new(),
        })
    }

    /// The agent's Ethereum address.
    pub fn address(&self) -> Address {
        self.signer.address()
    }

    /// The agent's on-chain key (bytes32) — zero-padded address.
    pub fn agent_key(&self) -> B256 {
        self.agent_key
    }

    fn make_provider(
        &self,
    ) -> Result<impl alloy::providers::Provider + Clone, crate::Error> {
        let url: reqwest::Url = self
            .rpc_url
            .parse()
            .map_err(|_| crate::Error::InvalidRpcUrl)?;
        Ok(ProviderBuilder::new().connect_http(url))
    }

    /// Create a provider with wallet attached — required for write operations.
    fn make_signer_provider(
        &self,
    ) -> Result<impl alloy::providers::Provider + Clone, crate::Error> {
        let url: reqwest::Url = self
            .rpc_url
            .parse()
            .map_err(|_| crate::Error::InvalidRpcUrl)?;
        let wallet = alloy::network::EthereumWallet::from(self.signer.clone());
        Ok(ProviderBuilder::new().wallet(wallet).connect_http(url))
    }

    /// Check if this agent is registered and verified on-chain.
    pub async fn is_registered(&self) -> Result<bool, crate::Error> {
        let provider = self.make_provider()?;
        let registry = IAgentRegistry::new(self.registry_address, provider);
        let result = registry
            .isVerifiedAgent(self.agent_key)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        Ok(result)
    }

    /// Get full agent info from the registry.
    pub async fn get_info(&self) -> Result<AgentInfo, crate::Error> {
        let provider = self.make_provider()?;
        let registry = IAgentRegistry::new(self.registry_address, provider);

        let agent_id = registry
            .getAgentId(self.agent_key)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;

        if agent_id == U256::ZERO {
            return Ok(AgentInfo {
                address: self.signer.address(),
                agent_key: self.agent_key,
                agent_id: U256::ZERO,
                is_verified: false,
                nullifier: U256::ZERO,
                agent_count: U256::ZERO,
            });
        }

        let is_verified = registry
            .hasHumanProof(agent_id)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        let nullifier = registry
            .getHumanNullifier(agent_id)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        let agent_count = registry
            .getAgentCountForHuman(nullifier)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;

        Ok(AgentInfo {
            address: self.signer.address(),
            agent_key: self.agent_key,
            agent_id,
            is_verified,
            nullifier,
            agent_count,
        })
    }

    /// Generate authentication headers for a request.
    ///
    /// Signature covers: `keccak256(timestamp + METHOD + canonicalPathAndQuery + bodyHash)`
    pub async fn sign_request(
        &self,
        method: &str,
        url: &str,
        body: Option<&str>,
    ) -> Result<HashMap<String, String>, crate::Error> {
        let timestamp = now_millis().to_string();
        self.sign_request_with_timestamp(method, url, body, &timestamp)
            .await
    }

    /// Sign a request with a specific timestamp (useful for testing).
    pub async fn sign_request_with_timestamp(
        &self,
        method: &str,
        url: &str,
        body: Option<&str>,
        timestamp: &str,
    ) -> Result<HashMap<String, String>, crate::Error> {
        let message = compute_signing_message(timestamp, method, url, body);

        // EIP-191 personal_sign over the raw 32 bytes
        let signature = self
            .signer
            .sign_message(message.as_ref())
            .await
            .map_err(|e| crate::Error::SigningError(e.to_string()))?;

        let sig_hex = format!("0x{}", hex::encode(signature.as_bytes()));

        let mut headers_map = HashMap::new();
        headers_map.insert(
            headers::ADDRESS.to_string(),
            format!("{:#x}", self.signer.address()),
        );
        headers_map.insert(headers::SIGNATURE.to_string(), sig_hex);
        headers_map.insert(headers::TIMESTAMP.to_string(), timestamp.to_string());

        Ok(headers_map)
    }

    /// Wrapper around reqwest that automatically adds agent signature headers.
    pub async fn fetch(
        &self,
        url: &str,
        method: Option<Method>,
        body: Option<String>,
    ) -> Result<Response, crate::Error> {
        let method = method.unwrap_or(Method::GET);
        let method_str = method.as_str();
        let body_ref = body.as_deref();

        let auth_headers = self.sign_request(method_str, url, body_ref).await?;

        let mut request: RequestBuilder = self.http_client.request(method, url);
        for (k, v) in &auth_headers {
            request = request.header(k, v);
        }
        if let Some(b) = body {
            request = request.header("content-type", "application/json");
            request = request.body(b);
        }

        request
            .send()
            .await
            .map_err(|e| crate::Error::HttpError(e.to_string()))
    }

    // ─── A2A Agent Card Methods ────────────────────────────────────────────

    /// Read the agent card from on-chain metadata (if set).
    /// Supports both the new ERC-8004 format and legacy A2A v0.1 cards.
    pub async fn get_agent_card(&self) -> Result<Option<Erc8004AgentDocument>, crate::Error> {
        let provider = self.make_provider()?;
        let registry = IAgentRegistry::new(self.registry_address, provider);

        let agent_id = registry
            .getAgentId(self.agent_key)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        if agent_id == U256::ZERO {
            return Ok(None);
        }

        let raw = registry
            .getAgentMetadata(agent_id)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        if raw.is_empty() {
            return Ok(None);
        }

        match serde_json::from_str::<Erc8004AgentDocument>(&raw) {
            Ok(card) => Ok(Some(card)),
            _ => Ok(None),
        }
    }

    /// Build and write an A2A Agent Card to on-chain metadata.
    /// Returns the transaction hash.
    pub async fn set_agent_card(
        &self,
        name: String,
        description: Option<String>,
        url: Option<String>,
        skills: Option<Vec<AgentSkill>>,
    ) -> Result<B256, crate::Error> {
        let provider = self.make_signer_provider()?;
        let registry = IAgentRegistry::new(self.registry_address, &provider);

        let agent_id = registry
            .getAgentId(self.agent_key)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        if agent_id == U256::ZERO {
            return Err(crate::Error::RpcError("Agent not registered".into()));
        }

        let proof_provider_addr = registry
            .getProofProvider(agent_id)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        if proof_provider_addr == Address::ZERO {
            return Err(crate::Error::RpcError(
                "Agent has no proof provider — cannot build card".into(),
            ));
        }

        let proof_provider =
            IHumanProofProvider::new(proof_provider_addr, &provider);

        let provider_name = proof_provider
            .providerName()
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        let strength = proof_provider
            .verificationStrength()
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;

        let credentials = registry
            .getAgentCredentials(agent_id)
            .call()
            .await
            .ok();

        let proof_type = get_provider_label(strength).to_string();

        let mut trust_model = TrustModel {
            proof_type,
            sybil_resistant: true,
            ofac_screened: false,
            minimum_age_verified: 0,
        };

        let card_credentials = credentials.map(|creds| {
            let older_than = creds.olderThan.try_into().unwrap_or(0u64);
            let ofac_screened = creds.ofac.first().copied().unwrap_or(false);
            trust_model.ofac_screened = ofac_screened;
            trust_model.minimum_age_verified = older_than;

            CardCredentials {
                nationality: non_empty(&creds.nationality),
                issuing_state: non_empty(&creds.issuingState),
                older_than: if older_than > 0 { Some(older_than) } else { None },
                ofac_clean: if ofac_screened { Some(true) } else { None },
                has_name: if !creds.name.is_empty() { Some(true) } else { None },
                has_date_of_birth: non_empty(&creds.dateOfBirth).map(|_| true),
                has_gender: non_empty(&creds.gender).map(|_| true),
                document_expiry: non_empty(&creds.expiryDate),
            }
        });

        let chain_id: u64 = alloy::providers::Provider::get_chain_id(&provider)
            .await
            .map_err(|e: alloy::transports::RpcError<alloy::transports::TransportErrorKind>| crate::Error::RpcError(e.to_string()))?;

        // Build services and supportedInterfaces if a URL is provided
        let mut services = Vec::new();
        let mut supported_interfaces = None;
        if let Some(ref agent_url) = url {
            services.push(Erc8004Service {
                name: "A2A".to_string(),
                endpoint: agent_url.clone(),
                version: Some("0.3.0".to_string()),
            });
            supported_interfaces = Some(vec![AgentInterface {
                url: agent_url.clone(),
                protocol_binding: "JSONRPC".to_string(),
                protocol_version: "0.3.0".to_string(),
            }]);
        }

        let card = Erc8004AgentDocument {
            doc_type: "https://eips.ethereum.org/EIPS/eip-8004#registration-v1".to_string(),
            name,
            description: description.unwrap_or_default(),
            image: String::new(),
            services,
            active: None,
            registrations: None,
            supported_trust: None,
            version: None,
            url,
            provider: None,
            capabilities: None,
            security_schemes: None,
            security: None,
            default_input_modes: None,
            default_output_modes: None,
            supported_interfaces,
            icon_url: None,
            documentation_url: None,
            signatures: None,
            extensions: None,
            self_protocol: Some(SelfProtocolExtension {
                agent_id: agent_id.try_into().unwrap_or(0),
                registry: format!("{:#x}", self.registry_address),
                chain_id,
                proof_provider: format!("{:#x}", proof_provider_addr),
                provider_name,
                verification_strength: strength,
                trust_model,
                credentials: card_credentials,
            }),
            skills,
        };

        let json =
            serde_json::to_string(&card).map_err(|e| crate::Error::RpcError(e.to_string()))?;

        let tx_hash = registry
            .updateAgentMetadata(agent_id, json)
            .send()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?
            .watch()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;

        Ok(tx_hash)
    }

    /// Returns a `data:` URI containing the base64-encoded Agent Card JSON.
    pub async fn to_agent_card_data_uri(&self) -> Result<String, crate::Error> {
        let card = self
            .get_agent_card()
            .await?
            .ok_or_else(|| crate::Error::RpcError("No A2A Agent Card set".into()))?;
        let json =
            serde_json::to_string(&card).map_err(|e| crate::Error::RpcError(e.to_string()))?;
        use base64::Engine;
        let encoded = base64::engine::general_purpose::STANDARD.encode(json.as_bytes());
        Ok(format!("data:application/json;base64,{}", encoded))
    }

    /// Read ZK-attested credentials for this agent from on-chain.
    pub async fn get_credentials(
        &self,
    ) -> Result<Option<IAgentRegistry::AgentCredentials>, crate::Error> {
        let provider = self.make_provider()?;
        let registry = IAgentRegistry::new(self.registry_address, provider);

        let agent_id = registry
            .getAgentId(self.agent_key)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        if agent_id == U256::ZERO {
            return Ok(None);
        }

        let creds = registry
            .getAgentCredentials(agent_id)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        Ok(Some(creds))
    }

    /// Read the verification strength score from the provider contract.
    pub async fn get_verification_strength(&self) -> Result<u8, crate::Error> {
        let provider = self.make_provider()?;
        let registry = IAgentRegistry::new(self.registry_address, &provider);

        let agent_id = registry
            .getAgentId(self.agent_key)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        if agent_id == U256::ZERO {
            return Ok(0);
        }

        let provider_addr = registry
            .getProofProvider(agent_id)
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        if provider_addr == Address::ZERO {
            return Ok(0);
        }

        let proof_provider = IHumanProofProvider::new(provider_addr, &provider);
        let strength = proof_provider
            .verificationStrength()
            .call()
            .await
            .map_err(|e| crate::Error::RpcError(e.to_string()))?;
        Ok(strength)
    }

    // ─── Registration / Deregistration (REST API) ────────────────────────

    /// Initiate agent registration via the REST API.
    ///
    /// Returns a [`RegistrationSession`] with a QR code URL and deep link
    /// that the human operator must scan with the Self app.
    pub async fn request_registration(
        req: RegistrationRequest,
        api_base: Option<&str>,
    ) -> Result<RegistrationSession, RegistrationError> {
        RegistrationSession::request(req, api_base).await
    }

    /// Query agent info via the REST API (no private key needed).
    pub async fn get_agent_info_rest(
        agent_id: u64,
        network: NetworkName,
        api_base: Option<&str>,
    ) -> Result<serde_json::Value, RegistrationError> {
        let base = api_base.unwrap_or(DEFAULT_API_BASE);
        let chain_id: u64 = match network {
            NetworkName::Mainnet => 42220,
            NetworkName::Testnet => 11142220,
        };
        let resp = reqwest::get(format!("{base}/api/agent/info/{chain_id}/{agent_id}"))
            .await
            .map_err(|e| RegistrationError::Http(e.to_string()))?;
        resp.json()
            .await
            .map_err(|e| RegistrationError::Http(e.to_string()))
    }

    /// Query all agents registered to a human address via the REST API.
    pub async fn get_agents_for_human(
        address: &str,
        network: NetworkName,
        api_base: Option<&str>,
    ) -> Result<serde_json::Value, RegistrationError> {
        let base = api_base.unwrap_or(DEFAULT_API_BASE);
        let chain_id: u64 = match network {
            NetworkName::Mainnet => 42220,
            NetworkName::Testnet => 11142220,
        };
        let resp = reqwest::get(format!("{base}/api/agent/agents/{chain_id}/{address}"))
            .await
            .map_err(|e| RegistrationError::Http(e.to_string()))?;
        resp.json()
            .await
            .map_err(|e| RegistrationError::Http(e.to_string()))
    }

    /// Initiate deregistration for this agent via the REST API.
    ///
    /// Returns a [`DeregistrationSession`] with a QR code URL that the
    /// human operator must scan with the Self app to confirm removal.
    pub async fn request_deregistration(
        &self,
        api_base: Option<&str>,
    ) -> Result<DeregistrationSession, RegistrationError> {
        let network_str = match self.network_name {
            NetworkName::Mainnet => "mainnet",
            NetworkName::Testnet => "testnet",
        };
        DeregistrationSession::request(
            DeregistrationRequest {
                network: network_str.to_string(),
                agent_address: format!("{:#x}", self.signer.address()),
            },
            api_base,
        )
        .await
    }
}

/// Convert a 20-byte address to a 32-byte agent key (left zero-padded).
/// Matches TS: `ethers.zeroPadValue(address, 32)`
pub fn address_to_agent_key(address: Address) -> B256 {
    let mut bytes = [0u8; 32];
    bytes[12..32].copy_from_slice(address.as_ref());
    FixedBytes(bytes)
}

/// Current time in milliseconds since Unix epoch.
fn now_millis() -> u64 {
    SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap()
        .as_millis() as u64
}

/// Returns `Some(s)` if non-empty, `None` otherwise.
fn non_empty(s: &str) -> Option<String> {
    if s.is_empty() {
        None
    } else {
        Some(s.to_string())
    }
}

/// Compute the signing message from request components.
/// Exposed for use by the verifier.
pub(crate) fn compute_signing_message(
    timestamp: &str,
    method: &str,
    url: &str,
    body: Option<&str>,
) -> B256 {
    let canonical_url = canonicalize_signing_url(url);
    let body_text = body.unwrap_or("");
    let body_hash = keccak256(body_text.as_bytes());
    let body_hash_hex = format!("{:#x}", body_hash);
    let concat = format!(
        "{}{}{}{}",
        timestamp,
        method.to_uppercase(),
        canonical_url,
        body_hash_hex
    );
    keccak256(concat.as_bytes())
}

/// Canonical URL for signing/verification: path + optional query string.
pub(crate) fn canonicalize_signing_url(url: &str) -> String {
    if url.is_empty() {
        return String::new();
    }

    if url.starts_with("http://") || url.starts_with("https://") {
        if let Ok(parsed) = reqwest::Url::parse(url) {
            let mut out = parsed.path().to_string();
            if out.is_empty() {
                out.push('/');
            }
            if let Some(query) = parsed.query() {
                out.push('?');
                out.push_str(query);
            }
            return out;
        }
        return url.to_string();
    }

    if url.starts_with('?') {
        return format!("/{url}");
    }
    if url.starts_with('/') {
        return url.to_string();
    }

    // Best effort for inputs like "api/data?x=1"
    if let Ok(parsed) = reqwest::Url::parse(&format!("http://self.local/{url}")) {
        let mut out = parsed.path().to_string();
        if let Some(query) = parsed.query() {
            out.push('?');
            out.push_str(query);
        }
        return out;
    }

    url.to_string()
}