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.

Sign up for GitHub

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

Jump to bottom

Light client tutorial using bdk-cli #49

Merged
merged 4 commits into from
Jun 25, 2021
Merged

Light client tutorial using bdk-cli #49

merged 4 commits into from
Jun 25, 2021

Conversation

rajarshimaitra
Copy link
Contributor

@rajarshimaitra rajarshimaitra commented May 28, 2021 •
edited
Loading

This is a draft tutorial I am working on for a demo of bdk-cli with compact_filters feature. (included in bitcoindevkit/bdk-cli#26)

This allows wallet devs to easily spawn their Neurtino like backend using BDK.

The demo only covers basic wallet functionalities.

The demo needs bdk-cli compiled on the above PR branch.

Suggestions, improvements, and additions are welcome.

Note to Reviewers.

Until bitcoindevkit/bdk-cli#26 gets merged, you have to build bdk-cli on top of that PR branch to get compact_filters support.

i5hi
i5hi reviewed May 28, 2021
View reviewed changes
content/blog/2021/compact_filters_demo.md Outdated
- Install `bdk-cli` with `compact_filters` feature

```shell
$ cargo install bdk-cli --features compact_filters
Copy link
Contributor

Choose a reason for hiding this comment

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

Package bdk-cli v0.2.0 does not have the feature compact_filters

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, because bitcoindevkit/bdk-cli#26 hasn't been merged yet. You can build bdk-cli on top of that PR branch to get compact_filters support.

Copy link
Contributor

Choose a reason for hiding this comment

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

oops, sorry!

Copy link
Contributor

Choose a reason for hiding this comment

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

got the correct version from your pr branch now :P

@rajarshimaitra rajarshimaitra marked this pull request as draft June 1, 2021 18:35
@rajarshimaitra rajarshimaitra changed the title [draft] Light client tutorial using bdk-cli Light client tutorial using bdk-cli Jun 1, 2021
notmandatory
notmandatory requested changes Jun 16, 2021
View reviewed changes
Copy link
Member

@notmandatory notmandatory left a comment

Choose a reason for hiding this comment

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

Hi sorry for the delay in getting this reviewed. I ran through all the steps and found a few things that should be fixed. For the bitcoin-cli commands I switched them to use the internal docker command so we don't need to worry about bitcoind rpc permissions.

@rajarshimaitra
Copy link
Contributor Author

Thanks @notmandatory for taking the time for such a thorough review.

Addressed all the comments. Hope I didn't miss any.

notmandatory
notmandatory approved these changes Jun 23, 2021
View reviewed changes
Copy link
Member

@notmandatory notmandatory left a comment

Choose a reason for hiding this comment

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

Looks good, I know these take a lot of work so thanks for putting it all together.

@notmandatory
Copy link
Member

Looks good, I know these take a lot of work so thanks for putting it all together. Please move it back to "Ready for review" when you're ready to have it merged.

@rajarshimaitra
Copy link
Contributor Author

rajarshimaitra commented Jun 25, 2021 •
edited
Loading

Thanks @notmandatory , I think I will always find nits to update every time I look.

Made a bunch of modification. Removed mentions of Neutrino in general and called it comapct_filters. Apart from metadata, as Neutrino is a popular term, so it might help in google indexing.

So far this seems final from my side.

Opening for the merge.

@rajarshimaitra rajarshimaitra marked this pull request as ready for review June 25, 2021 17:00
notmandatory
notmandatory approved these changes Jun 25, 2021
View reviewed changes
Copy link
Member

@notmandatory notmandatory left a comment

Choose a reason for hiding this comment

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

ACK, I also ran through the examples again and confirmed they work.

@rajarshimaitra @notmandatory
Add author details
af24bed
@rajarshimaitra @notmandatory
Add tutorial text
ac57ee5
@rajarshimaitra @notmandatory
Various nits and fixes from @notmandatory
77f7292
@rajarshimaitra @notmandatory
update various nits
d940d13 
Updated with better structuring of various sentences and segments.

Removed mentions of Neutrino apart from metadata and credit.
@notmandatory
Copy link
Member

I had to also do a re-base to resolve unrelated merge conflicts.

@notmandatory notmandatory merged commit d940d13 into bitcoindevkit:master Jun 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@i5hi i5hi i5hi left review comments

@notmandatory notmandatory notmandatory approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rajarshimaitra @notmandatory @i5hi