Skip to content

Commit c4f9e3e

Browse files
committed
add blob-archiver-rs doc
1 parent 133a2f2 commit c4f9e3e

File tree

4 files changed

+42
-0
lines changed

4 files changed

+42
-0
lines changed

Diff for: .cspell.json

+3
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@
6767
],
6868
"ignoreWords": [
6969
"Hildr",
70+
"Superproof",
71+
"Shisui",
72+
"Flashbots",
7073
"meili",
7174
"Linea"
7275
]

Diff for: docs/blob-archiver-rs-docs/index.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# blob-archiver-rs
2+
This is a Rust implementation of
3+
the [Beacon Chain blob archiver](https://github.com/base-org/blob-archiver)
4+
5+
### Development
6+
```sh
7+
# Run the tests
8+
cargo test --workspace --all-features --all-targets --locked
9+
10+
# Lint the project
11+
cargo clippy --workspace --all-targets --all-features -- -D warnings
12+
13+
# Build the project
14+
cargo build --workspace --all-targets --all-features
15+
16+
```
17+
18+
#### Run Locally
19+
To run the project locally, you should first copy `.env.template` to `.env` and then modify the environment variables
20+
to your beacon client and storage backend of choice. Then you can run the project with:
21+
22+
```sh
23+
docker compose up
24+
```

Diff for: docusaurus.config.js

+12
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,18 @@ const config = {
114114
position: "left",
115115
label: "Superproof",
116116
},
117+
{
118+
type: "doc",
119+
docId: "blob-archiver-rs-docs/index",
120+
position: "left",
121+
label: "Blob-arhiver-rs",
122+
},
123+
{
124+
type: "doc",
125+
docId: "blob-archiver-rs-docs/index",
126+
position: "left",
127+
label: "Blob-arhiver-rs",
128+
},
117129
{
118130
href: "https://discord.gg/YC34UKyc2Y",
119131
className: "header-discord-link",

Diff for: sidebars.js

+3
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ const sidebars = {
6262
],
6363
},
6464
],
65+
blobArchiverRs: [
66+
"blob-archiver-rs-docs/index",
67+
],
6568
};
6669

6770
module.exports = sidebars;

0 commit comments

Comments
 (0)