Merge branch 'main' into martin/newheightlogic

.github/workflows/mbt.yml

@@ -14,8 +14,8 @@ on:
       - .github/workflows/mbt.yml
 
 jobs:
-  gen-and-exec-traces:
-    name: Generate and execute random traces
+  mbt-tests:
+    name: Run MBT Tests
     runs-on: ubuntu-latest
     env:
       CARGO_INCREMENTAL: 0
@@ -46,6 +46,6 @@ jobs:
         run: cargo nextest run -p malachite-test-mbt --all-features --no-run
       - name: Current time as random seed for Quint
         run: echo "QUINT_SEED=$(date +%s)" >> $GITHUB_ENV
-      - name: Run tests from traces (with random seed)
+      - name: Run tests
         working-directory: code/crates/test/mbt
         run: cargo nextest run -p malachite-test-mbt --all-features

.github/workflows/rust.yml

@@ -49,7 +49,7 @@ jobs:
       - name: Install cargo-nextest
         uses: taiki-e/install-action@cargo-nextest
       - name: Run tests
-        run: cargo nextest run --workspace --all-features --no-fail-fast --failure-output final --test-threads 1 --exclude malachite-starknet-test --exclude malachite-discovery-test
+        run: cargo nextest run --workspace --all-features --no-fail-fast --failure-output final --exclude malachite-starknet-test --exclude malachite-discovery-test
 
   integration:
     name: Integration Tests
@@ -74,12 +74,14 @@ jobs:
         uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
           cache-workspaces: "code"
-      - name: Install cargo-nextest
-        uses: taiki-e/install-action@cargo-nextest
-      - name: Run Starknet tests
-        run: cargo nextest run --all-features --no-fail-fast --failure-output final --test-threads 1 -p malachite-starknet-test
-      - name: Run Discovery tests
-        run: cargo nextest run --all-features --no-fail-fast --failure-output final --test-threads 1 -p malachite-discovery-test
+      - name: Install cargo-maelstrom
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-maelstrom
+      - name: Disable apparmor container restrictions
+        run: sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
+      - name: Run integration tests
+        run: cargo maelstrom --slots 16 -i 'package.match(malachite-starknet-test) || package.match(malachite-discovery-test)'
 
   clippy:
     name: Clippy

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing to Malachite
+
+First, thank you for your interest in improving Malachite!
+
+There are multiple opportunities to contribute at any level. It doesn't matter if you are just getting started with Rust or are the most weathered expert, we can use your help.
+
+No contribution is too small and all contributions are valued.
+
+This document will help you get started. Do not let the document intimidate you. It should be considered as a guide to help you navigate the process.
+
+**The [Telegram group][tg] is available for any concerns you may have that are not covered in this guide.**
+
+If you contribute to this project, your contributions will be made to the project under Apache 2.0 license.
+
+## Code of Conduct
+
+### Contact: [email protected]
+
+The Malachite project adheres to the [Rust Code of Conduct][rust-coc]. This code of conduct describes the minimum behavior expected from all contributors.
+
+Violations of this Code of Conduct can be reported by contacting the team at `[email protected]`.
+
+## Ways to contribute
+
+There are three ways you can contribute to Malachite:
+
+1. **By opening an issue:** For example, if you believe that you have uncovered a bug
+   in Malachite, creating a new issue in the issue tracker is the way to report it.
+2. **By adding context:** Providing additional context to existing issues,
+   such as screenshots and code snippets to help resolve issues.
+3. **By resolving issues:** Typically this is done in the form of either
+   demonstrating that the issue reported is not a problem after all, or more often,
+   by opening a pull request that fixes the underlying problem, in a concrete and
+   reviewable manner.
+
+**Anybody can participate in any stage of contribution**. We urge you to participate in the discussion around bugs and
+participate in reviewing PRs.
+
+### Contributions Related to Spelling and Grammar
+
+At this time, we will not be accepting contributions that only fix spelling or grammatical errors in documentation, code or
+elsewhere.
+
+### Getting Help
+
+If you have reviewed existing documentation and still have questions, or you are having problems, you can get help by *opening a discussion*. This repository comes with a discussion board where we welcome everyone to ask and offer help. Click the "Discussions" tab at the top of the repo.
+
+
+_Adapted from the CometBFT and Reth contributing guides._
+
+
+[rust-coc]: https://www.rust-lang.org/en-US/conduct.html
+[tg]: https://t.me/MalachiteLibrary

SECURITY.md

@@ -0,0 +1,27 @@
+# How to Report a Security Bug in Malachite
+
+Please **DO NOT** file a public issue in this repository to report a security
+vulnerability.
+
+If you believe you have found a security vulnerability in Malachite,
+you can report it via our primary vulnerability disclosure channel, the
+email address `[email protected]`. Please enclose with your 
+report the issue details, reproduction, impact, and other
+information. Please submit only one unique email thread per vulnerability.
+
+There is no bounty reward system in place for Malachite yet.
+
+Artifacts from an email report are saved at the time the email is triaged.
+Please note: our team is not able to monitor dynamic content (e.g., a Google Docs
+link that is edited after receipt) throughout the lifecycle of a report. If you
+would like to share additional information or modify previous information,
+please include it in an additional reply as an additional attachment. Thank you
+for understanding.
+
+## Coordinated Vulnerability Disclosure Policy and Safe Harbor
+
+For the most up-to-date version of the policies that govern our approach to
+vulnerability disclosure, please consult
+the [Gold Standard Safe Harbor Statement][h1-statement].
+
+[h1-statement]: https://docs.hackerone.com/en/articles/8494525-gold-standard-safe-harbor-statement