bitcoin-s/docs/wallet/wallet-get-address.md
Ben Carman 891e6da11d GetAddress Wallet API call (#1287)
* GetAddress Wallet API call

* Add ability to get unfunded address

* Generate new address if no unfunded addresses

* Add test

* Add wallet get address documentation
2020-04-09 15:33:11 -05:00

17 lines
611 B
Markdown

---
title: Wallet Get Address APIs
id: wallet-get-address
---
The Bitcoin-S wallet has a few different functions for getting a wallet address
that all server different purposes.
First, there is `getNewAddress`. This function will always return a new a address
determined by the next address available address index.
Second, we have `getUnusedAddress`. This function will return an address that has
not ever received funds.
Third, there is `getAddress`. This function takes in an `AccountDb`, `HDChainType`,
and an `Int`. This will return the address associated with the pubkey at
the resulting `BIP32Path`.