Struct EphemeralTestnet 

pub struct EphemeralTestnet {
    pub testnet: Testnet,
}

A simple testnet with random ports assigned for all components.

Components included:

• A local DHT with bootstrapping nodes.
• A homeserver (default pubkey: 8pinxxgqs41n4aididenw5apqp1urfmzdztr8jt4abrkdn435ewo).
• An HTTP relay (optional, use .with_http_relay() to enable).

Recommended Usage

Use EphemeralTestnet::builder() to create a testnet with explicit configuration:

// Minimal testnet (admin/metrics disabled) - fastest for most tests
let testnet = EphemeralTestnet::builder().build().await?;

// Full-featured testnet (admin enabled) - for tests requiring admin API
let testnet = EphemeralTestnet::builder()
    .config(ConfigToml::default_test_config())
    .build()
    .await?;

Configuration Defaults

• [EphemeralTestnet::builder().build()] uses ConfigToml::minimal_test_config() (admin/metrics disabled)
• Deprecated EphemeralTestnet::start() uses ConfigToml::default_test_config() (admin enabled)

Fields

testnet: Testnet

Inner flexible testnet.

Implementations

impl EphemeralTestnet

pub fn builder() -> EphemeralTestnetBuilder

Create a new builder for configuring the testnet.

This is the recommended way to create a testnet with custom configuration.

Example

let testnet = EphemeralTestnet::builder()
    .config(ConfigToml::default_test_config())
    .keypair(Keypair::random())
    .build()
    .await?;

pub async fn start() -> Result<Self>

👎Deprecated since 0.5.0:

Use EphemeralTestnet::builder().config(ConfigToml::default_test_config()).build() for explicit behavior

Run a new simple testnet with full config (admin enabled).

Deprecated

Use Self::builder() for explicit configuration control. This method uses ConfigToml::default_test_config() which enables the admin server.

pub async fn start_with_custom_postgres( postgres_connection_string: ConnectionString, ) -> Result<Self>

👎Deprecated since 0.5.0:

Use EphemeralTestnet::builder().postgres(…).config(ConfigToml::default_test_config()).build() instead

Run a new simple testnet with custom postgres and full config (admin enabled).

Deprecated

Use Self::builder() with .postgres() for explicit configuration control.

pub async fn start_minimal_with_custom_postgres( postgres_connection_string: ConnectionString, ) -> Result<Self>

👎Deprecated since 0.5.0:

Use Testnet::new_with_custom_postgres() and create_http_relay() for fine-grained control

Run a new simple testnet with custom postgres but no homeserver (minimal setup).

Deprecated

Use Testnet directly for fine-grained control over component creation.

pub async fn start_minimal() -> Result<Self>

👎Deprecated since 0.5.0:

Use Testnet::new() and create_http_relay() for fine-grained control

Run a new simple testnet network with a minimal setup (no homeserver).

Deprecated

Use Testnet directly for fine-grained control over component creation.

pub async fn create_random_homeserver(&mut self) -> Result<&HomeserverApp>

Create an additional homeserver with a random keypair.

pub async fn create_random_homeserver_with_config( &mut self, config: Option<ConfigToml>, ) -> Result<&HomeserverApp>

Create an additional homeserver with a random keypair and custom config. Uses minimal_test_config() by default (admin/metrics disabled).

pub fn client_builder(&self) -> PubkyHttpClientBuilder

Create a new pubky client builder.

pub fn client(&self) -> Result<PubkyHttpClient, BuildError>

Creates a pubky::PubkyHttpClient pre-configured to use this test network.

pub fn sdk(&self) -> Result<Pubky, BuildError>

Creates a pubky::Pubky SDK facade pre-configured to use this test network.

This is a convenience method that builds a client from Self::client_builder.

pub fn pkarr_client_builder(&self) -> ClientBuilder

Create a new pkarr client builder.

pub fn homeserver_app(&self) -> &HomeserverApp

Get the homeserver in the testnet.

pub fn http_relay(&self) -> &HttpRelay

Get the http relay in the testnet.