clementine_core::extended_rpc

Struct ExtendedRpc

Source 
pub struct ExtendedRpc {
    pub url: String,
    pub client: Arc<Client>,
}
Expand description

Bitcoin RPC wrapper. Extended RPC provides useful wrapper functions for common operations, as well as direct access to Bitcoin RPC. Bitcoin RPC can be directly accessed via client member.

Fields§

§url: String§client: Arc<Client>

Implementations§

Source§

impl ExtendedRpc

Source

pub async fn connect( url: String, user: SecretString, password: SecretString, ) -> Result<Self, BitcoinRPCError>

Connects to Bitcoin RPC and returns a new ExtendedRpc.

Source

pub async fn confirmation_blocks( &self, txid: &Txid, ) -> Result<u32, BitcoinRPCError>

Returns the number of confirmations for a transaction.

§Parameters
  • txid: TXID of the transaction to check.
§Returns
  • u32: The number of confirmations for the transaction.
§Errors
  • BitcoinRPCError: If the transaction is not confirmed (0) or if there was an error retrieving the transaction info.
Source

pub async fn get_current_chain_height(&self) -> Result<u32, BitcoinRPCError>

Retrieves the current blockchain height (number of blocks).

§Returns
  • u32: Current block height
Source

pub async fn collateral_check( &self, operator_data: &OperatorData, kickoff_wpks: &KickoffWinternitzKeys, paramset: &'static ProtocolParamset, ) -> Result<bool, BridgeError>

Checks if an operator’s collateral is valid and available for use.

This function validates the operator’s collateral by:

  1. Verifying the collateral UTXO exists and has the correct amount
  2. Creating the round transaction chain to track current collateral position
  3. Determining if the current collateral UTXO in the chain is spent in a non-protocol tx, signaling the exit of operator from the protocol
§Parameters
  • operator_data: Data about the operator including collateral funding outpoint
  • kickoff_wpks: Kickoff Winternitz public keys for round transaction creation
  • paramset: Protocol parameters
§Returns
  • bool: true if the collateral is still usable, thus operator is still in protocol, false if the collateral is spent, thus operator is not in protocol anymore
§Errors
  • BridgeError: If there was an error retrieving transaction data, creating round transactions, or checking UTXO status
Source

pub async fn get_blockhash_of_tx( &self, txid: &Txid, ) -> Result<BlockHash, BitcoinRPCError>

Returns block hash of a transaction, if confirmed.

§Parameters
  • txid: TXID of the transaction to check.
§Returns
  • [bitcoin::BlockHash]: Block hash of the block that the transaction is in.
§Errors
  • BitcoinRPCError: If the transaction is not confirmed (0) or if there was an error retrieving the transaction info.
Source

pub async fn get_block_info_by_height( &self, height: u64, ) -> Result<(BlockHash, Header), BitcoinRPCError>

Retrieves the block header and hash for a given block height.

§Arguments
  • height: Target block height.
§Returns
  • ([bitcoin::BlockHash], [bitcoin::block::Header]): A tuple containing the block hash and header.
Source

pub async fn get_prevout_txs( &self, tx: &Transaction, ) -> Result<Vec<Transaction>, BitcoinRPCError>

Gets the transactions that created the inputs of a given transaction.

§Arguments
  • tx - The transaction to get the previous transactions for
§Returns

A vector of transactions that created the inputs of the given transaction.

Source

pub async fn get_tx_of_txid( &self, txid: &Txid, ) -> Result<Transaction, BitcoinRPCError>

Gets the transaction data for a given transaction ID.

§Parameters
  • txid: TXID of the transaction to check.
§Returns
  • [bitcoin::Transaction]: Transaction itself.
Source

pub async fn is_tx_on_chain(&self, txid: &Txid) -> Result<bool, BitcoinRPCError>

Checks if a transaction is on-chain.

§Parameters
  • txid: TXID of the transaction to check.
§Returns
  • bool: true if the transaction is on-chain, false otherwise.
Source

pub async fn check_utxo_address_and_amount( &self, outpoint: &OutPoint, address: &ScriptBuf, amount_sats: Amount, ) -> Result<bool, BitcoinRPCError>

Checks if a transaction UTXO has expected address and amount.

§Parameters
  • outpoint - The outpoint to check
  • address - Expected script pubkey
  • amount_sats - Expected amount in satoshis
§Returns
  • bool: true if the UTXO has the expected address and amount, false otherwise.
Source

pub async fn is_utxo_spent( &self, outpoint: &OutPoint, ) -> Result<bool, BitcoinRPCError>

Checks if an UTXO is spent.

§Parameters
  • outpoint: The outpoint to check
§Returns
  • bool: true if the UTXO is spent, false otherwise.
§Errors
  • BitcoinRPCError: If the transaction is not confirmed or if there was an error retrieving the transaction output.
Source

pub async fn mempool_size(&self) -> Result<usize, BitcoinRPCError>

Gets the number of transactions in the mempool.

§Returns
  • usize: The number of transactions in the mempool.
Source

pub async fn send_to_address( &self, address: &Address, amount_sats: Amount, ) -> Result<OutPoint, BitcoinRPCError>

Sends a specified amount of Bitcoins to the given address.

§Parameters
  • address - The recipient address
  • amount_sats - The amount to send in satoshis
§Returns
  • [OutPoint]: The outpoint (txid and vout) of the newly created output.
Source

pub async fn get_txout_from_outpoint( &self, outpoint: &OutPoint, ) -> Result<TxOut, BitcoinRPCError>

Retrieves the transaction output for a given outpoint.

§Arguments
  • outpoint - The outpoint (txid and vout) to retrieve
§Returns
  • [TxOut]: The transaction output at the specified outpoint.
Source

pub async fn bump_fee_with_fee_rate( &self, txid: Txid, fee_rate: FeeRate, ) -> Result<Txid, BitcoinRPCError>

Bumps the fee of a transaction to meet or exceed a target fee rate. Does nothing if the transaction is already confirmed. Returns the original txid if no bump was needed.

This function implements Replace-By-Fee (RBF) to increase the fee of an unconfirmed transaction. It works as follows:

  1. If the transaction is already confirmed, returns Err(TransactionAlreadyInBlock)
  2. If the current fee rate is already >= the requested fee rate, returns the original txid
  3. Otherwise, increases the fee rate by adding the node’s incremental fee to the current fee rate, then bump_fees the transaction

Note: This function currently only supports fee payer TXs.

§Arguments
  • txid - The transaction ID to bump
  • fee_rate - The target fee rate to achieve
§Returns
  • [Txid]: The txid of the bumped transaction (which may be the same as the input txid if no bump was needed).
§Errors
  • TransactionAlreadyInBlock - If the transaction is already confirmed
  • BumpFeeUTXOSpent - If the UTXO being spent by the transaction is already spent
  • BumpFeeError - For other errors with fee bumping
Source

pub async fn clone_inner(&self) -> Result<Self, Error>

Creates a new instance of the ExtendedRpc with a new client connection for cloning. This is needed when you need a separate connection to the Bitcoin RPC server.

§Returns
  • ExtendedRpc: A new instance of ExtendedRpc with a new client connection.

Trait Implementations§

Source§

impl Clone for ExtendedRpc

Source§

fn clone(&self) -> ExtendedRpc

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ExtendedRpc

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T, U> ExactFrom<T> for U
where U: TryFrom<T>,

§

fn exact_from(value: T) -> U

§

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

§

fn exact_into(self) -> U

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

§

fn overflowing_into(self) -> (U, bool)

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

§

fn rounding_into(self, rm: RoundingMode) -> (U, Ordering)

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

§

fn saturating_into(self) -> U

§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> ToDebugString for T
where T: Debug,

§

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples
use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryClone for T
where T: Clone,

§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

§

fn wrapping_into(self) -> U

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,