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

Update docs for SOR using Docker #67

Merged
merged 4 commits into from
Dec 24, 2023

Conversation

caike
Copy link
Contributor

@caike caike commented Dec 20, 2023

Summary

Add information on how to read and assign signing key and collateral for running the SOR using Docker.

Addresses part of Issue #60

Please mark the relevant option(s) for your pull request:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code refactoring (improving code quality without changing its behavior)
  • Documentation update (adding or updating documentation related to the project)

Checklist

Please ensure that your pull request meets the following criteria:

  • I have read the Contributing Guide
  • My code follows the project's coding style and best practices
  • My code is appropriately commented and includes relevant documentation
  • I have added tests to cover my changes
  • All new and existing tests pass
  • I have updated the documentation, if necessary

Add info on signing key and collateral
@caike caike force-pushed the docs/update-readme branch from 4fe9dfa to 6f96785 Compare December 20, 2023 18:27
@caike caike marked this pull request as ready for review December 20, 2023 18:28
@caike caike requested a review from a team as a code owner December 20, 2023 18:28
@caike caike changed the title Update README Update docs for SOR using Docker Dec 20, 2023
README.md Outdated Show resolved Hide resolved
4TT1L4
4TT1L4 previously requested changes Dec 22, 2023
Copy link
Contributor

@4TT1L4 4TT1L4 left a comment

Choose a reason for hiding this comment

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

Please add a not about the fact that the --testnet-magic 1 must be removed for mainnet.

Otherwise it looks good.

@caike caike requested review from 4TT1L4 and Sluder December 22, 2023 13:54
README.md Outdated
Use the following command to find and select the UTXO to be used for collateral:

```shell
cardano-cli query utxo --address $(cat bot.preprod.addr) --testnet-magic 1
Copy link
Member

Choose a reason for hiding this comment

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

Thanks a lot for your contribution @caike ! Maybe worth mentioning that this information can be conveniently obtained from explorer such as cexplorer.io.

Copy link
Contributor

@4TT1L4 4TT1L4 Dec 22, 2023

Choose a reason for hiding this comment

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

I would still prefer to add a note about mainnet or two commands: one for preprod and one for mainnet.

Actually.... the default config is for mainnet in other places. Maybe we should stick to mainnet here as well.

Copy link
Contributor Author

@caike caike Dec 22, 2023

Choose a reason for hiding this comment

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

Updated with these suggestions. However, the section of the README that shows how to create a wallet is using preprod:

cardano-cli address build \
    --payment-verification-key-file bot.vkey \
    --testnet-magic 1 \
    --out-file bot.preprod.addr

So maybe defaulting to --mainnet on the query command while using bot.preprod.addr as the address might be confusing. Thoughts ?

sourabhxyz
sourabhxyz previously approved these changes Dec 22, 2023
@caike caike requested review from sourabhxyz and Sluder December 22, 2023 15:41
Copy link

@adacapo21 adacapo21 left a comment

Choose a reason for hiding this comment

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

For me it seems ok after the update.

@sourabhxyz sourabhxyz dismissed 4TT1L4’s stale review December 24, 2023 05:10

Requested changes incorporated.

@sourabhxyz sourabhxyz merged commit 4a1557d into geniusyield:main Dec 24, 2023
1 check 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