global: one big snapshot

crates/brk_error/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "brk_error"
+description = "Errors used throughout the Bitcoin Research Kit"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+
+[dependencies]
+brk_vecs = { workspace = true }
+bitcoincore-rpc = { workspace = true }
+fjall = { workspace = true }
+jiff = { workspace = true }
+minreq = { workspace = true }
+zerocopy = { workspace = true }

crates/brk_error/README.md

@@ -0,0 +1,28 @@
+# BRK Core
+
+<p align="left">
+  <a href="https://github.com/bitcoinresearchkit/brk">
+    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/bitcoinresearchkit/brk?style=social">
+  </a>
+  <a href="https://github.com/bitcoinresearchkit/brk/blob/main/LICENSE.md">
+    <img src="https://img.shields.io/crates/l/brk" alt="License" />
+  </a>
+  <a href="https://crates.io/crates/brk_structs">
+    <img src="https://img.shields.io/crates/v/brk_structs" alt="Version" />
+  </a>
+  <a href="https://docs.rs/brk_structs">
+    <img src="https://img.shields.io/docsrs/brk_structs" alt="Documentation" />
+  </a>
+  <img src="https://img.shields.io/crates/size/brk_structs" alt="Size" />
+  <a href="https://deps.rs/crate/brk_structs">
+    <img src="https://deps.rs/crate/brk_structs/latest/status.svg" alt="Dependency status">
+  </a>
+  <a href="https://discord.gg/HaR3wpH3nr">
+    <img src="https://img.shields.io/discord/1350431684562124850?label=discord" alt="Discord" />
+  </a>
+  <a href="https://primal.net/p/nprofile1qqsfw5dacngjlahye34krvgz7u0yghhjgk7gxzl5ptm9v6n2y3sn03sqxu2e6">
+    <img src="https://img.shields.io/badge/nostr-purple?link=https%3A%2F%2Fprimal.net%2Fp%2Fnprofile1qqsfw5dacngjlahye34krvgz7u0yghhjgk7gxzl5ptm9v6n2y3sn03sqxu2e6" alt="Nostr" />
+  </a>
+</p>
+
+A list of structs that are used throughout the project as units, think of `Date`, `Height`, `Sats`, `Txindex` or anything that can be either a key and/or a value of a dataset.

crates/brk_error/src/lib.rs

@@ -0,0 +1,105 @@
+use std::{
+    fmt::{self, Debug},
+    io, result, time,
+};
+
+pub type Result<T, E = Error> = result::Result<T, E>;
+
+#[derive(Debug)]
+pub enum Error {
+    IO(io::Error),
+    BitcoinRPC(bitcoincore_rpc::Error),
+    Jiff(jiff::Error),
+    Fjall(fjall::Error),
+    Minreq(minreq::Error),
+    SystemTimeError(time::SystemTimeError),
+    ZeroCopyError,
+    Vecs(brk_vecs::Error),
+
+    WrongLength,
+    WrongAddressType,
+    UnindexableDate,
+    Str(&'static str),
+    String(String),
+}
+
+impl From<time::SystemTimeError> for Error {
+    fn from(value: time::SystemTimeError) -> Self {
+        Self::SystemTimeError(value)
+    }
+}
+
+impl From<io::Error> for Error {
+    fn from(value: io::Error) -> Self {
+        Self::IO(value)
+    }
+}
+
+impl From<bitcoincore_rpc::Error> for Error {
+    fn from(value: bitcoincore_rpc::Error) -> Self {
+        Self::BitcoinRPC(value)
+    }
+}
+
+impl From<minreq::Error> for Error {
+    fn from(value: minreq::Error) -> Self {
+        Self::Minreq(value)
+    }
+}
+
+impl From<brk_vecs::Error> for Error {
+    fn from(value: brk_vecs::Error) -> Self {
+        Self::Vecs(value)
+    }
+}
+
+impl From<jiff::Error> for Error {
+    fn from(value: jiff::Error) -> Self {
+        Self::Jiff(value)
+    }
+}
+
+impl From<fjall::Error> for Error {
+    fn from(value: fjall::Error) -> Self {
+        Self::Fjall(value)
+    }
+}
+
+impl<A, B, C> From<zerocopy::error::ConvertError<A, B, C>> for Error {
+    fn from(_: zerocopy::error::ConvertError<A, B, C>) -> Self {
+        Self::ZeroCopyError
+    }
+}
+
+impl<A, B> From<zerocopy::error::SizeError<A, B>> for Error {
+    fn from(_: zerocopy::error::SizeError<A, B>) -> Self {
+        Self::ZeroCopyError
+    }
+}
+
+impl fmt::Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match self {
+            Error::IO(error) => Debug::fmt(&error, f),
+            Error::Minreq(error) => Debug::fmt(&error, f),
+            Error::Vecs(error) => Debug::fmt(&error, f),
+            Error::BitcoinRPC(error) => Debug::fmt(&error, f),
+            Error::SystemTimeError(error) => Debug::fmt(&error, f),
+            Error::Jiff(error) => Debug::fmt(&error, f),
+            Error::Fjall(error) => Debug::fmt(&error, f),
+            Error::ZeroCopyError => write!(f, "ZeroCopy error"),
+
+            Error::WrongLength => write!(f, "Wrong length"),
+            Error::WrongAddressType => write!(f, "Wrong address type"),
+            Error::UnindexableDate => write!(
+                f,
+                "Date cannot be indexed, must be 2009-01-03, 2009-01-09 or greater"
+            ),
+
+            Error::Str(s) => write!(f, "{s}"),
+            Error::String(s) => write!(f, "{s}"),
+        }
+    }
+}
+
+impl std::error::Error for Error {}