ethereum / portal-network-specs

Official repository for specifications for the Portal Network
313 stars 85 forks source link

Organize spec/test by folders via network type #311

Closed KolbyML closed 5 months ago

KolbyML commented 5 months ago

Currently all the specs are in the root directory (except for beacon) so it is kind of confusing what belongs to what network for someone new.

I propose that we store all documents about a network, in a network specific folder so all documents with specific information per a network are easy to find. Well generic documents live instead the root directory

Example All documents about the history network will go into the history folder

I am deleting content-keys-test-vectors.md as it is redundent, we already have test vector files for specific networks. I don't think it makes sense to have a multiple network test vectors file in this way at least, these tests should be in network specific files which they were just formatted a little differently.

I am also deleting portal-bridge-nodes.md as it is a document about a state bridge, for a head state network? The document doesn't seem related to the current plans. It now doesn't fit with the scope so might as well remove it, if someone wants to document how each network bridges work that can be a future PR

I think if we want a portal-bridge document in the future, I think there should be a network specific one in each folder. I think the current document is very misleading for newcomers in it's current state, and fixing it would be making a new document from the ground up anyways

kdeme commented 5 months ago

I propose that we store all documents about a network

Sounds good to me. I had the same in mind with the exception that I would put portal-wire + utp documents under a wire or network-overlay folder.

I am deleting content-keys-test-vectors.md as it is redundent

It is mostly redundant compared to the provided test vectors. But I think the content id derivation is not covered elsewhere, at least not for history network? (Nor the Epoch accumulator key encoding?).

I am also deleting portal-bridge-nodes.md

I think that's fine. It's old and no longer applicable in its current form

KolbyML commented 5 months ago

I propose that we store all documents about a network

Sounds good to me. I had the same in mind with the exception that I would put portal-wire + utp documents under a wire or network-overlay folder.

I think portal-wire should be in root as it is generic and used by everything

I am deleting content-keys-test-vectors.md as it is redundent

It is mostly redundant compared to the provided test vectors. But I think the content id derivation is not covered elsewhere, at least not for history network? (Nor the Epoch accumulator key encoding?).

I will move some things around quick then

KolbyML commented 5 months ago

@kdeme I moved the respective sections you mentioned in content-keys-test-vectors.md to their respective test network files, let me know what you think

kdeme commented 5 months ago

let me know what you think

@KolbyML Yeah, looks fine like that. :shipit: