Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: ipns #184

Merged
merged 5 commits into from
Jan 3, 2019
Merged

docs: ipns #184

merged 5 commits into from
Jan 3, 2019

Conversation

vasco-santos
Copy link
Member

@vasco-santos vasco-santos commented Jun 27, 2018

Specs for IPNS implementation

@vasco-santos vasco-santos mentioned this pull request Jun 27, 2018
16 tasks
alanshaw pushed a commit to ipfs/js-ipfs that referenced this pull request Aug 29, 2018
A working version of **IPNS working locally** is here!  🚀 😎 💪 

Steps:

- [x] Create a new repo (**js-ipns**) like it was made with go in the last week ([go-ipns](https://github.com/ipfs/go-ipns)) and port the related code from this PR to there
- [x] Resolve IPNS names in publish, in order to verify if they exist (as it is being done for regular files) before being published
- [x] Handle remaining parameters in publish and resolve (except ttl). 
- [x] Test interface core spec [interface-ipfs-core#327](ipfs-inactive/interface-js-ipfs-core#327)
- [x] Test interoperability with go. [interop#26](ipfs/interop#26)
- [x] Integrate logging
- [x] Write unit tests
- [x] Add support for the lifetime with nanoseconds precision
- [x] Add Cache
- [x] Add initializeKeyspace
- [x] Republish

Some notes, regarding the previous steps: 

- There is an optional parameter not implemented in this PR, which is `ttl`, since it is still experimental, we can add it in a separate PR.

Finally, thanks @Stebalien for your help and time answering all my questions regarding the IPNS implementation in GO.

Moreover, since there are no specs, and not that much documentation, I have been writing a document with all the IPNS workflow. It is a WIP by now, but it is currently available [here](ipfs/specs#184).

Related PRs:

- [x] [js-ipns#4](ipfs/js-ipns#4)
- [x] [js-ipfs-repo#173](ipfs/js-ipfs-repo#173)
- [x] [js-ipfs#1496](#1496)
- [x] [interface-ipfs-core#327](ipfs-inactive/interface-js-ipfs-core#327)
- [x] enable `interface-ipfs-core` tests for IPNS in `js-ipfs`
@vasco-santos vasco-santos force-pushed the docs/ipns branch 2 times, most recently from df8f212 to a8eb579 Compare October 22, 2018 11:47
@vasco-santos vasco-santos changed the title [WIP] docs: ipns docs: ipns Oct 22, 2018
@vasco-santos
Copy link
Member Author

cc @Stebalien

@ghost ghost assigned vasco-santos Oct 22, 2018
@ghost ghost added the status/in-progress In progress label Oct 22, 2018
@vasco-santos
Copy link
Member Author

This is currently blocked on: ipfs/interop#39#issuecomment-434822613

@vasco-santos
Copy link
Member Author

Spec updated with the interop changes

Copy link
Member

@Stebalien Stebalien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks accurate from a technical perspective but it's very focused on "here's how to implement IPNS in your {js,go}-ipfs clone".

naming/README.md Outdated Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
naming/README.md Show resolved Hide resolved
naming/README.md Show resolved Hide resolved
naming/README.md Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
@vasco-santos vasco-santos force-pushed the docs/ipns branch 2 times, most recently from d50c138 to 016fd6e Compare December 24, 2018 15:09
@vasco-santos
Copy link
Member Author

Thanks for the review @Stebalien

I believe that I have taken all your feedback into account with the last commit. I changed the Implementation Details section to Protocol and modified the content accordingly.

Copy link
Member

@Stebalien Stebalien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from a technical standpoint. It could use a pass by a technical writer but, well, so could all of our specs/documentation.

naming/README.md Outdated Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
naming/README.md Outdated Show resolved Hide resolved
@vasco-santos
Copy link
Member Author

Thanks for the last pass @Stebalien !

I have fixed your last comments. I totally agree that it could use a pass by a technical writer. We should probably try to have one in the future to look at all our specs/documentation.

@Stebalien
Copy link
Member

LGTM. It looks ready to me but I'll let you merge it when you're ready.

@vasco-santos
Copy link
Member Author

It is good to go! However, I do not have write access to merge this.

@Stebalien Stebalien merged commit 0d8bfb0 into ipfs:master Jan 3, 2019
@ghost ghost removed the status/in-progress In progress label Jan 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants