From 9062d2112ad5811c9c84d7b3a22e40d47ec615f8 Mon Sep 17 00:00:00 2001 From: apoorvsadana <95699312+apoorvsadana@users.noreply.github.com> Date: Sat, 9 Mar 2024 01:12:43 +0530 Subject: [PATCH] fix ci --- .markdownlint.json | 9 +++++++++ Cargo.toml | 32 +++++++++++++++++------------- README.md | 8 +++++--- taplo/README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++ taplo/taplo.toml | 11 +++++++++++ 5 files changed, 92 insertions(+), 17 deletions(-) create mode 100644 .markdownlint.json create mode 100644 taplo/README.md create mode 100644 taplo/taplo.toml diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 00000000..68e7410c --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,9 @@ +{ + "MD033": false, + "MD041": false, + "MD045": false, + "MD003": false, + "MD013": { + "code_blocks": false + } +} diff --git a/Cargo.toml b/Cargo.toml index 83ac7ef9..b63d871c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,29 +7,33 @@ authors = ["Apoorv Sadana <@apoorvsadana>"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] +alloy = { git = "https://github.com/alloy-rs/alloy", rev = "86027c9bb984f3a12a30ffd2a3c5f2f06595f1d6", features = [ + "providers", + "rpc-client", + "transport-http", +], optional = true } +async-trait = "0.1.77" axum = { version = "0.7.4", features = ["macros"] } axum-macros = "0.4.1" -tokio = { version = "1.36.0", features = ["sync", "macros", "rt-multi-thread"] } -tracing = "0.1.40" -tracing-subscriber = { version = "0.3.18", features = ["env-filter"] } -dotenvy = "0.15.7" -starknet = "0.9.0" color-eyre = "0.6.2" -rstest = "0.18.2" -async-trait = "0.1.77" -alloy = { git = "https://github.com/alloy-rs/alloy", rev = "86027c9bb984f3a12a30ffd2a3c5f2f06595f1d6", features = ["providers", "rpc-client", "transport-http"], optional = true } -reqwest = { version = "0.11.24", optional = true } -url = "2.5.0" -uuid = { version = "1.7.0", features = ["v4", "serde"] } -serde = { version = "1.0.197" } +dotenvy = "0.15.7" futures = "0.3.30" mongodb = { version = "2.8.1", features = ["bson-uuid-1"], optional = true } omniqueue = { version = "0.2.0", optional = true } -thiserror = "1.0.57" +reqwest = { version = "0.11.24", optional = true } +rstest = "0.18.2" +serde = { version = "1.0.197" } serde_json = "1.0.114" +starknet = "0.9.0" +thiserror = "1.0.57" +tokio = { version = "1.36.0", features = ["sync", "macros", "rt-multi-thread"] } +tracing = "0.1.40" +tracing-subscriber = { version = "0.3.18", features = ["env-filter"] } +url = "2.5.0" +uuid = { version = "1.7.0", features = ["v4", "serde"] } [features] default = ["ethereum", "with_mongdb", "with_sqs"] ethereum = ["alloy", "reqwest"] with_mongdb = ["mongodb"] -with_sqs = ["omniqueue"] \ No newline at end of file +with_sqs = ["omniqueue"] diff --git a/README.md b/README.md index 33eb453c..374b3432 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # Madara Orchestrator -The Madara orchestrator is designed to be an additional service which runs in parallel to Madara and handles +The Madara orchestrator is designed to be an additional service which runs in +parallel to Madara and handles 1. publishing data to the respective DA layer 2. running SNOS and submitting jobs to the prover 3. updating the state on Cairo core contracts -As a v1, the orchestrator handles the DA publishing. The architecture for the same is as follows +As a v1, the orchestrator handles the DA publishing. The architecture for the +same is as follows -![orchestrator_da_sequencer_diagram](./docs/orchestrator_da_sequencer_diagram.png) \ No newline at end of file +![orchestrator_da_sequencer_diagram](./docs/orchestrator_da_sequencer_diagram.png) diff --git a/taplo/README.md b/taplo/README.md new file mode 100644 index 00000000..0d097bfc --- /dev/null +++ b/taplo/README.md @@ -0,0 +1,49 @@ +# Taplo + +[Taplo](https://github.com/tamasfe/taplo) is a TOML validator and formatter. It +provides a command-line interface (CLI) for working with TOML files. + +## Installation + +You can install Taplo using either cargo or Yarn or NPM. + +### Cargo + +```bash +cargo install taplo-cli --locked +``` + +### Yarn + +```bash +yarn global add @taplo/cli +``` + +### NPM + +```bash +npm install -g @taplo/cli +``` + +### Usage + +To check your TOML files for formatting issues, use the following command: + +```bash +npx @taplo/cli fmt --config taplo.toml --check +``` + +To format all TOML files in your project, use the following command: + +```bash +npx @taplo/cli fmt --config taplo.toml +``` + +This command will automatically format the TOML files, ensuring consistent and +readable formatting. + +### Configuration + +Taplo allows you to customize the formatting rules by adding configuration +options. You can find the available options and how to use them +[here](https://taplo.tamasfe.dev/configuration/formatter-options.html). diff --git a/taplo/taplo.toml b/taplo/taplo.toml new file mode 100644 index 00000000..e49b6628 --- /dev/null +++ b/taplo/taplo.toml @@ -0,0 +1,11 @@ +include = ["**/*.toml"] +exclude = ["**/bad.toml"] + +[formatting] +align_entries = false + +[[rule]] +keys = ["dependencies"] + +[rule.formatting] +reorder_keys = true