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

Think through the API, make it more consistent #4

Open
4 of 11 tasks
Kagami opened this issue Jan 28, 2015 · 0 comments
Open
4 of 11 tasks

Think through the API, make it more consistent #4

Kagami opened this issue Jan 28, 2015 · 0 comments
Assignees

Comments

@Kagami
Copy link
Member

Kagami commented Jan 28, 2015

  • var_int.value vs var_str.str vs var_list.list
  • net_addr.addrs vs inv.inventory vs error.vector
  • pubkey.needed vs msg.identities vs broadcast.subscriptions
  • bootstrap/connect/listen API: it's better to always use objects instead of positional arguments. (E.g. {host: "1.2.3.4", port: 8444})
  • connection pass 3 positional arguments (should it pass transport, {host, port} instead?)
  • error message fatal field is nonintuitive (better to use something like type)
  • version message version field is nonintuitive (better to use something like protoVersion)
  • version message streamNumbers field is awkward
  • High-level checkings (like connection to self detection) probably should lie in transport code
  • Exceptions in transport callbacks propogated further: do we want to auto-catch and warn about them?
  • Somehow make it clear that methods like tryDecode and validate don't throw exceptions
@Kagami Kagami self-assigned this Jan 28, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant