refactor: css and theme updates (#20)

Author: sambacha

.prettierignore

@@ -1,7 +1,7 @@
+.docusaurus/
 .next
 node_modules
 *.min.js
-*.css
 *.html
 cache/
 .cache

.prettierrc.js

@@ -7,7 +7,7 @@ module.exports = {
   jsxBracketSameLine: false,
   jsxSingleQuote: false,
   printWidth: 120,
-  proseWrap: 'always',
+  proseWrap: 'never',
   quoteProps: 'as-needed',
   semi: true,
   singleQuote: true,

README.md

@@ -0,0 +1,24 @@
+# [docs.openmev.org](https://docs.openmev.org)
+
+## Overview
+
+
+## Development
+
+
+## License
+
+Licensed under either of
+
+ * Apache License, Version 2.0
+   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license
+   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.

docs/guides/cheatsheet.md

@@ -0,0 +1,106 @@
+# Flashbots Cheatsheet
+
+> [source via docs.flashbots.net/flashbots-auction/overview](https://docs.flashbots.net/flashbots-auction/overview)
+
+> Notes on the current state of flashbots docs with relevance to assumptions of bundle process.
+
+## Anatomy of a bundle
+
+```ts
+const blockNumber = await provider.getBlockNumber()
+const minTimestamp = (await provider.getBlock(blockNumber)).timestamp
+const maxTimestamp = minTimestamp + 120
+const signedBundle = flashbotsProvider.signBundle(
+    [
+      {
+        signedTransaction: SIGNED_ORACLE_UPDATE_FROM_PENDING_POOL // serialized signed transaction hex
+      },
+      {
+        signer: wallet, // ethers signer
+        transaction: transaction // ethers populated transaction object
+      }
+    ])
+const bundleReceipt = await flashbotsProvider.sendRawBundle(
+    signedBundle, // bundle we signed above
+    targetBlockNumber, // block number at which this bundle is valid
+    {
+      minTimestamp, // optional minimum timestamp at which this bundle is valid (inclusive)
+      maxTimestamp, // optional maximum timestamp at which this bundle is valid (inclusive)
+      revertingTxHashes: [tx1, tx2] // optional list of transaction hashes allowed to revert. Without specifying here, any revert invalidates the entire bundle.
+    }
+  )
+)
+```
+
+## Miner reward through coinbase.transfer()
+
+https://docs.flashbots.net/flashbots-auction/searchers/advanced/coinbase-payment
+
+To include as last action of smart contract
+
+```solidity
+block.coinbase.transfer(AMOUNT_TO_TRANSFER)
+
+```
+
+Edge case to deal with sending to a miner contract
+```solidity
+block.coinbase.call{value: _ethAmountToCoinbase}(new bytes(0));
+```
+subject to [reentrancy attacks](https://medium.com/coinmonks/protect-your-solidity-smart-contracts-from-reentrancy-attacks-9972c3af7c21)
+
+## Bundle pricing
+
+https://docs.flashbots.net/flashbots-auction/searchers/advanced/bundle-pricing
+
+Conflicting bundles received by flashbots are ordered by the following formula:
+
+![\bg_white \Large score=\frac{minerBribe + totalGasUsed * priorityFeePerGas - mempoolGasUsed * priorityFeePerGas}{totalGasUsed}](https://latex.codecogs.com/png.latex?\bg_white&space;\Large&space;score=\frac{minerBribe&space;+&space;totalGasUsed&space;*&space;priorityFeePerGas&space;-&space;mempoolGasUsed&space;*&space;priorityFeePerGas}{totalGasUsed})
+
+## Eligibility
+
+https://docs.flashbots.net/flashbots-auction/miners/mev-geth-spec/v04
+
+Bundles must have a target `blockNumber` and a `priorityFeePerGas` >= 1 Gwei.
+
+## Reverting txs
+https://docs.flashbots.net/flashbots-auction/miners/mev-geth-spec/v04
+
+
+"When constructing a block the node should reject any bundle or megabundle that has a reverting transaction unless its hash is included in the RevertingTxHashes list of the bundle"
+
+## Debugging
+
+https://docs-staging.flashbots.net/flashbots-auction/searchers/advanced/troubleshooting
+
+1. Transaction failure (ANY within the bundle)
+2. Incentives (gas price/coinbase transfers) not high enough to offset value of block space
+
+Simulate bundle:
+```ts
+  const signedTransactions = await flashbotsProvider.signBundle(transactionBundle)
+  const simulation = await flashbotsProvider.simulate(signedTransactions, targetBlockNumber, targetBlockNumber + 1)
+  console.log(JSON.stringify(simulation, null, 2))
+```
+
+3. Competitors paying more
+
+Get conflicting bundles for a prior block:
+```ts
+const signedTransactions = await flashbotsProvider.signBundle(transactionBundle)
+console.log(await flashbotsProvider.getConflictingBundle(
+      signedTransactions,
+      13140328 // blockNumber
+  ))
+```
+
+4. Bundle received too late to appear in target block
+
+Get submission time data and compare to block time:
+```ts
+console.log(
+  await flashbotsProvider.getBundleStats("0x123456789abcdef123456789abcdef123456789abcdef123456789abcdef1234", 13509887)
+  )
+
+```
+

docs/introduction.md

@@ -36,56 +36,19 @@ Example use cases include:
 
 This ethos is at the heart of OpenMEV. Part of establishing credible neutrality is having a clear and comprehensive rule
 book that regulates off-chain behavior and activities. Our assumption concerning governance is that methods and
-processes that work in legacy markets may not be applicable in adversarial environments such as permissionless
-blockchains. With that understanding it is important not to rely solely on such systems and mechanics long term.
+processes that work in legacy markets may not be applicable in adversarial environments such as permissionless blockchains. With that understanding it is important not to rely solely on such systems and mechanics long term.
 
 > Discuss this and more on our [discourse forums](https://forums.manifoldfinance.com)
 
 :::info
 [MEV or Maximal Extractable Value](https://medium.com/-research/we-live-in-a-mempool-backrunning-the-mev-crisis-a4ea0b493b05)
 is the value of the ability to order transactions within a block or blocks.
 
-- Tom Schmidt, Dragonfly Capital :::
+- Tom Schmidt, Dragonfly Capital 
+:::
 
 ## Getting started
 
 OpenMEV consists of several components. If you want to learn more about the way it works, go to our
 [technical overview](/technical-reference/intro). If you have an application or a service that needs a system to prevent
 MEV attacks, you can read our guides on how to integrate our SDK.
-
-### Acknowledgements
-
-> Not an exhaustive list
-
-- Nikolai Mushegian
-- Florian (@floki)
-- BoringCrypto
-- Barry London
-- Banteg
-- BobTheBuilder
-- WeArethe0.3xpercent (group)
-- Robert Miller (@bertmiller)
-- Edgar Arout (@fxfactorial)
-- Alex Obadia
-- Nathan (@CodeForcer)
-- 0xMaki
-- Joseph Delong (@dangerousfood)
-- Alexey Akhunov (@AlexeyAkhunov)
-- Igor Barinov (@igorbarinov)
-- bokkypoobah (@bokkypoobah)
-- x48 (@x48-crypto)
-- Jonas Chevalier (@zimbatm)
-- BMG (@brianmcgee)
-- Aldo Borrero (@aldoborrero)
-- Sandy Bradley (@sandybradley)
-- Connor Gervin (@Connor-Gervin)
-- OhHeyMatty
-- Chad
-- Manifold Finance Telegram Chat (t.me/manifoldfinance)
-- Ramin (@chillichelli)
-- Caleb Sheridan (Eden Network)
-- ControlCplusControlV
-- I Am Software (@matthewlilley)
-- Antony Ducommun
-- Jörg Thalheim (@Mic92)
-- Tom Schmidt (dragonfly capital)

docusaurus.config.js

@@ -1,3 +1,9 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require('prism-react-renderer/themes/github');
+const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+
 // With JSDoc @type annotations, IDEs can provide config autocompletion
 /** @type {import('@docusaurus/types').DocusaurusConfig} */
 module.exports = {
@@ -6,11 +12,19 @@ module.exports = {
   url: 'https://docs.openmev.org',
   baseUrl: '/',
   favicon: '/img/favicon.ico',
+  trailingSlash: false,
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
   organizationName: 'openmev',
   projectName: 'docs',
-
+  plugins: [
+    [
+      require.resolve('@cmfcmf/docusaurus-search-local'),
+      {
+        indexBlog: false,
+      },
+    ],
+  ],
   presets: [
     [
       '@docusaurus/preset-classic',
@@ -33,6 +47,8 @@ module.exports = {
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
       prism: {
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
         additionalLanguages: ['solidity'],
       },
       navbar: {
@@ -103,7 +119,7 @@ module.exports = {
             ],
           },
         ],
-        copyright: `Copyright © 2021 CommodityStream llc. | All rights reserved.`,
+        copyright: `Copyright © ${new Date().getFullYear()} Manifold Finance, Inc. | All rights reserved.`,
       },
       colorMode: {
         defaultMode: 'dark',

package.json

@@ -1,7 +1,7 @@
 {
   "name": "openmev-docs",
   "description": "OpenMEV documentation website.",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -16,6 +16,7 @@
     "typecheck": "tsc"
   },
   "dependencies": {
+    "@cmfcmf/docusaurus-search-local": "^0.10.0",
     "@docusaurus/core": "2.0.0-beta.18",
     "@docusaurus/preset-classic": "2.0.0-beta.18",
     "@mdx-js/react": "^1.6.22",
@@ -37,9 +38,10 @@
   },
   "browserslist": {
     "production": [
-      ">0.5%",
-      "not dead",
-      "not op_mini all"
+      ">0.3%",
+      "not IE > 0",
+      "not op_mini all",
+      "not dead"
     ],
     "development": [
       "last 1 chrome version",