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

v1.4.0: add recovery endpoint [BAC-2015] #134

Merged
merged 2 commits into from
Oct 28, 2021
Merged

v1.4.0: add recovery endpoint [BAC-2015] #134

merged 2 commits into from
Oct 28, 2021

Conversation

samweinberg23
Copy link
Contributor

the api-keys module no longer really works as a name if we include recovery as an eth-private endpoint and it didn't make sense to add a new module for another eth private endpoint so I overhauled the module :(

@linear
Copy link

linear bot commented Oct 28, 2021

BAC-2015 GET v3/recovery endpoint for Force-Withdrawals from frontend

  • This is needed to unblock @darryl on the force-withdrawal project
  • This will be an Ethereum Key Private Endpoint as described here.
  • The endpoint should be added to proposals.
  • The endpoint should be added to librarian
  • Sync with @darryl if additional code is needed in v3-client for this endpoint
  • Afterwards add the endpoint to v3-teacher

Content of the endpoint:

If no such account, return a 404 code. Otherwise return the:

  • starkKey of the account
  • quoteBalance of the account
  • each open position of the account

Comment on lines 130 to 132
* @description This is for users who can't recover their starkKey or apiKey and need an
* additional way to get their starkKey and balance on our exchange, both of which are needed to
* call the L1 solidity function needed to recover their funds.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: i think this comment would be better if written from the perspective of the user rather than us, if that makes sense

@samweinberg23 samweinberg23 merged commit 1234b0f into master Oct 28, 2021
@samweinberg23 samweinberg23 deleted the sw_recovery branch October 28, 2021 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants