Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@dleonard00 here is a first stab at describing a flow the client can implement to provide communication between 2 peers using PSS, please don't hesitate to alter anything you see fit.
I don't know about Sphinx and the usual practices for these docs, but one thing that could be useful would be to add HTML anchors to each API method in the PSS docs, so they could be linked to directly in this example or other docs.
I also noticed that there are 2 APIs documented in PSS that seem at odds with the rest:
pss.GetSymmetricAddressHint(topic, symkeyid)
andpss.GetAsymmetricAddressHint(topic, publickey)
have an uppercase leadingG
while all other APIs start with a lowercase character, I think it's a leftover from the Go API.