keep-ecdsa icon indicating copy to clipboard operation
keep-ecdsa copied to clipboard

Operating documentation

Open creckhow-zz opened this issue 5 years ago • 3 comments

keep-core has a great set of docs on the random beacon -- a glossary, details on misbehavior and slashing, how to run and operate the client.

Am I correct, these don't exist yet for ecdsa/tBTC? Of particularly urgency for our business partners is information about running and operating the client, and ETH slashing/liquidation parameters.

@Shadowfiend @sthompson22 @pdyraga let me know how I can help. I will just start forking Promethea's beacon docs and filling them with vague guesses over here in this repo at some point. :):):)

creckhow-zz avatar Apr 10 '20 14:04 creckhow-zz

We don't have anything for ECDSA keeps yet. The best source of information here is tBTC spec for now.

pdyraga avatar Apr 10 '20 14:04 pdyraga

I will just start forking Promethea's beacon docs and filling them with vague guesses over here in this repo at some point.

This is probably not the right thing to do. The beacon “docs” are a full spec, not documentation. The keep-ecdsa docs will most likely start as something less complete for folks to get oriented, and will be referring to the “beacon” docs for a lot of things, as what is currently the beacon spec also defines a lot of the root of the Keep system (e.g., authorizations and staking).

It would be better if you wanted to compile a list of questions you need/would like the docs to answer, as well as some initial takes at answers if you have them. If you want to base that on what's in the beacon docs, that's fine. We can gather that in this issue and start turning it into either checkboxes or multiple issues as we start organizing the written work.

Shadowfiend avatar Apr 13 '20 00:04 Shadowfiend

ETH slashing/liquidation parameters.

This part is 100% in tBTC. The spec covers all things that can happen with your ETH, accept what happens with it after a deposit is successfully redeemed IIRC.

Some stuff that might be appropriate in this issue though

  • [ ] How does keep-ecdsa relate to keep-core? Is it a separate client?
  • [ ] How do I opt in to using the BondedECDSAKeep?
  • [ ] What other contracts do I need to authorize?
  • [ ] What are the system requirements for running keep-ecdsa?
  • [ ] Where are key shares stored? How should I ensure they aren't corrupted?
  • [ ] How does ETH custody work? Can I run keep-ecdsa non-custodially? (NB - My understanding here is that anyone can bond for an operator, and that we're working to make sure beneficiaries work the same way as with KEEP. This is a high priority question for professional stakers)

@creckhow do you have any other questions in your notes?

mhluongo avatar Apr 13 '20 01:04 mhluongo