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

view: extend view service for auctions #4227

Closed
Tracked by #4196
erwanor opened this issue Apr 17, 2024 · 2 comments
Closed
Tracked by #4196

view: extend view service for auctions #4227

erwanor opened this issue Apr 17, 2024 · 2 comments
Assignees
Labels
A-auction Area: Relates to the auction component _P-high High priority _P-V1 Priority: slated for V1 release protobuf-changes Makes changes to the protobuf definitions.
Milestone

Comments

@erwanor
Copy link
Member

erwanor commented Apr 17, 2024

We want to amend the view service definition to add an Auctions rpc that the transaction planner will be able to use:

service ViewService {
    // ...

    // Gets the auctions controlled by the user's wallet.
    rpc Auctions(AuctionsRequest) returns (stream AuctionsResponse);

    // ...
}

message AuctionsRequest {
    // If present, filter balances to only include the account specified by the `AddressIndex`.
    core.keys.v1.AddressIndex account_filter = 1;
    // If present, include inactive auctions as well as active ones.
    bool include_inactive = 2;
    // If set, query a fullnode for the current state of the auctions.
    bool query_latest_state = 3;
}

message AuctionsResponse {
    core.component.auction.v1.AuctionId id = 1;
    // The note recording the auction NFT.
    SpendableNoteRecord note_record = 4;

    // The state of the returned auction.
    //
    // Only present when `query_latest_state` was provided.
    google.protobuf.Any auction = 2;
    // The state of any DEX positions relevant to the returned auction.
    //
    // Only present when `query_latest_state` was provided.
    // Could be empty, depending on the auction state.
    repeated core.component.dex.v1.Position positions = 3;
}
@github-project-automation github-project-automation bot moved this to Backlog in Penumbra Apr 17, 2024
@github-actions github-actions bot added the needs-refinement unclear, incomplete, or stub issue that needs work label Apr 17, 2024
@erwanor erwanor added protobuf-changes Makes changes to the protobuf definitions. and removed needs-refinement unclear, incomplete, or stub issue that needs work labels Apr 17, 2024
@erwanor erwanor moved this from Backlog to Todo in Penumbra Apr 17, 2024
@erwanor erwanor added this to the Sprint 4 milestone Apr 17, 2024
@TalDerei TalDerei added the A-auction Area: Relates to the auction component label Apr 17, 2024
@erwanor erwanor added _P-V1 Priority: slated for V1 release _P-high High priority labels Apr 17, 2024
TalDerei added a commit that referenced this issue Apr 20, 2024
## Describe your changes
adds `Auctions` rpc interface that the transaction planner can query.

## Issue ticket number and link
References #4227

## Checklist before requesting a review

- [x] If this code contains consensus-breaking changes, I have added the
"consensus-breaking" label. Otherwise, I declare my belief that there
are not consensus-breaking changes, for the following reason:
@TalDerei
Copy link
Collaborator

should we wait to close this until a storage impl is filled into the stub?

@erwanor
Copy link
Member Author

erwanor commented Apr 20, 2024

@TalDerei Created #4251 to track impl.

@erwanor erwanor closed this as completed Apr 20, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Penumbra Apr 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-auction Area: Relates to the auction component _P-high High priority _P-V1 Priority: slated for V1 release protobuf-changes Makes changes to the protobuf definitions.
Projects
Archived in project
Development

No branches or pull requests

2 participants