deploy: b484046

index.html

@@ -177,9 +177,12 @@ <h1 class="menu-title">Eigen-Bridge</h1>
 
                 <div id="content" class="content">
                     <main>
-                        <h1 id="eigen-bridge---proof-of-concept-cross-chain-bridge-secured-by-eigenlayer"><a class="header" href="#eigen-bridge---proof-of-concept-cross-chain-bridge-secured-by-eigenlayer">Eigen-Bridge - Proof of Concept Cross-Chain Bridge Secured by EigenLayer</a></h1>
+                        <h1 id="proof-of-concept-cross-chain-bridge-secured-by-eigenlayer"><a class="header" href="#proof-of-concept-cross-chain-bridge-secured-by-eigenlayer">Proof of Concept Cross-Chain Bridge Secured by EigenLayer</a></h1>
 <p><img src="https://img.shields.io/badge/build-passing-brightgreen.svg" alt="Build Status" />
-<img src="https://img.shields.io/badge/license-UNLICENSED-blue.svg" alt="License" /></p>
+<img src="https://img.shields.io/badge/license-UNLICENSED-blue.svg" alt="License" />
+<a href="https://idatsy.github.io/eigen-bridge/"><img src="https://img.shields.io/badge/docs-available-blue.svg" alt="Docs" /></a></p>
+<h2 id="developer-documentation"><a class="header" href="#developer-documentation">Developer Documentation</a></h2>
+<p>For detailed developer documentation, please visit our <a href="https://idatsy.github.io/eigen-bridge/">GitHub Pages site</a>. This site is autogenerated from the code and provides comprehensive information about the project's structure, functions, and usage.</p>
 <h2 id="overview"><a class="header" href="#overview">Overview</a></h2>
 <p>This project is a proof of concept for a decentralized bridge secured with attestations by EigenLayer's AVS operators.
 The goal is to demonstrate how EigenLayer can be used to secure cross-chain token transfers without direct communication between chains.
@@ -234,7 +237,7 @@ <h3 id="installation"><a class="header" href="#installation">Installation</a></h
 <h3 id="running-tests"><a class="header" href="#running-tests">Running Tests</a></h3>
 <p>To run the tests, use the Foundry framework. Running the tests requires an HTTP endpoint to Ethereum mainnet.</p>
 <blockquote>
-<p>The tests use an anvil fork-test from latest Ethereum mainnet state in order to simulate a realistic environment.</p>
+<p>The tests use an anvil fork-test from latest Ethereum mainnet state in order to simulate a realistic environment and test against the EigenLayer contracts deployed there.</p>
 </blockquote>
 <pre><code class="language-bash">forge test --rpc-url &lt;RPC_URL&gt;
 </code></pre>

print.html

@@ -178,9 +178,12 @@ <h1 class="menu-title">Eigen-Bridge</h1>
 
                 <div id="content" class="content">
                     <main>
-                        <h1 id="eigen-bridge---proof-of-concept-cross-chain-bridge-secured-by-eigenlayer"><a class="header" href="#eigen-bridge---proof-of-concept-cross-chain-bridge-secured-by-eigenlayer">Eigen-Bridge - Proof of Concept Cross-Chain Bridge Secured by EigenLayer</a></h1>
+                        <h1 id="proof-of-concept-cross-chain-bridge-secured-by-eigenlayer"><a class="header" href="#proof-of-concept-cross-chain-bridge-secured-by-eigenlayer">Proof of Concept Cross-Chain Bridge Secured by EigenLayer</a></h1>
 <p><img src="https://img.shields.io/badge/build-passing-brightgreen.svg" alt="Build Status" />
-<img src="https://img.shields.io/badge/license-UNLICENSED-blue.svg" alt="License" /></p>
+<img src="https://img.shields.io/badge/license-UNLICENSED-blue.svg" alt="License" />
+<a href="https://idatsy.github.io/eigen-bridge/"><img src="https://img.shields.io/badge/docs-available-blue.svg" alt="Docs" /></a></p>
+<h2 id="developer-documentation"><a class="header" href="#developer-documentation">Developer Documentation</a></h2>
+<p>For detailed developer documentation, please visit our <a href="https://idatsy.github.io/eigen-bridge/">GitHub Pages site</a>. This site is autogenerated from the code and provides comprehensive information about the project's structure, functions, and usage.</p>
 <h2 id="overview"><a class="header" href="#overview">Overview</a></h2>
 <p>This project is a proof of concept for a decentralized bridge secured with attestations by EigenLayer's AVS operators.
 The goal is to demonstrate how EigenLayer can be used to secure cross-chain token transfers without direct communication between chains.
