Make PublishError.InsufficientPeers a bit more self-explanatory?
#472
Comments
achingbrain
added a commit
that referenced
this issue
Feb 2, 2024
People continually mistake the `InsufficientPeers` error for something that can be "worked around" by setting `allowPublishToZeroPeers` to true, and they then expect other network nodes to still recieve their messages. This PR renames the option to `allowPublishToZeroTopicPeers` - this makes it clear(er) that it's not that you don't have any peers, it's that no peers you have are listening on the topic. It also improves the JSDoc comment on the option and changes the `Error` message from `PublishError.InsufficientPeers` to `PublishError.NoPeersSubscribedToTopic` which (I hope) more accurately describes what's wrong. BREAKING CHANGE: The `allowPublishToZeroPeers` option has been renamed to `allowPublishToZeroTopicPeers` Fixes #472
wemeetagain
pushed a commit
that referenced
this issue
Feb 27, 2024
People continually mistake the `InsufficientPeers` error for something that can be "worked around" by setting `allowPublishToZeroPeers` to true, and they then expect other network nodes to still recieve their messages. This PR renames the option to `allowPublishToZeroTopicPeers` - this makes it clear(er) that it's not that you don't have any peers, it's that no peers you have are listening on the topic. It also improves the JSDoc comment on the option and changes the `Error` message from `PublishError.InsufficientPeers` to `PublishError.NoPeersSubscribedToTopic` which (I hope) more accurately describes what's wrong. BREAKING CHANGE: The `allowPublishToZeroPeers` option has been renamed to `allowPublishToZeroTopicPeers` Fixes #472
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
A recurring question that comes up is:
The error does not mean you don't have peers, it means you don't have any peers listening on the pubsub topic you are trying to publish on.
If this was changed to
PublishError.InsufficientTopicPeersor even something likePublishError.InsufficientPeersSubscribedToTopicit might be a bit clearer for people?The text was updated successfully, but these errors were encountered: