From ca2da9be745109033a962b3df392874dd2c6ad4d Mon Sep 17 00:00:00 2001 From: Jonas Bostoen Date: Mon, 28 Oct 2024 12:36:53 +0100 Subject: [PATCH] feat(ci): try fix --- .github/.linkspector.yml | 1 + .github/workflows/linkspector.yml | 2 +- README.md | 7 +++---- bolt-boost/README.md | 2 +- bolt-contracts/README.md | 11 +++++------ bolt-contracts/docs/admin/upgrading.md | 2 +- 6 files changed, 12 insertions(+), 13 deletions(-) diff --git a/.github/.linkspector.yml b/.github/.linkspector.yml index 511f8020a..f914de298 100644 --- a/.github/.linkspector.yml +++ b/.github/.linkspector.yml @@ -3,5 +3,6 @@ dirs: excludedDirs: - bolt-contracts/lib + - testnets/helder useGitIgnore: true \ No newline at end of file diff --git a/.github/workflows/linkspector.yml b/.github/workflows/linkspector.yml index 9cf35a3fa..92526550a 100644 --- a/.github/workflows/linkspector.yml +++ b/.github/workflows/linkspector.yml @@ -20,7 +20,7 @@ jobs: uses: umbrelladocs/action-linkspector@v1.1.3 with: github_token: ${{ secrets.github_token }} - reporter: github-pr-check + reporter: github-pr-review config_file: .github/.linkspector.yml fail_on_error: true filter_mode: nofilter \ No newline at end of file diff --git a/README.md b/README.md index 76acc921c..cd677471c 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,8 @@ - [Additional components](#additional-components) - [Kurtosis Devnet](#kurtosis-devnet) - [Requirements and setup](#requirements-and-setup) - - [Running the devnet](#running-the-devnet-and-demo) - - [Stopping the devnet](#stopping-the-devnet-and-demo) -- [Telemetry & Metrics](#telemetry-&-metrics) + - [Running the devnet](#running-the-devnet) + - [Stopping the devnet](#stopping-the-devnet) - [License](#license) @@ -178,7 +177,7 @@ just up **Commit-Boost support** The devnet by default will run using a fork of MEV-Boost which supports -the [Constraints-API](https://docs.boltprotocol.xyz/api/builder). Bolt also +the [Constraints-API](https://docs.boltprotocol.xyz/technical-docs/api/builder). Bolt also supports [Commit-Boost][commit-boost] by providing a compatible MEV-Boost module called _Bolt-Boost_ that implements the Constraints-API. To use it in the devnet add the appropriate `bolt_boost_image` in the `kurtosis_config.yaml` file: diff --git a/bolt-boost/README.md b/bolt-boost/README.md index 13f1da4f5..5ed7fe736 100644 --- a/bolt-boost/README.md +++ b/bolt-boost/README.md @@ -5,6 +5,6 @@ with the [constraints-API][constraints-api]. It inherits the PBS module configur for the modified `get_header` call. [commit-boost]: https://commit-boost.github.io/commit-boost-client -[constraints-api]: https://docs.boltprotocol.xyz/api/builder +[constraints-api]: https://docs.boltprotocol.xyz/technical-docs/api/builder diff --git a/bolt-contracts/README.md b/bolt-contracts/README.md index 30bf9c069..f335c8f52 100644 --- a/bolt-contracts/README.md +++ b/bolt-contracts/README.md @@ -7,11 +7,10 @@ - [Admin Privileges](#admin-privileges) - [Validator Registration: `BoltValidators`](#validator-registration-boltvalidators) - [Bolt Network Entrypoint: `BoltManager`](#bolt-network-entrypoint-boltmanager) -- [Fault Proof Challenge and Slashing: `BoltChallenger`](#fault-proof-challenge-and-slashing-boltchallenger) +- [Fault Proof Challenge: `BoltChallenger`](#fault-proof-challenge-boltchallenger) - [Holesky Deployments](#holesky-deployments) - [Testing](#testing) - [Security Considerations](#security-considerations) -- [Conclusion](#conclusion) ## Overview @@ -38,7 +37,7 @@ and multiple system-wide parameters can be changed by this administrator in the ## System-wide Parameters: `BoltParameters` -[`BoltParameters`](./src/contracts/BoltParameters.sol) is an upgradeable storage contract that stores system-wide parameters that the other +[`BoltParameters`](./src/contracts/BoltParametersV1.sol) is an upgradeable storage contract that stores system-wide parameters that the other contracts can read from. An overview is given in the table below: | Parameter | Initial Value | Mutable after deployment | @@ -58,7 +57,7 @@ The values of these parameters can also be found in [`parameters.json`](./config ## Validator Registration: `BoltValidators` -The [`BoltValidators`](./src/contracts/BoltValidators.sol) contract is the only point of entry for +The [`BoltValidators`](./src/contracts/BoltValidatorsV1.sol) contract is the only point of entry for validators to signal their intent to participate in Bolt Protocol and authenticate with their BLS private key. The registration process includes the following steps: @@ -77,7 +76,7 @@ will allow us to test the registration flow in a controlled environment. ## Bolt Network Entrypoint: `BoltManager` -The [`BoltManager`](./src/contracts/BoltManager.sol) contract is a crucial component of Bolt that +The [`BoltManager`](./src/contracts/BoltManagerV1.sol) contract is a crucial component of Bolt that integrates with restaking ecosystems Symbiotic and Eigenlayer. It manages the registration and coordination of validators, operators, and vaults within the Bolt network. @@ -92,7 +91,7 @@ the `IBoltMiddleware` contracts, such as `BoltSymbioticMiddleware` and `BoltEige ## Fault Proof Challenge: `BoltChallenger` -The [`BoltChallenger`](./src/contracts/BoltChallenger.sol) contract is the component responsible +The [`BoltChallenger`](./src/contracts/BoltChallengerV1.sol) contract is the component responsible for handling fault attribution in the case of a validator failing to meet their commitments. In short, the challenger contract allows any user to challenge a validator's commitment by opening diff --git a/bolt-contracts/docs/admin/upgrading.md b/bolt-contracts/docs/admin/upgrading.md index 28de9192f..a0c5abf7a 100644 --- a/bolt-contracts/docs/admin/upgrading.md +++ b/bolt-contracts/docs/admin/upgrading.md @@ -13,7 +13,7 @@ bytes memory initManager = abi.encodeCall(BoltManagerV2.initialize, (params)); Upgrades.upgradeProxy(proxy, "BoltManagerV2.sol", initManager, opts); ``` -Before an upgrade, update the [`Upgrade.s.sol`](../script/holesky/Upgrade.s.sol) script to include the correct contracts, references and configurations. +Before an upgrade, update the [`Upgrade.s.sol](../../script/holesky/admin/Upgrade.s.sol) script to include the correct contracts, references and configurations. ## Unsafe In order to run an unsafe upgrade, set `Options.unsafeSkipAllChecks` to `true`: