diff --git a/.cspell.json b/.cspell.json index 9d6abbf..600fa69 100644 --- a/.cspell.json +++ b/.cspell.json @@ -67,6 +67,9 @@ ], "ignoreWords": [ "Hildr", + "Superproof", + "Shisui", + "Flashbots", "meili", "Linea" ] diff --git a/docs/blob-archiver-rs-docs/index.md b/docs/blob-archiver-rs-docs/index.md new file mode 100644 index 0000000..36d3b5c --- /dev/null +++ b/docs/blob-archiver-rs-docs/index.md @@ -0,0 +1,24 @@ +# blob-archiver-rs +This is a Rust implementation of +the [Beacon Chain blob archiver](https://github.com/base-org/blob-archiver) + +### Development +```sh +# Run the tests +cargo test --workspace --all-features --all-targets --locked + +# Lint the project +cargo clippy --workspace --all-targets --all-features -- -D warnings + +# Build the project +cargo build --workspace --all-targets --all-features + +``` + +#### Run Locally +To run the project locally, you should first copy `.env.template` to `.env` and then modify the environment variables +to your beacon client and storage backend of choice. Then you can run the project with: + +```sh +docker compose up +``` \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 63a920c..4d6c319 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -114,6 +114,18 @@ const config = { position: "left", label: "Superproof", }, + { + type: "doc", + docId: "blob-archiver-rs-docs/index", + position: "left", + label: "Blob-arhiver-rs", + }, + { + type: "doc", + docId: "blob-archiver-rs-docs/index", + position: "left", + label: "Blob-arhiver-rs", + }, { href: "https://discord.gg/YC34UKyc2Y", className: "header-discord-link", diff --git a/sidebars.js b/sidebars.js index edba587..b7727ee 100644 --- a/sidebars.js +++ b/sidebars.js @@ -62,6 +62,9 @@ const sidebars = { ], }, ], + blobArchiverRs: [ + "blob-archiver-rs-docs/index", + ], }; module.exports = sidebars;