frost/bdk-ffi
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update docs for new pinned dependency

Browse Source
This commit is contained in:
thunderbiscuit 2023-09-06 14:13:15 -04:00
parent 0b07b8ed05
commit fbec953149
No known key found for this signature in database
GPG Key ID: 88253696EB836462
3 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -33,6 +33,8 @@ To build with the MSRV you will need to pin dependencies as follows:
cargo update -p hashlink --precise "0.8.1" cargo update -p hashlink --precise "0.8.1"
# tokio 1.30.0 has MSRV 1.63.0 # tokio 1.30.0 has MSRV 1.63.0
cargo update -p tokio --precise "1.29.1" cargo update -p tokio --precise "1.29.1"
# flate2 1.0.27 and up do not work with Rust 1.61.0, but 1.0.26 does
cargo update -p flate2 --precise "1.0.26"
``` ```
## Contributing ## Contributing
@ -62,8 +64,8 @@ See the [UniFFI User Guide](https://mozilla.github.io/uniffi-rs/)
repositories { repositories {
mavenCentral() mavenCentral()
} }
dependencies { dependencies {
implementation("org.bitcoindevkit:bdk-android:<version>") implementation("org.bitcoindevkit:bdk-android:<version>")
} }
``` ```
@ -73,8 +75,8 @@ dependencies {
repositories { repositories {
mavenCentral() mavenCentral()
} }
dependencies { dependencies {
implementation("org.bitcoindevkit:bdk-jvm:<version>") implementation("org.bitcoindevkit:bdk-jvm:<version>")
} }
``` ```

8
bdk-android/README.md
View File

@ -8,8 +8,8 @@ repositories {
mavenCentral() mavenCentral()
} }
dependencies { dependencies {
implementation("org.bitcoindevkit:bdk-android:<version>") implementation("org.bitcoindevkit:bdk-android:<version>")
} }
``` ```
@ -38,8 +38,8 @@ repositories {
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/") maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
} }
dependencies { dependencies {
implementation("org.bitcoindevkit:bdk-android:<version-SNAPSHOT>") implementation("org.bitcoindevkit:bdk-android:<version-SNAPSHOT>")
} }
``` ```

8
bdk-jvm/README.md
View File

@ -25,8 +25,8 @@ val internalDescriptor = Descriptor("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8
val databaseConfig = DatabaseConfig.Memory val databaseConfig = DatabaseConfig.Memory
val blockchainConfig = BlockchainConfig.Electrum( val blockchainConfig = BlockchainConfig.Electrum(
ElectrumConfig("ssl://electrum.blockstream.info:60002", null, 5u, null, 10u, true) ElectrumConfig("ssl://electrum.blockstream.info:60002", null, 5u, null, 10u, true)
) )
val wallet = Wallet(externalDescriptor, internalDescriptor, Network.TESTNET, databaseConfig, blockchainConfig) val wallet = Wallet(externalDescriptor, internalDescriptor, Network.TESTNET, databaseConfig, blockchainConfig)
val newAddress = wallet.getAddress(AddressIndex.LastUnused) val newAddress = wallet.getAddress(AddressIndex.LastUnused)
``` ```
@ -38,8 +38,8 @@ repositories {
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/") maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
} }
dependencies { dependencies {
implementation("org.bitcoindevkit:bdk-jvm:<version-SNAPSHOT>") implementation("org.bitcoindevkit:bdk-jvm:<version-SNAPSHOT>")
} }
``` ```