Add a tool to reset persistent storage

.github/workflows/build.yml

@@ -66,6 +66,7 @@ jobs:
             target/release/sequencer
             target/release/cli
             target/release/commitment-task
+            target/release/reset-storage
 
   build-arm:
     runs-on: [self-hosted, ARM64]
@@ -101,6 +102,7 @@ jobs:
             target/release/sequencer
             target/release/cli
             target/release/commitment-task
+            target/release/reset-storage
 
   build-dockers:
     runs-on: ubuntu-latest

.github/workflows/build_static.yml

@@ -80,6 +80,7 @@ jobs:
             ${{ env.CARGO_TARGET_DIR }}/${{ env.TARGET_TRIPLET }}/release/sequencer
             ${{ env.CARGO_TARGET_DIR }}/${{ env.TARGET_TRIPLET }}/release/cli
             ${{ env.CARGO_TARGET_DIR }}/${{ env.TARGET_TRIPLET }}/release/commitment-task
+            ${{ env.CARGO_TARGET_DIR }}/${{ env.TARGET_TRIPLET }}/release/reset-storage
 
   static-dockers:
     runs-on: ubuntu-latest

docker/sequencer.Dockerfile

@@ -10,6 +10,9 @@ ENTRYPOINT ["tini", "--"]
 COPY target/$TARGETARCH/release/sequencer /bin/sequencer
 RUN chmod +x /bin/sequencer
 
+COPY target/$TARGETARCH/release/reset-storage /bin/reset-storage
+RUN chmod +x /bin/reset-storage
+
 # Set a path to save the consensus config on startup.
 #
 # Upon restart, the config will be loaded from this file and the node will be able to resume

scripts/build-docker-images

@@ -31,7 +31,7 @@ for ARCH in "amd64" "arm64"; do
       ;;
   esac
   mkdir -p ${WORKDIR}/target/$ARCH/release
-  for binary in "orchestrator" "web-server" "sequencer" "commitment-task"; do
+  for binary in "orchestrator" "web-server" "sequencer" "commitment-task" "reset-storage"; do
     cp -v "${CARGO_TARGET_DIR}/${TARGET}/release/$binary" ${WORKDIR}/target/$ARCH/release
   done
 done

scripts/build-docker-images-native

@@ -71,7 +71,7 @@ cleanup(){
 }
 
 mkdir -p ${WORKDIR}/target/$ARCH/release
-for binary in "orchestrator" "web-server" "sequencer" "commitment-task"; do
+for binary in "orchestrator" "web-server" "sequencer" "commitment-task" "reset-storage"; do
   cp -v "${CARGO_TARGET_DIR}/release/$binary" ${WORKDIR}/target/$ARCH/release
   # Patch the interpreter for running without nix inside the ubuntu based docker image.
   if [ $KERNEL == "linux" ]; then

sequencer/src/api.rs

@@ -4,7 +4,7 @@ use data_source::SubmitDataSource;
 use hotshot::types::SystemContextHandle;
 use hotshot_query_service::data_source::ExtensibleDataSource;
 
-mod data_source;
+pub mod data_source;
 pub mod endpoints;
 pub mod fs;
 pub mod options;

sequencer/src/api/data_source.rs

@@ -9,19 +9,24 @@ use hotshot_query_service::{
     QueryResult,
 };
 
+pub trait DataSourceOptions {
+    type DataSource: SequencerDataSource<Options = Self>;
+    fn reset_storage(&mut self);
+}
+
 /// A data source with sequencer-specific functionality.
 ///
 /// This trait extends the generic [`AvailabilityDataSource`] with some additional data needed to
 /// provided sequencer-specific endpoints.
 #[async_trait]
-pub(crate) trait SequencerDataSource:
+pub trait SequencerDataSource:
     AvailabilityDataSource<SeqTypes>
     + StatusDataSource
     + UpdateDataSource<SeqTypes>
     + VersionedDataSource
     + Sized
 {
-    type Options;
+    type Options: DataSourceOptions<DataSource = Self>;
 
     /// Instantiate a data source from command line options.
     async fn create(opt: Self::Options) -> anyhow::Result<Self>;
@@ -42,7 +47,7 @@ pub(crate) trait SequencerDataSource:
         ID: Into<BlockId<SeqTypes>> + Send + Sync;
 }
 
-pub(crate) trait SubmitDataSource<N: network::Type> {
+pub trait SubmitDataSource<N: network::Type> {
     fn handle(&self) -> &SystemContextHandle<SeqTypes, Node<N>>;
 }
 

sequencer/src/api/options.rs

@@ -1,8 +1,10 @@
 //! Sequencer-specific API options and initialization.
 
 use super::{
-    data_source::SequencerDataSource, endpoints, fs, sql, update::update_loop, AppState, Consensus,
-    NodeIndex, SequencerNode,
+    data_source::{DataSourceOptions, SequencerDataSource},
+    endpoints, fs, sql,
+    update::update_loop,
+    AppState, Consensus, NodeIndex, SequencerNode,
 };
 use crate::network;
 use async_std::{
@@ -190,6 +192,14 @@ pub struct Sql {
     pub reset_store: bool,
 }
 
+impl DataSourceOptions for Sql {
+    type DataSource = sql::DataSource;
+
+    fn reset_storage(&mut self) {
+        self.reset_store = true;
+    }
+}
+
 /// Options for the query API module backed by the file system.
 #[derive(Parser, Clone, Debug)]
 pub struct Fs {
@@ -202,6 +212,14 @@ pub struct Fs {
     pub reset_store: bool,
 }
 
+impl DataSourceOptions for Fs {
+    type DataSource = fs::DataSource;
+
+    fn reset_storage(&mut self) {
+        self.reset_store = true;
+    }
+}
+
 async fn init_with_query_module<N, D>(
     opt: Options,
     mod_opt: D::Options,

sequencer/src/bin/reset-storage.rs

@@ -0,0 +1,34 @@
+use clap::Parser;
+use hotshot_query_service::data_source::VersionedDataSource;
+use sequencer::api::{
+    data_source::{DataSourceOptions, SequencerDataSource},
+    options,
+};
+
+/// Reset the persistent storage of a sequencer.
+///
+/// This will remove all the persistent storage of a sequencer node, effectively resetting it to
+/// its genesis state. Do not run this program while the sequencer is running.
+#[derive(Clone, Debug, Parser)]
+enum Options {
+    /// Reset file system storage.
+    Fs(options::Fs),
+    /// Reset SQL storage.
+    Sql(options::Sql),
+}
+
+#[async_std::main]
+async fn main() -> anyhow::Result<()> {
+    let opt = Options::parse();
+    match opt {
+        Options::Fs(opt) => reset_storage(opt).await,
+        Options::Sql(opt) => reset_storage(opt).await,
+    }
+}
+
+async fn reset_storage<O: DataSourceOptions>(mut opt: O) -> anyhow::Result<()> {
+    opt.reset_storage();
+    let mut ds = O::DataSource::create(opt).await?;
+    ds.commit().await?;
+    Ok(())
+}