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

TSDK-666 initWalletState parameter improvement #166

Merged
merged 3 commits into from
Dec 14, 2023
Merged

Conversation

DiademShoukralla
Copy link
Collaborator

Purpose

Ease of use improvement for using initWalletState. Now users do not have to do a (x=1,y=1) partial derivative of their Topl Main key pair before initializing a wallet state.

Approach

  • Updated Signature of the function to take in a KeyPair (needed for partial derivation).
  • Updated Service Kit to perform the partial derivation within the initWalletState function
  • Updated all callers (tests) to use the updated parameter
  • Updated documentation to use the updated parameter

Testing

  • Ensure all tests pass
  • Ensure all documentation examples run successfully. Note: The code examples within "Service Kit > Usage" are not directly runnable using scala-cli yet. This is because it depends on a released version of the SDK. These changes are not yet released but will be a part of beta2 (which is what the dependency references). In other words, this will be runnable once beta2 is released (which is when the documentation portal will be updated). Despite this, I ensured running the code in a worksheet works as expected (same as the other code examples).
  • Used in brambl-cli and ensured the unit tests and integration tests all pass.

Tickets

  • TSDK-666

Copy link
Contributor

@mundacho mundacho left a comment

Choose a reason for hiding this comment

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

LGTM!

@DiademShoukralla DiademShoukralla merged commit 58bc32d into main Dec 14, 2023
4 checks passed
@DiademShoukralla DiademShoukralla deleted the TSDK-666 branch December 14, 2023 19:06
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.

None yet

2 participants