Packages

t

org.bitcoins.core.api.dlc.wallet

DLCNeutrinoHDWalletApi

trait DLCNeutrinoHDWalletApi extends NeutrinoHDWalletApi with DLCWalletApi

An HDWallet that supports DLCs and Neutrino method of syncing

Linear Supertypes
DLCWalletApi, NeutrinoHDWalletApi, NeutrinoWalletApi, HDWalletApi, WalletApi, StartStopAsync[WalletApi], StartStop[Future[WalletApi]], AnyRef, Any
Known Subclasses
DLCWallet, WalletHolder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DLCNeutrinoHDWalletApi
  2. DLCWalletApi
  3. NeutrinoHDWalletApi
  4. NeutrinoWalletApi
  5. HDWalletApi
  6. WalletApi
  7. StartStopAsync
  8. StartStop
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def acceptDLCOffer(dlcOffer: DLCOffer, peerAddress: Option[InetSocketAddress], externalPayoutAddressOpt: Option[BitcoinAddress], externalChangeAddressOpt: Option[BitcoinAddress]): Future[DLCAccept]
    Definition Classes
    DLCWalletApi
  2. abstract def addDLCContact(contact: DLCContactDb): Future[Unit]
    Definition Classes
    DLCWalletApi
  3. abstract def addDLCContactMapping(dlcId: Sha256Digest, contactId: InetSocketAddress): Future[Unit]
    Definition Classes
    DLCWalletApi
  4. abstract def addDLCSigs(sigs: DLCSign): Future[DLCDb]
    Definition Classes
    DLCWalletApi
  5. abstract def addDLCSigs(signTLV: DLCSignTLV): Future[DLCDb]
    Definition Classes
    DLCWalletApi
  6. abstract def broadcastDLCFundingTx(contractId: ByteVector): Future[Transaction]
    Definition Classes
    DLCWalletApi
  7. abstract def bumpFeeCPFP(txId: DoubleSha256DigestBE, feeRate: FeeUnit): Future[Transaction]

    Bumps the fee of the parent transaction with a new child transaction with the given fee rate

    Bumps the fee of the parent transaction with a new child transaction with the given fee rate

    Definition Classes
    WalletApi
  8. abstract def bumpFeeRBF(txId: DoubleSha256DigestBE, newFeeRate: FeeUnit): Future[Transaction]
    Definition Classes
    WalletApi
  9. abstract def cancelDLC(dlcId: Sha256Digest): Future[Unit]
    Definition Classes
    DLCWalletApi
  10. abstract val chainQueryApi: ChainQueryApi
    Definition Classes
    WalletApi
  11. abstract def clearAllAddresses(): Future[WalletApi]
    Definition Classes
    WalletApi
  12. abstract def clearAllUtxos(): Future[HDWalletApi]

    Removes all utxos from the wallet.

    Removes all utxos from the wallet. Don't call this unless you are sure you can recover your wallet

    Definition Classes
    HDWalletApi → WalletApi
  13. abstract def clearUtxos(account: HDAccount): Future[HDWalletApi]
    Definition Classes
    HDWalletApi
  14. abstract def createDLCOffer(contractInfo: ContractInfo, collateral: Satoshis, feeRateOpt: Option[SatoshisPerVirtualByte], locktime: UInt32, refundLT: UInt32, peerAddressOpt: Option[InetSocketAddress], externalPayoutAddressOpt: Option[BitcoinAddress], externalChangeAddressOpt: Option[BitcoinAddress]): Future[DLCOffer]
    Definition Classes
    DLCWalletApi
  15. abstract def createDLCOffer(contractInfo: ContractInfo, collateral: Satoshis, feeRateOpt: Option[SatoshisPerVirtualByte], refundLT: UInt32, peerAddressOpt: Option[InetSocketAddress], externalPayoutAddressOpt: Option[BitcoinAddress], externalChangeAddressOpt: Option[BitcoinAddress]): Future[DLCOffer]
    Definition Classes
    DLCWalletApi
  16. abstract def createNewAccount(hdAccount: HDAccount, keyManagerParams: KeyManagerParams): Future[HDWalletApi]

    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

    Definition Classes
    HDWalletApi
    See also

    BIP44 account section

  17. abstract def createNewAccount(keyManagerParams: KeyManagerParams): Future[HDWalletApi]
    Definition Classes
    HDWalletApi
  18. abstract val creationTime: Instant
    Definition Classes
    WalletApi
  19. abstract def discoveryBatchSize(): Int
    Definition Classes
    NeutrinoWalletApi
  20. abstract def dropAddressTag(addressTagDb: AddressTagDb): Future[Int]
    Definition Classes
    WalletApi
  21. abstract def dropAddressTagName(address: BitcoinAddress, tagName: AddressTagName): Future[Int]
    Definition Classes
    WalletApi
  22. abstract def dropAddressTagType(address: BitcoinAddress, addressTagType: AddressTagType): Future[Int]
    Definition Classes
    WalletApi
  23. abstract def dropAddressTagType(addressTagType: AddressTagType): Future[Int]
    Definition Classes
    WalletApi
  24. abstract def executeDLC(contractId: ByteVector, oracleSigs: Vector[OracleSignatures]): Future[Option[Transaction]]

    Creates the CET for the given contractId and oracle signature, does not broadcast it

    Creates the CET for the given contractId and oracle signature, does not broadcast it

    Definition Classes
    DLCWalletApi
  25. abstract def executeDLC(contractId: ByteVector, oracleSigs: Seq[OracleAttestmentTLV]): Future[Option[Transaction]]

    Creates the CET for the given contractId and oracle signature, does not broadcast it

    Creates the CET for the given contractId and oracle signature, does not broadcast it

    Definition Classes
    DLCWalletApi
  26. abstract def executeDLCRefund(contractId: ByteVector): Future[Transaction]

    Creates the refund transaction for the given contractId, does not broadcast it

    Creates the refund transaction for the given contractId, does not broadcast it

    Definition Classes
    DLCWalletApi
  27. abstract val feeRateApi: FeeRateApi
    Definition Classes
    WalletApi
  28. abstract def findAccount(account: HDAccount): Future[Option[AccountDb]]
    Definition Classes
    HDWalletApi
  29. abstract def findByOutPoints(outPoints: Vector[TransactionOutPoint]): Future[Vector[SpendingInfoDb]]
    Definition Classes
    WalletApi
  30. abstract def findByScriptPubKey(scriptPubKey: ScriptPubKey): Future[Vector[SpendingInfoDb]]
    Definition Classes
    WalletApi
  31. abstract def findByTxIds(txIds: Vector[DoubleSha256DigestBE]): Future[Vector[TransactionDb]]
    Definition Classes
    WalletApi
  32. abstract def findDLC(dlcId: Sha256Digest): Future[Option[DLCStatus]]
    Definition Classes
    DLCWalletApi
  33. abstract def findDLCByTemporaryContractId(tempContractId: Sha256Digest): Future[Option[DLCStatus]]
    Definition Classes
    DLCWalletApi
  34. abstract def findDLCContacts(alias: String): Future[Vector[DLCContactDb]]
    Definition Classes
    DLCWalletApi
  35. abstract def findIncomingDLCOffer(offerHash: Sha256Digest): Future[Option[IncomingDLCOfferDb]]
    Definition Classes
    DLCWalletApi
  36. abstract def findOutputsBeingSpent(tx: Transaction): Future[Vector[SpendingInfoDb]]

    Finds all the outputs in our wallet being spent in the given transaction

    Finds all the outputs in our wallet being spent in the given transaction

    Definition Classes
    WalletApi
  37. abstract def findTransaction(txId: DoubleSha256DigestBE): Future[Option[TransactionDb]]
    Definition Classes
    WalletApi
  38. abstract def fundRawTransaction(destinations: Vector[TransactionOutput], feeRate: FeeUnit, fromAccount: AccountDb, markAsReserved: Boolean): Future[FundRawTxHelper[ShufflingNonInteractiveFinalizer]]
    Definition Classes
    HDWalletApi
  39. abstract def fundRawTransaction(destinations: Vector[TransactionOutput], feeRate: FeeUnit, fromTagOpt: Option[AddressTag], markAsReserved: Boolean): Future[FundRawTxHelper[ShufflingNonInteractiveFinalizer]]

    Funds a transaction from the wallet.

    Funds a transaction from the wallet.

    returns

    funded transaction send funds to desinations with the given fee rate

    Definition Classes
    WalletApi
  40. abstract def getAddress(account: AccountDb, chainType: HDChainType, addressIndex: Int): Future[AddressDb]

    Gets the address associated with the pubkey at the resulting BIP32Path determined the given account, chainType, and addressIndex

    Gets the address associated with the pubkey at the resulting BIP32Path determined the given account, chainType, and addressIndex

    Definition Classes
    HDWalletApi
  41. abstract def getAddressInfo(address: BitcoinAddress): Future[Option[AddressInfo]]

    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
    WalletApi
  42. abstract def getAddressTags(tagType: AddressTagType): Future[Vector[AddressTagDb]]
    Definition Classes
    WalletApi
  43. abstract def getAddressTags(): Future[Vector[AddressTagDb]]
    Definition Classes
    WalletApi
  44. abstract def getAddressTags(address: BitcoinAddress, tagType: AddressTagType): Future[Vector[AddressTagDb]]
    Definition Classes
    WalletApi
  45. abstract def getAddressTags(address: BitcoinAddress): Future[Vector[AddressTagDb]]
    Definition Classes
    WalletApi
  46. abstract def getConfirmedBalance(account: HDAccount): Future[CurrencyUnit]
    Definition Classes
    HDWalletApi
  47. abstract def getConfirmedBalance(tag: AddressTag): Future[CurrencyUnit]
    Definition Classes
    WalletApi
  48. abstract def getConfirmedBalance(): Future[CurrencyUnit]

    Gets the sum of all confirmed UTXOs in this wallet

    Gets the sum of all confirmed UTXOs in this wallet

    Definition Classes
    WalletApi
  49. abstract def getDLCFundingTx(contractId: ByteVector): Future[Transaction]
    Definition Classes
    DLCWalletApi
  50. abstract def getDLCOffer(dlcId: Sha256Digest): Future[Option[DLCOffer]]
    Definition Classes
    DLCWalletApi
  51. abstract def getDefaultAccount(): Future[AccountDb]

    Fetches the default account from the DB

    Fetches the default account from the DB

    returns

    Future[AccountDb]

    Definition Classes
    HDWalletApi
  52. abstract def getDefaultAccountForType(addressType: AddressType): Future[AccountDb]

    Fetches the default account for the given address/account kind

    Fetches the default account for the given address/account kind

    Definition Classes
    HDWalletApi
  53. abstract def getInfo(): Future[WalletInfo]
    Definition Classes
    WalletApi
  54. abstract def getNewAddress(account: AccountDb): Future[BitcoinAddress]
    Definition Classes
    HDWalletApi
  55. abstract def getNewAddress(account: HDAccount): Future[BitcoinAddress]
    Definition Classes
    HDWalletApi
  56. abstract def getNewAddress(tags: Vector[AddressTag]): Future[BitcoinAddress]
    Definition Classes
    WalletApi
  57. abstract def getNewAddress(addressType: AddressType, tags: Vector[AddressTag]): Future[BitcoinAddress]
    Definition Classes
    WalletApi
  58. abstract def getNewAddress(): Future[BitcoinAddress]

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

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

    Definition Classes
    WalletApi
  59. abstract def getNewAddress(addressType: AddressType): Future[BitcoinAddress]

    Gets a new external address with the specified type.

    Gets a new external address with the specified type.

    Definition Classes
    WalletApi
  60. abstract def getNewChangeAddress(account: AccountDb): Future[BitcoinAddress]

    Generates a new change address

    Generates a new change address

    Definition Classes
    HDWalletApi
  61. abstract def getSyncDescriptorOpt(): Future[Option[SyncHeightDescriptor]]
    Definition Classes
    WalletApi
  62. abstract def getSyncState(): Future[BlockSyncState]
    Definition Classes
    WalletApi
  63. abstract def getUnconfirmedBalance(account: HDAccount): Future[CurrencyUnit]
    Definition Classes
    HDWalletApi
  64. abstract def getUnconfirmedBalance(tag: AddressTag): Future[CurrencyUnit]
    Definition Classes
    WalletApi
  65. abstract def getUnconfirmedBalance(): Future[CurrencyUnit]

    Gets the sum of all unconfirmed UTXOs in this wallet

    Gets the sum of all unconfirmed UTXOs in this wallet

    Definition Classes
    WalletApi
  66. abstract def getUnusedAddress: Future[BitcoinAddress]

    Gets a external address.

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

    Definition Classes
    WalletApi
  67. abstract def getUnusedAddress(addressType: AddressType): Future[BitcoinAddress]

    Gets a external address the given AddressType.

    Gets a external address the given AddressType. Calling this method multiple times will return the same address, until it has received funds.

    Definition Classes
    WalletApi
  68. abstract def getWalletAccounting(): Future[DLCWalletAccounting]

    Retrieves accounting and financial metrics for the entire dlc wallet

    Retrieves accounting and financial metrics for the entire dlc wallet

    Definition Classes
    DLCWalletApi
  69. abstract def getWalletName(): Future[String]
    Definition Classes
    WalletApi
  70. abstract def isChange(output: TransactionOutput): Future[Boolean]

    Determines if the given output is from this wallet and is a change output from this wallet

    Determines if the given output is from this wallet and is a change output from this wallet

    Definition Classes
    WalletApi
  71. abstract def isEmpty(): Future[Boolean]

    Checks if the wallet contains any data

    Checks if the wallet contains any data

    Definition Classes
    WalletApi
  72. abstract def isRescanning(): Future[Boolean]
    Definition Classes
    WalletApi
  73. abstract def keyManager: BIP39KeyManagerApi
    Definition Classes
    HDWalletApi → WalletApi
  74. abstract def listAccounts(): Future[Vector[AccountDb]]
    Definition Classes
    HDWalletApi
  75. abstract def listAddresses(account: HDAccount): Future[Vector[AddressDb]]
    Definition Classes
    HDWalletApi
  76. abstract def listAddresses(): Future[Vector[AddressDb]]
    Definition Classes
    WalletApi
  77. abstract def listDLCContacts(): Future[Vector[DLCContactDb]]
    Definition Classes
    DLCWalletApi
  78. abstract def listDLCs(): Future[Vector[DLCStatus]]
    Definition Classes
    DLCWalletApi
  79. abstract def listDLCs(states: Vector[DLCState]): Future[Vector[DLCStatus]]

    Fetches all DLCs with the given set of states

    Fetches all DLCs with the given set of states

    Definition Classes
    DLCWalletApi
  80. abstract def listDLCsByContact(address: InetSocketAddress): Future[Vector[DLCStatus]]
    Definition Classes
    DLCWalletApi
  81. abstract def listDefaultAccountUtxos(): Future[Vector[SpendingInfoDb]]
    Definition Classes
    HDWalletApi
  82. abstract def listFundedAddresses(account: HDAccount): Future[Vector[(AddressDb, CurrencyUnit)]]
    Definition Classes
    HDWalletApi
  83. abstract def listFundedAddresses(): Future[Vector[(AddressDb, CurrencyUnit)]]
    Definition Classes
    WalletApi
  84. abstract def listIncomingDLCOffers(): Future[Vector[IncomingDLCOfferDb]]
    Definition Classes
    DLCWalletApi
  85. abstract def listScriptPubKeys(): Future[Vector[ScriptPubKeyDb]]
    Definition Classes
    WalletApi
  86. abstract def listSpentAddresses(account: HDAccount): Future[Vector[AddressDb]]
    Definition Classes
    HDWalletApi
  87. abstract def listSpentAddresses(): Future[Vector[AddressDb]]
    Definition Classes
    WalletApi
  88. abstract def listTransactions(): Future[Vector[TransactionDb]]
    Definition Classes
    WalletApi
  89. abstract def listUnusedAddresses(account: HDAccount): Future[Vector[AddressDb]]
    Definition Classes
    HDWalletApi
  90. abstract def listUnusedAddresses(): Future[Vector[AddressDb]]
    Definition Classes
    WalletApi
  91. abstract def listUtxos(hdAccount: HDAccount, state: TxoState): Future[Vector[SpendingInfoDb]]
    Definition Classes
    HDWalletApi
  92. abstract def listUtxos(hdAccount: HDAccount, tag: AddressTag): Future[Vector[SpendingInfoDb]]
    Definition Classes
    HDWalletApi
  93. abstract def listUtxos(account: HDAccount): Future[Vector[SpendingInfoDb]]
    Definition Classes
    HDWalletApi
  94. abstract def listUtxos(state: TxoState): Future[Vector[SpendingInfoDb]]
    Definition Classes
    WalletApi
  95. abstract def listUtxos(tag: AddressTag): Future[Vector[SpendingInfoDb]]
    Definition Classes
    WalletApi
  96. abstract def listUtxos(): Future[Vector[SpendingInfoDb]]

    Lists unspent transaction outputs in the wallet

    Lists unspent transaction outputs in the wallet

    returns

    Vector[SpendingInfoDb]

    Definition Classes
    WalletApi
  97. abstract def makeOpReturnCommitment(message: String, hashMessage: Boolean, feeRate: FeeUnit, fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  98. abstract def markUTXOsAsReserved(tx: Transaction): Future[Vector[SpendingInfoDb]]

    Marks all utxos that are ours in this transactions as reserved

    Marks all utxos that are ours in this transactions as reserved

    Definition Classes
    WalletApi
  99. abstract def markUTXOsAsReserved(utxos: Vector[SpendingInfoDb]): Future[Vector[SpendingInfoDb]]
    Definition Classes
    WalletApi
  100. abstract val nodeApi: NodeApi
    Definition Classes
    WalletApi
  101. abstract def processBlock(block: Block): Future[WalletApi]

    Processes the give block, updating our DB state if it's relevant to us.

    Processes the give block, updating our DB state if it's relevant to us.

    block

    The block we're processing

    Definition Classes
    WalletApi
  102. abstract def processCompactFilters(blockFilters: Vector[(DoubleSha256DigestBE, GolombFilter)]): Future[NeutrinoHDWalletApi]
    Definition Classes
    NeutrinoWalletApi
  103. abstract def processOurTransaction(transaction: Transaction, feeRate: FeeUnit, inputAmount: CurrencyUnit, sentAmount: CurrencyUnit, blockHashOpt: Option[DoubleSha256DigestBE], newTags: Vector[AddressTag]): Future[ProcessTxResult]

    Processes TXs originating from our wallet.

    Processes TXs originating from our wallet. This is called right after we've signed a TX, updating our UTXO state.

    Definition Classes
    WalletApi
  104. abstract def processTransaction(transaction: Transaction, blockHashOpt: Option[DoubleSha256DigestBE]): Future[WalletApi]

    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

    Definition Classes
    WalletApi
  105. abstract def registerIncomingDLCOffer(offerTLV: DLCOfferTLV, peer: Option[String], message: Option[String]): Future[Sha256Digest]
    Definition Classes
    DLCWalletApi
  106. abstract def rejectIncomingDLCOffer(offerHash: Sha256Digest): Future[Unit]
    Definition Classes
    DLCWalletApi
  107. abstract def removeDLCContact(address: InetSocketAddress): Future[Unit]
    Definition Classes
    DLCWalletApi
  108. abstract def removeDLCContactMapping(dlcId: Sha256Digest): Future[Unit]
    Definition Classes
    DLCWalletApi
  109. abstract def rescanNeutrinoWallet(startOpt: Option[BlockStamp], endOpt: Option[BlockStamp], addressBatchSize: Int, useCreationTime: Boolean, force: Boolean)(implicit ec: ExecutionContext): Future[RescanState]

    Recreates the account using BIP-157 approach

    Recreates the account using BIP-157 approach

    DANGER! This method removes all records from the wallet database and creates new ones while the account discovery process.

    The Wallet UI should check if the database is empty before calling this method and let the end users to decide whether they want to proceed or not.

    This method generates addressBatchSize of addresses, then matches them against the BIP-158 compact filters, and downloads and processes the matched blocks. This method keeps doing the steps until there are WalletConfig.addressGapLimit or more unused addresses in a row. In this case it considers the discovery process completed.

    addressBatchSize - the number of addresses we should generate from a keychain to attempt to match in in a rescan WalletConfig.addressGapLimit - the number of addresses required to go without a match before we determine that our wallet is "discovered". For instance, if addressBatchSize=100, and AddressGapLimit=20 we do a rescan and the last address we find containing funds is at index 75, we would not generate more addresses to try and rescan. However if the last index containing funds was 81, we would generate another 100 addresses from the keychain and attempt to rescan those.

    startOpt

    start block (if None it starts from the genesis block)

    endOpt

    end block (if None it ends at the current tip)

    addressBatchSize

    how many addresses to match in a single pass

    Definition Classes
    NeutrinoWalletApi
  110. abstract def sendFromOutPoints(outPoints: Vector[TransactionOutPoint], address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, fromAccount: AccountDb, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]

    Sends money from the specified account

    Sends money from the specified account

    todo: add error handling to signature

    Definition Classes
    HDWalletApi
  111. abstract def sendFromOutPoints(outPoints: Vector[TransactionOutPoint], address: BitcoinAddress, feeRate: FeeUnit)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    WalletApi
  112. abstract def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, fromAccount: AccountDb, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]

    Sends money from the specified account

    Sends money from the specified account

    todo: add error handling to signature

    Definition Classes
    HDWalletApi
  113. abstract def sendToAddresses(addresses: Vector[BitcoinAddress], amounts: Vector[CurrencyUnit], feeRate: FeeUnit, fromAccount: AccountDb, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]

    Sends money from the specified account

    Sends money from the specified account

    todo: add error handling to signature

    Definition Classes
    HDWalletApi
  114. abstract def sendToOutputs(outputs: Vector[TransactionOutput], feeRate: FeeUnit, fromAccount: AccountDb, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]

    Sends money from the specified account

    Sends money from the specified account

    todo: add error handling to signature

    Definition Classes
    HDWalletApi
  115. abstract def sendWithAlgo(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, algo: CoinSelectionAlgo, fromAccount: AccountDb, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  116. abstract def signDLC(accept: DLCAccept): Future[DLCSign]
    Definition Classes
    DLCWalletApi
  117. abstract def signDLC(acceptTLV: DLCAcceptTLV): Future[DLCSign]
    Definition Classes
    DLCWalletApi
  118. abstract def signPSBT(psbt: PSBT)(implicit ec: ExecutionContext): Future[PSBT]
    Definition Classes
    HDWalletApi
  119. abstract def start(): Future[WalletApi]
    Definition Classes
    WalletApi → StartStop
  120. abstract def stop(): Future[WalletApi]
    Definition Classes
    WalletApi → StartStop
  121. abstract def sweepWallet(address: BitcoinAddress, feeRate: FeeUnit)(implicit ec: ExecutionContext): Future[Transaction]

    Sends the entire wallet balance to the given address

    Sends the entire wallet balance to the given address

    Definition Classes
    WalletApi
  122. abstract def tagAddress(address: BitcoinAddress, tag: AddressTag): Future[AddressTagDb]

    Tags the address with the address tag, updates the tag if one of tag's TagType already exists

    Tags the address with the address tag, updates the tag if one of tag's TagType already exists

    Definition Classes
    WalletApi
  123. abstract def unmarkUTXOsAsReserved(tx: Transaction): Future[Vector[SpendingInfoDb]]

    Unmarks all utxos that are ours in this transactions indicating they are no longer reserved

    Unmarks all utxos that are ours in this transactions indicating they are no longer reserved

    Definition Classes
    WalletApi
  124. abstract def unmarkUTXOsAsReserved(utxos: Vector[SpendingInfoDb]): Future[Vector[SpendingInfoDb]]
    Definition Classes
    WalletApi
  125. abstract def updateUtxoPendingStates(): Future[Vector[SpendingInfoDb]]

    Takes in a block header and updates our TxoStates to the new chain tip

    Takes in a block header and updates our TxoStates to the new chain tip

    Definition Classes
    WalletApi
  126. abstract def watchScriptPubKey(scriptPubKey: ScriptPubKey): Future[ScriptPubKeyDb]
    Definition Classes
    WalletApi

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def acceptDLCOffer(dlcOfferTLV: DLCOfferTLV, peerAddress: Option[InetSocketAddress], externalPayoutAddressOpt: Option[BitcoinAddress], externalChangeAddressOpt: Option[BitcoinAddress]): Future[DLCAccept]
    Definition Classes
    DLCWalletApi
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def broadcastTransaction(transaction: Transaction): Future[Unit]
    Definition Classes
    WalletApi
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def createDLCOffer(contractInfoTLV: ContractInfoTLV, collateral: Satoshis, feeRateOpt: Option[SatoshisPerVirtualByte], locktime: UInt32, refundLT: UInt32, peerAddressOpt: Option[InetSocketAddress], externalPayoutAddressOpt: Option[BitcoinAddress], externalChangeAddressOpt: Option[BitcoinAddress]): Future[DLCOffer]
    Definition Classes
    DLCWalletApi
  9. def createDLCOffer(contractInfoTLV: ContractInfoTLV, collateral: Satoshis, feeRateOpt: Option[SatoshisPerVirtualByte], refundLT: UInt32, peerAddressOpt: Option[InetSocketAddress], externalPayoutAddressOpt: Option[BitcoinAddress], externalChangeAddressOpt: Option[BitcoinAddress]): Future[DLCOffer]
    Definition Classes
    DLCWalletApi
  10. def determineFeeRate(feeRateOpt: Option[FeeUnit]): Future[FeeUnit]
    Attributes
    protected
    Definition Classes
    WalletApi
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def executeDLC(contractId: ByteVector, oracleSig: OracleSignatures): Future[Option[Transaction]]

    Creates the CET for the given contractId and oracle signature, does not broadcast it

    Creates the CET for the given contractId and oracle signature, does not broadcast it

    Definition Classes
    DLCWalletApi
  14. def executeDLC(contractId: ByteVector, oracleSig: OracleAttestmentTLV): Future[Option[Transaction]]

    Creates the CET for the given contractId and oracle signature, does not broadcast it

    Creates the CET for the given contractId and oracle signature, does not broadcast it

    Definition Classes
    DLCWalletApi
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. def findByOutPoint(outPoint: TransactionOutPoint)(implicit ec: ExecutionContext): Future[Option[SpendingInfoDb]]
    Definition Classes
    WalletApi
  17. def findByTxId(txId: DoubleSha256Digest)(implicit ec: ExecutionContext): Future[Option[TransactionDb]]
    Definition Classes
    WalletApi
  18. def findByTxId(txId: DoubleSha256DigestBE)(implicit ec: ExecutionContext): Future[Option[TransactionDb]]
    Definition Classes
    WalletApi
  19. def fullRescanNeutrinoWallet(addressBatchSize: Int, force: Boolean = false)(implicit ec: ExecutionContext): Future[RescanState]

    Helper method to rescan the ENTIRE blockchain.

    Helper method to rescan the ENTIRE blockchain.

    Definition Classes
    NeutrinoWalletApi
  20. def getAddress(chainType: HDChainType, addressIndex: Int)(implicit ec: ExecutionContext): Future[AddressDb]

    Gets the address associated with the pubkey at the resulting BIP32Path determined by the default account and the given chainType and addressIndex

    Gets the address associated with the pubkey at the resulting BIP32Path determined by the default account and the given chainType and addressIndex

    Definition Classes
    HDWalletApi
  21. def getAddressInfo(spendingInfoDb: SpendingInfoDb, networkParameters: NetworkParameters): Future[Option[AddressInfo]]
    Definition Classes
    WalletApi
  22. def getBalance(account: HDAccount)(implicit ec: ExecutionContext): Future[CurrencyUnit]

    Gets the balance of the given account

    Gets the balance of the given account

    Definition Classes
    HDWalletApi
  23. def getBalance(tag: AddressTag)(implicit ec: ExecutionContext): Future[CurrencyUnit]

    Gets the sum of all UTXOs in this wallet with the address tag

    Gets the sum of all UTXOs in this wallet with the address tag

    Definition Classes
    WalletApi
  24. def getBalance()(implicit ec: ExecutionContext): Future[CurrencyUnit]

    Gets the sum of all UTXOs in this wallet

    Gets the sum of all UTXOs in this wallet

    Definition Classes
    WalletApi
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def getFeeRate(): Future[FeeUnit]
    Definition Classes
    WalletApi
  27. def getNewChangeAddress()(implicit ec: ExecutionContext): Future[BitcoinAddress]

    Generates a new change address

    Generates a new change address

    Definition Classes
    HDWalletApi → WalletApi
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def listAccounts(purpose: HDPurpose)(implicit ec: ExecutionContext): Future[Vector[AccountDb]]

    Lists all wallet accounts with the given type

    Lists all wallet accounts with the given type

    returns

    Future[Vector[AccountDb

    Definition Classes
    HDWalletApi
  31. def makeOpReturnCommitment(message: String, hashMessage: Boolean, feeRate: FeeUnit)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi → WalletApi
  32. def makeOpReturnCommitment(message: String, hashMessage: Boolean, feeRateOpt: Option[FeeUnit], fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  33. def makeOpReturnCommitment(message: String, hashMessage: Boolean, feeRateOpt: Option[FeeUnit])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    WalletApi
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. def processCompactFilter(blockHash: DoubleSha256DigestBE, blockFilter: GolombFilter): Future[NeutrinoHDWalletApi]
    Definition Classes
    NeutrinoWalletApi
  38. def processTransactions(transactions: Vector[Transaction], blockHashOpt: Option[DoubleSha256DigestBE])(implicit ec: ExecutionContext): Future[WalletApi]
    Definition Classes
    WalletApi
  39. def sendFromOutPoints(outPoints: Vector[TransactionOutPoint], address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  40. def sendFromOutPoints(outPoints: Vector[TransactionOutPoint], address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi → WalletApi
  41. def sendFromOutPoints(outPoints: Vector[TransactionOutPoint], address: BitcoinAddress, amount: CurrencyUnit, feeRateOpt: Option[FeeUnit])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi → WalletApi
  42. def sendFromOutPoints(outPoints: Vector[TransactionOutPoint], address: BitcoinAddress, amount: CurrencyUnit, feeRateOpt: Option[FeeUnit], fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  43. def sendFromOutPoints(outPoints: Vector[TransactionOutPoint], address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  44. def sendFromOutPoints(outPoints: Vector[TransactionOutPoint], address: BitcoinAddress, feeRateOpt: Option[FeeUnit])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    WalletApi
  45. def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  46. def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit)(implicit ec: ExecutionContext): Future[Transaction]

    Sends money to the address

    Sends money to the address

    todo: add error handling to signature

    Definition Classes
    HDWalletApi → WalletApi
  47. def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, feeRateOpt: Option[FeeUnit])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi → WalletApi
  48. def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, feeRateOpt: Option[FeeUnit], fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  49. def sendToAddress(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  50. def sendToAddresses(addresses: Vector[BitcoinAddress], amounts: Vector[CurrencyUnit], feeRate: FeeUnit, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  51. def sendToAddresses(addresses: Vector[BitcoinAddress], amounts: Vector[CurrencyUnit], feeRate: FeeUnit)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi → WalletApi
  52. def sendToAddresses(addresses: Vector[BitcoinAddress], amounts: Vector[CurrencyUnit], feeRateOpt: Option[FeeUnit])(implicit ec: ExecutionContext): Future[Transaction]

    Sends funds to each address

    Sends funds to each address

    Definition Classes
    HDWalletApi → WalletApi
  53. def sendToAddresses(addresses: Vector[BitcoinAddress], amounts: Vector[CurrencyUnit], feeRateOpt: Option[FeeUnit], fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  54. def sendToAddresses(addresses: Vector[BitcoinAddress], amounts: Vector[CurrencyUnit], feeRate: FeeUnit, fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  55. def sendToOutputs(outputs: Vector[TransactionOutput], feeRate: FeeUnit)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi → WalletApi
  56. def sendToOutputs(outputs: Vector[TransactionOutput], feeRateOpt: Option[FeeUnit])(implicit ec: ExecutionContext): Future[Transaction]

    Sends funds using the specified outputs

    Sends funds using the specified outputs

    todo: add error handling to signature

    Definition Classes
    HDWalletApi → WalletApi
  57. def sendToOutputs(outputs: Vector[TransactionOutput], feeRate: FeeUnit, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  58. def sendToOutputs(outputs: Vector[TransactionOutput], feeRateOpt: Option[FeeUnit], fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  59. def sendToOutputs(outputs: Vector[TransactionOutput], feeRate: FeeUnit, fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  60. def sendWithAlgo(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, algo: CoinSelectionAlgo, newTags: Vector[AddressTag])(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  61. def sendWithAlgo(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, algo: CoinSelectionAlgo)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi → WalletApi
  62. def sendWithAlgo(address: BitcoinAddress, amount: CurrencyUnit, feeRateOpt: Option[FeeUnit], algo: CoinSelectionAlgo)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi → WalletApi
  63. def sendWithAlgo(address: BitcoinAddress, amount: CurrencyUnit, feeRateOpt: Option[FeeUnit], algo: CoinSelectionAlgo, fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  64. def sendWithAlgo(address: BitcoinAddress, amount: CurrencyUnit, feeRate: FeeUnit, algo: CoinSelectionAlgo, fromAccount: AccountDb)(implicit ec: ExecutionContext): Future[Transaction]
    Definition Classes
    HDWalletApi
  65. def sweepWallet(address: BitcoinAddress, feeRateOpt: Option[FeeUnit])(implicit ec: ExecutionContext): Future[Transaction]

    Sends the entire wallet balance to the given address

    Sends the entire wallet balance to the given address

    Definition Classes
    WalletApi
  66. def sweepWallet(address: BitcoinAddress)(implicit ec: ExecutionContext): Future[Transaction]

    Sends the entire wallet balance to the given address

    Sends the entire wallet balance to the given address

    Definition Classes
    WalletApi
  67. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  68. def toString(): String
    Definition Classes
    AnyRef → Any
  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  71. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from DLCWalletApi

Inherited from NeutrinoHDWalletApi

Inherited from NeutrinoWalletApi

Inherited from HDWalletApi

Inherited from WalletApi

Inherited from StartStopAsync[WalletApi]

Inherited from StartStop[Future[WalletApi]]

Inherited from AnyRef

Inherited from Any

Ungrouped