Merge branch 'main' into fix-ledger-api-doc

minikin · web-flow · commit fe1c757d4659 · 2022-12-15T12:13:38.000+01:00
diff --git a/.github/workflows/nix.yml b/.github/workflows/nix.yml
@@ -0,0 +1,105 @@
+name: Nix CI
+
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/nix.yml'
+      - 'nix/**'
+      - 'src/**'
+      - 'Cargo.*'
+      - 'flake.*'
+  push:
+    branches:
+      - main
+    paths:
+      - '.github/workflows/nix.yml'
+      - 'nix/**'
+      - 'src/**'
+      - 'Cargo.*'
+      - 'flake.*'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  discover:
+    outputs:
+      hits: ${{ steps.discovery.outputs.hits }}
+      nix_conf: ${{ steps.discovery.outputs.nix_conf }}
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}
+    steps:
+      - name: Standard Discovery
+        uses: divnix/std-action/discover@main
+        id: discovery
+  publish-containers:
+    needs: discover
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ fromJSON(needs.discover.outputs.hits).containers.publish }}
+    name: ${{ matrix.target.cell }} - ${{ matrix.target.name }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          config="$HOME/.docker/config.json"
+          mkdir -p "${config%/*}"
+          jq -n --arg token "${{ secrets.DOCKER_AUTH_TOKEN }}" '{ "auths": { "registry.ci.iog.io": { auth: $token } } }' > "$config"
+          chmod 0600 "$config"
+      - uses: divnix/std-action/run@main
+        with:
+          extra_nix_config: |
+            ${{ needs.discover.outputs.nix_conf }}
+          json: ${{ toJSON(matrix.target) }}
+          nix_key: ${{ secrets.NIX_SIGNING_KEY }}
+          s3_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          s3_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          cache: s3://iog-catalyst-cache?region=eu-central-1
+  build-packages:
+    if: always()
+    needs:
+      - discover
+      - publish-containers
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ fromJSON(needs.discover.outputs.hits).packages.build }}
+    name: ${{ matrix.target.cell }} - ${{ matrix.target.name }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: divnix/std-action/run@main
+        with:
+          extra_nix_config: |
+            ${{ needs.discover.outputs.nix_conf }}
+          json: ${{ toJSON(matrix.target) }}
+          nix_key: ${{ secrets.NIX_SIGNING_KEY }}
+          s3_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          s3_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          cache: s3://iog-catalyst-cache?region=eu-central-1
+  build-devshells:
+    if: always()
+    needs:
+      - discover
+      - publish-containers
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ fromJSON(needs.discover.outputs.hits).devshells.build }}
+    name: ${{ matrix.target.cell }} - ${{ matrix.target.name }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: divnix/std-action/run@main
+        with:
+          extra_nix_config: |
+            ${{ needs.discover.outputs.nix_conf }}
+          json: ${{ toJSON(matrix.target) }}
+          nix_key: ${{ secrets.NIX_SIGNING_KEY }}
+          s3_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          s3_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          cache: s3://iog-catalyst-cache?region=eu-central-1
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -31,14 +31,14 @@
       cellsFrom = ./nix;
 
       cellBlocks = [
-        (std.blockTypes.containers "containers")
-        (std.blockTypes.devshells "devshells")
+        (std.blockTypes.containers "containers" {ci.publish = true;})
+        (std.blockTypes.devshells "devshells" {ci.build = true;})
         (std.blockTypes.functions "constants")
         (std.blockTypes.functions "lib")
         (std.blockTypes.functions "toolchains")
         (std.blockTypes.installables "artifacts")
         (std.blockTypes.installables "libraries")
-        (std.blockTypes.installables "packages")
+        (std.blockTypes.installables "packages" {ci.build = true;})
         (std.blockTypes.nixago "configs")
         (std.blockTypes.runnables "operables")
       ];
diff --git a/src/chain-libs/chain-storage/src/lib.rs b/src/chain-libs/chain-storage/src/lib.rs
@@ -41,7 +41,7 @@
 //! __fig.1 - note that root does not actually exist, this is an ID referredby__
 //! __the first block in the chain__
 //!
-//! ```ignore
+//! ```text
 //! +---------+       +---------+
 //! |         |       |         |
 //! | Block 4 |       | Block 4'|
@@ -104,7 +104,7 @@
 //!
 //! __fig. 2 - permanent storage structure__
 //!
-//! ```ignore
+//! ```text
 //! store                  block no. index
 //!
 //! +--------------+       +-------------+
@@ -128,7 +128,7 @@
 //!
 //! # Storage directory layout
 //!
-//! ```ignore
+//! ```text
 //! store
 //! ├── permanent       - permanent storage directory
 //! │   └── flatfile    - storage file that can be transferred over the network
diff --git a/src/chain-libs/chain-time/src/lib.rs b/src/chain-libs/chain-time/src/lib.rs
@@ -1,3 +1,5 @@
+// #![warn(clippy::all)]
+// #![deny(missing_docs)]
 pub mod era;
 pub mod timeframe;
 pub mod timeline;
diff --git a/src/chain-libs/chain-time/src/timeframe.rs b/src/chain-libs/chain-time/src/timeframe.rs
@@ -1,3 +1,6 @@
+//! Timeframe
+//!
+
 use crate::timeline::Timeline;
 use std::time::{Duration, SystemTime};
 
diff --git a/src/chain-wallet-libs/bindings/wallet-core/src/wallet.rs b/src/chain-wallet-libs/bindings/wallet-core/src/wallet.rs
@@ -35,7 +35,7 @@ impl Wallet {
     /// Retrieve a wallet from a key used as utxo's
     ///
     /// You can also use this function to recover a wallet even after you have
-    /// transferred all the funds to the new format (see the [Self::convert] function).
+    /// transferred all the funds to the new format
     ///
     /// Parameters
     ///
diff --git a/src/chain-wallet-libs/chain-path-derivation/src/bip44.rs b/src/chain-wallet-libs/chain-path-derivation/src/bip44.rs
@@ -107,7 +107,7 @@ impl DerivationPath<Bip44<Root>> {
     /// use the same "model" of 5 derivation level but instead of starting with the
     /// bip44 Hard Derivation uses the `'1852` (`'0x073C`) derivation path.
     ///
-    /// see https://input-output-hk.github.io/adrestia/docs/key-concepts/hierarchical-deterministic-wallets/
+    /// see <https://input-output-hk.github.io/adrestia/docs/key-concepts/hierarchical-deterministic-wallets/>
     ///
     pub fn chimeric(&self) -> DerivationPath<Bip44<Purpose>> {
         let mut p = self.clone();
diff --git a/src/jormungandr/jcli/src/jcli_lib/utils/output_format.rs b/src/jormungandr/jcli/src/jcli_lib/utils/output_format.rs
@@ -8,7 +8,7 @@ use thiserror::Error;
 pub struct OutputFormat {
     /// Format of output data. Possible values: json, yaml.
     /// Any other value is treated as a custom format using values from output data structure.
-    /// Syntax is Go text template: https://golang.org/pkg/text/template/.
+    /// Syntax is Go text template: <https://golang.org/pkg/text/template/>.
     #[structopt(long = "output-format", default_value = "yaml", parse(from_str))]
     format: FormatVariant,
 }
diff --git a/src/jormungandr/jormungandr-lib/src/crypto/key.rs b/src/jormungandr/jormungandr-lib/src/crypto/key.rs
@@ -168,7 +168,7 @@ impl<A: AsymmetricPublicKey> Identifier<A> {
     /// encode the `Identifier` into an hexadecimal string
     ///
     /// While this is still a human readable format. it is lesser than
-    /// the output of [`to_bech32_str`] as it does not provide user input
+    /// the output of [`Self::to_bech32_str`] as it does not provide user input
     /// verification.
     ///
     /// `Display` implementation of `Identifier` provides the hexadecimal string support.
diff --git a/src/jormungandr/testing/mjolnir/src/mjolnir_lib/bootstrap/mod.rs b/src/jormungandr/testing/mjolnir/src/mjolnir_lib/bootstrap/mod.rs
@@ -28,18 +28,18 @@ pub struct ClientLoadCommand {
     #[structopt(short = "a", long = "address")]
     pub address: String,
 
-    /// amount of delay [seconds] between sync attempts
+    /// amount of delay (in seconds) between sync attempts
     #[structopt(short = "p", long = "pace", default_value = "2")]
     pub pace: u64,
 
     #[structopt(short = "d", long = "storage")]
     pub initial_storage: Option<PathBuf>,
 
-    /// amount of delay [seconds] between sync attempts
+    /// amount of delay (in seconds) between sync attempts
     #[structopt(short = "r", long = "duration")]
     pub duration: Option<u64>,
 
-    /// amount of delay [seconds] between sync attempts
+    /// amount of delay (in seconds) between sync attempts
     #[structopt(short = "n", long = "iterations")]
     pub sync_iteration: Option<u32>,
 
diff --git a/src/jormungandr/testing/mjolnir/src/mjolnir_lib/explorer.rs b/src/jormungandr/testing/mjolnir/src/mjolnir_lib/explorer.rs
@@ -24,7 +24,7 @@ pub struct ExplorerLoadCommand {
     #[structopt(short = "e", long = "endpoint")]
     pub endpoint: String,
 
-    /// Amount of delay [milliseconds] between sync attempts
+    /// Amount of delay (in milliseconds) between sync attempts
     #[structopt(long = "delay", default_value = "50")]
     pub delay: u64,
 
diff --git a/src/jormungandr/testing/mjolnir/src/mjolnir_lib/rest.rs b/src/jormungandr/testing/mjolnir/src/mjolnir_lib/rest.rs
@@ -24,11 +24,11 @@ pub struct RestLoadCommand {
     #[structopt(short = "e", long = "endpoint")]
     pub endpoint: String,
 
-    /// Amount of delay [milliseconds] between sync attempts
+    /// Amount of delay (in milliseconds) between sync attempts
     #[structopt(long = "delay", default_value = "50")]
     pub delay: u64,
 
-    /// Amount of delay [seconds] between sync attempts
+    /// Amount of delay (in seconds) between sync attempts
     #[structopt(short = "d", long = "duration")]
     pub duration: u64,
 
diff --git a/src/vit-testing/iapyx/src/bin/load/burst/count.rs b/src/vit-testing/iapyx/src/bin/load/burst/count.rs
@@ -16,7 +16,7 @@ pub struct BurstCountIapyxLoadCommand {
     #[structopt(short = "a", long = "address", default_value = "127.0.0.1:8000")]
     pub address: String,
 
-    /// Amount of delay [miliseconds] between requests
+    /// Amount of delay (in miliseconds) between requests
     #[structopt(short = "d", long = "delay", default_value = "10000")]
     pub delay: u64,
 
diff --git a/src/vit-testing/iapyx/src/bin/load/burst/duration.rs b/src/vit-testing/iapyx/src/bin/load/burst/duration.rs
@@ -18,7 +18,7 @@ pub struct BurstDurationIapyxLoadCommand {
     #[structopt(short = "a", long = "address", default_value = "127.0.0.1:8000")]
     pub address: String,
 
-    /// Amount of delay [miliseconds] between requests
+    /// Amount of delay (in miliseconds) between requests
     #[structopt(short = "d", long = "delay", default_value = "10000")]
     pub delay: u64,
 
diff --git a/src/vit-testing/iapyx/src/bin/load/constant/count.rs b/src/vit-testing/iapyx/src/bin/load/constant/count.rs
@@ -19,7 +19,7 @@ pub struct ConstantCountIapyxLoadCommand {
     #[structopt(short = "a", long = "address", default_value = "127.0.0.1:8000")]
     pub address: String,
 
-    /// Amount of delay [miliseconds] between requests
+    /// Amount of delay (in miliseconds) between requests
     #[structopt(short = "d", long = "delay", default_value = "10000")]
     pub delay: u64,
 
diff --git a/src/vit-testing/iapyx/src/bin/load/constant/duration.rs b/src/vit-testing/iapyx/src/bin/load/constant/duration.rs
@@ -19,7 +19,7 @@ pub struct ConstDurationIapyxLoadCommand {
     #[structopt(short = "a", long = "address", default_value = "127.0.0.1:8000")]
     pub address: String,
 
-    /// Amount of delay [miliseconds] between requests
+    /// Amount of delay (in miliseconds) between requests
     #[structopt(short = "d", long = "delay", default_value = "10000")]
     pub delay: u64,
 
diff --git a/src/vit-testing/mainnet-lib/src/lib.rs b/src/vit-testing/mainnet-lib/src/lib.rs
@@ -1,6 +1,6 @@
 //! Rust implementation of Cardano various tools
 //!
-//! [`DbSyncInstance`] - mock of db sync based on json file rather than postgres db
+//! [`InMemoryDbSync`] - mock of db sync based on json file rather than postgres db
 //! Network - mock of cardano network in memory
 //! Wallet - api implementation of cardano wallet which is capable of sending and signing registration
 //! transactions
diff --git a/src/voting-tools-rs/src/db/mod.rs b/src/voting-tools-rs/src/db/mod.rs
@@ -32,12 +32,6 @@ pub struct DbConfig {
 }
 
 /// Inner module to hide database internals from database code
-///
-/// Calls to the database are blocking, which blocks tokio. Instead, all calls should go through
-/// `exec`, which uses runs them on a thread pool with [`tokio::task::spawn_blocking`].
-///
-/// This module hides the inner connection pool from queries, so they cannot accidentally get a
-/// regular connection and block the executor
 mod inner {
     use super::DbConfig;
     use color_eyre::Result;
@@ -77,7 +71,7 @@ mod inner {
                 .unwrap_or_default();
 
             let url = format!("postgres://{user}{password}@{host}/{name}",);
-            let manager = ConnectionManager::new(&url);
+            let manager = ConnectionManager::new(url);
             let pool = Pool::new(manager)?;
 
             password.zeroize();
diff --git a/src/voting-tools-rs/src/testing/test_api/fake.rs b/src/voting-tools-rs/src/testing/test_api/fake.rs
@@ -13,7 +13,7 @@ use mainnet_lib::{
 use std::collections::HashMap;
 use std::str::FromStr;
 
-/// Mock db provider based on [`DbSyncInstance`] struct from [`mainnet_lib`] project.
+/// Mock db provider based on [`InMemoryDbSync`] struct from [`mainnet_lib`] project.
 /// In essence struct keep data in memory and provides query for voting tools logic
 #[derive(Debug)]
 pub struct MockDbProvider {
@@ -45,8 +45,8 @@ impl DataProvider for MockDbProvider {
         let mut tx_id = 0;
 
         Ok(filtered_regs
-            .iter()
-            .map(|(_block0, registrations)| {
+            .values()
+            .map(|registrations| {
                 registrations
                     .iter()
                     .map(|r| {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// #![warn(clippy::all)]`
	`2`	`+// #![deny(missing_docs)]`
`1`	`3`	`pub mod era;`
`2`	`4`	`pub mod timeframe;`
`3`	`5`	`pub mod timeline;`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ use thiserror::Error;`
`8`	`8`	`pub struct OutputFormat {`
`9`	`9`	`/// Format of output data. Possible values: json, yaml.`
`10`	`10`	`/// Any other value is treated as a custom format using values from output data structure.`
`11`		`- /// Syntax is Go text template: https://golang.org/pkg/text/template/.`
	`11`	`+ /// Syntax is Go text template: <https://golang.org/pkg/text/template/>.`
`12`	`12`	`#[structopt(long = "output-format", default_value = "yaml", parse(from_str))]`
`13`	`13`	`format: FormatVariant,`
`14`	`14`	`}`