From: BitcoinZavior Date: Fri, 14 Oct 2022 16:02:29 +0000 (-0400) Subject: rewording some steps for readability X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/struct.EncoderStringWriter.html?a=commitdiff_plain;h=dc1b445ac5cd922049fa49a8d3fdbf232af7f4b8;p=bitcoindevkit.org rewording some steps for readability --- diff --git a/docs/tutorials/exploring_bdk_rn.md b/docs/tutorials/exploring_bdk_rn.md index d1a8c1fa3c..6633d5428e 100644 --- a/docs/tutorials/exploring_bdk_rn.md +++ b/docs/tutorials/exploring_bdk_rn.md @@ -35,7 +35,7 @@ Now let's jump into Bitcoin Dev Kit ## Bitcoin Dev Kit and bdk-rn `bdk-rn` is a React Native library of Bitcoin Dev Kit(BDK) for building React Native Apps. -It encapsulates all of the low-level APIs and methods for BDK and exposes them in a react native context. To use BDK in React Native(RN) apps only the `bdk-rn` module is required. `Bdk-rn` can be used like any other react native library and is available in public package managers. +It encapsulates all of the low-level APIs and methods for BDK and exposes them in a react native context. To use BDK in React Native(RN) apps only the `bdk-rn` module is required. `Bdk-rn` can be used like any other react native library and is available on [public package managers(npm and yarn)](https://www.npmjs.com/package/bdk-rn). ## Getting Started @@ -226,8 +226,8 @@ const mnemonic = response.data; We can specify a longer length or we can also specify the bits of entropy we need by passing the length or entropy arguments. -To create a mnemonic with an entropy of 256 bits which will be a 24-word length mnemonic sentence we can use `{ entropy: 256 }`. -Refer to the readme file on [GitHub](https://github.com/LtbLightning/bdk-rn#generatemnemomic) +To create a mnemonic with an entropy of 256 bits, which will be a 24-word length mnemonic sentence, we can use `{ entropy: 256 }`. +Refer to the readme file on [GitHub](https://github.com/LtbLightning/bdk-rn#generatemnemomic) for more details. ```javascript const {data: mnemonic} = await BdkRn.generateMnemonic({ entropy: 256 }); @@ -432,7 +432,7 @@ The wallet created is a HD wallet and the address displayed is the 0 index addre As we specified `testnet` and did not specify `blockChainName` and `blockChainConfigUrl` a default testnet server will be used as the bitcoin node, `ssl://electrum.blockstream.info` is the default url used for testnet. -Using `mnemonic` is a quick way to create a new wallet with bdk-rn. The `createWallet()` method in `bdk-rn` has many optional arguments to configure the wallet. In addition to mnemonic, a wallet can also be created with a descriptor. If a descriptor is passed as an argument the wallet will be created using the descriptor. When using a descriptor, arguments for network, password and mnemonic are not required. `bdk-rn` has a `createDescriptor()` method to create a descriptor. More about output descriptors [here](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md). Refer to the [readme](https://github.com/LtbLightning/bdk-rn#createdescriptor) for all options available when creating output descriptors with `bdk-rn` +Using `mnemonic` is a quick way to create a new wallet with `bdk-rn`. The `createWallet()` method in `bdk-rn` has many optional arguments to configure the wallet. In addition to mnemonic, a wallet can also be created with a descriptor. If a descriptor is passed as an argument the wallet will be created using the descriptor. When using a descriptor, arguments for network, password and mnemonic are not required. `bdk-rn` has a `createDescriptor()` method to create a descriptor. More about output descriptors [here](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md). Refer to the [readme](https://github.com/LtbLightning/bdk-rn#createdescriptor) for all options available when creating output descriptors with `bdk-rn` ```javascript // using a descriptor to create wallet @@ -452,11 +452,11 @@ Refer to [readme](https://github.com/LtbLightning/bdk-rn#createwallet) for a com ## UTXOs and balance -With the wallet created, we can now add methods to sync UTXOs and get a balance. +With the wallet created, we can now add methods to sync UTXOs compute balance. -`bdk-rn` has a `syncWallet` method to sync all UTXOs belonging to the wallet with the bitcoin network, the specified `blockChainName` and `blockChainConfigUrl` is used to sync. Once the wallet sync is complete `getBalance` can fetch the balance. +`bdk-rn` has a `syncWallet` method to sync all UTXOs belonging to the wallet with the bitcoin network, the specified `blockChainName` and `blockChainConfigUrl` is used to sync. Once the wallet sync is complete balance is computed and `getBalance` can fetch the balance. -Earlier we have aleady added state variables for`syncResponse`and `balance`. Now we will add buttons to call syncWallet and getBalance. Just below the Create Wallet button lets add two buttons as follows: +Earlier we have aleady added state variables for`syncResponse`and `balance`. Now we will add buttons to call `syncWallet` and `getBalance`. Just below the Create Wallet button lets add two buttons as follows: ```jsx