Packages

p

org.bitcoins.rpc

jsonmodels

package jsonmodels

Type Members

  1. case class AddressInfoResult(address: BitcoinAddress, scriptPubKey: ScriptPubKey, ismine: Boolean, iswatchonly: Boolean, isscript: Boolean, iswitness: Boolean, iscompressed: Option[Boolean], witness_version: Option[WitnessVersion], witness_program: Option[String], script: Option[ScriptType], hex: Option[ScriptPubKey], pubkeys: Option[Vector[ECPublicKey]], sigsrequired: Option[Int], pubkey: Option[ECPublicKey], embedded: Option[EmbeddedResult], label: String, timestamp: Option[LocalDateTime], hdkeypath: Option[BIP32Path], hdseedid: Option[RipeMd160Digest], hdmasterkeyid: Option[RipeMd160Digest], labels: Vector[LabelResult]) extends WalletResult with Product with Serializable
  2. final case class AnalyzePsbtInput(has_utxo: Boolean, is_final: Boolean, missing: Option[PsbtMissingData], next: Option[String]) extends RpcPsbtResult with Product with Serializable
  3. final case class AnalyzePsbtResult(inputs: Vector[AnalyzePsbtInput], estimated_vsize: Option[Double], estimated_feerate: Option[Double], fee: Option[Bitcoins], next: String) extends RpcPsbtResult with Product with Serializable
  4. final case class ArrayOfWalletsInput(name: String) extends WalletResult with Product with Serializable
  5. case class Bip9Softfork(status: String, bit: Option[Int], startTime: Int, timeout: BigInt, since: Int) extends BlockchainResult with Product with Serializable
  6. case class BlockTransaction(data: Transaction, txid: DoubleSha256Digest, hash: DoubleSha256Digest, depends: Vector[Int], fee: Satoshis, sigops: Int, weight: Int, required: Option[Boolean]) extends OtherResult with Product with Serializable
  7. sealed abstract class BlockchainResult extends AnyRef
  8. case class BumpFeeResult(txid: DoubleSha256DigestBE, origfee: Bitcoins, fee: Bitcoins, errors: Vector[String]) extends WalletResult with Product with Serializable
  9. case class ChainTip(height: Int, hash: DoubleSha256DigestBE, branchlen: Int, status: String) extends BlockchainResult with Product with Serializable
  10. final case class CreateWalletResult(name: String, warning: String) extends WalletResult with Product with Serializable
  11. final case class DecodePsbtResult(tx: RpcTransaction, unknown: Map[String, String], inputs: Vector[RpcPsbtInput], outputs: Vector[RpcPsbtOutput], fee: Option[Bitcoins]) extends RpcPsbtResult with Product with Serializable
  12. case class DecodeScriptResult(asm: String, typeOfScript: Option[ScriptType], reqSigs: Option[Int], addresses: Option[Vector[P2PKHAddress]], p2sh: P2SHAddress) extends RawTransactionResult with Product with Serializable
  13. final case class DeriveAddressesResult(addresses: Vector[BitcoinAddress]) extends OtherResult with Product with Serializable
  14. case class DumpWalletResult(filename: File) extends Product with Serializable
  15. case class EmbeddedResult(isscript: Boolean, iswitness: Boolean, witness_version: WitnessVersion, witness_program: Option[String], pubkey: ECPublicKey, address: BitcoinAddress, scriptPubKey: ScriptPubKey) extends WalletResult with Product with Serializable
  16. case class EstimateSmartFeeResult(feerate: Option[BitcoinFeeUnit], errors: Option[Vector[String]], blocks: Int) extends OtherResult with Product with Serializable
  17. sealed abstract class FinalizePsbtResult extends RpcPsbtResult
  18. final case class FinalizedPsbt(hex: Transaction) extends FinalizePsbtResult with Product with Serializable
  19. case class FundRawTransactionResult(hex: Transaction, fee: Bitcoins, changepos: Int) extends RawTransactionResult with Product with Serializable
  20. case class GetBlockChainInfoResult(chain: NetworkParameters, blocks: Int, headers: Int, bestblockhash: DoubleSha256DigestBE, difficulty: BigDecimal, mediantime: Int, verificationprogress: BigDecimal, initialblockdownload: Boolean, chainwork: String, size_on_disk: Long, pruned: Boolean, pruneheight: Option[Int], softforks: Vector[Softfork], bip9_softforks: Map[String, Bip9Softfork], warnings: String) extends BlockchainResult with Product with Serializable
  21. case class GetBlockHeaderResult(hash: DoubleSha256DigestBE, confirmations: Int, height: Int, version: Int, versionHex: Int32, merkleroot: DoubleSha256DigestBE, time: UInt32, mediantime: UInt32, nonce: UInt32, bits: UInt32, difficulty: BigDecimal, chainwork: String, previousblockhash: Option[DoubleSha256DigestBE], nextblockhash: Option[DoubleSha256DigestBE]) extends BlockchainResult with Product with Serializable
  22. case class GetBlockResult(hash: DoubleSha256DigestBE, confirmations: Int, strippedsize: Int, size: Int, weight: Int, height: Int, version: Int, versionHex: Int32, merkleroot: DoubleSha256DigestBE, tx: Vector[DoubleSha256DigestBE], time: UInt32, mediantime: UInt32, nonce: UInt32, bits: UInt32, difficulty: BigDecimal, chainwork: String, previousblockhash: Option[DoubleSha256DigestBE], nextblockhash: Option[DoubleSha256DigestBE]) extends BlockchainResult with Product with Serializable
  23. case class GetBlockTemplateResult(capabilities: Vector[String], version: Int, rules: Vector[String], vbavailable: Map[String, Int], vbrequired: Int, previousblockhash: DoubleSha256Digest, transactions: Vector[BlockTransaction], coinbaseaux: Map[String, String], coinbasevalue: Satoshis, longpollid: String, coinbasetxn: Option[JsObject], target: String, mintime: UInt32, mutable: Vector[String], noncerange: String, sigoplimit: Int, sizelimit: Int, weightlimit: Int, curtime: UInt32, bits: String, height: Int) extends OtherResult with Product with Serializable
  24. case class GetBlockWithTransactionsResult(hash: DoubleSha256DigestBE, confirmations: Int, strippedsize: Int, size: Int, weight: Int, height: Int, version: Int, versionHex: Int32, merkleroot: DoubleSha256DigestBE, tx: Vector[RpcTransaction], time: UInt32, mediantime: UInt32, nonce: UInt32, bits: UInt32, difficulty: BigDecimal, chainwork: String, previousblockhash: Option[DoubleSha256DigestBE], nextblockhash: Option[DoubleSha256DigestBE]) extends BlockchainResult with Product with Serializable
  25. case class GetChainTxStatsResult(time: UInt32, txcount: Int, window_block_count: Int, window_tx_count: Option[Int], window_interval: Option[UInt32], txrate: Option[BigDecimal]) extends BlockchainResult with Product with Serializable
  26. final case class GetDescriptorInfoResult(descriptor: String, isrange: Boolean, issolvable: Boolean, hasprivatekeys: Boolean) extends OtherResult with Product with Serializable
  27. case class GetMemPoolEntryResult(size: Int, fee: Bitcoins, modifiedfee: Bitcoins, time: UInt32, height: Int, descendantcount: Int, descendantsize: Int, descendantfees: Bitcoins, ancestorcount: Int, ancestorsize: Int, ancestorfees: Bitcoins, depends: Option[Vector[DoubleSha256DigestBE]]) extends BlockchainResult with Product with Serializable
  28. case class GetMemPoolInfoResult(size: Int, bytes: Int, usage: Int, maxmempool: Int, mempoolminfee: BitcoinFeeUnit, minrelaytxfee: Bitcoins) extends BlockchainResult with Product with Serializable
  29. case class GetMemPoolResult(size: Int, fee: Option[Bitcoins], modifiedfee: Option[Bitcoins], time: UInt32, height: Int, descendantcount: Int, descendantsize: Int, descendantfees: Option[Bitcoins], ancestorcount: Int, ancestorsize: Int, ancestorfees: Option[Bitcoins], wtxid: DoubleSha256DigestBE, depends: Vector[DoubleSha256DigestBE]) extends BlockchainResult with Product with Serializable
  30. case class GetMemoryInfoResult(locked: MemoryManager) extends OtherResult with Product with Serializable
  31. case class GetMiningInfoResult(blocks: Int, currentblockweight: Option[Int], currentblocktx: Option[Int], difficulty: BigDecimal, networkhashps: BigDecimal, pooledtx: Int, chain: String, warnings: String) extends OtherResult with Product with Serializable
  32. case class GetNetTotalsResult(totalbytesrecv: Int, totalbytessent: Int, timemillis: UInt64, uploadtarget: NetTarget) extends NetworkResult with Product with Serializable
  33. case class GetNetworkInfoResult(version: Int, subversion: String, protocolversion: Int, localservices: String, localrelay: Boolean, timeoffset: Int, networkactive: Boolean, connections: Int, networks: Vector[Network], relayfee: Bitcoins, incrementalfee: Bitcoins, localadresses: Option[Vector[NetworkAddress]], warnings: String) extends NetworkResult with Product with Serializable
  34. final case class GetNodeAddressesResult(time: FiniteDuration, services: Int, address: URI, port: Int) extends NetworkResult with Product with Serializable
  35. case class GetRawTransactionResult(in_active_blockchain: Option[Boolean], hex: Transaction, txid: DoubleSha256DigestBE, hash: DoubleSha256DigestBE, size: Int, vsize: Int, version: Int, locktime: UInt32, vin: Vector[GetRawTransactionVin], vout: Vector[RpcTransactionOutput], blockhash: Option[DoubleSha256DigestBE], confirmations: Option[Int], time: Option[UInt32], blocktime: Option[UInt32]) extends RawTransactionResult with Product with Serializable
  36. case class GetRawTransactionScriptSig(asm: String, hex: ScriptSignature) extends RawTransactionResult with Product with Serializable
  37. case class GetRawTransactionVin(txid: Option[DoubleSha256DigestBE], vout: Option[Int], scriptSig: Option[GetRawTransactionScriptSig], sequence: Option[BigDecimal], txinwitness: Option[Vector[String]]) extends RawTransactionResult with Product with Serializable
  38. final case class GetRpcInfoResult(active_commands: Vector[RpcCommands]) extends RawTransactionResult with Product with Serializable
  39. case class GetTransactionResult(amount: Bitcoins, fee: Option[Bitcoins], confirmations: Int, generated: Option[Boolean], blockhash: Option[DoubleSha256DigestBE], blockindex: Option[Int], blocktime: Option[UInt32], txid: DoubleSha256DigestBE, walletconflicts: Vector[DoubleSha256DigestBE], time: UInt32, timereceived: UInt32, bip125_replaceable: String, comment: Option[String], to: Option[String], details: Vector[TransactionDetails], hex: Transaction) extends WalletResult with Product with Serializable
  40. case class GetTxOutResult(bestblock: DoubleSha256DigestBE, confirmations: Int, value: Bitcoins, scriptPubKey: RpcScriptPubKey, coinbase: Boolean) extends BlockchainResult with Product with Serializable
  41. case class GetTxOutSetInfoResult(height: Int, bestblock: DoubleSha256DigestBE, transactions: Int, txouts: Int, bogosize: Int, hash_serialized_2: DoubleSha256DigestBE, disk_size: Int, total_amount: Bitcoins) extends BlockchainResult with Product with Serializable
  42. case class GetWalletInfoResult(walletname: String, walletversion: Int, balance: Bitcoins, unconfirmed_balance: Bitcoins, immature_balance: Bitcoins, txcount: Int, keypoololdest: UInt32, keypoolsize: Int, keypoolsize_hd_internal: Int, paytxfee: BitcoinFeeUnit, hdmasterkeyid: Option[Sha256Hash160Digest], unlocked_until: Option[Int]) extends WalletResult with Product with Serializable
  43. case class ImportMultiError(code: Int, message: String) extends WalletResult with Product with Serializable
  44. case class ImportMultiResult(success: Boolean, error: Option[ImportMultiError]) extends WalletResult with Product with Serializable
  45. case class LabelResult(name: String, purpose: LabelPurpose) extends WalletResult with Product with Serializable
  46. case class ListSinceBlockResult(transactions: Vector[Payment], lastblock: DoubleSha256DigestBE) extends WalletResult with Product with Serializable
  47. case class ListTransactionsResult(account: Option[String], address: Option[BitcoinAddress], category: String, amount: Bitcoins, label: Option[String], vout: Option[Int], fee: Option[Bitcoins], confirmations: Option[Int], trusted: Option[Boolean], generated: Option[Boolean], blockhash: Option[DoubleSha256DigestBE], blockindex: Option[Int], blocktime: Option[UInt32], txid: Option[DoubleSha256DigestBE], walletconflicts: Option[Vector[DoubleSha256DigestBE]], time: UInt32, timereceived: Option[UInt32], comment: Option[String], to: Option[String], otheraccount: Option[String], bip125_replaceable: String, abandoned: Option[Boolean]) extends WalletResult with Product with Serializable
  48. final case class ListWalletDirResult(wallets: Vector[ArrayOfWalletsInput]) extends WalletResult with Product with Serializable
  49. case class MemoryManager(used: Int, free: Int, total: Int, locked: Int, chunks_used: Int, chunks_free: Int) extends OtherResult with Product with Serializable
  50. case class MultiSigResult(address: BitcoinAddress, redeemScript: ScriptPubKey) extends WalletResult with Product with Serializable
  51. case class NetTarget(timeframe: UInt32, target: Int, target_reached: Boolean, serve_historical_blocks: Boolean, bytes_left_in_cycle: Int, time_left_in_cycle: UInt32) extends NetworkResult with Product with Serializable
  52. case class Network(name: String, limited: Boolean, reachable: Boolean, proxy: String, proxy_randomize_credentials: Boolean) extends NetworkResult with Product with Serializable
  53. case class NetworkAddress(address: String, port: Int, score: Int) extends NetworkResult with Product with Serializable
  54. sealed abstract class NetworkResult extends AnyRef
  55. case class Node(addednode: URI, connected: Option[Boolean], addresses: Option[Vector[NodeAddress]]) extends NetworkResult with Product with Serializable
  56. case class NodeAddress(address: URI, connected: String) extends NetworkResult with Product with Serializable
  57. case class NodeBan(address: URI, banned_until: UInt32, ban_created: UInt32, ban_reason: String) extends NetworkResult with Product with Serializable
  58. final case class NonFinalizedPsbt(psbt: String) extends FinalizePsbtResult with Product with Serializable
  59. sealed abstract class OtherResult extends AnyRef
  60. case class Payment(involvesWatchonly: Option[Boolean], account: Option[String], address: Option[BitcoinAddress], category: String, amount: Bitcoins, vout: Int, fee: Option[Bitcoins], confirmations: Int, generated: Option[Boolean], blockhash: Option[DoubleSha256DigestBE], blockindex: Option[Int], blocktime: Option[UInt32], txid: DoubleSha256DigestBE, walletconflicts: Vector[DoubleSha256DigestBE], time: UInt32, timereceived: UInt32, bip125_replaceable: String, comment: Option[String], to: Option[String]) extends WalletResult with Product with Serializable
  61. case class Peer(id: Int, networkInfo: PeerNetworkInfo, version: Int, subver: String, inbound: Boolean, addnode: Boolean, startingheight: Int, banscore: Int, synced_headers: Int, synced_blocks: Int, inflight: Vector[Int], whitelisted: Boolean, bytessent_per_msg: Map[String, Int], bytesrecv_per_msg: Map[String, Int], minfeefilter: Option[SatoshisPerKiloByte]) extends NetworkResult with Product with Serializable
  62. case class PeerNetworkInfo(addr: URI, addrbind: URI, addrlocal: Option[URI], services: String, relaytxes: Boolean, lastsend: UInt32, lastrecv: UInt32, bytessent: Int, bytesrecv: Int, conntime: UInt32, timeoffset: Int, pingtime: Option[BigDecimal], minping: Option[BigDecimal], pingwait: Option[BigDecimal]) extends NetworkResult with Product with Serializable
  63. final case class PsbtBIP32Deriv(pubkey: ECPublicKey, masterFingerprint: String, path: String) extends RpcPsbtResult with Product with Serializable
  64. final case class PsbtMissingData(pubkeys: Option[Vector[ECPublicKey]], signatures: Option[Vector[ECDigitalSignature]], redeemscript: Option[RpcPsbtScript], witnessscript: Option[RpcPsbtScript]) extends RpcPsbtResult with Product with Serializable
  65. final case class PsbtWitnessUtxoInput(amount: Bitcoins, scriptPubKey: RpcPsbtScript) extends RpcPsbtResult with Product with Serializable
  66. sealed abstract class RawTransactionResult extends AnyRef
  67. case class ReceivedAccount(involvesWatchonly: Option[Boolean], account: String, amount: Bitcoins, confirmations: Int, lable: Option[String]) extends WalletResult with Product with Serializable
  68. case class ReceivedAddress(involvesWatchonly: Option[Boolean], address: BitcoinAddress, account: String, amount: Bitcoins, confirmations: Int, label: String, txids: Vector[DoubleSha256DigestBE]) extends WalletResult with Product with Serializable
  69. case class ReceivedLabel(involvesWatchonly: Option[Boolean], amount: Bitcoins, confirmations: Int, label: String) extends WalletResult with Product with Serializable
  70. case class RescanBlockChainResult(start_height: Int, stop_height: Int) extends WalletResult with Product with Serializable
  71. case class RpcAccount(involvesWatchonly: Boolean, account: String, amount: Bitcoins, confirmations: Int) extends WalletResult with Product with Serializable
  72. case class RpcAddress(address: BitcoinAddress, balance: Bitcoins, account: Option[String]) extends WalletResult with Product with Serializable
  73. final case class RpcCommands(method: String, duration: FiniteDuration) extends RawTransactionResult with Product with Serializable
  74. final case class RpcPsbtInput(nonWitnessUtxo: Option[RpcTransaction], witnessUtxo: Option[PsbtWitnessUtxoInput], partialSignatures: Option[Map[ECPublicKey, ECDigitalSignature]], sighash: Option[HashType], redeemScript: Option[RpcPsbtScript], witnessScript: Option[RpcPsbtScript], bip32Derivs: Option[Vector[PsbtBIP32Deriv]], finalScriptSig: Option[RpcPsbtScript], finalScriptwitness: Option[Vector[String]], unknown: Option[Map[String, String]]) extends RpcPsbtResult with Product with Serializable
  75. final case class RpcPsbtOutput(redeemScript: Option[RpcPsbtScript], witnessScript: Option[RpcPsbtScript], bip32Derivs: Option[Vector[PsbtBIP32Deriv]], unknown: Option[Map[String, String]]) extends RpcPsbtResult with Product with Serializable
  76. sealed abstract class RpcPsbtResult extends AnyRef
  77. final case class RpcPsbtScript(asm: String, hex: ScriptPubKey, scriptType: Option[ScriptType], address: Option[BitcoinAddress]) extends RpcPsbtResult with Product with Serializable
  78. case class RpcScriptPubKey(asm: String, hex: String, reqSigs: Option[Int], scriptType: ScriptType, addresses: Option[Vector[BitcoinAddress]]) extends RawTransactionResult with Product with Serializable
  79. case class RpcTransaction(txid: DoubleSha256DigestBE, hash: DoubleSha256DigestBE, version: Int, size: Int, vsize: Int, locktime: UInt32, vin: Vector[TransactionInput], vout: Vector[RpcTransactionOutput], hex: Option[Transaction]) extends RawTransactionResult with Product with Serializable
  80. case class RpcTransactionOutput(value: Bitcoins, n: Int, scriptPubKey: RpcScriptPubKey) extends RawTransactionResult with Product with Serializable
  81. case class SignRawTransactionError(txid: DoubleSha256DigestBE, vout: Int, scriptSig: ScriptPubKey, sequence: UInt32, error: String) extends RawTransactionResult with Product with Serializable
  82. case class SignRawTransactionResult(hex: Transaction, complete: Boolean, errors: Option[Vector[SignRawTransactionError]]) extends RawTransactionResult with Product with Serializable
  83. case class Softfork(id: String, version: Int, enforce: Option[Map[String, SoftforkProgress]], reject: SoftforkProgress) extends BlockchainResult with Product with Serializable
  84. case class SoftforkProgress(status: Option[Boolean], found: Option[Int], required: Option[Int], window: Option[Int]) extends BlockchainResult with Product with Serializable
  85. final case class SubmitHeaderResult(header: BlockHeader) extends OtherResult with Product with Serializable
  86. case class TestMempoolAcceptResult(txid: DoubleSha256DigestBE, allowed: Boolean, rejectReason: Option[String]) extends Product with Serializable
  87. case class TransactionDetails(involvesWatchonly: Option[Boolean], account: Option[String], address: Option[BitcoinAddress], category: String, amount: Bitcoins, vout: Int, fee: Option[Bitcoins], abandoned: Option[Boolean]) extends WalletResult with Product with Serializable
  88. case class UnspentOutput(txid: DoubleSha256DigestBE, vout: Int, address: Option[BitcoinAddress], account: Option[String], scriptPubKey: Option[ScriptPubKey], reedemScript: Option[ScriptPubKey], amount: Bitcoins, confirmations: Int, spendable: Boolean, solvable: Boolean) extends WalletResult with Product with Serializable
  89. trait ValidateAddressResult extends AnyRef

    Note

    This is defined as a trait and not just a raw case class (as is done in other RPC return values) in order to make it possible to deprecate fields.

  90. case class ValidateAddressResultImpl(isvalid: Boolean, address: Option[BitcoinAddress], scriptPubKey: Option[ScriptPubKey], ismine: Option[Boolean], iswatchonly: Option[Boolean], isscript: Option[Boolean], script: Option[String], hex: Option[String], sigsrequired: Option[Int], pubkey: Option[ECPublicKey], iscompressed: Option[Boolean], account: Option[String], hdkeypath: Option[String], hdmasterkeyid: Option[Sha256Hash160Digest], ischange: Option[Boolean], solvable: Option[Boolean], desc: Option[String]) extends ValidateAddressResult with Product with Serializable
  91. final case class WalletCreateFundedPsbtResult(psbt: String, fee: Bitcoins, changepos: Int) extends RpcPsbtResult with Product with Serializable
  92. final case class WalletProcessPsbtResult(psbt: String, complete: Boolean) extends RpcPsbtResult with Product with Serializable
  93. sealed abstract class WalletResult extends AnyRef

Ungrouped