Interface LightClientBuilderInterface
-
- All Implemented Interfaces:
public interface LightClientBuilderInterface
Build a BIP 157/158 light client to fetch transactions for a
Wallet
.Options:
List of
Peer
: Bitcoin full-nodes for the light client to connect to. May be empty.connections
: The number of connections for the light client to maintain.scan_type
: Sync, recover, or start a new wallet. For more information see `ScanType`.data_dir
: Optional directory to store block headers and peers.
A note on recovering wallets. Developers should allow users to provide an approximate recovery height and an estimated number of transactions for the wallet. When determining how many scripts to check filters for, the
Wallet
lookahead
value will be used. To ensure all transactions are recovered, thelookahead
should be roughly the number of transactions in the wallet history.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
LightClientBuilderInterface.Companion
-
Method Summary
Modifier and Type Method Description abstract LightClient
build(Wallet wallet)
Construct a `LightClient` for a `Wallet`. abstract LightClientBuilder
connections(UByte connections)
The number of connections for the light client to maintain. abstract LightClientBuilder
dataDir(String dataDir)
Directory to store block headers and peers. abstract LightClientBuilder
peers(List<Peer> peers)
Bitcoin full-nodes to attempt a connection with. abstract LightClientBuilder
scanType(ScanType scanType)
Select between syncing, recovering, or scanning for new wallets.
-
-
-
Method Detail
-
build
abstract LightClient build(Wallet wallet)
Construct a `LightClient` for a `Wallet`.
-
connections
abstract LightClientBuilder connections(UByte connections)
The number of connections for the light client to maintain. Default is two.
-
dataDir
abstract LightClientBuilder dataDir(String dataDir)
Directory to store block headers and peers. If none is provided, the current working directory will be used.
-
peers
abstract LightClientBuilder peers(List<Peer> peers)
Bitcoin full-nodes to attempt a connection with.
-
scanType
abstract LightClientBuilder scanType(ScanType scanType)
Select between syncing, recovering, or scanning for new wallets.
-
-