Merge branch 'remote_dev' into dev

ikripaka · ikripaka · commit 416f5bff0a8a · 2025-11-05T09:04:12.000+02:00
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,28 @@
+name: Bug Report
+description: File a bug report
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: version
+    attributes:
+      label: "Project version"
+      placeholder: "1.2.3"
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A brief description of what happened and what you expected to happen
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: "Minimal reproduction steps"
+      description: "The minimal steps needed to reproduce the bug"
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,11 @@
+name: Feature request
+description: Suggest a new feature
+labels: ['feature']
+body:
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: "Describe the feature"
+      description: "A description of what you would like to see in the project"
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/other-issue.md b/.github/ISSUE_TEMPLATE/other-issue.md
@@ -0,0 +1,4 @@
+---
+name: Other issue
+about: Other kind of issue
+---
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,48 @@
+name: Linting Checks and Tests
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint-and-test:
+    name: Lint and Test (Ubuntu)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Rust toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          components: clippy, rustfmt
+
+      - name: Cache cargo registry, git and target
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-
+
+      - name: Run Rust fmt
+        run: cargo fmt --all --check
+
+      - name: Run clippy
+        run: cargo clippy --workspace --all-targets --all-features -- -D warnings
+
+      - name: Run tests
+        run: cargo test --workspace --all-features --locked --no-fail-fast
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,41 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# Ignoring .js files, as typescript firstly compiles into it
+/tests/*.js
+
+# Disable logs that have obtained during run
+/logs
+*.log
+.env
+
+# RustRover
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+.vscode/
+
+# frontend code
+node_modules/
+dist/
+
+# Mac OSX temporary files
+.DS_Store
+**/.DS_Store
+
+# Logs
+logs/*
diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,41 @@
+[workspace]
+resolver = "3"
+members = [
+    "nostr_options_cli",
+    "crates/*"
+]
+
+[workspace.package]
+version = "0.1.0"
+edition = "2024"
+rust-version = "1.91.0"
+authors = ["Blockstream"]
+readme = "README.md"
+
+
+[workspace.dependencies]
+anyhow = { version = "1.0.100" }
+clap = { version = "4.5.49", features = ["derive"] }
+config = { version = "0.15.16", default-features = true }
+dotenvy = { version = "0.15" }
+global_utils = { path = "./crates/global_utils" }
+hex = { version = "0.4.3" }
+itertools = { version = "0.14.0" }
+reqwest = { version = "0.12.23", features = ["blocking", "json"] }
+ring = { version = "0.17.14" }
+serde = { version = "1.0.228", features = ["derive"] }
+serde_json = { version = "1.0.145" }
+sha2 = { version = "0.10.9", features = ["compress"] }
+simplicity-lang = { version = "0.5.0" }
+simplicityhl = { version = "0.2.0", features = ["serde"] }
+simplicityhl-core = { version = "0.1.1" }
+state_change_types = { path = "./crates/state_change_types" }
+thiserror = { version = "2.0.17" }
+tracing = { version = "0.1.41" }
+tracing-appender = { version = "0.2.3" }
+tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
+nostr = { version = "0.43.1" }
+tokio-tungstenite = { version = "0.28.0", features = ["native-tls"] }
+futures-util = "0.3.31"
+tokio = {version =  "1.48.0", features = ["full"] }
+
diff --git a/Makefile b/Makefile
@@ -0,0 +1,27 @@
+## This help screen
+help:
+	@printf "Available targets:\n\n"
+	@awk '/^[a-zA-Z\-\_0-9%:\\]+/ { \
+          helpMessage = match(lastLine, /^## (.*)/); \
+          if (helpMessage) { \
+            helpCommand = $$1; \
+            helpMessage = substr(lastLine, RSTART + 3, RLENGTH); \
+      gsub("\\\\", "", helpCommand); \
+      gsub(":+$$", "", helpCommand); \
+            printf "  \x1b[32;01m%-35s\x1b[0m %s\n", helpCommand, helpMessage; \
+          } \
+        } \
+        { lastLine = $$0 }' $(MAKEFILE_LIST) | sort -u
+	@printf "\n"
+
+## Format code
+fmt:
+	cargo +nightly fmt --all
+
+## Show lints
+clippy:
+	cargo clippy -- -Dclippy::pedantic
+
+## Show lints for all features
+clippy_all_features:
+	cargo clippy --workspace --all-targets --all-features -- -D warnings
diff --git a/crates/global_utils/Cargo.toml b/crates/global_utils/Cargo.toml
@@ -0,0 +1,13 @@
+[package]
+name = "global_utils"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+authors.workspace = true
+readme.workspace = true
+
+[dependencies]
+thiserror = { workspace = true }
+tracing = { workspace = true }
+tracing-appender = { workspace = true }
+tracing-subscriber = { workspace = true }
diff --git a/crates/global_utils/src/env_parser.rs b/crates/global_utils/src/env_parser.rs
@@ -0,0 +1,24 @@
+use std::env::VarError;
+use thiserror::Error;
+use tracing::instrument;
+
+#[derive(Debug, Error)]
+pub enum EnvParserError {
+    #[error("Failed to parse env variable {missing_var_name}, err: {err}, check if it exists and is valid")]
+    ConfigEnvParseError { missing_var_name: String, err: VarError },
+}
+
+pub trait EnvParser {
+    const ENV_NAME: &'static str;
+    fn obtain_env_value() -> Result<String, EnvParserError> {
+        obtain_env_value(Self::ENV_NAME)
+    }
+}
+
+#[instrument(level = "trace", skip(name), fields(name = name.as_ref()), ret)]
+pub fn obtain_env_value(name: impl AsRef<str>) -> Result<String, EnvParserError> {
+    std::env::var(name.as_ref()).map_err(|err| EnvParserError::ConfigEnvParseError {
+        missing_var_name: name.as_ref().to_string(),
+        err,
+    })
+}
diff --git a/crates/global_utils/src/lib.rs b/crates/global_utils/src/lib.rs
@@ -0,0 +1,2 @@
+pub mod env_parser;
+pub mod logger;
diff --git a/crates/global_utils/src/logger.rs b/crates/global_utils/src/logger.rs
@@ -0,0 +1,38 @@
+use std::io;
+
+use tracing::{level_filters::LevelFilter, trace};
+use tracing_appender::non_blocking::WorkerGuard;
+use tracing_subscriber::{EnvFilter, Layer, fmt, layer::SubscriberExt, util::SubscriberInitExt};
+
+#[derive(Debug)]
+pub struct LoggerGuard {
+    _std_out_guard: WorkerGuard,
+    _std_err_guard: WorkerGuard,
+}
+
+pub fn init_logger() -> LoggerGuard {
+    let (std_out_writer, std_out_guard) = tracing_appender::non_blocking(io::stdout());
+    let (std_err_writer, std_err_guard) = tracing_appender::non_blocking(io::stderr());
+    let std_out_layer = fmt::layer()
+        .with_writer(std_out_writer)
+        .with_target(false)
+        .with_level(true)
+        .with_filter(EnvFilter::try_from_default_env().unwrap_or(EnvFilter::new("TRACE")));
+
+    let std_err_layer = fmt::layer()
+        .with_writer(std_err_writer)
+        .with_target(false)
+        .with_level(true)
+        .with_filter(LevelFilter::WARN);
+
+    tracing_subscriber::registry()
+        .with(std_out_layer)
+        .with(std_err_layer)
+        .init();
+
+    trace!("Logger successfully initialized!");
+    LoggerGuard {
+        _std_out_guard: std_out_guard,
+        _std_err_guard: std_err_guard,
+    }
+}
diff --git a/crates/nostr_relay_processor/Cargo.toml b/crates/nostr_relay_processor/Cargo.toml
@@ -0,0 +1,10 @@
+[package]
+name = "nostr_relay_processor"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+authors.workspace = true
+readme.workspace = true
+
+[dependencies]
+anyhow = { workspace = true }
diff --git a/crates/nostr_relay_processor/src/handlers.rs b/crates/nostr_relay_processor/src/handlers.rs
@@ -0,0 +1,3 @@
+pub(crate) mod list_orders;
+pub(crate) mod place_order;
+pub(crate) mod reply_order;
diff --git a/crates/nostr_relay_processor/src/handlers/list_orders.rs b/crates/nostr_relay_processor/src/handlers/list_orders.rs
@@ -0,0 +1,4 @@
+#[warn(unused)]
+pub fn handle() -> anyhow::Result<()> {
+    Ok(())
+}
diff --git a/crates/nostr_relay_processor/src/handlers/place_order.rs b/crates/nostr_relay_processor/src/handlers/place_order.rs
@@ -0,0 +1,4 @@
+#[allow(unused)]
+pub fn handle() -> anyhow::Result<()> {
+    Ok(())
+}
diff --git a/crates/nostr_relay_processor/src/handlers/reply_order.rs b/crates/nostr_relay_processor/src/handlers/reply_order.rs
@@ -0,0 +1,4 @@
+#[warn(unused)]
+pub fn handle() -> anyhow::Result<()> {
+    Ok(())
+}
diff --git a/crates/nostr_relay_processor/src/lib.rs b/crates/nostr_relay_processor/src/lib.rs
@@ -0,0 +1,2 @@
+mod handlers;
+mod relay_processor;
diff --git a/crates/nostr_relay_processor/src/relay_processor.rs b/crates/nostr_relay_processor/src/relay_processor.rs
@@ -0,0 +1,29 @@
+use crate::handlers;
+
+#[allow(unused)]
+pub struct RelayProcessor {}
+
+impl RelayProcessor {
+    #[allow(unused)]
+    pub fn new() -> Self {
+        Self {}
+    }
+
+    #[allow(unused)]
+    pub fn place_order() -> anyhow::Result<()> {
+        handlers::place_order::handle()?;
+        Ok(())
+    }
+
+    #[allow(unused)]
+    pub fn list_order() -> anyhow::Result<()> {
+        handlers::list_orders::handle()?;
+        Ok(())
+    }
+
+    #[allow(unused)]
+    pub fn reply_order() -> anyhow::Result<()> {
+        handlers::reply_order::handle()?;
+        Ok(())
+    }
+}
diff --git a/docs/maker_taker_flow.puml b/docs/maker_taker_flow.puml
@@ -0,0 +1,21 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+autonumber
+
+== Order matching ==
+
+Maker -> LiquidNetwork: Create Option
+Maker -> NostrRelay: Place order
+Taker --> NostrRelay: Sync data
+Taker --> Taker: Check available Option
+Taker -> LiquidNetwork: Make transaction to fund Maker's order
+Taker -> NostrRelay: Place own respond ack on the Maker's order
+
+== After 30 days ==
+
+Taker <--> PriceOracle: Obtain information \n about current token price
+Taker -> LiquidNetwork: Execute Option
+Maker <--> PriceOracle: Obtain information \n about current token price
+Maker -> LiquidNetwork: Execute Option
+@enduml
diff --git a/nostr_options_cli/Cargo.toml b/nostr_options_cli/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "nostr_options_cli"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+nostr = { workspace = true }
+global_utils = { workspace = true }
+tokio-tungstenite = { workspace = true }
+futures-util = { workspace = true }
+serde_json = { workspace = true }
+tokio = { workspace = true }
diff --git a/nostr_options_cli/src/main.rs b/nostr_options_cli/src/main.rs
@@ -0,0 +1,9 @@
+use global_utils::logger::init_logger;
+use nostr::prelude::*;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let _logger_guard = init_logger();
+
+    Ok(())
+}
diff --git a/rustfmt.toml b/rustfmt.toml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +---
 +name: Other issue
 +about: Other kind of issue
 +---
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+pub mod env_parser;`
	`2`	`+pub mod logger;`