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

document ipns pubsub #4903

Merged
merged 5 commits into from
Apr 4, 2018
Merged

document ipns pubsub #4903

merged 5 commits into from
Apr 4, 2018

Conversation

vyzo
Copy link
Contributor

@vyzo vyzo commented Mar 30, 2018

Closes #4902

License: MIT
Signed-off-by: vyzo <vyzo@hackzen.org>
@vyzo vyzo requested a review from Kubuxu as a code owner March 30, 2018 17:34
@ghost ghost assigned vyzo Mar 30, 2018
@ghost ghost added the status/in-progress In progress label Mar 30, 2018
@vyzo vyzo requested a review from Stebalien March 30, 2018 17:35
Copy link
Member

@magik6k magik6k left a comment

Choose a reason for hiding this comment

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

I assume that both the publishing and resolving nodes have to have this feature enabled for it to work. If this is true (or isn't), it would be useful to add a note mentioning that.

@vyzo
Copy link
Contributor Author

vyzo commented Mar 30, 2018

@magik6k yes, this is true; i'll add a note.

License: MIT
Signed-off-by: vyzo <vyzo@hackzen.org>

Experimental, default-disabled.

Utilizes pubsub for publishing ipns records in real time.
Copy link
Contributor

@Mr0grog Mr0grog Mar 30, 2018

Choose a reason for hiding this comment

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

Can we say slightly more about how it works/what it does? e.g:

When you publish an IPNS record, a message about the record will also be published via pubsub (note: does it get repeatedly sent [and roughly what frequency] or just once at publish time?). When you resolve an IPNS address, your daemon will subscribe to the pubsub topic for that name so it is immediately informed of changes.

I’m not even totally sure my understanding there is correct, so please fix if it’s not!

Copy link
Member

Choose a reason for hiding this comment

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

Really, the important part is: what should the user expect and why would they want to try this feature out?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes. Exactly that ^

Copy link
Contributor Author

@vyzo vyzo Mar 31, 2018

Choose a reason for hiding this comment

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

ok fine, I'll add another sentence paragraph :)


### In Version

0.4.13
Copy link
Member

Choose a reason for hiding this comment

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

Was it in this version? I thought this only made it into 0.4.14.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

uhm ok, not sure either.

License: MIT
Signed-off-by: vyzo <vyzo@hackzen.org>
When it is enabled:
- IPNS publishers push records to a name-specific pubsub topic,
in addition to publishing to the DHT.
- IPNS resolvers subscribe to the name-specific topic and receive newly
Copy link
Member

Choose a reason for hiding this comment

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

At the moment, it's a bit unclear what this actually means, I'd go with something like:

IPNS resolvers subscribe to name-specific topics on first resolutions to speedup future resolutions of the same name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i'll massage it a bit.

License: MIT
Signed-off-by: vyzo <vyzo@hackzen.org>
published records through pubsub in real time. Note that the initial resolution
still goes through the DHT, as there is no message history in pubsub.
- IPNS resolvers subscribe to the name-specific topic on first
resoltion and receive subsequently published records through pubsub
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo on “resolution”

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed, thanks.

License: MIT
Signed-off-by: vyzo <vyzo@hackzen.org>
@Stebalien Stebalien added RFM and removed status/in-progress In progress labels Apr 2, 2018
@whyrusleeping whyrusleeping merged commit 18eb6e8 into master Apr 4, 2018
@whyrusleeping whyrusleeping deleted the doc/ipns-pubsub branch April 4, 2018 23:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants