Add bdk-rn blogpost - #107
Conversation
✅ Deploy Preview for awesome-golick-685c88 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| hidden: true | ||
| draft: false | ||
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api or rust is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. |
There was a problem hiding this comment.
"of the underlying bitcoin and bdk api or rust is not required"
the "or rust" doesn't read right to me...typo?
There was a problem hiding this comment.
Thanks, updated to remove 'or rust'
There was a problem hiding this comment.
Both comments addressed. Thanks @vladimirfomene @thunderbiscuit
thunderbiscuit
left a comment
thunderbiscuit
left a comment
There was a problem hiding this comment.
Hey thanks for the great write-up! It's good to have starting points where we can link people to if they have questions are are interested in digging, and it shows you're the person to contact if they want to learn more.
One of my comments might be that I'd be interested in "following along" from start to finish one or two of the APIs being built. I think that's sort of what you did with getBalance but I'm not sure I understood fully from beginning to end how it traverses the layers. In the end you create a wallet but the user didn't call getBalance on it. When trying to trace back, I find a code block I think might need explaining:
val balance: String = wallet.getBalance().toLong()
result.resolve(balance)I also found a few little typos and repeats, nothing too major. Take what you like of my comments and throw the rest out!
| hidden: true | ||
| draft: false | ||
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. |
There was a problem hiding this comment.
We're calling the bdk-android and bdk-swift "libraries" rather than "versions". Would be good to follow that convention here as well.
There was a problem hiding this comment.
I'm thinking bdk api should be BDK API given that they are abbreviations. There is also the double use of using on the last but one line.
| hidden: true | ||
| draft: false | ||
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. |
There was a problem hiding this comment.
"configurations" instead of "confugurations"
| hidden: true | ||
| draft: false | ||
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. |
There was a problem hiding this comment.
I think iOS is spelled with the "i" not in caps.
| hidden: true | ||
| draft: false | ||
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. |
There was a problem hiding this comment.
"rust lang implementation, confugurations any and other details are all taken
There was a problem hiding this comment.
Should rust not be capitalized given that it is a proper noun?
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. | ||
|
|
||
| This article is **NOT a guide on how to use bdk-rn** to build a bitcoin Application, rather this is an insight into how `bdk-rn` was developed. For help on how to use `bdk-rn` to develop a bitcoin Wallet or Application please refer to the user guide in the readme on github: https://github.com/LtbLightning/bdk-rn#usage. There will be `how to guides` published shortly on getting started with `bdk-rn`. |
There was a problem hiding this comment.
build a bitcoin Application application,
There was a problem hiding this comment.
It might be better, to write README so that the link is clickable. Also github is a proper noun so is better, GitHub.
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. | ||
|
|
||
| This article is **NOT a guide on how to use bdk-rn** to build a bitcoin Application, rather this is an insight into how `bdk-rn` was developed. For help on how to use `bdk-rn` to develop a bitcoin Wallet or Application please refer to the user guide in the readme on github: https://github.com/LtbLightning/bdk-rn#usage. There will be `how to guides` published shortly on getting started with `bdk-rn`. |
There was a problem hiding this comment.
I think this link (https://github.com/LtbLightning/bdk-rn#usage) should be made a direct link inside a few words preceding, for example like so:
please refer to the user guide in the readme on github
|
|
||
| The native part of RN consists of Android as well as IOS modules and components. The Android and IOS sections are full fledged native projects which interact with the JS side over the native bridge. A RN project has all the build configuraiton required to build both Android and IOS projects. | ||
|
|
||
| For the purpose of making `bdk-rn`, `bdk-kotlin` is used as the native Android module and `bdk-swift` as native IOS module. These are configured and wrapped in a RN Project as part of the platform specific native modules within the RN Project. This RN Project is then built to be a reusable React Native module. |
There was a problem hiding this comment.
and bdk-swift as the native iOS module
|
|
||
| We will go into the details of how the BDK Android Module is integrated, similar steps are done for IOS as well. | ||
|
|
||
| Starting off with a basic RN project. This project will be enhanced with bdk-kotlin and bdk-swift binaries and native code. For now lets go into the details for Android, IOS has similar steps to be done. |
There was a problem hiding this comment.
"IOS has similar steps to be done" is repeated from the paragraph above. Can be removed.
|
|
||
| ``` | ||
|
|
||
| The actual bdk-rn module has organised the native code into granular methods for different stages of creating a wallet and for different interactions with the wallet, like generating seeds, creating wallet for different network, creating descriptors, creating or restoring wallet, fetching balance, fetching transactions and many other methods. Please refer:[https://github.com/LtbLightning/bdk-rn#library-api](https://github.com/LtbLightning/bdk-rn#library-api) The set of APIs available will grow in the near future as more APIs will get added. This article can also be used as a guide to add new methods to the existing bdk-rn project. |
There was a problem hiding this comment.
I'd say "For the complete API, please refer to this section of the readme" maybe to clean up that sentence a bit.
|
|
||
| The actual bdk-rn module has organised the native code into granular methods for different stages of creating a wallet and for different interactions with the wallet, like generating seeds, creating wallet for different network, creating descriptors, creating or restoring wallet, fetching balance, fetching transactions and many other methods. Please refer:[https://github.com/LtbLightning/bdk-rn#library-api](https://github.com/LtbLightning/bdk-rn#library-api) The set of APIs available will grow in the near future as more APIs will get added. This article can also be used as a guide to add new methods to the existing bdk-rn project. | ||
|
|
||
| The objective of `bdk-rn` is to enable React Native developers to quickly start developing applications without the need to package BDK as described above. This article can also be used as a guide to add new methods to the existing bdk-rn project. |
There was a problem hiding this comment.
This sentence is repeated from above (one of the two should be deleted): This article can also be used as a guide to add new methods to the existing bdk-rn project.
vladimirfomene
left a comment
vladimirfomene
left a comment
There was a problem hiding this comment.
Just Nits. Great write-up! I look forward to using it to build a wallet.
| hidden: true | ||
| draft: false | ||
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. |
There was a problem hiding this comment.
I'm thinking bdk api should be BDK API given that they are abbreviations. There is also the double use of using on the last but one line.
| hidden: true | ||
| draft: false | ||
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. |
There was a problem hiding this comment.
Should rust not be capitalized given that it is a proper noun?
| --- | ||
| The **BitcoinDevkit**'s **React Native** version (`bdk-rn`) makes it easy to develop bitcoin applications for both Android and IOS mobile platforms. Using `bdk-rn` knowledge of the underlying bitcoin and bdk api is not required and using `bdk-rn` is similar to using any other RN module. The goal is **Rapid Bitcoin Application Development** by doing the heavy lifting in advance and providing a reusable package for other developers to use. Developers simply install using using `yarn add` and start using it in a React Native Project. The native code, rust lang implementation, confugurations any other details are all taken care of by `bdk-rn`. | ||
|
|
||
| This article is **NOT a guide on how to use bdk-rn** to build a bitcoin Application, rather this is an insight into how `bdk-rn` was developed. For help on how to use `bdk-rn` to develop a bitcoin Wallet or Application please refer to the user guide in the readme on github: https://github.com/LtbLightning/bdk-rn#usage. There will be `how to guides` published shortly on getting started with `bdk-rn`. |
There was a problem hiding this comment.
It might be better, to write README so that the link is clickable. Also github is a proper noun so is better, GitHub.
| val changeDescriptor: String = descriptor.replace("/84'/1'/0'/0/*","/84'/1'/0'/1/*") | ||
| ``` | ||
|
|
||
| To create a wallet with bdk we need to specify wallet descriptor, network, a database config, blockchain config. We intend to use bitcoin testnet and want to use default memory for data. For bitcoin node we will use a public electrum server. We will need to define these parameters to create a wallet. |
There was a problem hiding this comment.
Here again, I think bdk should be BDK.
There was a problem hiding this comment.
Thanks @vladimirfomene all above comments have been addressed now ✅
| result.resolve(balance) | ||
| ``` | ||
|
|
||
| At this point we have an Android native module and it can be invoked from JS by calling createWallet. if the wallet is created correctly it will return the balance. |
There was a problem hiding this comment.
It think you should write createWallet here as createWallet. Also start the sentence if .... with caps.
| ) | ||
| ``` | ||
|
|
||
| Once done we can use these parameters to create a bdk wallet using the native android bdk library: |
There was a problem hiding this comment.
You might want to change bdk and android here to BDK and Android.
| ) | ||
| ``` | ||
|
|
||
| Once done we can use these parameters to create a bdk wallet using the native android bdk library: |
There was a problem hiding this comment.
You might want to change bdk and android here to BDK and Android.
vladimirfomene
left a comment
vladimirfomene
left a comment
There was a problem hiding this comment.
Just Nits. Great write-up! I look forward to using it to build a wallet.
notmandatory
left a comment
notmandatory
left a comment
There was a problem hiding this comment.
ACK a17d0b2
Thanks, great intro to how bdk-rn works!
5 participants
A blog post about bdk-rn. This blogpost describes how bdk-rn was created, covers architecture and key React Native aspects that are required for creating React Native modules.