Merge Narwhal into Sui

narwhal/.assets/diagram.drawio

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2021-06-29T11:40:36.080Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36" etag="OybOxsFT5Ujje8oWMdfj" version="14.8.2" type="device" pages="2"><diagram id="04SbDpS5iBzByXe31BT4" name="worker">7V1td5s2FP41Oaf7kB7ewR+btGl3tm7Z0nXrR2Jkw4KRC3Lj7NdP4sU2kmwrCaBL4pzT2ghZxs9zr+6LLuLMvlysP+bhMv6MI5SeWUa0PrPfn1mW6VgefWEtD1WLb/tVwzxPorrTtuEm+Q/VjUbdukoiVLQ6EoxTkizbjVOcZWhKWm1hnuP7drcZTtvfugznSGi4mYap2Pp3EpG4ag1cY9v+CSXzuPlm06jPLMKmc91QxGGE73ea7A9n9mWOManeLdaXKGXgNbhUn7vac3ZzYTnKiMoH7rJ/8C/J1fxrnnz4+umPq/Off7k+Nx23GudHmK7qn1xfLnloMMjxKosQG8Y4sy/u44Sgm2U4ZWfvKeu0LSaLlB6Z9G1BcnyHLnGK8/LTtlH+0TNhmswz2paiGb3gi1mSpk23DGd0tAvxJ9W/8gfKCVrvNNU/8SPCC0TyB9qlPuvUaDfi1hzfb8mzG0biXeK8ujGsBWa+GXqLKX1Tw/oYiA1bArGXMgyWLaC97ysmDBdpkqHz5uLe0S6mTS/O3Xag7+b1a1q9Xi35tthsWn5Fc5RFTfttLvn0tvPOlR36Dk5CKDnkkBjU/EooL6ggJdmcNrjboy+YCtX7c2ufuGEqD7O0VKY4iSJEpeqiLaScrHUgWB4nWK4oWFYgESynL7kKLEGs/kRpEt5SUizjhlKOcpH0NwTTs5jE7KRxj/M7lBc/PU/lJbQyXBM6i76rebjFhOAFPRGFRVyOa3ZDy0aZa15cT8KLI1N4ozdiHIGYm2SxfFW0OPBYEQ3dq2NlAlBZvCfTsmKkLPNkEeYPIyYl4EgJDJEU03KHJMUJBDhRRN3i+rBGqI3wv6vFsnbfPWaicxLjOc7C9FdcWnOG1r+IkIe6U7iiLLZIoBDmD/+w4d66zeG3evTy4P26dfRQH1WuRuOdW+z8OiHVQJZbH35rvoS+347DDpph9lJZUEmbokMeXtWPhPkckQP97FrWGZYHJSNHaUiSH+0QpHuWJyeW+2DZB8Vy46eeWO6WZQcWy+ZLYdmHxLIFiuTGtRDzCLeNa3QRkmlM+3wO72Se004wv/nIm7Ao0IJGjQVDZM3+T7LSw7plg6GDDq953LfqwEVyjbaL5Ej8VlOW1ektqeOKWbJR6dvTVcdSnSBBqY6YKxFU548VzleLv0MqzLlMTyRxyD3tzPRlhlkoEtJ/38tBGD5MgcLpXbGJVEptAqBLARcDBtp1ydahS13qhK1qTmApxf689Ebor3M8RUWBVW1JzIJjJvMhyzhTSnFeHsIxJZz4+9Joe1Dx1xJsS1ywJxqXp6uNo6g2JiitEbO7P/+mXawdbnnClnhIssReb6sTvh4HaRNGqEcREJwqX9WAwMot+Fosdx9R5xBBpzLJsFILvnMiuQeSYeWC/eOu4CeULpVzCjlapkmVUdhkEsof832FCgLAD5wE0FIKwSv0xvm1L/0sOKJJO01tFTQTxanNnoCa2pyT/eqBZAdYUOaeSO6BZAMUyZPjFvLmIZvGOc4oY+quSuWT0JEXSVGwYkRAFtIEt/ThjXhBuRopescKw7fXSluuEgZC+Qm1+p7jS4yGopKZFigl80a8kgyRXljBvKcnLfdi2TVhuUHNdR8ykX+iKaIXomoeF2GSEfqvXMjMWFnml8vrs80NNwnOGMZlgeyUhvwZ0W8z+XIBS3ITyMBrPFpK7SCs8TQKMrJFnuayYa3yeBawVR7Xf7VybY1Tri2Icu1Ck2tT4a5I0RVpOR87CLXlf1dBtsL/YdvKa8gjFhqPStkOoK4E0KZNWRjrb7jG1Ek421tkYQccUZV61Z/aciUM5BlHBqrUTxioJH3zs5/hLute4PS1LUmbnuIEF4Ca4Dwt2d5uEno7vFtDmTFVlmEVHpjiXWMAzFgArQjHG/EdPkNG+6qL9iaslS3/lIntll5Ypsw/ZWK7pRdWyY2pUHPz8nN1E3C5Og9eTmMwbzAYpTfoQamgf57P/7hYbwCWYZlDUyyQA+Dzmwa03JWnpRRmvNqgWgwDSxs870WwPJhlU2UZlmVrLhvWnMdvI6R9ymuu55Suf1K6nq+Ff3K63jQ05+sdLbNidyFzSySPxc9Pnw2bjsfvUrFATYebqepVh8x8Saj+kNnREjJDuHGzUZCjmgQrc9xcNiy/wnSA+RX+qOT6UcajUyVQ3f/CBmZOlDbAKPeXvKzMgfKddwVFe3OnHX2Nknl9j8Hj9q7Ucxue/k0xLHGXhd//+qIdqAm/r61k85xhIx9xIRwCTibvo+gHSlxtAQEUHzHpB0p2H/IplhZR3hcCc0UgHr9Lr3owHRwZqedgurHWwFSGr7LZGC9dGmPDtFU2NFtlw7RV/N0i+nGCaaoccDidLNVzLBW/ZZg7mbyd7PwFTzNbDr+/5OFh+7Zh4gIKBF3iodetSs3AwGCyLGg4iQloCDiZ4HASXcfT1PyIIMJvz5mu28dMbU6e8y09T9w+lDtmB92YRbUyq/uNhPesDHMxhOd1I3l80ZRv6ZS1YH8l7gyX1y0+o4+dOC9KOSqf0Oct1/ufz7fdQy/MovLRRgtUFOG83IxtlmO2YXgrJXxo/3HaVl1V58/iax6aN6Vyi2i78AykRRJF5QwrM2ltXez8KUltgTFlu5Z7Q5q4YP9+fX0JTbUAXS4i5GFWhOXydHGSFSFShScs+7euGnCGaT/H7iQ3whwDTm4mMrnh3aI0TZbFPsR2KAqLZfWE5FmyZrCJXOzytfvk3g6w9dvQBrYEWgmyZl/IbhaoBnjw8T5YBfx7wNlwdeMsq9nicY7x4nZVjBVj19GMsXTbp/HLssulyaRlCcMCrSLM4wM6UNlkcligFRJIIwSa90wBAC2rgRqlhyHMFpJ14YGxFReGR4qtMEHIPONhsVXZoWkU2E48cHOCuFA/UmzBTbeSej3Rro3LG3YUqrYHBlmWzx03yPwKn36QmwD+BYEcgJNk++UFz7wrEWgP6iR1jmMHmd9VxdUvyQq+8MhAtuGBrOAUjwxkvrJFP8YqzsVj6n/243zMU74q/zpyMILj03IgAdruD2ggu/rsBbfv4guBEjd467YHUS244AsOg2ZD+oEqLExJgSHBdwm7F46ExZ3A9PMXGFM0I89bXuxi9lJajpGoldWbWklKGBsmpnGYZSh9NWQ4E+1kiK7nb4iwBfqXSsIEHgdiBvyG4Dykk/sr4cDSPymJ0cHl9V+vBX9pBNwN/vQwx6xiaGvN6Y+KP+MIsR7/Aw==</diagram><diagram id="u77JRGBOouUTT-4SinIf" name="primary">7V1bc5s4FP41mdl9SIc7+DF1rt2mcS5Nt3nZUYxsaDEigGO7v34lDDYIGWOHi3zJTKdGCFk+37nrSJzI3dH0ygeedYtM6JxIgjk9kc9PJElUJA3/R1pm8xZd1ucNQ982407Lhkf7D4wbhbh1bJswyHQMEXJC28s29pHrwn6YaQO+jybZbgPkZL/VA0OYa3jsAyff+sM2Q2veaqjCsv0a2kMr+WZRiO+MQNI5bggsYKJJqkm+OJG7PkLh/NNo2oUOIV5Cl+uzM09RrUHn6f0evmhnp4M7/XQ+2OUmjyx+gg/dcOuhPdiDZw9I7frnLzcP0gvU3x9PxXjsd+CMY4LFPzacJRT00dg1IRlFOJE/Tyw7hI8e6JO7E8wzuM0KRw6+EvHHIPTRb9hFDvKjp2Uh+sN3gGMPXdzmwAH+EZ8HtuMk3Vzk4tE+l/yZyZShH8JpCuT4Z19BNIKhP8Nd4rtKDGDCwQmgkyU/KEbcZqV5QYsbQcyDw8XQSzrjDzGp2WR/+65dK5//uVP1d/0qhJeTzs3NqSTnqAxNzLbxZUyPLOF/jUdeLF4avkR+aKEhcoHzFSEvpv4vGIazuBMYh4jGBvjhGZGp5XdEbZc2mX70LdA1kx59BwSB3Z83xl2WECfCJEX3MVH+JSN8UpPLn4sB8cX5NHM1S66mdph6DF/9jL+DfF4+RC6SZzZjkgCN/X5M4dPra+fszbd+9tRvxkC46l1N7FhmBEyFIYzHewfPvzrSQH/583Q3/WKJ/33u3JzGgBGUClnOhw4I7fes8vkI/xTNOiW1N98K5FZcL7d1yZ4oZYVPMhjCx5A9pQLRY5JOzNGpAcnbVkCyoiZm5TOe61I4yRMmCKwF5hXLipKXFWY/jStZyRu0I+AVAy5wBXgrtvWwAFe5Alxh+LCaQ5zMV/xhSD48wD7E8/AXN/zkTtKCv3nR+68RsN0Q/wvwsAQDSXjq9pZBio1cQnUynNB3bEz7vzm1vlrW+i6uU9Z3YaHT5rc+z1c9er58eL7qTnq+6s54vgtPtwXPly16ylH0+BA9bSdFT9sZ0RNbFD0m6XSGh0KLYs7tyzh6KaplJTQtwkvxvFi20jKcl6TNYFjLjSkiqwwiJ22lmTb+hh7CPllKvVJZPVmgwJtLYfxUOi9KD6StGWguprmBIkZY/OztecNYzxu+hUav42C9QK3OvqbTraysbB9jj/3ZGmVSWC+TIisJW5s51PbVHOq7Zg87Je1hWQ1UuT1kMpDcSiqxPgbagg9STCdtxHQtMZDOlUPV2RmHyiihvJvN4gs5Qh2TfCWFRZTz0sLuyFeaT2xF3x4Y5h2+ID8u3jQg5gpfmMuMgOiYzo/MsMJdOt84+sDbBl5Vyztj8W4XoqhWPDleOajVKKo0B/EVRon59V9e46iOxtuakH6UPl70d9kFWb70t9Q5chAv+rssB1Wuv9krKx2ZWlnRm11ZEXenWMBo0TCwaZdf7c3L+XHJcjN5kCpasuysW/usW7BKrGfvw5qlXqKOoK41y/G927EnTy/6xRu4Hk5urWnQY9T9J/mOAYoYZAmA9jZGyY3TIJKlM9xB1Lzp8iadNVmkTK6BazokUTKCQQCGkGROBj4akQTKmORJJsj/Df2AlW5Jtc1nlTRTHIJBCItYIdYpjI1COQYgkNp94JzFN0a2aUaKhMV7WWX0gRTcBovfdOJGYDCSVpN+Z3ISa99X45wUWlHOzfPtEfBteOSmks6C1CI3sYOAlvP0Gad7mbRfmadPBQ/L0CAdP1DJ+83jhyRiSM2ohmoKpndfdktba3Fk0ayLsv6PWBxBOPaJNnmE/ruNyVBuASDATwaRMAATWy1O0/satcous9yNRtP7e5qbLR3ZVyyZyf73lGRCqXf3OsP2OdRf4Lj3ZXDt95Ita5xkePaszCkxGgsLslGRHO+sU7lSZ0egmppVVQqtgqqLQNkOR6v+RpZ1Ukm/Mg7HQWq01nYyMLmnlY0wH8wsb1iJUp+HWz8HMftVvqk8ehT/fDBLdfCIwgpW6z069FI1geLG+YiVKrtWCtW3s5MNrMtITZSpf4hVDa6UXSsVOitCcw4C82SVl2cGaq0gj+3/t1xrzZX+EXnnndZqtotmXZTV6SK/bBrHinLJqUTOidQlo6MQxh/7JHU7sPsAt3Ca5dHp/YZNZnmYIEnrQboC/is5aE8SushxYD9EfknMxp4JIniE0CLPXxGYIiA4xYfOwumt41OiILoHZg4CJu61YWl0gJFMofMKwr6F/zftIQxCXkWIPtak/USpeKyDrtjeMWpR2ZRvzeCxp3Msh2uLEfjymqU9XTvZAUZoLdlYNO0i630debO40w9gh6VNtw/fxsRI4+dGNobRHSYGPDLo2FfeDYeYLovTmtzVVBRDFUYtS7puitsEd46qYIgPLYBoOnPvy7KJO0ZIgwa7gZ0oGLyBxypcpb1lH3ko2GD74G+CjgsnJ7yXENDBZaNwPMsXEFnhw8X5wyy8kme3gvDUVvJ6CxNXyna2nQbS80aQSXapLRvInE0rTvGRCVpzhJizaSuPfOhcwFedH2vrQM4ddrwNvGDPsecZLJRKYCXOMad2OrcVpPUM1n5tBK1Y1Iy8qBVl0jkRNdbJgrnFFzeAbjAOSkob8ufLLrsQm9CJ/EZ9YWYVVL7G+QE6Nnh15hXNrsnSen9Fei23V6KI6MJ6ojP2QdDbHl5RGKLRSUObGhQqkFQZmxqYWyBFevNbZXDlFy/vvj/xyesqxesq6x1HNe0IKSph3gXaaRpntMuv93FLO5U32rGyrbRfc9y2vILyK2q96ZpHufOpk/ozsgOW3cSsKRsNW11BOZNvWClfWuD2YEezQssra+tgTTuamcFp3iV6tEfe0SFipNYVRoxYn0dUlEqo0jLlD02sjaD0EeQs5q/LWBUlaXfB0Iv0MfmtE68GL6lJXuSNnJwZwAahELT1erbRNxOIeb2wrVEkbaQhc2jHvllK+vAkVsVmfYaysAZlF1S7QfkZRoOqqLCSaxeIJwoKb9TLa3JuqUcfZNU+8Q7kZCv6JGlmkXtNNo/5IvrVx394Geon5w05tgtPk5lFxxGRwwbV1QcS4Vl5dJslJi1f4RCSermCRZBl59TMir6DYpvtDygKMIeR6j75XF1ePUVLbKTMlM2HCDPDwImyXJZtmtDN5bMSZnPgIKyR1WjjLDOMs1GTjDNZjbUnicIKj2J7AVwv4iDwYJ9MeGBPCWHzErxK1Osit05pVLFlwc77sgWmqIT3ybFS1WmdqrZLeta+oT20ZTTHy0q7ZC+xBLFFVqIUiSksLqO/Or1fY70bwdLtcl20b+nt0jWv83xwAYdGyZCNT6qw/JOyA2774kxD7mQHqm7Jhol1vtA7RL9tkgYJQfC7Qv+LcpQ+cDxkXXJYxvSw5FCqSw7zYVSCTd8Crgudg4bHSA7NbwuefGXYNxiS7OBBwdJZj8oiQ9gILJ0cLI8h8qN99wcMi8Byo5uEJfEUU7h0e98PGRN2uqgmTJ5Gp2fnb+o9GMCXi9uh/HZ7Py1zXOwP9nHSK0P9wAIeaew7aGxWFRGtOmO6LqByp1eoeaTkmjxyJlCs+J9+m98hApU7BqZtoMq8dpFnoJpcMRaz2GmMnGaj2JXY83qQ2lAukZ9oFKgSu5+4FrKmgDKkvNPXKFD5CAmEaGT3o2zM/LSGA3L/FGl9qFRXAMuEJx8pLeCZ+POzGA4YnibTPz64upihy6evQLMvBt5DZ/ToM71zWoEdq/BXUH5FEleiy/DFSsrwRYmuwy8et7qkLpNzWOHCkXM+xjkCFRMaFXGOQFuFpjjnTR+q96b5/EeZwqcvtzfQ+fZcSufs7rI+/QYx5obxuopUWeTe7yoKUVA5o3eZjW27S2+jwxm5S5TD7zC5O2W2xjdJ7jJvm91dcue2GDRJb2ly8/xv//376+Wg++w8310D9Z8yxnJfqrJUoz3VwqR9Ccu5L7Sn1brS4HZTJu1LhBf7Qnua72vUOfjSR6TqeunPY0pZt8iEpMf/</diagram></mxfile>

narwhal/.clang-format

@@ -0,0 +1,5 @@
+# For proto file format
+BasedOnStyle: Google
+IndentWidth: 4
+ColumnLimit: 100
+

narwhal/.clippy.toml

@@ -0,0 +1,19 @@
+# cyclomatic complexity is not always useful
+cognitive-complexity-threshold = 100
+# types are used for safety encoding
+type-complexity-threshold = 10000
+# big constructors
+too-many-arguments-threshold =  15
+
+disallowed-methods = [
+    {path = "anyhow", reason = "we prefer to use eyre"},
+    # we use tracing with the log feature instead of the log crate.
+    { path = "log::info", reason = "use tracing::info instead" },
+    { path = "log::debug", reason = "use tracing::debug instead" },
+    { path = "log::error", reason = "use tracing::error instead" },
+    { path = "log::warn", reason = "use tracing::warn instead" },
+    # unbounded channels are for expert use only
+    { path = "tokio::sync::mpsc::unbounded_channel", reason = "use a bounded channel instead" },
+    { path = "futures::channel::mpsc::unbounded", reason = "use a bounded channel instead" },
+    { path = "futures_channel::mpsc::unbounded", reason = "use a bounded channel instead" },
+]

narwhal/.dockerignore

@@ -0,0 +1,7 @@
+# Exclude directories from getting copied
+# to the Docker image once built.
+.cargo
+.github
+.idea
+target
+benchmark

narwhal/.github/CODEOWNERS

@@ -0,0 +1,10 @@
+
+/crypto/ @huitseeker @kchalkias
+/executor/ @asonnino @akichidis
+/examples/ @arun-koshy
+/network/ @bmwill
+/config/tests/snapshots/ @huitseeker
+/dag/ @huitseeker
+/storage/ @akichidis
+/primary/src/block_synchronizer/ @akichidis
+/primary/src/block_waiter.rs @akichidis

narwhal/.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,13 @@
+---
+name: Bug
+about: Create a new bug
+title: '<title>'
+labels: bug
+assignees: ''
+---
+
+### Description
+<!-- give the bug description here -->
+
+### Steps to reproduce
+<!-- provide the steps to reproduce here -->

narwhal/.github/ISSUE_TEMPLATE/epic.md

@@ -0,0 +1,9 @@
+---
+name: Epic
+about: Create a new epic
+title: '<title>'
+labels: epic
+assignees: ''
+---
+
+### Description

narwhal/.github/ISSUE_TEMPLATE/story.md

@@ -0,0 +1,14 @@
+---
+name: Story
+about: Create a new story
+title: '<title>'
+labels: story
+assignees: ''
+---
+
+### Epic
+<!-- here you can reference they parent Epic, given that this exists. Just insert the number of issue (e.x #34).
+If no Epic exists, ignore and feel free to delete the "Epic" section. -->
+Parent epic: #
+
+### Description

narwhal/.github/ISSUE_TEMPLATE/task.md

@@ -0,0 +1,14 @@
+---
+name: Task
+about: Create a new task
+title: '<title>'
+labels: task
+assignees: ''
+---
+
+### Story
+<!-- here you can reference they parent Story, given that this exists. Just insert the number of issue (e.x #34).
+If no Story exists, ignore and feel free to delete the "Story" section. -->
+Parent story: #
+
+### Description

narwhal/.github/config/.hadolint.yaml

@@ -0,0 +1,2 @@
+---
+failure-threshold: error

narwhal/.github/dependabot.yml

@@ -0,0 +1,14 @@
+#
+# Dependabot configuration file
+#
+
+version: 2
+updates:
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

narwhal/.github/workflows/bench.yml

@@ -0,0 +1,86 @@
+name: Benchmark
+
+on:
+  ## Allow triggering this workflow manually via GitHub CLI/web
+  workflow_dispatch:
+
+  push:
+    branches:
+      - main
+      - devnet
+
+env:
+  CARGO_TERM_COLOR: always
+  # Disable incremental compilation.
+  #
+  # Incremental compilation is useful as part of an edit-build-test-edit cycle,
+  # as it lets the compiler avoid recompiling code that hasn't changed. However,
+  # on CI, we're not making small edits; we're almost always building the entire
+  # project from scratch. Thus, incremental compilation on CI actually
+  # introduces *additional* overhead to support making future builds
+  # faster...but no future builds will ever occur in any given CI environment.
+  #
+  # See https://matklad.github.io/2021/09/04/fast-rust-builds.html#ci-workflow
+  # for details.
+  CARGO_INCREMENTAL: 0
+  # Allow more retries for network requests in cargo (downloading crates) and
+  # rustup (installing toolchains). This should help to reduce flaky CI failures
+  # from transient network timeouts or other issues.
+  CARGO_NET_RETRY: 10
+  RUSTUP_MAX_RETRIES: 10
+  # Don't emit giant backtraces in the CI logs.
+  RUST_BACKTRACE: short
+
+jobs:
+  bench:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/cache@v3
+      id: cache-id
+      with:
+        path: ${{ runner.temp }}/benchmark-cache-directory
+        key: ${{ runner.os }}-benchmark-cache-v1.0
+    - uses: airvzxf/[email protected]
+      with:
+        script: 'install.sh'
+        is_cached: ${{ steps.cache-id.outputs.cache-hit }}
+        cache: ${{ runner.temp }}/benchmark-cache-directory
+        snapshot: '/'
+        exclude: '/boot /data /dev /mnt /proc /run /sys'
+    - name: Install python dependencies
+      run: |
+        if [ -f benchmark/requirements.txt ]; then pip install -r benchmark/requirements.txt; fi
+    - uses: actions-rs/toolchain@v1
+    # Enable caching of the 'librocksdb-sys' crate by additionally caching the
+    # 'librocksdb-sys' src directory which is managed by cargo
+    - uses: bmwill/rust-cache@v1 # Fork of 'Swatinem/rust-cache' which allows caching additional paths
+      with:
+        path: ~/.cargo/registry/src/**/librocksdb-sys-*
+    - name: prepare artifact directory
+      run: |
+        mkdir -p artifacts
+        echo '# Bench results' > artifacts/bench_results.md
+    - name: build benchmarks
+      run: cd benchmark && fab local | tail -n 31 | tee -a ../artifacts/bench_results.md
+    - name: finish the benchmark results
+      run: |
+          cat >> artifacts/bench_results.md <<EOF
+          <details>
+          <summary>PR to merge $GITHUB_HEAD_REF $GITHUB_SHA -> $GITHUB_BASE_REF</summary>
+          </details>
+          EOF
+    - name: escape benchmark results
+      id: get-comment-body
+      run: |
+        body=$(cat artifacts/bench_results.md)
+        body="${body//'%'/'%25'}"
+        body="${body//$'\n'/'%0A'}"
+        body="${body//$'\r'/'%0D'}"
+        echo ::set-output name=body::$body
+    - name: Create commit comment
+      uses: peter-evans/commit-comment@v2
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        body: ${{ steps.get-comment-body.outputs.body }}

narwhal/.github/workflows/codecov.yml

@@ -0,0 +1,48 @@
+name: Codecov
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    types: [opened, reopened, synchronize]
+
+jobs:
+  codecov-grcov:
+    name: Generate code coverage
+    runs-on: ubuntu-ghcloud
+    strategy:
+      fail-fast: true
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions-rs/toolchain@v1
+        with:
+          components: llvm-tools-preview
+      # Enable caching of the 'librocksdb-sys' crate by additionally caching the
+      # 'librocksdb-sys' src directory which is managed by cargo
+      - uses: bmwill/rust-cache@v1 # Fork of 'Swatinem/rust-cache' which allows caching additional paths
+        with:
+          path: ~/.cargo/registry/src/**/librocksdb-sys-*
+      - name: Install grcov, and cache the binary
+        uses: baptiste0928/cargo-install@v1
+        with:
+          crate: grcov
+          locked: true
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+        env:
+          RUSTFLAGS: '-Cinstrument-coverage'
+          RUSTDOCFLAGS: '-Cinstrument-coverage'
+      - name: Run tests
+        env:
+          RUSTFLAGS: '-Cinstrument-coverage'
+          RUSTDOCFLAGS: '-Cinstrument-coverage'
+          LLVM_PROFILE_FILE: 'codecov-instrumentation-%p-%m.profraw'
+        run: cargo test --tests
+      - name: Run grcov
+        run: grcov . --binary-path target/debug/ -s . -t lcov --branch --ignore-not-existing --ignore '../**' --ignore '/*' -o coverage.lcov
+      - name: Upload to codecov.io
+        uses: codecov/codecov-action@v3

narwhal/.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,58 @@
+name: auto-merge & finishing steps for dependabot
+
+on:
+  pull_request_target:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/[email protected]
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+          token: ${{ secrets.AUTOMERGE_TOKEN }}
+      - uses: actions-rs/toolchain@v1
+      - name: Install cargo-hakari, and cache the binary
+        uses: baptiste0928/cargo-install@v1
+        with:
+          crate: cargo-hakari
+          locked: true
+      - name: run cargo-hakari
+        run: |
+          cargo hakari generate
+      - name: Check for modified files
+        id: git-check
+        run: echo ::set-output name=modified::$(if git diff-index --quiet HEAD --; then echo "false"; else echo "true"; fi)
+      - name: Push changes
+        if: steps.git-check.outputs.modified == 'true'
+        # using secrets.AUTOMERGE_TOKEN in the below is key to re-trigger CI
+        run: |
+          git config --global user.name 'Francois Garillot'
+          git config --global user.email '[email protected]'
+          git remote set-url origin https://x-access-token:${{ secrets.AUTOMERGE_TOKEN }}@github.com/${{ github.repository }}
+          git commit -am "chore(deps): cargo hakari"
+          git push
+      - uses: ahmadnassri/[email protected]
+        with:
+          github-token: ${{ secrets.AUTOMERGE_TOKEN }}
+          command: 'squash and merge'
+          target: minor
+      - name: Enable auto-merge for Dependabot PRs on patch versions
+        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

narwhal/.github/workflows/docs.yml

@@ -0,0 +1,41 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+      - devnet
+    paths:
+      - "**.rs"
+      - "Cargo.toml"
+      - "Cargo.lock"
+  workflow_dispatch:
+
+jobs:
+  docs:
+    name: Generate crate documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+
+      - name: Generate documentation
+        uses: actions-rs/cargo@v1
+        env:
+          RUSTDOCFLAGS: "--enable-index-page -Zunstable-options"
+        with:
+          command: doc
+          args: --workspace --no-deps
+
+      - name: Deploy documentation
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./target/doc

narwhal/.github/workflows/install.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# Copyright (c) 2022, Mysten Labs, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+# Add clang & others
+sudo apt-get update
+
+sudo apt-get install -y --no-install-recommends python3-numpy libatlas-base-dev clang-11
+
+# Make python3 default
+sudo update-alternatives --install /usr/local/bin/python python /usr/bin/python3 40
+sudo pip3 --no-cache-dir install --upgrade pip