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.

Sign up for GitHub

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

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c59b624
docs/experimental-features: document ipns pubsub
vyzo Mar 30, 2018
f360ed7
add clarifying note on ipns pubsub documentation
vyzo Mar 30, 2018
d9cd292
more words for ipns pubsub documentation
vyzo Mar 31, 2018
0466956
words words words
vyzo Apr 2, 2018
36bcbed
fix typo
vyzo Apr 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/experimental-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,3 +365,41 @@ ipfs config --json Experimental.ShardingEnabled true

- [ ] Make sure that objects that don't have to be sharded aren't
- [ ] Generalize sharding and define a new layer between IPLD and IPFS

---

## IPNS pubsub

### In Version

0.4.14

### State

Experimental, default-disabled.

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

@Mr0grog Mr0grog Mar 30, 2018 •
edited
Loading

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 •
edited
Loading

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 :)


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 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.

in real time. This makes subsequent resolutions instant, as they
are resolved through the local cache. Note that the initial
resolution still goes through the DHT, as there is no message
history in pubsub.

Both the publisher and the resolver nodes need to have the feature enabled for it
to work effectively.

### How to enable

run your daemon with the `--enable-namesys-pubsub` flag; enables pubsub.

### Road to being a real feature

- [ ] Needs more people to use and report on how well it works
- [ ] Add a mechanism for last record distribution on subscription,
so that we don't have to hit the DHT for the initial resolution.
Alternatively, we could republish the last record periodically.