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: transfer set up from a covenant signer to a covenant emulator #50

Merged
merged 42 commits into from
Dec 17, 2024

Conversation

samricotta
Copy link
Contributor

Summary

Currently we dont have documentation for transferring the setup from solely covenant signer to covenant emulator. This documentation serves that purpose.

@samricotta samricotta marked this pull request as draft November 29, 2024 14:29
docs/transfer-setup.md Outdated Show resolved Hide resolved
docs/transfer-setup.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
@samricotta
Copy link
Contributor Author

Not sure about the structure of these guides. Maybe we should have the (./README.md)to hold the overviews of the programs as we do in finality provider

covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
docs/transfer-setup.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
covenant-signer/README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/configure-emulator.md Outdated Show resolved Hide resolved

After executing the above command, the key name will be saved in the config file
created in [step](#configuration).
Note that the `public-key` in the output should be used as one of the inputs of
Copy link
Member

Choose a reason for hiding this comment

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

I'm confused. Is this the public key that should be used for submitting transactions on Babylon or is this the key that the covenant signer is using?

The genesis file of Babylon should contain the covenant signer public key. The Babylon keyring does not relate to this afaik

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yup, the covenant key which is maintained by covenant-emulator is only for signing and sending Babylon transactions.

It is not covenant key which should sign BTC transacitons. (this one is maintained by covenant-signer)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the name of the key to make it a little clearer

docs/configure-emulator.md Outdated Show resolved Hide resolved
docs/configure-emulator.md Outdated Show resolved Hide resolved
docs/configure-emulator.md Outdated Show resolved Hide resolved
docs/configure-emulator.md Outdated Show resolved Hide resolved
RafilxTenfen and others added 7 commits December 11, 2024 14:51
)

* chore: bump babylon to v0.18.0 and update min unbonding time blocks to just unbonding time blocks, affected one check from '<' to '!='

* chore: add #57 to changelog

* chore: bump bbn v018 in covenant-signer

* fix: flag --min-unbonding-time

* chore: move to UnbondingTimeBlocks higher than ComfirmationTimeBlocks
* feat: add babylon address to keys output and moved public-key to public-key-hex

* fix: Casing on covenant-signer Dockerfile (#65)

* chore: add #63 to changelog

---------

Co-authored-by: Vitalis Salis <[email protected]>
Copy link
Contributor

@RafilxTenfen RafilxTenfen left a comment

Choose a reason for hiding this comment

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

Great job putting this together, a few comments/suggestions

@samricotta samricotta marked this pull request as ready for review December 16, 2024 09:35
Copy link
Member

@vitsalis vitsalis left a comment

Choose a reason for hiding this comment

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

Structure of the docs is a bit weird:

  • We have a README file that outlines the two major programs in the repository: covenant signer and emulator.
  • For the covenant-signer, we have a README that points users to a transition guide from phase-1 to phase-2.
  • Then for covenant-emulator, we only have docs mixing the transition (there's nothing to transition, it's a new program) and setting up of the program

Let's say I'm a covenant committee member. Which docs will be shared to me?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
covenant-signer/docs/transition-from-phase1.md Outdated Show resolved Hide resolved
covenant-signer/docs/transition-from-phase1.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/covenant-emulator-setup.md Show resolved Hide resolved
docs/covenant-emulator-setup.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@samricotta samricotta merged commit 8017988 into main Dec 17, 2024
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants