Skip to content

chore: Move bind URLs to sockets #2054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sergerad wants to merge 8 commits into
base: next
Choose a base branch
from
Open

chore: Move bind URLs to sockets #2054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c5586f7
Move bind URLs to ports
sergerad May 6, 2026
d00f9c5
Lint and changelog
sergerad May 6, 2026
6d5ce36
Update compose usage.md and run-node.sh
sergerad May 6, 2026
7c7ca09
Merge branch 'next' of github.com:0xMiden/miden-node into sergerad-bi…
sergerad May 7, 2026
9ec725c
Move to socket env / args
sergerad May 7, 2026
ebe76f8
RM option for ntx builder arg
sergerad May 7, 2026
6e7227d
Reword changelog
sergerad May 7, 2026
25d7472
Update run script
sergerad May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- Added `StoreReplica` gRPC service with endpoints for streaming blocks and proofs ([#1987](https://github.com/0xMiden/node/pull/1987)).
- Replaced the network monitor's JavaScript dashboard with a server-rendered Maud + HTMX frontend ([#2024](https://github.com/0xMiden/node/pull/2024)).
- [BREAKING] Removed `CheckNullifiers` endpoint ([#2049](https://github.com/0xMiden/node/pull/2049)).
- [BREAKING] Replaced binding URL env vars and CLI flags with sockets ([#2054](https://github.com/0xMiden/node/pull/2054)).

## v0.14.10 (2026-05-29)

Expand Down
14 changes: 7 additions & 7 deletions bin/node/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ MIDEN_NODE_ENABLE_OTEL=true
MIDEN_NODE_DATA_DIRECTORY=

# Block Producer
MIDEN_NODE_BLOCK_PRODUCER_URL=
MIDEN_NODE_BLOCK_PRODUCER_SOCKET=
MIDEN_NODE_BLOCK_PRODUCER_STORE_URL=
MIDEN_NODE_BLOCK_PRODUCER_VALIDATOR_URL=
MIDEN_NODE_BLOCK_PRODUCER_MAX_TXS_PER_BATCH=
Expand All @@ -15,27 +15,27 @@ MIDEN_NODE_BLOCK_PRODUCER_MEMPOOL_TX_CAPACITY=
MIDEN_NODE_BLOCK_PRODUCER_BATCH_PROVER_URL=

# Store
MIDEN_NODE_STORE_RPC_URL=
MIDEN_NODE_STORE_RPC_SOCKET=
MIDEN_NODE_STORE_UPSTREAM_RPC_URL=
MIDEN_NODE_STORE_NTX_BUILDER_URL=
MIDEN_NODE_STORE_BLOCK_PRODUCER_URL=
MIDEN_NODE_STORE_NTX_BUILDER_SOCKET=
MIDEN_NODE_STORE_BLOCK_PRODUCER_SOCKET=
MIDEN_NODE_STORE_BLOCK_PROVER_URL=

# RPC
MIDEN_NODE_RPC_URL=http://0.0.0.0:57291
MIDEN_NODE_RPC_SOCKET=0.0.0.0:57291
MIDEN_NODE_RPC_STORE_URL=
MIDEN_NODE_RPC_BLOCK_PRODUCER_URL=
MIDEN_NODE_RPC_VALIDATOR_URL=
MIDEN_NODE_RPC_NTX_BUILDER_URL=

# Validator
MIDEN_NODE_VALIDATOR_URL=
MIDEN_NODE_VALIDATOR_SOCKET=
MIDEN_NODE_VALIDATOR_GENESIS_CONFIG_FILE=
MIDEN_NODE_VALIDATOR_KEY=
MIDEN_NODE_VALIDATOR_KMS_KEY_ID=

# NTX Builder
MIDEN_NODE_NTX_BUILDER_URL=
MIDEN_NODE_NTX_BUILDER_SOCKET=
MIDEN_NODE_NTX_BUILDER_STORE_URL=
MIDEN_NODE_NTX_BUILDER_BLOCK_PRODUCER_URL=
MIDEN_NODE_NTX_BUILDER_VALIDATOR_URL=
Expand Down
19 changes: 9 additions & 10 deletions bin/node/src/commands/block_producer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use std::net::SocketAddr;
use std::num::NonZeroUsize;
use std::time::Duration;

Expand All @@ -10,12 +11,11 @@ use miden_node_block_producer::{
DEFAULT_MAX_TXS_PER_BATCH,
};
use miden_node_utils::clap::{GrpcOptionsInternal, duration_to_human_readable_string};
use miden_node_utils::grpc::UrlExt;
use url::Url;

use super::ENV_ENABLE_OTEL;

const ENV_URL: &str = "MIDEN_NODE_BLOCK_PRODUCER_URL";
const ENV_SOCKET: &str = "MIDEN_NODE_BLOCK_PRODUCER_SOCKET";
const ENV_STORE_URL: &str = "MIDEN_NODE_BLOCK_PRODUCER_STORE_URL";
const ENV_VALIDATOR_URL: &str = "MIDEN_NODE_BLOCK_PRODUCER_VALIDATOR_URL";
const ENV_MAX_TXS_PER_BATCH: &str = "MIDEN_NODE_BLOCK_PRODUCER_MAX_TXS_PER_BATCH";
Expand All @@ -30,9 +30,9 @@ const ENV_BATCH_PROVER_URL: &str = "MIDEN_NODE_BLOCK_PRODUCER_BATCH_PROVER_URL";
pub enum BlockProducerCommand {
/// Starts the block-producer component.
Start {
/// Url at which to serve the gRPC API.
#[arg(env = ENV_URL)]
url: Url,
/// Socket address at which to serve the gRPC API.
#[arg(long = "socket", env = ENV_SOCKET, value_name = "SOCKET")]
socket: SocketAddr,
Copy link
Copy Markdown
Collaborator

@Mirko-von-Leipzig Mirko-von-Leipzig May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: socket naming feels a bit awkward because a socket is what you get after binding to this host+port.

This shouldn't hold up the PR, but some alternatives

--endpoint <ENDPOINT>
--listen <ENDPOINT>

Copy link
Copy Markdown
Collaborator Author

@sergerad sergerad May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its short for socket address

Copy link
Copy Markdown
Collaborator

@Mirko-von-Leipzig Mirko-von-Leipzig May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand that, but that isn't something I've seen used before in a CLI, and socket already has a meaning so having it be shortened from something else isn't great.

Copy link
Copy Markdown
Collaborator Author

@sergerad sergerad May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think --socket or --listen are clearest

Copy link
Copy Markdown
Collaborator

@Mirko-von-Leipzig Mirko-von-Leipzig May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See what --listen looks like and then make a call 👍 (endpoint makes more sense as the client I think).


/// The store's block-producer service gRPC url.
#[arg(long = "store.url", env = ENV_STORE_URL)]
Expand Down Expand Up @@ -60,16 +60,15 @@ pub enum BlockProducerCommand {
impl BlockProducerCommand {
pub async fn handle(self) -> anyhow::Result<()> {
let Self::Start {
url,
socket,
store_url,
validator_url,
block_producer,
enable_otel: _,
grpc_options,
} = self;

let block_producer_address =
url.to_socket().context("Failed to extract socket address from store URL")?;
let block_producer_address = socket;

// Runtime validation for protocol constraints
if block_producer.max_batches_per_block > miden_protocol::MAX_BATCHES_PER_BLOCK {
Expand Down Expand Up @@ -123,7 +122,7 @@ mod tests {
#[tokio::test]
async fn rejects_too_large_max_batches_per_block() {
let cmd = BlockProducerCommand::Start {
url: dummy_url(),
socket: "0.0.0.0:1234".parse().unwrap(),
Copy link
Copy Markdown
Collaborator

@Mirko-von-Leipzig Mirko-von-Leipzig May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe these should be localhost with an arbitrary port?

Suggested change
socket: "0.0.0.0:1234".parse().unwrap(),
socket: "[::1]:0".parse().unwrap(),

store_url: dummy_url(),
validator_url: dummy_url(),
block_producer: BlockProducerConfig {
Expand All @@ -146,7 +145,7 @@ mod tests {
#[tokio::test]
async fn rejects_too_large_max_txs_per_batch() {
let cmd = BlockProducerCommand::Start {
url: dummy_url(),
socket: "0.0.0.0:1234".parse().unwrap(),
store_url: dummy_url(),
validator_url: dummy_url(),
block_producer: BlockProducerConfig {
Expand Down
27 changes: 9 additions & 18 deletions bin/node/src/commands/ntx_builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
use std::net::SocketAddr;
use std::num::NonZeroUsize;
use std::path::PathBuf;
use std::time::Duration;

use anyhow::Context;
use miden_node_utils::clap::duration_to_human_readable_string;
use miden_node_utils::grpc::UrlExt;
use tokio::net::TcpListener;
use url::Url;

use super::ENV_ENABLE_OTEL;
use crate::commands::ENV_DATA_DIRECTORY;

const ENV_URL: &str = "MIDEN_NODE_NTX_BUILDER_URL";
const ENV_SOCKET: &str = "MIDEN_NODE_NTX_BUILDER_SOCKET";
const ENV_STORE_URL: &str = "MIDEN_NODE_NTX_BUILDER_STORE_URL";
const ENV_BLOCK_PRODUCER_URL: &str = "MIDEN_NODE_NTX_BUILDER_BLOCK_PRODUCER_URL";
const ENV_VALIDATOR_URL: &str = "MIDEN_NODE_NTX_BUILDER_VALIDATOR_URL";
Expand All @@ -27,9 +27,9 @@ const DEFAULT_MAX_CYCLES: u32 = 1 << 18;
pub enum NtxBuilderCommand {
/// Starts the network transaction builder component.
Start {
/// Url at which to serve the ntx-builder's gRPC API.
#[arg(long = "url", env = ENV_URL, value_name = "URL")]
url: Option<Url>,
/// Socket address at which to serve the ntx-builder's gRPC API.
#[arg(long = "socket", env = ENV_SOCKET, value_name = "SOCKET")]
socket: SocketAddr,

/// The store's ntx-builder service gRPC url.
#[arg(long = "store.url", env = ENV_STORE_URL, value_name = "URL")]
Expand Down Expand Up @@ -105,7 +105,7 @@ pub enum NtxBuilderCommand {
impl NtxBuilderCommand {
pub async fn handle(self) -> anyhow::Result<()> {
let Self::Start {
url,
socket,
store_url,
block_producer_url,
validator_url,
Expand All @@ -118,18 +118,9 @@ impl NtxBuilderCommand {
enable_otel: _,
} = self;

let listener = if let Some(url) = url {
let addr = url
.to_socket()
.context("Failed to extract socket address from ntx-builder URL")?;
Some(
TcpListener::bind(addr)
.await
.context("Failed to bind to ntx-builder's gRPC URL")?,
)
} else {
None
};
let listener = TcpListener::bind(socket)
.await
.context("Failed to bind to ntx-builder's gRPC socket")?;

let database_filepath = data_directory.join("ntx-builder.sqlite3");

Expand Down
18 changes: 9 additions & 9 deletions bin/node/src/commands/rpc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
use std::net::SocketAddr;

use anyhow::Context;
use miden_node_rpc::Rpc;
use miden_node_utils::clap::GrpcOptionsExternal;
use miden_node_utils::grpc::UrlExt;
use url::Url;

use super::ENV_ENABLE_OTEL;

const ENV_URL: &str = "MIDEN_NODE_RPC_URL";
const ENV_SOCKET: &str = "MIDEN_NODE_RPC_SOCKET";
const ENV_STORE_URL: &str = "MIDEN_NODE_RPC_STORE_URL";
const ENV_BLOCK_PRODUCER_URL: &str = "MIDEN_NODE_RPC_BLOCK_PRODUCER_URL";
const ENV_VALIDATOR_URL: &str = "MIDEN_NODE_RPC_VALIDATOR_URL";
Expand All @@ -16,9 +17,9 @@ const ENV_NTX_BUILDER_URL: &str = "MIDEN_NODE_RPC_NTX_BUILDER_URL";
pub enum RpcCommand {
/// Starts the RPC component.
Start {
/// Url at which to serve the gRPC API.
#[arg(long = "url", env = ENV_URL, value_name = "URL")]
url: Url,
/// Socket address at which to serve the gRPC API.
#[arg(long = "socket", env = ENV_SOCKET, value_name = "SOCKET")]
socket: SocketAddr,

/// The store's RPC service gRPC url.
#[arg(long = "store.url", env = ENV_STORE_URL, value_name = "URL")]
Expand Down Expand Up @@ -52,7 +53,7 @@ pub enum RpcCommand {
impl RpcCommand {
pub async fn handle(self) -> anyhow::Result<()> {
let Self::Start {
url,
socket,
store_url,
block_producer_url,
validator_url,
Expand All @@ -61,10 +62,9 @@ impl RpcCommand {
grpc_options,
} = self;

let listener = url.to_socket().context("Failed to extract socket address from RPC URL")?;
let listener = tokio::net::TcpListener::bind(listener)
let listener = tokio::net::TcpListener::bind(socket)
.await
.context("Failed to bind to RPC's gRPC URL")?;
.context("Failed to bind to RPC's gRPC socket")?;

Rpc {
listener,
Expand Down
Loading
Loading