Merge pull request #688 from pragma-org/jeluard/cargo-release

chore: prepare for amaru release

Author: jeluard

.github/check-license-header.config.json

@@ -5,6 +5,9 @@
             "examples/**/*.rs",
             "simulation/**/*.rs"
         ],
+        "exclude": [
+            "crates/vendor/**"
+        ],
         "license": ".github/license-Apache-2.0.template.rs"
     },
     {

.github/workflows/release.yml

@@ -231,6 +231,23 @@ jobs:
         run: |
           docker buildx imagetools inspect ${{ env.DOCKER_IMAGE }}:${{ steps.meta.outputs.version }}
 
+  cargo-publish:
+    name: Publish crates to crates.io
+    runs-on: ubuntu-latest
+    if: ${{ github.ref_type == 'tag' }}
+    needs: rust-build
+    environment: crates-io
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Publish crates
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        run: cargo release publish --workspace --no-confirm
+
   merge-artifacts:
     name: Merge build artifacts
 

Cargo.lock

@@ -7,10 +7,13 @@ authors = ["Amaru Maintainers <amaru@pragma.builders>"]
 repository = "https://github.com/pragma-org/amaru"
 homepage = "https://github.com/pragma-org/amaru"
 documentation = "https://docs.rs/amaru"
+keywords = ["cardano", "blockchain", "node", "ouroboros", "crypto"]
+categories = ["cryptography::cryptocurrencies"]
 rust-version = "1.93"                                    # ⚠️ Also change in rust-toolchain.toml
 
 [workspace]
-members = ["crates/*", "simulation/*"]
+members = ["crates/*", "crates/amaru-observability/macros/", "crates/vendor/*", "simulation/*"]
+exclude = ["crates/vendor"]
 default-members = ["crates/*"]
 resolver = "2"
 
@@ -113,8 +116,10 @@ pure-stage = { path = "crates/pure-stage" }
 uplc-turbo = { git = "https://github.com/pragma-org/uplc" }
 
 # The vrf crate has not been fully tested in production environments and still has several upstream issues that are open PRs but not merged yet.
-vrf_dalek = { git = "https://github.com/txpipe/vrf", rev = "044b45a1a919ba9d9c2471fc5c4d441f13086676" }
-kes-summed-ed25519 = { git = "https://github.com/txpipe/kes", rev = "f69fb357d46f6a18925543d785850059569d7e78" }
+vrf_dalek = { package = "amaru-vrf-dalek", path = "crates/vendor/amaru-vrf-dalek", version = "0.1.0" }
+kes-summed-ed25519 = { package = "amaru-kes-summed-ed25519", path = "crates/vendor/amaru-kes-summed-ed25519", version = "0.2.1" }
+# curve25519-dalek fork used by vrf_dalek (txpipe/curve25519-dalek@70a36f41, branch ietf03_vrf_compat_ell2)
+amaru-curve25519-dalek = { package = "amaru-curve25519-dalek", path = "crates/vendor/amaru-curve25519-dalek", version = "3.2.0" }
 
 # dev-dependencies
 assertables = "9.8.2"

Cargo.toml

@@ -4,13 +4,16 @@ lints.workspace = true
 name = "amaru-consensus"
 version.workspace = true
 edition.workspace = true
-description.workspace = true
+description = "Consensus engine for the Amaru Cardano node"
 license.workspace = true
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true
 documentation.workspace = true
+readme = "README.md"
 rust-version.workspace = true
+keywords.workspace = true
+categories.workspace = true
 
 [features]
 default = []

crates/amaru-consensus/Cargo.toml

@@ -4,13 +4,16 @@ lints.workspace = true
 name = "amaru-iter-borrow"
 version.workspace = true
 edition.workspace = true
-description.workspace = true
+description = "Iterator adaptor supporting mutable borrowing of elements"
 license.workspace = true
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true
 documentation.workspace = true
+readme = "../../README.md"
 rust-version.workspace = true
+keywords.workspace = true
+categories.workspace = true
 
 [dependencies]
 minicbor.workspace = true

crates/amaru-iter-borrow/Cargo.toml

@@ -4,13 +4,16 @@ lints.workspace = true
 name = "amaru-kernel"
 version.workspace = true
 edition.workspace = true
-description.workspace = true
+description = "Core Cardano types, primitives, and domain logic for the Amaru Cardano node"
 license.workspace = true
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true
 documentation.workspace = true
+readme = "../../README.md"
 rust-version.workspace = true
+keywords.workspace = true
+categories.workspace = true
 
 [features]
 default = []

crates/amaru-kernel/Cargo.toml

@@ -4,13 +4,16 @@ lints.workspace = true
 name = "amaru-ledger"
 version.workspace = true
 edition.workspace = true
-description.workspace = true
+description = "Ledger engine for the Amaru Cardano node"
 license.workspace = true
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true
 documentation.workspace = true
+readme = "README.md"
 rust-version.workspace = true
+keywords.workspace = true
+categories.workspace = true
 
 [features]
 default = []

crates/amaru-ledger/Cargo.toml

@@ -2,13 +2,16 @@
 name = "amaru-mempool"
 version.workspace = true
 edition.workspace = true
-description.workspace = true
+description = "Transaction mempool for the Amaru Cardano node"
 license.workspace = true
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true
 documentation.workspace = true
+readme = "../../README.md"
 rust-version.workspace = true
+keywords.workspace = true
+categories.workspace = true
 
 [dependencies]
 amaru-kernel.workspace = true

crates/amaru-mempool/Cargo.toml

@@ -5,13 +5,16 @@ lints.workspace = true
 name = "amaru-metrics"
 version.workspace = true
 edition.workspace = true
-description.workspace = true
+description = "Metrics collection and telemetry primitives for the Amaru Cardano node"
 license.workspace = true
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true
 documentation.workspace = true
+readme = "README.md"
 rust-version.workspace = true
+keywords.workspace = true
+categories.workspace = true
 
 [dependencies]
 # External Dependencies