Skip to content

Commit

Permalink
[v2] Remove InsufficientSignatures blob state (#936)
Browse files Browse the repository at this point in the history
  • Loading branch information
ian-shim authored Dec 11, 2024
1 parent 4a9bf58 commit 17259f5
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 84 deletions.
12 changes: 2 additions & 10 deletions api/docs/disperser_v2.html
Original file line number Diff line number Diff line change
Expand Up @@ -780,7 +780,7 @@ <h3 id="disperser.v2.SignedBatch">SignedBatch</h3>


<h3 id="disperser.v2.BlobStatus">BlobStatus</h3>
<p>BlobStatus represents the status of a blob.</p><p>The status of a blob is updated as the blob is processed by the disperser.</p><p>The status of a blob can be queried by the client using the GetBlobStatus API.</p><p>Intermediate states are states that the blob can be in while being processed, and it can be updated to a differet state:</p><p>- QUEUED</p><p>- ENCODED</p><p>Terminal states are states that will not be updated to a different state:</p><p>- CERTIFIED</p><p>- FAILED</p><p>- INSUFFICIENT_SIGNATURES</p>
<p>BlobStatus represents the status of a blob.</p><p>The status of a blob is updated as the blob is processed by the disperser.</p><p>The status of a blob can be queried by the client using the GetBlobStatus API.</p><p>Intermediate states are states that the blob can be in while being processed, and it can be updated to a differet state:</p><p>- QUEUED</p><p>- ENCODED</p><p>Terminal states are states that will not be updated to a different state:</p><p>- CERTIFIED</p><p>- FAILED</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
Expand Down Expand Up @@ -814,15 +814,7 @@ <h3 id="disperser.v2.BlobStatus">BlobStatus</h3>
<tr>
<td>FAILED</td>
<td>4</td>
<td><p>FAILED means that the blob has failed permanently (for reasons other than insufficient
signatures, which is a separate state)</p></td>
</tr>

<tr>
<td>INSUFFICIENT_SIGNATURES</td>
<td>5</td>
<td><p>INSUFFICIENT_SIGNATURES means that the confirmation threshold for the blob was not met
for at least one quorum.</p></td>
<td><p>FAILED means that the blob has failed permanently</p></td>
</tr>

</tbody>
Expand Down
4 changes: 1 addition & 3 deletions api/docs/disperser_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,16 +285,14 @@ Intermediate states are states that the blob can be in while being processed, an
Terminal states are states that will not be updated to a different state:
- CERTIFIED
- FAILED
- INSUFFICIENT_SIGNATURES

| Name | Number | Description |
| ---- | ------ | ----------- |
| UNKNOWN | 0 | |
| QUEUED | 1 | QUEUED means that the blob has been queued by the disperser for processing |
| ENCODED | 2 | ENCODED means that the blob has been encoded and is ready to be dispersed to DA Nodes |
| CERTIFIED | 3 | CERTIFIED means the blob has been dispersed and attested by the DA nodes |
| FAILED | 4 | FAILED means that the blob has failed permanently (for reasons other than insufficient signatures, which is a separate state) |
| INSUFFICIENT_SIGNATURES | 5 | INSUFFICIENT_SIGNATURES means that the confirmation threshold for the blob was not met for at least one quorum. |
| FAILED | 4 | FAILED means that the blob has failed permanently |



Expand Down
12 changes: 2 additions & 10 deletions api/docs/eigenda-protos.html
Original file line number Diff line number Diff line change
Expand Up @@ -2443,7 +2443,7 @@ <h3 id="disperser.v2.SignedBatch">SignedBatch</h3>


<h3 id="disperser.v2.BlobStatus">BlobStatus</h3>
<p>BlobStatus represents the status of a blob.</p><p>The status of a blob is updated as the blob is processed by the disperser.</p><p>The status of a blob can be queried by the client using the GetBlobStatus API.</p><p>Intermediate states are states that the blob can be in while being processed, and it can be updated to a differet state:</p><p>- QUEUED</p><p>- ENCODED</p><p>Terminal states are states that will not be updated to a different state:</p><p>- CERTIFIED</p><p>- FAILED</p><p>- INSUFFICIENT_SIGNATURES</p>
<p>BlobStatus represents the status of a blob.</p><p>The status of a blob is updated as the blob is processed by the disperser.</p><p>The status of a blob can be queried by the client using the GetBlobStatus API.</p><p>Intermediate states are states that the blob can be in while being processed, and it can be updated to a differet state:</p><p>- QUEUED</p><p>- ENCODED</p><p>Terminal states are states that will not be updated to a different state:</p><p>- CERTIFIED</p><p>- FAILED</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
Expand Down Expand Up @@ -2477,15 +2477,7 @@ <h3 id="disperser.v2.BlobStatus">BlobStatus</h3>
<tr>
<td>FAILED</td>
<td>4</td>
<td><p>FAILED means that the blob has failed permanently (for reasons other than insufficient
signatures, which is a separate state)</p></td>
</tr>

<tr>
<td>INSUFFICIENT_SIGNATURES</td>
<td>5</td>
<td><p>INSUFFICIENT_SIGNATURES means that the confirmation threshold for the blob was not met
for at least one quorum.</p></td>
<td><p>FAILED means that the blob has failed permanently</p></td>
</tr>

</tbody>
Expand Down
4 changes: 1 addition & 3 deletions api/docs/eigenda-protos.md
Original file line number Diff line number Diff line change
Expand Up @@ -986,16 +986,14 @@ Intermediate states are states that the blob can be in while being processed, an
Terminal states are states that will not be updated to a different state:
- CERTIFIED
- FAILED
- INSUFFICIENT_SIGNATURES

| Name | Number | Description |
| ---- | ------ | ----------- |
| UNKNOWN | 0 | |
| QUEUED | 1 | QUEUED means that the blob has been queued by the disperser for processing |
| ENCODED | 2 | ENCODED means that the blob has been encoded and is ready to be dispersed to DA Nodes |
| CERTIFIED | 3 | CERTIFIED means the blob has been dispersed and attested by the DA nodes |
| FAILED | 4 | FAILED means that the blob has failed permanently (for reasons other than insufficient signatures, which is a separate state) |
| INSUFFICIENT_SIGNATURES | 5 | INSUFFICIENT_SIGNATURES means that the confirmation threshold for the blob was not met for at least one quorum. |
| FAILED | 4 | FAILED means that the blob has failed permanently |



Expand Down
79 changes: 35 additions & 44 deletions api/grpc/disperser/v2/disperser_v2.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 1 addition & 7 deletions api/proto/disperser/v2/disperser_v2.proto
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,6 @@ message GetPaymentStateReply {
// Terminal states are states that will not be updated to a different state:
// - CERTIFIED
// - FAILED
// - INSUFFICIENT_SIGNATURES
enum BlobStatus {
UNKNOWN = 0;

Expand All @@ -112,13 +111,8 @@ enum BlobStatus {
// CERTIFIED means the blob has been dispersed and attested by the DA nodes
CERTIFIED = 3;

// FAILED means that the blob has failed permanently (for reasons other than insufficient
// signatures, which is a separate state)
// FAILED means that the blob has failed permanently
FAILED = 4;

// INSUFFICIENT_SIGNATURES means that the confirmation threshold for the blob was not met
// for at least one quorum.
INSUFFICIENT_SIGNATURES = 5;
}

// SignedBatch is a batch of blobs with a signature.
Expand Down
7 changes: 0 additions & 7 deletions disperser/common/v2/blob.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ const (
Encoded
Certified
Failed
InsufficientSignatures
)

func (s BlobStatus) String() string {
Expand All @@ -28,8 +27,6 @@ func (s BlobStatus) String() string {
return "Certified"
case Failed:
return "Failed"
case InsufficientSignatures:
return "InsufficientSignatures"
default:
return "Unknown"
}
Expand All @@ -45,8 +42,6 @@ func (s BlobStatus) ToProfobuf() pb.BlobStatus {
return pb.BlobStatus_CERTIFIED
case Failed:
return pb.BlobStatus_FAILED
case InsufficientSignatures:
return pb.BlobStatus_INSUFFICIENT_SIGNATURES
default:
return pb.BlobStatus_UNKNOWN
}
Expand All @@ -62,8 +57,6 @@ func BlobStatusFromProtobuf(s pb.BlobStatus) (BlobStatus, error) {
return Certified, nil
case pb.BlobStatus_FAILED:
return Failed, nil
case pb.BlobStatus_INSUFFICIENT_SIGNATURES:
return InsufficientSignatures, nil
default:
return 0, fmt.Errorf("unknown blob status: %v", s)
}
Expand Down

0 comments on commit 17259f5

Please sign in to comment.