From 87b44efbdb1f759eca3d449b8de8695a054f191b Mon Sep 17 00:00:00 2001 From: Ismail Khoffi Date: Tue, 16 Jul 2024 00:13:15 +0200 Subject: [PATCH] Render protos in readme from last commit --- cips/cip_canoncical-blob-api-v1.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/cips/cip_canoncical-blob-api-v1.md b/cips/cip_canoncical-blob-api-v1.md index 24bb0bb2..cc48f5d2 100644 --- a/cips/cip_canoncical-blob-api-v1.md +++ b/cips/cip_canoncical-blob-api-v1.md @@ -12,7 +12,7 @@ requires: CIP number(s). Only required when you reference an CIP in the `Specifi - + @@ -37,7 +37,7 @@ The v1 is motivated to address these issues by these specific points: ## Specification -Find the full protobuf definitions in the [proto](./proto) directory. +Find the full protobuf definitions in the [proto](../assets/cip-api-v1/proto) directory. TODO: define expected behaviour for each service @@ -49,16 +49,20 @@ These are types used across multiple services and are defined in the `common` pa #### Error Messages [error.proto](../assets/cip-api-v1/proto/common/error.proto) +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/common/error.proto#L1-L18 + TODO: Maybe have errors per service instead of global errors? #### Data Retrieval Options [retrieval_options.proto](../assets/cip-api-v1/proto/common/retrieval_options.proto) +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/common/retrieval_options.proto#L1-L12 #### Transaction Options [tx_config.proto](../assets/cip-api-v1/proto/common/tx_config.proto) +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/common/tx_config.proto#L1-L10 ### Header @@ -66,23 +70,27 @@ TODO: Maybe have errors per service instead of global errors? #### Types [header.proto](../assets/cip-api-v1/proto/header/header.proto) +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/header/header.proto#L1-L48 #### Service [header_service.proto](../assets/cip-api-v1/proto/header/header_service.proto) +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/header/header_service.proto#L1-L17 ### Blob Service #### Types [blob.proto](../assets/cip-api-v1/proto/blob/blob.proto) +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/blob/blob.proto#L1-L76 #### Service [blob_service.proto](../assets/cip-api-v1/proto/blob/blob_service.proto) +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/blob/blob_service.proto#L1-L13 ### Share Service @@ -90,22 +98,26 @@ TODO: Maybe have errors per service instead of global errors? #### Types [share.proto](../assets/cip-api-v1/proto/share/share.proto) - +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/share/share.proto#L3-L53 #### Service [share_service.proto](../assets/cip-api-v1/proto/share/share_service.proto) +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/share/share_service.proto#L1-L11 ### Bad Encoding Fraud Proofs Service #### Types -[befp.proto](./proto/befp/befp.proto) +[befp.proto](../assets/cip-api-v1/proto/befp/befp.proto) + +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/befp/befp.proto#L1-L9 #### Service -[befp_service.proto](./proto/befp/befp_service.proto) +[befp_service.proto](../assets/cip-api-v1/proto/befp/befp_service.proto) +https://github.com/celestiaorg/CIPs/blob/511f955eae663d13eee2ffa0b323fd9562bf7d5e/assets/cip-api-v1/proto/befp/befp_service.proto#L1-L12 ## Rationale