Skip to content

Commit 3c6122a

Browse files
authored
fix specs links (#806)
* fix specs links * fix specs links * unnecessary line * revert: unnecessary line
1 parent ed549a5 commit 3c6122a

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

docs/celestia-architecture/adr-001-block-propagation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The proposed design is as follows.
2020

2121
The proposal and vote types have a BlockID, this will be replaced with a header hash. The proposal will contain add fields.
2222

23-
The current proposal will be updated to include required fields. The entirety of the message will be reworked at a later date. To see the extent of the needed changes you can visit the [spec repo](https://github.com/celestiaorg/celestia-specs/blob/master/specs/proto/consensus.proto#L19)
23+
The current proposal will be updated to include required fields. The entirety of the message will be reworked at a later date. To see the extent of the needed changes you can visit the [spec repo](https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/proto/consensus.proto#L19)
2424

2525
```proto
2626
message Proposal {
@@ -67,7 +67,7 @@ message Vote {
6767
}
6868
```
6969

70-
See [specs](https://github.com/celestiaorg/celestia-specs/blob/master/specs/data_structures.md#vote) for more details on the vote.
70+
See [specs](https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/data_structures.md#vote) for more details on the vote.
7171

7272
### Disk Storage
7373

docs/celestia-architecture/adr-002-ipld-da-sampling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A high-level, implementation-independent formalization of above mentioned sampli
1717
[_Fraud and Data Availability Proofs: Detecting Invalid Blocks in Light Clients_](https://fc21.ifca.ai/papers/83.pdf).
1818

1919
For the time being, besides the academic paper, no other formalization or specification of the protocol exists.
20-
Currently, the Celestia specification itself only describes the [erasure coding](https://github.com/celestiaorg/celestia-specs/blob/master/specs/data_structures.md#erasure-coding)
20+
Currently, the Celestia specification itself only describes the [erasure coding](https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/data_structures.md#erasure-coding)
2121
and how to construct the extended data square from the block data.
2222

2323
This ADR:
@@ -263,7 +263,7 @@ Proposed
263263

264264
[celestia-specs#126]: https://github.com/celestiaorg/celestia-specs/issues/126
265265
[celestia-specs#127]: https://github.com/celestiaorg/celestia-specs/pulls/127
266-
[Header]: https://github.com/celestiaorg/celestia-specs/blob/master/specs/data_structures.md#header
266+
[Header]: https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/data_structures.md#header
267267

268268
[go-ipfs documentation]: https://github.com/ipfs/go-ipfs/tree/master/docs/examples/go-ipfs-as-a-library#use-go-ipfs-as-a-library-to-spawn-a-node-and-add-a-file
269269
[ipld experiments]: https://github.com/celestia/ipld-plugin-experiments

docs/celestia-architecture/adr-003-application-data-retrieval.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
## Context
88

99
This ADR builds on top of [ADR 002](adr-002-ipld-da-sampling.md) and will use the implemented APIs described there.
10-
The reader should familiarize themselves at least with the high-level concepts the as well as in the [specs](https://github.com/celestiaorg/celestia-specs/blob/master/specs/data_structures.md#2d-reed-solomon-encoding-scheme).
10+
The reader should familiarize themselves at least with the high-level concepts the as well as in the [specs](https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/data_structures.md#2d-reed-solomon-encoding-scheme).
1111

1212
The academic [paper](https://arxiv.org/abs/1905.09274) describes the motivation and context for this API.
1313
The main motivation can be quoted from section 3.3 of that paper:
@@ -29,7 +29,7 @@ An implementation can be found in [this repository](https://github.com/celestiao
2929
This ADR basically describes version of the [`GetWithProof`](https://github.com/celestiaorg/nmt/blob/ddcc72040149c115f83b2199eafabf3127ae12ac/nmt.go#L193-L196) of the NMT that leverages the fact that IPFS uses content addressing and that we have implemented an [IPLD plugin](https://github.com/celestiaorg/celestia-core/tree/37502aac69d755c189df37642b87327772f4ac2a/p2p/ipld) for an NMT.
3030

3131
**Note**: The APIs defined here will be particularly relevant for Optimistic Rollup (full) nodes that want to download their Rollup's data (see [celestiaorg/optimint#48](https://github.com/celestiaorg/optimint/issues/48)).
32-
Another potential use-case of this API could be for so-called [light validator nodes](https://github.com/celestiaorg/celestia-specs/blob/master/specs/node_types.md#node-type-definitions) that want to download and replay the state-relevant portion of the block data, i.e. transactions with [reserved namespace IDs](https://github.com/celestiaorg/celestia-specs/blob/master/specs/consensus.md#reserved-namespace-ids).
32+
Another potential use-case of this API could be for so-called [light validator nodes](https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/node_types.md#node-type-definitions) that want to download and replay the state-relevant portion of the block data, i.e. transactions with [reserved namespace IDs](https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/consensus.md#reserved-namespace-ids).
3333

3434
## Alternative Approaches
3535

pkg/consts/consts.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ import (
88
)
99

1010
// This contains all constants of:
11-
// https://github.com/celestiaorg/celestia-specs/blob/master/specs/consensus.md#constants
11+
// https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/consensus.md#constants
1212
const (
1313
// ShareSize is the size of a share (in bytes).
14-
// see: https://github.com/celestiaorg/celestia-specs/blob/master/specs/consensus.md#constants
14+
// see: https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/consensus.md#constants
1515
ShareSize = 256
1616

1717
// NamespaceSize is the namespace size in bytes.
@@ -45,7 +45,7 @@ const (
4545

4646
var (
4747
// See spec for further details on the types of available data
48-
// https://github.com/celestiaorg/celestia-specs/blob/master/specs/consensus.md#reserved-namespace-ids
48+
// https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/consensus.md#reserved-namespace-ids
4949
// https://github.com/celestiaorg/celestia-specs/blob/de5f4f74f56922e9fa735ef79d9e6e6492a2bad1/specs/data_structures.md#availabledata
5050

5151
// TxNamespaceID is the namespace reserved for transaction data
@@ -60,7 +60,7 @@ var (
6060

6161
// MaxReservedNamespace is the lexicographically largest namespace that is
6262
// reserved for protocol use. It is derived from NAMESPACE_ID_MAX_RESERVED
63-
// https://github.com/celestiaorg/celestia-specs/blob/master/specs/consensus.md#constants
63+
// https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/consensus.md#constants
6464
MaxReservedNamespace = namespace.ID{0, 0, 0, 0, 0, 0, 0, 255}
6565
// TailPaddingNamespaceID is the namespace ID for tail padding. All data
6666
// with this namespace will be ignored

pkg/da/data_availability_header.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const (
2525
// 2k × 2k matrix applying multiple times Reed-Solomon encoding.
2626
// For details see Section 5.2: https://arxiv.org/abs/1809.09044
2727
// or the Celestia specification:
28-
// https://github.com/celestiaorg/celestia-specs/blob/master/specs/data_structures.md#availabledataheader
28+
// https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/data_structures.md#availabledataheader
2929
// Note that currently we list row and column roots in separate fields
3030
// (different from the spec).
3131
type DataAvailabilityHeader struct {

proto/tendermint/da/data_availability_header.pb.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

proto/tendermint/da/data_availability_header.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ option go_package = "github.com/tendermint/tendermint/proto/tendermint/da";
1010
// 2k × 2k matrix applying multiple times Reed-Solomon encoding.
1111
// For details see Section 5.2: https://arxiv.org/abs/1809.09044
1212
// or the Celestia specification:
13-
// https://github.com/celestiaorg/celestia-specs/blob/master/specs/data_structures.md#availabledataheader
13+
// https://github.com/celestiaorg/celestia-specs/blob/master/src/specs/data_structures.md#availabledataheader
1414
// Note that currently we list row and column roots in separate fields
1515
// (different from the spec).
1616
message DataAvailabilityHeader {
1717
// RowRoot_j = root((M_{j,1} || M_{j,2} || ... || M_{j,2k} ))
1818
repeated bytes row_roots = 1;
1919
// ColumnRoot_j = root((M_{1,j} || M_{2,j} || ... || M_{2k,j} ))
2020
repeated bytes column_roots = 2;
21-
}
21+
}

0 commit comments

Comments
 (0)