Skip to content

interledger-stream API review for v1.0-rc #575

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

Closed
8 tasks done
gakonst opened this issue Dec 18, 2019 · 2 comments
Closed
8 tasks done

interledger-stream API review for v1.0-rc #575

gakonst opened this issue Dec 18, 2019 · 2 comments

Comments

@gakonst
Copy link
Collaborator

gakonst commented Dec 18, 2019

interledger-stream public items marked with x are documented. Non-exported items are not taken into account. Follows format from #561.

Part of #557.

  • StreamDelivery (struct)
  • send_money (fn)
  • SendMoneyFuture (struct)
    • Not public, but its implementation and fields must be documented in detail since it's our main low-level payments protocol and may be a prime target for future optimizations etc.
  • Error (enum)
    • Do we need this? It's only imported in the SPSP Error wrapper enum, but that variant does not seem to get hit ever
  • ConnectionGenerator (struct)
  • `PaymentNotification (struct)
  • StreamNotificationStore (trait)
  • StreamReceiverService (struct)
@gakonst gakonst changed the title interledger-http API review for v1.0-rc interledger-stream API review for v1.0-rc Dec 18, 2019
@gakonst gakonst mentioned this issue Jan 20, 2020
11 tasks
@gakonst gakonst added the docs label Jan 20, 2020
@gakonst gakonst self-assigned this Jan 20, 2020
@bstrie
Copy link
Contributor

bstrie commented Feb 4, 2020

  • Error: not sure if this was already addressed in the error overhaul, but if we don't need it then let's get rid of it

@gakonst
Copy link
Collaborator Author

gakonst commented Feb 4, 2020

Not sure why I had written this bullet initially, the error type is actually used within stream

@gakonst gakonst closed this as completed Feb 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants