Skip to content

Commit

Permalink
Misc documentation fix (#1139)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jianoaix
jianoaix authored Jan 30, 2025
1 parent 2a9b5a7 commit f4b5c18
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 148 deletions.
4 changes: 2 additions & 2 deletions core/v2/types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ func BatchFromProtobuf(proto *commonpb.Batch) (*Batch, error) {
type Attestation struct {
*BatchHeader

// AttestedAt is the time the attestation was made
// AttestedAt is the time the attestation was made in nanoseconds
AttestedAt uint64
// NonSignerPubKeys are the public keys of the operators that did not sign the blob
NonSignerPubKeys []*core.G1Point
Expand All @@ -322,7 +322,7 @@ type Attestation struct {
Sigma *core.Signature
// QuorumNumbers contains the quorums relevant for the attestation
QuorumNumbers []core.QuorumID
// QuorumResults contains the results of the quorum verification
// QuorumResults contains the operators' total signing percentage of the quorum
QuorumResults map[core.QuorumID]uint8
}

Expand Down
2 changes: 1 addition & 1 deletion disperser/common/v2/blob.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ type BlobMetadata struct {
NumRetries uint
// BlobSize is the size of the blob in bytes
BlobSize uint64
// RequestedAt is the Unix timestamp of when the blob was requested in seconds
// RequestedAt is the Unix timestamp of when the blob was requested in nanoseconds
RequestedAt uint64
// UpdatedAt is the Unix timestamp of when the blob was last updated in _nanoseconds_
UpdatedAt uint64
Expand Down
18 changes: 0 additions & 18 deletions disperser/dataapi/docs/v1/V1_docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1141,12 +1141,6 @@ const docTemplateV1 = `{
"items": {
"type": "integer"
}
},
"y": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand All @@ -1155,9 +1149,6 @@ const docTemplateV1 = `{
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand All @@ -1166,9 +1157,6 @@ const docTemplateV1 = `{
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand Down Expand Up @@ -1199,12 +1187,6 @@ const docTemplateV1 = `{
"items": {
"type": "integer"
}
},
"a1": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand Down
18 changes: 0 additions & 18 deletions disperser/dataapi/docs/v1/V1_swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1137,12 +1137,6 @@
"items": {
"type": "integer"
}
},
"y": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand All @@ -1151,9 +1145,6 @@
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand All @@ -1162,9 +1153,6 @@
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand Down Expand Up @@ -1195,12 +1183,6 @@
"items": {
"type": "integer"
}
},
"a1": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand Down
12 changes: 0 additions & 12 deletions disperser/dataapi/docs/v1/V1_swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,24 +263,16 @@ definitions:
items:
type: integer
type: array
"y":
items:
type: integer
type: array
type: object
encoding.G2Commitment:
properties:
x:
$ref: '#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2'
"y":
$ref: '#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2'
type: object
encoding.LengthProof:
properties:
x:
$ref: '#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2'
"y":
$ref: '#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2'
type: object
github_com_Layr-Labs_eigenda_disperser.BlobStatus:
enum:
Expand All @@ -304,10 +296,6 @@ definitions:
items:
type: integer
type: array
a1:
items:
type: integer
type: array
type: object
semver.SemverMetrics:
properties:
Expand Down
39 changes: 3 additions & 36 deletions disperser/dataapi/docs/v2/V2_docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -663,12 +663,6 @@ const docTemplateV2 = `{
"items": {
"type": "integer"
}
},
"y": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand All @@ -677,9 +671,6 @@ const docTemplateV2 = `{
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand Down Expand Up @@ -712,12 +703,6 @@ const docTemplateV2 = `{
"items": {
"type": "integer"
}
},
"y": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand Down Expand Up @@ -746,12 +731,6 @@ const docTemplateV2 = `{
"items": {
"type": "integer"
}
},
"y": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand All @@ -760,9 +739,6 @@ const docTemplateV2 = `{
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand All @@ -771,9 +747,6 @@ const docTemplateV2 = `{
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand All @@ -789,7 +762,7 @@ const docTemplateV2 = `{
]
},
"attestedAt": {
"description": "AttestedAt is the time the attestation was made",
"description": "AttestedAt is the time the attestation was made in nanoseconds",
"type": "integer"
},
"batchRoot": {
Expand Down Expand Up @@ -821,7 +794,7 @@ const docTemplateV2 = `{
}
},
"quorumResults": {
"description": "QuorumResults contains the results of the quorum verification",
"description": "QuorumResults contains the operators' total signing percentage of the quorum",
"type": "object",
"additionalProperties": {
"type": "integer"
Expand Down Expand Up @@ -976,12 +949,6 @@ const docTemplateV2 = `{
"items": {
"type": "integer"
}
},
"a1": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand Down Expand Up @@ -1137,7 +1104,7 @@ const docTemplateV2 = `{
"type": "integer"
},
"requestedAt": {
"description": "RequestedAt is the Unix timestamp of when the blob was requested in seconds",
"description": "RequestedAt is the Unix timestamp of when the blob was requested in nanoseconds",
"type": "integer"
},
"signature": {
Expand Down
39 changes: 3 additions & 36 deletions disperser/dataapi/docs/v2/V2_swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -660,12 +660,6 @@
"items": {
"type": "integer"
}
},
"y": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand All @@ -674,9 +668,6 @@
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand Down Expand Up @@ -709,12 +700,6 @@
"items": {
"type": "integer"
}
},
"y": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand Down Expand Up @@ -743,12 +728,6 @@
"items": {
"type": "integer"
}
},
"y": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand All @@ -757,9 +736,6 @@
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand All @@ -768,9 +744,6 @@
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
},
"y": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
Expand All @@ -786,7 +759,7 @@
]
},
"attestedAt": {
"description": "AttestedAt is the time the attestation was made",
"description": "AttestedAt is the time the attestation was made in nanoseconds",
"type": "integer"
},
"batchRoot": {
Expand Down Expand Up @@ -818,7 +791,7 @@
}
},
"quorumResults": {
"description": "QuorumResults contains the results of the quorum verification",
"description": "QuorumResults contains the operators' total signing percentage of the quorum",
"type": "object",
"additionalProperties": {
"type": "integer"
Expand Down Expand Up @@ -973,12 +946,6 @@
"items": {
"type": "integer"
}
},
"a1": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
Expand Down Expand Up @@ -1134,7 +1101,7 @@
"type": "integer"
},
"requestedAt": {
"description": "RequestedAt is the Unix timestamp of when the blob was requested in seconds",
"description": "RequestedAt is the Unix timestamp of when the blob was requested in nanoseconds",
"type": "integer"
},
"signature": {
Expand Down
Loading

0 comments on commit f4b5c18

Please sign in to comment.