Improve go-namesys documentation #1
Conversation
publisher.go
Outdated
| // PutRecordToRouting publishes the given entry using the provided ValueStore, | ||
| // using the ID associated to the provided public key and embedding the public | ||
| // key in the IPNS entry when it cannot be extracted from the ID. In that | ||
| // case, it calls PublishPublicKey in addition to PublishEntry. |
There was a problem hiding this comment.
In that case, it calls PublishPublicKey in addition to PublishEntry.
This is true, although it's something we may drop as more of the IPFS DHT upgrades as it needlessly slows down publishes.
Unfortunately, the comment below about waiting for go-ipfs v0.4.16 to be widespread was overly optimistic as the code was still bugged and was only fixed in ipfs/kubo#7549 (go-ipfs v0.7.0). All this is just to say that no one should be relying on this behavior as part of the function contract.
There was a problem hiding this comment.
Should I change the godoc line and not mention the embedding part?
There was a problem hiding this comment.
Yep, IMO a library developer doesn't need to be aware of all the optimization details here (i.e. smaller Ed25519 keys will save a bunch of space compared with larger RSA keys). Continuing below where we can use GitHub suggestions (my bad for not referencing the whole block in my initial comment).
| [](https://travis-ci.com/ipfs/go-namesys) | ||
|
|
||
|
|
||
| > go-namesys provides publish and resolution support for the /ipns/ namespace | ||
|
|
||
| go-namesys allows to publish and resolve IPNS records or dnslink domain names. | ||
| Package namesys defines `Resolver` and `Publisher` interfaces for IPNS paths, that is, paths in the form of `/ipns/<name_to_be_resolved>`. A "resolved" IPNS path becomes an `/ipfs/<cid>` path. |
There was a problem hiding this comment.
SGTM.
Note: we probably want to allow access to partial resolutions (or returning the full resolution path), but that's later 😄
Co-authored-by: Adin Schmahmann <[email protected]>
Improve go-namesys documentation This commit was moved from ipfs/go-namesys@1340654
Improve go-namesys documentation This commit was moved from ipfs/go-namesys@1340654
No description provided.