feat: initial commit

.gitignore

@@ -0,0 +1,175 @@
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+# This is a library so no lock
+package-lock.json

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Koray Koska
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,71 @@
+# mev-bundle-submitter
+
+This npm package submits given bundles to all known builders in the Ethereum builder space.
+
+## Example
+
+You can find a usage guide in `tester.js`. Simply replace the placeholders with your bloxroute token,
+the Ethereum Mainnet Json RPC provider with your URL or API key from [Chainnodes](https://www.chainnodes.org/),
+your bundle transactions (raw transaction strings) with your own and a current or near future block number.
+
+## Configuration
+
+The only required argument in the constructor is `provider`. So the below is a minimal example:
+
+```JS
+import { ethers } from "ethers";
+import { MEVBundleSubmitter } from "mev-bundle-submitter";
+
+const submitter = new MEVBundleSubmitter({
+  provider: new ethers.providers.JsonRpcProvider(
+    "https://mainnet.chainnodes.org/api_key"
+  ),
+});
+```
+
+If the optional parameter `bloxrouteAuth` is set, `submitToAll` will also send to BloXroute.
+
+If the optional parameter `authSigner` is set, it will be used to sign the bundles (instead of a random Wallet).
+
+A full example can be seen below:
+
+```JS
+import { ethers, Wallet } from "ethers";
+import { MEVBundleSubmitter } from "mev-bundle-submitter";
+
+const submitter = new MEVBundleSubmitter({
+  bloxrouteAuth: "BloxRoute_Token",
+  provider: new ethers.providers.JsonRpcProvider(
+    "https://mainnet.chainnodes.org/api_key"
+  ),
+  authSigner: new Wallet("0xprivate_key"),
+});
+```
+
+## Usage
+
+After creating the instance `MEVBundleSubmitter`, you can call `submitToAll` as many times as you wish.
+
+The only required parameter is `bundle`, which includes raw transactions and a block number to submit for.
+
+Optionally you can set `exclude`, to exclude an array of builders, and `customBuilders` to add a list of custom builders.
+
+A full list of included builders can be seen by calling `MEVBundleSubmitter.allBuilders` or checking the `index.js`.
+
+Full example:
+
+```JS
+const instanceOfFlashbotsBundleProvider = await FlashbotsBundleProvider.create(...);
+
+const response = await submitter.submitToAll({
+  bundle: {
+    transactions: ["0xmempooltx", "0xraw_tx"],
+    blockNumber: BigInt("15000000"),
+  },
+  exclude: ["beaver", "rsync"],
+  customBuilders: {
+    my_custom_builder1: instanceOfFlashbotsBundleProvider,
+    my_custom_builder2: { url: "https://a-good-builder.com/bundles" }
+  }
+});
+```