@@ -235,7 +238,7 @@ <h3 id="installation"><a class="header" href="#installation">Installation</a></h
 <h3 id="running-tests"><a class="header" href="#running-tests">Running Tests</a></h3>
 <p>To run the tests, use the Foundry framework. Running the tests requires an HTTP endpoint to Ethereum mainnet.</p>
 <blockquote>
-<p>The tests use an anvil fork-test from latest Ethereum mainnet state in order to simulate a realistic environment.</p>
+<p>The tests use an anvil fork-test from latest Ethereum mainnet state in order to simulate a realistic environment and test against the EigenLayer contracts deployed there.</p>
 </blockquote>
 <pre><code class="language-bash">forge test --rpc-url &lt;RPC_URL&gt;
 </code></pre>
@@ -458,7 +461,7 @@ <h2 id="license"><a class="header" href="#license">License</a></h2>
 <h2 id="disclaimer"><a class="header" href="#disclaimer">Disclaimer</a></h2>
 <p>This project is provided "as is" with no guarantees or warranties. It is intended as a proof of concept only and should not be used in production environments. Use at your own risk.</p>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="ecdsautils"><a class="header" href="#ecdsautils">ECDSAUtils</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/ECDSAUtils.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/ECDSAUtils.sol">Git Source</a></p>
 <p><strong>Inherits:</strong>
 EIP712</p>
 <p>Provides ECDSA signature utilities for verifying bridge request data</p>
@@ -502,7 +505,7 @@ <h3 id="getsigner"><a class="header" href="#getsigner">getSigner</a></h3>
 <tr><td><code>&lt;none&gt;</code></td><td><code>address</code></td><td>The address of the signer</td></tr>
 </tbody></table>
 </div><div style="break-before: page; page-break-before: always;"></div><h1 id="bridgeservicemanager"><a class="header" href="#bridgeservicemanager">BridgeServiceManager</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/EigenLayerBridge.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/EigenLayerBridge.sol">Git Source</a></p>
 <p><strong>Inherits:</strong>
 ECDSAServiceManagerBase, <a href="src/EigenLayerBridge.sol//src/Vault.sol/abstract.Vault.html">Vault</a></p>
 <p>Manages bridge operations and attestation validations</p>
@@ -652,7 +655,7 @@ <h3 id="receive"><a class="header" href="#receive">receive</a></h3>
 <pre><code class="language-solidity">receive() external payable;
 </code></pre>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="events"><a class="header" href="#events">Events</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/Events.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/Events.sol">Git Source</a></p>
 <p>Contains event definitions for bridge operations</p>
 <h2 id="events-1"><a class="header" href="#events-1">Events</a></h2>
 <h3 id="bridgerequest"><a class="header" href="#bridgerequest">BridgeRequest</a></h3>
@@ -702,7 +705,7 @@ <h3 id="fundsreleased"><a class="header" href="#fundsreleased">FundsReleased</a>
 <tr><td><code>amountOut</code></td><td><code>uint256</code></td><td>The amount of tokens released</td></tr>
 </tbody></table>
 </div><div style="break-before: page; page-break-before: always;"></div><h1 id="permissionedbridge"><a class="header" href="#permissionedbridge">PermissionedBridge</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/PermissionedBridge.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/PermissionedBridge.sol">Git Source</a></p>
 <p><strong>Inherits:</strong>
 <a href="src/PermissionedBridge.sol//src/Vault.sol/abstract.Vault.html">Vault</a></p>
 <p>Manages bridge operations with manually set operator weights</p>
@@ -814,7 +817,7 @@ <h3 id="receive-1"><a class="header" href="#receive-1">receive</a></h3>
 <pre><code class="language-solidity">receive() external payable;
 </code></pre>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="structs"><a class="header" href="#structs">Structs</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/Structs.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/Structs.sol">Git Source</a></p>
 <p>Contains struct definitions and related functions for bridge operations</p>
 <h2 id="functions-3"><a class="header" href="#functions-3">Functions</a></h2>
 <h3 id="hash"><a class="header" href="#hash">hash</a></h3>
@@ -855,7 +858,7 @@ <h3 id="bridgerequestdata"><a class="header" href="#bridgerequestdata">BridgeReq
 <tr><td><code>transferIndex</code></td><td><code>uint256</code></td><td>The transfer index for unique tracking</td></tr>
 </tbody></table>
 </div><div style="break-before: page; page-break-before: always;"></div><h1 id="vault"><a class="header" href="#vault">Vault</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/Vault.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/Vault.sol">Git Source</a></p>
 <p><strong>Inherits:</strong>
 <a href="src/Vault.sol//src/ECDSAUtils.sol/contract.ECDSAUtils.html">ECDSAUtils</a>, <a href="src/Vault.sol//src/Events.sol/contract.Events.html">Events</a>, ReentrancyGuard, OwnableUpgradeable</p>
 <p>Abstract contract providing common vault functionality for bridge contracts</p>

src/ECDSAUtils.sol/contract.ECDSAUtils.html

@@ -178,7 +178,7 @@ <h1 class="menu-title">Eigen-Bridge</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="ecdsautils"><a class="header" href="#ecdsautils">ECDSAUtils</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/ECDSAUtils.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/ECDSAUtils.sol">Git Source</a></p>
 <p><strong>Inherits:</strong>
 EIP712</p>
 <p>Provides ECDSA signature utilities for verifying bridge request data</p>

src/EigenLayerBridge.sol/contract.BridgeServiceManager.html

@@ -178,7 +178,7 @@ <h1 class="menu-title">Eigen-Bridge</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="bridgeservicemanager"><a class="header" href="#bridgeservicemanager">BridgeServiceManager</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/EigenLayerBridge.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/EigenLayerBridge.sol">Git Source</a></p>
 <p><strong>Inherits:</strong>
 ECDSAServiceManagerBase, <a href="/src/Vault.sol/abstract.Vault.html">Vault</a></p>
 <p>Manages bridge operations and attestation validations</p>

src/Events.sol/contract.Events.html

@@ -178,7 +178,7 @@ <h1 class="menu-title">Eigen-Bridge</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="events"><a class="header" href="#events">Events</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/Events.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/Events.sol">Git Source</a></p>
 <p>Contains event definitions for bridge operations</p>
 <h2 id="events-1"><a class="header" href="#events-1">Events</a></h2>
 <h3 id="bridgerequest"><a class="header" href="#bridgerequest">BridgeRequest</a></h3>

src/PermissionedBridge.sol/contract.PermissionedBridge.html

@@ -178,7 +178,7 @@ <h1 class="menu-title">Eigen-Bridge</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="permissionedbridge"><a class="header" href="#permissionedbridge">PermissionedBridge</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/PermissionedBridge.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/PermissionedBridge.sol">Git Source</a></p>
 <p><strong>Inherits:</strong>
 <a href="/src/Vault.sol/abstract.Vault.html">Vault</a></p>
 <p>Manages bridge operations with manually set operator weights</p>

src/Structs.sol/library.Structs.html

@@ -178,7 +178,7 @@ <h1 class="menu-title">Eigen-Bridge</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="structs"><a class="header" href="#structs">Structs</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/Structs.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/Structs.sol">Git Source</a></p>
 <p>Contains struct definitions and related functions for bridge operations</p>
 <h2 id="functions"><a class="header" href="#functions">Functions</a></h2>
 <h3 id="hash"><a class="header" href="#hash">hash</a></h3>

src/Vault.sol/abstract.Vault.html

@@ -178,7 +178,7 @@ <h1 class="menu-title">Eigen-Bridge</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="vault"><a class="header" href="#vault">Vault</a></h1>
-<p><a href="https://github.com/idatsy/eigen-bridge/blob/c580a263608f0a9abe800c41a2d4bf408db0805d/src/Vault.sol">Git Source</a></p>
+<p><a href="https://github.com/idatsy/eigen-bridge/blob/eebec4f167dbfa8749ada8d03753364230dd7d49/src/Vault.sol">Git Source</a></p>
 <p><strong>Inherits:</strong>
 <a href="/src/ECDSAUtils.sol/contract.ECDSAUtils.html">ECDSAUtils</a>, <a href="/src/Events.sol/contract.Events.html">Events</a>, ReentrancyGuard, OwnableUpgradeable</p>
 <p>Abstract contract providing common vault functionality for bridge contracts</p>