WIP: swagger

Commit-Boost · Jul 5, 2024 · 5c342bb · 5c342bb
1 parent c7e3fae
commit 5c342bb
Show file tree

Hide file tree

Showing 27 changed files with 195 additions and 6 deletions.
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -1,4 +1,4 @@
 # Architecture
 The following are schematics and details around Commit-Boost.
 1. [Core Commit-Boost](architecture-core-commit-boost.md)
-1. [Terminology](terminology.md)
+2. [Terminology](terminology.md)
diff --git a/docs/commit-boost.png b/docs/commit-boost.png
diff --git a/docs/dist/favicon-16x16.png b/docs/dist/favicon-16x16.png
diff --git a/docs/dist/favicon-32x32.png b/docs/dist/favicon-32x32.png
diff --git a/docs/dist/index.css b/docs/dist/index.css
@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}
diff --git a/docs/dist/index.html b/docs/dist/index.html
@@ -0,0 +1,19 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="index.css" />
+    <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="./swagger-initializer.js" charset="UTF-8"> </script>
+  </body>
+</html>
diff --git a/docs/dist/oauth2-redirect.html b/docs/dist/oauth2-redirect.html
@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1).replace('?', '&');
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&");
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';});
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value);
+                }
+        ) : {};
+
+        isValid = qp.state === sentState;
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode" ||
+          oauth2.auth.schema.get("flow") === "authorizationCode" ||
+          oauth2.auth.schema.get("flow") === "authorization_code"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg;
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>
diff --git a/api/signer-api.yml → docs/dist/signer-api.yml b/api/signer-api.yml → docs/dist/signer-api.yml
diff --git a/docs/dist/swagger-initializer.js b/docs/dist/swagger-initializer.js
@@ -0,0 +1,20 @@
+window.onload = function() {
+  //<editor-fold desc="Changeable Configuration Block">
+
+  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
+  window.ui = SwaggerUIBundle({
+    url: "signer-api.yml",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+
+  //</editor-fold>
+};
diff --git a/docs/dist/swagger-ui-bundle.js b/docs/dist/swagger-ui-bundle.js
diff --git a/docs/dist/swagger-ui-bundle.js.map b/docs/dist/swagger-ui-bundle.js.map
diff --git a/docs/dist/swagger-ui-es-bundle-core.js b/docs/dist/swagger-ui-es-bundle-core.js
diff --git a/docs/dist/swagger-ui-es-bundle-core.js.map b/docs/dist/swagger-ui-es-bundle-core.js.map
diff --git a/docs/dist/swagger-ui-es-bundle.js b/docs/dist/swagger-ui-es-bundle.js
diff --git a/docs/dist/swagger-ui-es-bundle.js.map b/docs/dist/swagger-ui-es-bundle.js.map
diff --git a/docs/dist/swagger-ui-standalone-preset.js b/docs/dist/swagger-ui-standalone-preset.js
diff --git a/docs/dist/swagger-ui-standalone-preset.js.map b/docs/dist/swagger-ui-standalone-preset.js.map
diff --git a/docs/dist/swagger-ui.css b/docs/dist/swagger-ui.css
diff --git a/docs/dist/swagger-ui.css.map b/docs/dist/swagger-ui.css.map
diff --git a/docs/dist/swagger-ui.js b/docs/dist/swagger-ui.js
diff --git a/docs/dist/swagger-ui.js.map b/docs/dist/swagger-ui.js.map
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,9 @@
-# Welcome to Commit-Boost
+# Introduction
+![logo](logo.jpeg)
+Commit-Boost is an open-source public good that is fully compatible with [MEV-Boost](https://github.com/flashbots/mev-boost), but acts as a light-weight validator platform to enable safe commitments. Specifically, Commit-Boost is a new Ethereum validator sidecar focused on standardizing the last mile of communication between validators and commitments. It has been designed with modularity at its core, with the goal of not limiting the range of different proposer commitments protocols and the open design space around those protocols. 
 
-Commit-Boost is a powerful tool for optimizing your commit workflow.
+[Background](background.md)
+[What is Commit-Boost?](what-is-cb.md)
 
 ## Table of Contents
 

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1,5 +1,6 @@
 # Introduction
-Commit-Boost is an open-source public good that is fully compatible with [MEV-Boost](https://github.com/flashbots/mev-boost), but acts as a light-weight validator platform to enable safe commitments. Specifically, Commit-Boost is a new Ethereum validator sidecar focused on standardizing the last mile of communication between validators and commitments. It has been designed with modularity at its core, with the goal of not limiting the range of different proposer commitments protocols and the open design space around those protocols. 
 
 [Background](background.md)
-[What is Commit-Boost?](what-is-cb.md)
+[What is Commit-Boost?](what-is-cb.md)
+[Architecture](architecture.md)
+[Discussion Points / Roadmap](roadmap.md)
diff --git a/docs/logo.jpeg b/docs/logo.jpeg
diff --git a/docs/reference.md b/docs/reference.md
@@ -1,3 +1,3 @@
 # Reference
-1. [Signer API](signer-api.md)
+1. [Signer API](signer-api.html)
 3. [Terminology](terminology.md)
diff --git a/docs/roadmap.md b/docs/roadmap.md
@@ -0,0 +1,12 @@
+# Discussion Points / Roadmap
+- Signer: Least explored area, right now Commit-Boost is built to leverage a proxy key of the validator but we are post ETH CC / this post hope to engage on how best to safely design this
+
+- Docker and Binary: right now we just have support for Docker to instantiate modules, but shortly after ETH CC we plan to expand this to support binary (i.e., both Docker and binary will be enabled allowing the proper to select its preferred approach given the set-up)
+
+- More detailed telemetry and logging: We have some standard metrics reporting already, but plan to continue to expand this based on feedback / development work from a few teams across the community
+
+- Support for additional key managers (web3signer, ERC-2335, keystores, proxy): Right now we just have support for remote key signers, but are expanding this post ETH CC alongside the broader R&D efforts for the signer
+
+- Post ETH CC we plan to Increase modularity for services, including in-process monitoring and extensive configurability by the validator
+
+- Support both BLS and ECDSA
diff --git a/docs/signer-api.html b/docs/signer-api.html
@@ -0,0 +1,19 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="dist/swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="dist/index.css" />
+    <link rel="icon" type="image/png" href="dist/favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="dist/favicon-16x16.png" sizes="16x16" />
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="dist/swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="dist/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="dist/swagger-initializer.js" charset="UTF-8"> </script>
+  </body>
+</html>