Skip to content

Commit dd149b7

Browse files
committed
Render protos in readme from last commit
1 parent 511f955 commit dd149b7

1 file changed

Lines changed: 18 additions & 6 deletions

File tree

cips/cip_canoncical-blob-api-v1.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ requires: CIP number(s). Only required when you reference an CIP in the `Specifi
1212

1313
<!-- URL snippets for perma links -->
1414
<!-- -->
15-
<!-- commit hash for perma links: -->
15+
<!-- commit hash for perma links: 511f955eae663d13eee2ffa0b323fd9562bf7d5e -->
1616
<!-- example link: -->
1717

1818

@@ -37,7 +37,7 @@ The v1 is motivated to address these issues by these specific points:
3737

3838
## Specification
3939

40-
Find the full protobuf definitions in the [proto](./proto) directory.
40+
Find the full protobuf definitions in the [proto](../assets/cip-api-v1/proto) directory.
4141

4242
TODO: define expected behaviour for each service
4343

@@ -49,63 +49,75 @@ These are types used across multiple services and are defined in the `common` pa
4949
#### Error Messages
5050
[error.proto](../assets/cip-api-v1/proto/common/error.proto)
5151

52+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/common/error.proto#L1-L18
53+
5254
TODO: Maybe have errors per service instead of global errors?
5355

5456

5557
#### Data Retrieval Options
5658
[retrieval_options.proto](../assets/cip-api-v1/proto/common/retrieval_options.proto)
5759

60+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/common/retrieval_options.proto#L1-L12
5861

5962
#### Transaction Options
6063
[tx_config.proto](../assets/cip-api-v1/proto/common/tx_config.proto)
6164

65+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/common/tx_config.proto#L1-L10
6266

6367

6468
### Header
6569

6670
#### Types
6771
[header.proto](../assets/cip-api-v1/proto/header/header.proto)
6872

73+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/header/header.proto#L1-L48
6974

7075

7176
#### Service
7277

7378
[header_service.proto](../assets/cip-api-v1/proto/header/header_service.proto)
7479

80+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/header/header_service.proto#L1-L17
7581

7682
### Blob Service
7783

7884
#### Types
7985
[blob.proto](../assets/cip-api-v1/proto/blob/blob.proto)
8086

87+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/blob/blob.proto#L1-L76
8188

8289
#### Service
8390

8491
[blob_service.proto](../assets/cip-api-v1/proto/blob/blob_service.proto)
8592

93+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/blob/blob_service.proto#L1-L13
8694

8795

8896
### Share Service
8997

9098
#### Types
9199
[share.proto](../assets/cip-api-v1/proto/share/share.proto)
92100

93-
101+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/share/share.proto#L3-L53
94102

95103
#### Service
96104
[share_service.proto](../assets/cip-api-v1/proto/share/share_service.proto)
97105

106+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/share/share_service.proto#L1-L11
98107

99108
### Bad Encoding Fraud Proofs Service
100109

101110
#### Types
102111

103-
[befp.proto](./proto/befp/befp.proto)
112+
[befp.proto](../assets/cip-api-v1/proto/befp/befp.proto)
113+
114+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/befp/befp.proto#L1-L9
104115

105116
#### Service
106117

107-
[befp_service.proto](./proto/befp/befp_service.proto)
118+
[befp_service.proto](../assets/cip-api-v1/proto/befp/befp_service.proto)
108119

120+
https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/befp/befp_service.proto#L1-L12
109121

110122
## Rationale
111123

@@ -122,7 +134,7 @@ The canonical Blob API v1 is not backwards compatible with the current beta API.
122134
Hence, the current beta API will be deprecated and eventually removed from the Celestia node software.
123135
Parts of the current API may continue to be supported as form of an internal API, but will not be exposed publicly to developers.
124136

125-
TODO: add more specif timeline for deprecation and removal
137+
TODO: add more specific timeline for deprecation and removal
126138

127139
## Test Cases
128140

0 commit comments

Comments
 (0)