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

docs: RFC 003: Language-independent Module Semantics & ABI #15410

Closed
wants to merge 7 commits into from

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented Mar 15, 2023

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

package cosmos.app.services.v1;

// Store defines a service for interacting with key-value stores.
service Store {
Copy link
Member Author

@aaronc aaronc Apr 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would we deal with kv and memory stores with this model? I can think of these approaches:

  • find some way to address distinct Store services for kv and memory stores
  • add parameters to each request for the type of store
  • decide not to support memory or transient stores at all

rpc Delete(DeleteRequest) returns (DeleteResponse);

// Iterator queries the store for all keys between a certain start and end range.
rpc Iterator(IteratorRequest) returns (stream IteratorResponse);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One challenge with doing this as a streaming service is that the server just starts pushing all the data to the client and I'm not finding any obvious way to cancel a server stream. Maybe that's okay if usage is documented clearly, but it's quite different from our current pull based iterator approach

@github-actions
Copy link
Contributor

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the Stale label May 18, 2023
@github-actions github-actions bot closed this May 22, 2023
@tac0turtle tac0turtle reopened this May 22, 2023
@github-actions github-actions bot removed the Stale label May 23, 2023
@tac0turtle tac0turtle force-pushed the aaronc/rfc-module-abi branch from 2985947 to 41649a5 Compare May 23, 2023 09:16
@kocubinski
Copy link
Member

Ok to merge this as is?

@aaronc
Copy link
Member Author

aaronc commented Jun 12, 2023

I'm not sure we should merge this with the proto files. Instead the proto files should be code snippets in the RFC. I'll make this change before we merge

@github-actions
Copy link
Contributor

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the Stale label Jul 13, 2023
@github-actions github-actions bot closed this Jul 17, 2023
@tac0turtle tac0turtle deleted the aaronc/rfc-module-abi branch February 21, 2024 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants