Transport Configuration

from syft_flwr.bootstrap import bootstrap

bootstrap(
    flwr_project_dir="./my-project",
    aggregator="server@example.com",
    datasites=["client1@example.com", "client2@example.com"],
    transport="syftbox"
)

from syft_flwr.bootstrap import bootstrap

bootstrap(
    flwr_project_dir="./my-project",
    aggregator="server@example.com",
    datasites=["client1@example.com", "client2@example.com"],
    transport="p2p"
)

# bootstrap.py:119-126
if transport is None:
    if _is_colab():
        transport = "p2p"
        logger.info("Detected Colab environment, using 'p2p' transport")
    else:
        transport = "syftbox"
        logger.info("Using default 'syftbox' transport")

# bootstrap.py:15-22
def _is_colab() -> bool:
    """Check if running in Google Colab."""
    try:
        import google.colab  # noqa: F401
        return True
    except ImportError:
        return False

# rpc/protocol.py
class SyftFlwrRpc(ABC):
    """Protocol for syft-flwr RPC implementations.
    
    This abstraction allows syft-flwr to work with different
    transport mechanisms for sending FL messages:
    - syft_core: syft_rpc (using SyftBox Go Client) with futures database
    - syft_client: P2P File-based RPC via Google Drive sync
    """
    
    @abstractmethod
    def send(
        self,
        to_email: str,
        app_name: str,
        endpoint: str,
        body: bytes,
        encrypt: bool = False,
    ) -> str:
        """Send a message to a recipient."""
        ...
    
    @abstractmethod
    def get_response(self, future_id: str) -> Optional[bytes]:
        """Get response for a future ID."""
        ...
    
    @abstractmethod
    def delete_future(self, future_id: str) -> None:
        """Delete a future after processing its response."""
        ...

# Enable encryption (default)
export SYFT_FLWR_ENCRYPTION_ENABLED=true

# Disable encryption (development only)
export SYFT_FLWR_ENCRYPTION_ENABLED=false

# run_simulation.py:68-130
def _bootstrap_encryption_keys(
    do_clients: list[RDSClient], ds_client: RDSClient
) -> None:
    """Bootstrap the encryption keys for all clients if encryption is enabled."""
    encryption_enabled = (
        os.environ.get(SYFT_FLWR_ENCRYPTION_ENABLED, "true").lower() != "false"
    )
    
    if not encryption_enabled:
        logger.warning("⚠️ Encryption disabled - skipping key bootstrap")
        return
    
    logger.info("🔐 Bootstrapping encryption keys for all participants...")
    
    # Bootstrap server
    server_client = ds_client._syftbox_client
    ensure_bootstrap(server_client)
    
    # Bootstrap each client
    for do_client in do_clients:
        client = do_client._syftbox_client
        ensure_bootstrap(client)
    
    # Verify all DID documents are accessible
    logger.info("🔐 All participants bootstrapped for E2E encryption ✅✅✅")

# Each participant has:
# - Private key: ~/.syftbox/{email}_private_key.pem
# - DID document: ~/datasites/{email}/did.json
#
# DID document contains public key for encryption

from syft_flwr.utils import setup_client

# Automatically detects transport from pyproject.toml
client, encryption_enabled, app_path = setup_client(
    app_name="my-fl-app",
    project_dir="./my-project"
)

# For SyftBox transport:
# - client: syft_core.Client instance
# - encryption_enabled: True (default)
# - app_path: "flwr/my-fl-app"

# Same API, different behavior based on transport config
client, encryption_enabled, app_path = setup_client(
    app_name="my-fl-app",
    project_dir="./my-project"
)

# For P2P transport:
# - client: SyftP2PClient instance
# - encryption_enabled: False
# - app_path: "flwr/my-fl-app"

# Originally bootstrapped with SyftBox
syft_flwr bootstrap ./my-project -a server@example.com -d client@example.com

# To switch to P2P:
rm ./my-project/main.py  # Remove generated file
syft_flwr bootstrap ./my-project \
  -a server@example.com \
  -d client@example.com \
  --transport p2p  # Explicitly set transport

# pyproject.toml now has:
# [tool.syft_flwr]
# transport = "p2p"

# rpc/factory.py:41-42
else:
    raise TypeError(f"Unknown client type: {type(native_client)}")

⚠️ Encryption disabled - skipping client key bootstrap
⚠️ End-to-end encryption is DISABLED for FL messages

# Ensure SyftBox is installed
which syftbox

# Check SyftBox is running
syftbox status

# Verify cloud storage is mounted
ls ~/Google\ Drive/
ls ~/OneDrive/

# Check sync status
# (varies by provider)