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.

Sign up for GitHub

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

Add suppport for blob feed API at dataapi #1116

Merged
merged 11 commits into from
Jan 16, 2025
Merged

Add suppport for blob feed API at dataapi #1116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
742f1ed
Add suppport for blob feed API at dataapi
jianoaix Jan 15, 2025
1b62334
fix
jianoaix Jan 15, 2025
f9ed82f
docs
jianoaix Jan 15, 2025
2270143
formatting
jianoaix Jan 15, 2025
1389db0
fix
jianoaix Jan 16, 2025
657a9bf
same-timestamp blobs pagination
jianoaix Jan 16, 2025
8f3dfcd
cap how large the interval can be
jianoaix Jan 16, 2025
be64f1d
fix
jianoaix Jan 16, 2025
68a8b32
limit
jianoaix Jan 16, 2025
325f87c
limit
jianoaix Jan 16, 2025
c73c8ef
fix
jianoaix Jan 16, 2025
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
127 changes: 127 additions & 0 deletions disperser/dataapi/docs/v2/V2_docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,58 @@ const docTemplateV2 = `{
"big.Int": {
"type": "object"
},
"core.BlobHeader": {
"type": "object",
"properties": {
"accountID": {
"description": "AccountID is the account that is paying for the blob to be stored",
"type": "string"
},
"commitment": {
"$ref": "#/definitions/encoding.G1Commitment"
},
"length": {
"type": "integer"
},
"length_commitment": {
"$ref": "#/definitions/encoding.G2Commitment"
},
"length_proof": {
"$ref": "#/definitions/encoding.LengthProof"
},
"quorumInfos": {
"description": "QuorumInfos contains the quorum specific parameters for the blob",
"type": "array",
"items": {
"$ref": "#/definitions/core.BlobQuorumInfo"
}
}
}
},
"core.BlobQuorumInfo": {
"type": "object",
"properties": {
"adversaryThreshold": {
"description": "AdversaryThreshold is the maximum amount of stake that can be controlled by an adversary in the quorum as a percentage of the total stake in the quorum",
"type": "integer"
},
"chunkLength": {
"description": "ChunkLength is the number of symbols in a chunk",
"type": "integer"
},
"confirmationThreshold": {
"description": "ConfirmationThreshold is the amount of stake that must sign a message for it to be considered valid as a percentage of the total stake in the quorum",
"type": "integer"
},
"quorumID": {
"type": "integer"
},
"quorumRate": {
"description": "Rate Limit. This is a temporary measure until the node can derive rates on its own using rollup authentication. This is used\nfor restricting the rate at which retrievers are able to download data from the DA node to a multiple of the rate at which the\ndata was posted to the DA node.",
"type": "integer"
}
}
},
"core.G1Point": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -741,6 +793,23 @@ const docTemplateV2 = `{
}
}
},
"github_com_Layr-Labs_eigenda_disperser_common_v2.BlobStatus": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4
],
"x-enum-varnames": [
"Queued",
"Encoded",
"Certified",
"Failed",
"InsufficientSignatures"
]
},
"github_com_Layr-Labs_eigenda_disperser_dataapi_v2.SignedBatch": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -811,6 +880,64 @@ const docTemplateV2 = `{
}
}
},
"v2.BlobFeedResponse": {
"type": "object",
"properties": {
"blobs": {
"type": "array",
"items": {
"$ref": "#/definitions/v2.BlobMetadata"
}
},
"pagination_token": {
"type": "string"
}
}
},
"v2.BlobMetadata": {
"type": "object",
"properties": {
"blobHeader": {
"$ref": "#/definitions/core.BlobHeader"
},
"blobSize": {
"description": "BlobSize is the size of the blob in bytes",
"type": "integer"
},
"blobStatus": {
"description": "BlobStatus indicates the current status of the blob",
"allOf": [
{
"$ref": "#/definitions/github_com_Layr-Labs_eigenda_disperser_common_v2.BlobStatus"
}
]
},
"expiry": {
"description": "Expiry is Unix timestamp of the blob expiry in seconds from epoch",
"type": "integer"
},
"fragmentSizeBytes": {
"description": "FragmentSizeBytes is the maximum fragment size used to store the chunk coefficients.",
"type": "integer"
},
"numRetries": {
"description": "NumRetries is the number of times the blob has been retried",
"type": "integer"
},
"requestedAt": {
"description": "RequestedAt is the Unix timestamp of when the blob was requested in seconds",
"type": "integer"
},
"totalChunkSizeBytes": {
"description": "TotalChunkSizeBytes is the total size of the file containing all chunk coefficients for the blob.",
"type": "integer"
},
"updatedAt": {
"description": "UpdatedAt is the Unix timestamp of when the blob was last updated in _nanoseconds_",
"type": "integer"
}
}
},
"v2.BlobResponse": {
"type": "object",
"properties": {
Expand Down
127 changes: 127 additions & 0 deletions disperser/dataapi/docs/v2/V2_swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,58 @@
"big.Int": {
"type": "object"
},
"core.BlobHeader": {
"type": "object",
"properties": {
"accountID": {
"description": "AccountID is the account that is paying for the blob to be stored",
"type": "string"
},
"commitment": {
"$ref": "#/definitions/encoding.G1Commitment"
},
"length": {
"type": "integer"
},
"length_commitment": {
"$ref": "#/definitions/encoding.G2Commitment"
},
"length_proof": {
"$ref": "#/definitions/encoding.LengthProof"
},
"quorumInfos": {
"description": "QuorumInfos contains the quorum specific parameters for the blob",
"type": "array",
"items": {
"$ref": "#/definitions/core.BlobQuorumInfo"
}
}
}
},
"core.BlobQuorumInfo": {
"type": "object",
"properties": {
"adversaryThreshold": {
"description": "AdversaryThreshold is the maximum amount of stake that can be controlled by an adversary in the quorum as a percentage of the total stake in the quorum",
"type": "integer"
},
"chunkLength": {
"description": "ChunkLength is the number of symbols in a chunk",
"type": "integer"
},
"confirmationThreshold": {
"description": "ConfirmationThreshold is the amount of stake that must sign a message for it to be considered valid as a percentage of the total stake in the quorum",
"type": "integer"
},
"quorumID": {
"type": "integer"
},
"quorumRate": {
"description": "Rate Limit. This is a temporary measure until the node can derive rates on its own using rollup authentication. This is used\nfor restricting the rate at which retrievers are able to download data from the DA node to a multiple of the rate at which the\ndata was posted to the DA node.",
"type": "integer"
}
}
},
"core.G1Point": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -738,6 +790,23 @@
}
}
},
"github_com_Layr-Labs_eigenda_disperser_common_v2.BlobStatus": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4
],
"x-enum-varnames": [
"Queued",
"Encoded",
"Certified",
"Failed",
"InsufficientSignatures"
]
},
"github_com_Layr-Labs_eigenda_disperser_dataapi_v2.SignedBatch": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -808,6 +877,64 @@
}
}
},
"v2.BlobFeedResponse": {
"type": "object",
"properties": {
"blobs": {
"type": "array",
"items": {
"$ref": "#/definitions/v2.BlobMetadata"
}
},
"pagination_token": {
"type": "string"
}
}
},
"v2.BlobMetadata": {
"type": "object",
"properties": {
"blobHeader": {
"$ref": "#/definitions/core.BlobHeader"
},
"blobSize": {
"description": "BlobSize is the size of the blob in bytes",
"type": "integer"
},
"blobStatus": {
"description": "BlobStatus indicates the current status of the blob",
"allOf": [
{
"$ref": "#/definitions/github_com_Layr-Labs_eigenda_disperser_common_v2.BlobStatus"
}
]
},
"expiry": {
"description": "Expiry is Unix timestamp of the blob expiry in seconds from epoch",
"type": "integer"
},
"fragmentSizeBytes": {
"description": "FragmentSizeBytes is the maximum fragment size used to store the chunk coefficients.",
"type": "integer"
},
"numRetries": {
"description": "NumRetries is the number of times the blob has been retried",
"type": "integer"
},
"requestedAt": {
"description": "RequestedAt is the Unix timestamp of when the blob was requested in seconds",
"type": "integer"
},
"totalChunkSizeBytes": {
"description": "TotalChunkSizeBytes is the total size of the file containing all chunk coefficients for the blob.",
"type": "integer"
},
"updatedAt": {
"description": "UpdatedAt is the Unix timestamp of when the blob was last updated in _nanoseconds_",
"type": "integer"
}
}
},
"v2.BlobResponse": {
"type": "object",
"properties": {
Expand Down
Loading
Loading