Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removes Status blog and clean up quickstart #29

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions blog/2024-02-16-eigenda-goerli.md

This file was deleted.

21 changes: 0 additions & 21 deletions blog/2024-02-19-eigenda-goerli.md

This file was deleted.

Empty file removed blog/authors.yml
Empty file.
29 changes: 10 additions & 19 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,16 @@ title: Quick Start

**Prerequisites:**

- Open a linux terminal.
- Open a Linux terminal.
- [Install grpccurl for your environment](https://github.com/fullstorydev/grpcurl#installation).
- Download the eigenda repository and change your current working directory. The
included Protobuf definitions will be required:
- Download the EigenDA repository and change your current working directory.

```
gh repo clone Layr-Labs/eigenda
cd eigenda
git clone https://github.com/Layr-Labs/eigenda.git
cd eigenda
```

**Step 1: Build EigenDA Utils**

The next step requires the `kzgpad` utility, which you can build with the following:

```
Expand All @@ -34,13 +32,7 @@ Invoke the Disperser/DisperseBlob endpoint.
Example request:

```
# Download the EigenDA repo via gh client or wget
$ gh repo clone Layr-Labs/eigenda
# Change your working directory to the eigenda folder in order to point to the
# protobuf defintions correctly
$ cd eigenda

$ grpcurl \
grpcurl \
-import-path ./api/proto \
-proto ./api/proto/disperser/disperser.proto \
-d '{"data": "'$(tools/kzgpad/bin/kzgpad -e hello)'"}' \
Expand All @@ -54,9 +46,9 @@ correctly stored and dispersed to the EigenDA network. The GetBlobStatus service
will return a value via the BlobStatus enumerated type.

Best practice is for users to poll the GetBlobStatus service to monitor status
of the Blobs as needed. Rollups may Polling once every 5-10 seconds to monitor
of the Blobs as needed. Rollups may poll once every 5-10 seconds to monitor
the status of a blob until it has successfully dispersed on the network with
status of CONFIRMED. Confirmation can take up to a few minutes after the blob
status of `CONFIRMED`. Confirmation can take up to a few minutes after the blob
has been initially sent to the disperser, depending on network conditions.

Example request:
Expand All @@ -65,7 +57,7 @@ Example request:
# Update the value of INSERT_REQUEST_ID with the result of your disperse call
# above

$ grpcurl \
grpcurl \
-import-path ./api/proto \
-proto ./api/proto/disperser/disperser.proto \
-d '{"request_id": "INSERT_REQUEST_ID"}' \
Expand All @@ -74,17 +66,16 @@ $ grpcurl \

**Step 4: Retrieve a blob**

Option A: invoke the Disperser/RetrieveBlob rpc endpoint. This is a recommended
Option A: invoke the Disperser/RetrieveBlob RPC endpoint. This is a recommended
function for anyone that would like to inspect a stored blob.

Example request:

```

# Note the value for batch_header_hash can be obtained from the result of your
# call to GetBlobStatus via info.blob_verification_proof.batch_metadata.batch_header_hash.

$ grpcurl \
grpcurl \
-import-path ./api/proto \
-proto ./api/proto/disperser/disperser.proto \
-d '{"batch_header_hash": "INSERT_VALUE", "blob_index":"INSERT_VALUE"}' \
Expand Down
10 changes: 0 additions & 10 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -218,11 +218,6 @@ const config = {
rehypePlugins: [katex],
showLastUpdateTime: false
},
blog: {
blogTitle: "EigenDA Status",
postsPerPage: "ALL",
routeBasePath: "/status",
},

theme: {
customCss: require.resolve("./src/css/custom.css"),
Expand Down Expand Up @@ -256,11 +251,6 @@ const config = {
label: "EigenLayer Docs",
position: "right",
},
{
to: "status",
label: "Status",
position: "right",
},
{
href: "https://github.com/Layr-Labs",
className: "header--github-link",
Expand Down
20 changes: 20 additions & 0 deletions sidebar.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
export default {
myAutogeneratedSidebar: [
{
type: 'autogenerated',
dirName: '.', // '.' means the current docs folder
},
],
};
// export default {
// BasicSidebar: [
// {
// type: 'category',
// label: 'Overview',
// items: [
// 'overview',
// 'overview/test',
// ]
// }
// ]
// };
100 changes: 100 additions & 0 deletions src/pages/_index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import Layout from '@theme/Layout';
import styles from './index.module.css';
import Card from "../components/Card";



function Home() {
const context = useDocusaurusContext();
const { siteConfig = {} } = context;

return (
<Layout title="Homepage" description="EigenDA Documentation">
<main className={styles.main}>
<br />
<h1
align="center"
title="tagline"
style={{
fontWeight: "700",
marginBottom: "0px",
fontSize: "x-large",
}}
>
EigenDA Documentation
</h1>
<section className={styles.features}>
<div className="container">
<div className="row cards__container">

<Card
to="overview"
header={{
label: "Overview"
}}
body={{
label: "Start your journey with an overview of the EigenDA protocol"
}}
/>

<Card
to="integrations-guides/dispersal/api-documentation/overview"
header={{
label: "Learn: Network API Reference"
}}
body={{
label: "These pages document the details of how to integrate with EigenDA"
}}
/>

<Card
to="quick-start"
header={{
label: "Disperse your first blob"
}}
body={{
label: "Learn how EigenDA works by dispersing and retrieving a blob on the command line"
}}
/>

<Card
to="integrations-guides/rollup-guides/op-stack/"
header={{
label: "Launch an OP Stack Rollup"
}}
body={{
label: "Ready to launch a rollup on EigenDA? Get started here"
}}
/>

<Card
to="operator-guides/overview"
header={{
label: "Run an EigenDA node"
}}
body={{
label: "Look here for docs on spinning up an EigenDA node"
}}
/>

<Card
to="https://forms.gle/CMSJTxQPXfG5HTQQ7"
header={{
label: "Register for EigenDA Mainnet"
}}
body={{
label: "EigenDA Mainnet will soon be permissionless; until then please register here to launch your rollup"
}}
/>

</div>
</div>
</section>
</main>

</Layout>
);
}

export default Home;