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

chore: Update commitment schemas in README #95

Merged
merged 2 commits into from
Aug 22, 2024
Merged
Changes from 1 commit
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
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,15 +155,26 @@ Container can be built via running `make docker-build`.

## Commitment Schemas

Commitments returned from the EigenDA Proxy adhere to the following byte encoding:
### Optimism Commitment Mode
For `alt-da` clients running on Optimism, the following commitment schema is supported:

```
0 1 2 3 N
|--------|--------|---------|---------------|
commit da layer version raw commitment
0 1 2 3 N
|--------|--------|---------|----------------|
commit da layer version raw commitment
ethenotethan marked this conversation as resolved.
Show resolved Hide resolved
type type byte
```

### Generic Commitment Mode
ethenotethan marked this conversation as resolved.
Show resolved Hide resolved
For generic clients communicating with proxy, the following commitment schema is supported:

```
0 1 N
|---------|-----------------|
version raw commitment
byte
```

The `raw commitment` is an RLP-encoded [EigenDA certificate](https://github.com/Layr-Labs/eigenda/blob/eb422ff58ac6dcd4e7b30373033507414d33dba1/api/proto/disperser/disperser.proto#L168).

**NOTE:** Commitments are cryptographically verified against the data fetched from EigenDA for all `/get` calls. The server will respond with status `500` in the event where EigenDA were to lie and provide falsified data thats irrespective of the client provided commitment. This feature cannot be disabled and is part of standard operation.
Expand Down
Loading