Trait

org.bitcoins.wallet.api

UnlockedWalletApi

Related Doc: package api

Permalink

trait UnlockedWalletApi extends LockedWalletApi

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnlockedWalletApi
  2. LockedWalletApi
  3. WalletApi
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def createNewAccount(): Future[WalletApi]

    Permalink

    Tries to create a new account in this wallet for the default account type.

    Tries to create a new account in this wallet for the default account type. Fails if the most recent account has no transaction history, as per BIP44

    See also

    BIP44 account section

  2. abstract def createNewAccount(purpose: HDPurpose): Future[WalletApi]

    Permalink

    Tries to create a new account in this wallet.

    Tries to create a new account in this wallet. Fails if the most recent account has no transaction history, as per BIP44

    See also

    BIP44 account section

  3. implicit abstract val ec: ExecutionContext

    Permalink
    Definition Classes
    WalletApi
  4. abstract def getAddressInfo(address: BitcoinAddress): Future[Option[AddressInfo]]

    Permalink

    Mimics the getaddressinfo RPC call in Bitcoin Core

    Mimics the getaddressinfo RPC call in Bitcoin Core

    returns

    If the address is found in our database Some(address) is returned, otherwise None

    Definition Classes
    LockedWalletApi
  5. abstract def getBloomFilter(): Future[BloomFilter]

    Permalink

    Retrieves a bloom filter that that can be sent to a P2P network node to get information about our transactions, pubkeys and scripts.

    Retrieves a bloom filter that that can be sent to a P2P network node to get information about our transactions, pubkeys and scripts.

    Definition Classes
    LockedWalletApi
  6. abstract def getConfirmedBalance(): Future[CurrencyUnit]

    Permalink

    Gets the sum of all confirmed UTXOs in this wallet

    Gets the sum of all confirmed UTXOs in this wallet

    Definition Classes
    LockedWalletApi
  7. abstract def getDefaultAccount(): Future[AccountDb]

    Permalink

    Fetches the default account from the DB

    Fetches the default account from the DB

    returns

    Future[AccountDb]

    Attributes
    protected[org.bitcoins.wallet]
    Definition Classes
    LockedWalletApi
  8. abstract def getDefaultAccountForType(addressType: AddressType): Future[AccountDb]

    Permalink

    Fetches the default account for the given address/account kind

    Fetches the default account for the given address/account kind

    Attributes
    protected[org.bitcoins.wallet]
    Definition Classes
    LockedWalletApi
  9. abstract def getNewAddress(addressType: AddressType): Future[BitcoinAddress]

    Permalink

    Gets a new external address with the specified type.

    Gets a new external address with the specified type. Calling this method multiple times will return the same address, until it has received funds. TODO: Last sentence is not true, implement that https://github.com/bitcoin-s/bitcoin-s/issues/628

    Definition Classes
    LockedWalletApi
  10. abstract def getNewChangeAddress(account: AccountDb): Future[BitcoinAddress]

    Permalink

    Generates a new change address

    Generates a new change address

    Attributes
    protected[org.bitcoins.wallet]
    Definition Classes
    LockedWalletApi
  11. abstract def getUnconfirmedBalance(): Future[CurrencyUnit]

    Permalink

    Gets the sum of all unconfirmed UTXOs in this wallet

    Gets the sum of all unconfirmed UTXOs in this wallet

    Definition Classes
    LockedWalletApi
  12. abstract def listAccounts(): Future[Vector[AccountDb]]

    Permalink
    Definition Classes
    LockedWalletApi
  13. abstract def listAddresses(): Future[Vector[AddressDb]]

    Permalink
    Definition Classes
    LockedWalletApi
  14. abstract def listUtxos(): Future[Vector[SpendingInfoDb]]

    Permalink

    Lists unspent transaction outputs in the wallet

    Lists unspent transaction outputs in the wallet

    returns

    Vector[SpendingInfoDb]

    Definition Classes
    LockedWalletApi
  15. abstract def lock(): LockedWalletApi

    Permalink

    Locks the wallet.

    Locks the wallet. After this operation is called, all sensitive material in the wallet should be encrypted and unaccessible

  16. abstract def mnemonicCode: MnemonicCode

    Permalink
  17. abstract def passphrase: AesPassword

    Permalink
  18. abstract def processTransaction(transaction: Transaction, confirmations: Int): Future[LockedWalletApi]

    Permalink

    Processes the given transaction, updating our DB state if it's relevant to us.

    Processes the given transaction, updating our DB state if it's relevant to us.

    transaction

    The transaction we're processing

    confirmations

    How many confirmations the TX has

    Definition Classes
    LockedWalletApi
  19. abstract def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, fromAccount: AccountDb): Future[Transaction]

    Permalink

    Sends money from the specified account

    Sends money from the specified account

    todo: add error handling to signature

  20. abstract def unlock(passphrase: AesPassword): UnlockWalletResult

    Permalink

    Unlocks the wallet with the provided passphrase, making it possible to send transactions.

    Unlocks the wallet with the provided passphrase, making it possible to send transactions.

    Definition Classes
    LockedWalletApi
  21. implicit abstract val walletConfig: WalletAppConfig

    Permalink
    Definition Classes
    WalletApi

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def chainParams: ChainParams

    Permalink
    Definition Classes
    WalletApi
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def getBalance(): Future[CurrencyUnit]

    Permalink

    Gets the sum of all UTXOs in this wallet

    Gets the sum of all UTXOs in this wallet

    Definition Classes
    LockedWalletApi
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def getNewAddress(): Future[BitcoinAddress]

    Permalink

    Gets a new external address from the default account.

    Gets a new external address from the default account. Calling this method multiple times will return the same address, until it has received funds.

    Definition Classes
    LockedWalletApi
  13. final def getNewChangeAddress(): Future[BitcoinAddress]

    Permalink

    Generates a new change address for the default account

    Generates a new change address for the default account

    Attributes
    protected[org.bitcoins.wallet]
    Definition Classes
    LockedWalletApi
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def listAccounts(purpose: HDPurpose): Future[Vector[AccountDb]]

    Permalink

    Lists all wallet accounts with the given type

    Lists all wallet accounts with the given type

    returns

    Future[Vector[AccountDb

    Definition Classes
    LockedWalletApi
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def networkParameters: NetworkParameters

    Permalink
    Definition Classes
    WalletApi
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. lazy val seed: BIP39Seed

    Permalink

    The wallet seed

  22. def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit): Future[Transaction]

    Permalink

    Sends money from the default account

    Sends money from the default account

    todo: add error handling to signature

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from LockedWalletApi

Inherited from WalletApi

Inherited from AnyRef

Inherited from Any

Ungrouped