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

interledger-settlement API review for v1.0-rc #576

Closed
29 tasks done
gakonst opened this issue Dec 18, 2019 · 0 comments
Closed
29 tasks done

interledger-settlement API review for v1.0-rc #576

gakonst opened this issue Dec 18, 2019 · 0 comments
Assignees
Labels
crate/interledger-settlement docs v1.0 Issues which need to be handled for a v1.0 release

Comments

@gakonst
Copy link
Member

gakonst commented Dec 18, 2019

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

Part of #557.

  • api (module)
  • client::SettlementClient struct (need to also document its send_settlement method)
  • SettlementMessageService (struct): passthrough unless message is targeted for our node's SE
  • create_settlements_filter
  • core (module)
  • backends_common (module)
  • engines_api (module)
  • idempotency (module)
  • types (module)
  • NO_ENGINE_CONFIGURED_ERROR_TYPE (const)
  • CONVERSION_ERROR_TYPE (const)
  • SE_ILP_ADDRESS (const)
  • Quantity (struct)
  • ApiResponse(enum): Some APIs have default responses, e.g. Creating an account on the engine does not require us to get a response from the engine, so we use that to return a default value instead
  • SettlementEngine (trait): trait is documented, could use some extension and docs on its functions
  • SettlementEngineDetails (struct)
  • SettlementAccount (trait)
  • SettlementStore (trait)
  • LeftoversStore (trait)
  • ConvertDetails (struct)
  • Convert (trait)
  • scale_with_precision_loss (fn)
  • IdempotentStore (trait)
  • make_idempotent_call (fn): Should this be made pub(crate)?
  • get_hash_of (fn) Should this be made pub(crate)? Note that this function is redefined in a few crates.
  • CreateAccount
  • create_settlement_engine_filter
  • EngineRedisStore
  • EngineRedisStoreBuilder
@gakonst gakonst mentioned this issue Jan 20, 2020
11 tasks
@gakonst gakonst self-assigned this Jan 20, 2020
@gakonst gakonst added v1.0 Issues which need to be handled for a v1.0 release docs labels Jan 20, 2020
@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
Labels
crate/interledger-settlement docs v1.0 Issues which need to be handled for a v1.0 release
Projects
None yet
Development

No branches or pull requests

1 participant