Feat/offline election prediction tool

.dockerignore

@@ -0,0 +1,25 @@
+# Ignore build artifacts and large/generated data to keep the context slim.
+target/*
+!target/release/
+target/release/*
+!target/release/polkadot-staking-miner
+results
+artifacts/tmp
+
+# Git metadata and local configs.
+.git
+.gitignore
+.github
+
+# Editor / OS files.
+*.swp
+*.swo
+*.log
+*.tmp
+.DS_Store
+Thumbs.db
+
+# Docker related.
+Dockerfile.README.md
+docker-compose*
+

Cargo.toml

@@ -3,12 +3,11 @@ name = "polkadot-staking-miner"
 version = "1.8.0"
 authors = ["Parity Technologies <[email protected]>"]
 edition = "2024"
-rust-version = "1.85.0"
+rust-version = "1.88.0"
 license = "GPL-3.0"
 repository = "https://github.com/paritytech/polkadot-staking-miner"
 homepage = "https://www.parity.io/"
 description = "A tool to submit NPoS election solutions for substrate based chains"
-resolver = "2"
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "3.7.5" }
@@ -57,14 +56,17 @@ hyper-util = { version = "0.1.18", features = [
 http-body-util = "0.1.0"
 once_cell = "1.21"
 
+ss58-registry = "1.9"
+
 [dev-dependencies]
 anyhow = "1"
 assert_cmd = "2.1"
 regex = "1"
+tempfile = "3.8"
 
 [features]
 integration-tests = []
 
 [package.metadata.docs.rs]
 default-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs"]

Dockerfile

@@ -1,42 +1,44 @@
-FROM docker.io/library/ubuntu:20.04
+# Runtime image expecting a pre-built binary alongside the Docker build context.
+FROM ubuntu:20.04
 
-# metadata
-ARG VCS_REF
-ARG BUILD_DATE
+# Metadata
+ARG VCS_REF=unknown
+ARG BUILD_DATE=unknown
 
 LABEL io.parity.image.authors="[email protected]" \
-    io.parity.image.vendor="Parity Technologies" \
-    io.parity.image.title="polkadot-staking-miner" \
-    io.parity.image.description="Polkadot staking miner for substrate based chains" \
-    io.parity.image.source="https://github.com/paritytech/polkadot-staking-miner/blob/${VCS_REF}/Dockerfile" \
-    io.parity.image.revision="${VCS_REF}" \
-    io.parity.image.created="${BUILD_DATE}" \
-    io.parity.image.documentation="https://github.com/paritytech/polkadot/"
-
-# show backtraces
-ENV RUST_BACKTRACE 1
-
-# install tools and dependencies
+      io.parity.image.vendor="Parity Technologies" \
+      io.parity.image.title="polkadot-staking-miner" \
+      io.parity.image.description="Polkadot staking miner for substrate based chains" \
+      io.parity.image.source="https://github.com/paritytech/polkadot-staking-miner/blob/${VCS_REF}/Dockerfile" \
+      io.parity.image.revision="${VCS_REF}" \
+      io.parity.image.created="${BUILD_DATE}" \
+      io.parity.image.documentation="https://github.com/paritytech/polkadot/"
+
+# Backtraces & useful defaults
+ENV RUST_BACKTRACE=1 \
+    SEED="" \
+    URI="wss://rpc.polkadot.io" \
+    RUST_LOG="info"
+
+# Install runtime dependencies (libssl1.1 still available on focal)
 RUN apt-get update && \
     DEBIAN_FRONTEND=noninteractive apt-get install -y \
-    libssl1.1 \
-    ca-certificates && \
-    # apt cleanup
+      libssl1.1 \
+      ca-certificates && \
     apt-get autoremove -y && \
     apt-get clean && \
-    find /var/lib/apt/lists/ -type f -not -name lock -delete; \
+    find /var/lib/apt/lists/ -type f -not -name lock -delete && \
     useradd -u 10000 -U -s /bin/sh miner
 
-# add binary to docker image
+# Copy the pre-built binary into the image
 COPY ./polkadot-staking-miner /usr/local/bin
 
-USER miner
+# Create writable workspace and output directories
+RUN mkdir -p /workspace/results /workspace/outputs && \
+    chmod 777 /workspace /workspace/results /workspace/outputs && \
+    /usr/local/bin/polkadot-staking-miner --version
 
-ENV SEED=""
-ENV URI="wss://rpc.polkadot.io"
-ENV RUST_LOG="info"
+WORKDIR /workspace
 
-# check if the binary works in this container
-RUN /usr/local/bin/polkadot-staking-miner --version
-
-ENTRYPOINT [ "/usr/local/bin/polkadot-staking-miner" ]
+ENTRYPOINT ["/usr/local/bin/polkadot-staking-miner"]
+CMD ["--help"]

Dockerfile.README.md

@@ -2,4 +2,70 @@
 
 [GitHub](https://github.com/paritytech/polkadot-staking-miner)
 
-Formerly known as `staking-miner-v2` historical images versions are available in the [hub.docker.com](https://hub.docker.com/r/paritytech/staking-miner-v2)
+Formerly known as `staking-miner-v2` historical images versions are available in the [hub.docker.com](https://hub.docker.com/r/paritytech/staking-miner-v2)
+
+## Using Pre-built Docker Image
+
+### Pull the image from Docker Hub
+
+```bash
+docker pull polkadot-staking-miner
+```
+
+Or if using a specific registry:
+
+```bash
+docker pull <registry>/polkadot-staking-miner:<tag>
+```
+
+### Run prediction with custom file
+
+```bash
+sudo docker run --rm \
+  -v "$(pwd):/workspace" \
+  polkadot-staking-miner \
+  --uri wss://westend-asset-hub-rpc.polkadot.io \
+  predict --custom-file custom.json --desired-validators 1
+```
+
+### Run basic prediction
+
+```bash
+docker run --rm \
+  -v "$(pwd):/workspace" \
+  polkadot-staking-miner \
+  --uri wss://westend-asset-hub-rpc.polkadot.io \
+  predict
+```
+
+## Building Locally
+
+If you need to build the image locally:
+
+```bash
+docker build -t polkadot-staking-miner .
+```
+
+
+
+### Pull the image from Docker Hub
+
+
+sudo docker pull paritytech/staking-miner-v2:latest
+
+### for custom validators
+
+sudo docker run --rm -v "$(pwd):/workspace" paritytech/staking-miner-v2:latest   --uri wss://westend-asset-hub-rpc.polkadot.io   predict --custom-file custom.json --desired-validators 1
+
+
+### for basic prediction
+
+sudo docker run --rm -v "$(pwd):/workspace" paritytech/staking-miner-v2:latest   --uri wss://westend-asset-hub-rpc.polkadot.io   predict
+
+### monitor command
+
+sudo docker run --rm -v "$(pwd):/workspace" paritytech/staking-miner-v2:latest   --uri wss://westend-asset-hub-rpc.polkadot.io  monitor --seed-or-path //Alice
+
+### info commanda
+
+sudo docker run --rm -v "$(pwd):/workspace" paritytech/staking-miner-v2:latest   --uri wss://westend-asset-hub-rpc.polkadot.io   info