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

perf: Fork bech32 from btcsuite/btcutil (#10082) #10111

Closed
wants to merge 3 commits into from
Closed

perf: Fork bech32 from btcsuite/btcutil (#10082) #10111

wants to merge 3 commits into from

Conversation

conr2d
Copy link
Contributor

@conr2d conr2d commented Sep 10, 2021

Description

Closes: #10082

Forked bech32 from https://github.com/btcsuite/btcutil/blob/e2ba6805/bech32.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@robert-zaremba
Copy link
Collaborator

How about removing types/bech32/bech32.go and adding btcsuite/btcutil as a module dependency?

@robert-zaremba
Copy link
Collaborator

We already have github.com/btcsuite/btcutil v1.0.3-0.20201208143702-a53e38424cce as a dependency

@codecov
Copy link

codecov bot commented Sep 10, 2021

Codecov Report

Merging #10111 (356f918) into master (148451b) will increase coverage by 0.11%.
The diff coverage is 86.32%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #10111      +/-   ##
==========================================
+ Coverage   63.60%   63.71%   +0.11%     
==========================================
  Files         572      574       +2     
  Lines       53588    53833     +245     
==========================================
+ Hits        34085    34301     +216     
- Misses      17557    17583      +26     
- Partials     1946     1949       +3     
Impacted Files Coverage Δ
types/bech32/error.go 0.00% <0.00%> (ø)
types/bech32/convert.go 43.75% <43.75%> (ø)
types/bech32/bech32.go 96.01% <96.83%> (+52.26%) ⬆️
crypto/keys/internal/ecdsa/privkey.go 82.45% <0.00%> (-1.76%) ⬇️

@alexanderbez
Copy link
Contributor

alexanderbez commented Sep 10, 2021

Can we not have this exist in the SDK if possible please? Instead let's actually just fork the repo and use that as the dep. I can fork it under the cosmos org.

@conr2d
Copy link
Contributor Author

conr2d commented Sep 10, 2021

@robert-zaremba
To be honest, this is a preparation for #10025. If there is no plan to accept the PR about it soon, I will import btcsuite/btcutil this time.

@alexanderbez
I don't have any preference between putting this in SDK or separating it to independent repository. If you create a forked one, I will send following PRs to it.

@alexanderbez
Copy link
Contributor

Forked: https://github.com/cosmos/btcutil

Please make PRs against that repo. Once made, we'll pull and use that in the SDK's go.mod. Let me know if you need access to the repo.

@conr2d
Copy link
Contributor Author

conr2d commented Sep 12, 2021

@alexanderbez I sent PR to cosmos/btcutil. Could you give me an access to that repo to update module name and publish to make all tests work?

@alexanderbez
Copy link
Contributor

@conr2d done :)

@tac0turtle
Copy link
Member

is it okay to close this now?

@alexanderbez
Copy link
Contributor

Yes, let's close this PR and create a follow up PR where we use our cosmos fork with the relevant changes in that fork.

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.

Maintain our own bech32 library
4 participants