Skip to content

Rename Tx to EsploraTx and add conversions #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oleonardolima merged 2 commits into from
May 1, 2026
Merged

Rename Tx to EsploraTx and add conversions #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b450d09
refactor(api)!: rename `Tx` to `EsploraTx` and add conversions
luisschwab Apr 30, 2026
d03a68b
refactor(api): remove `EsploraTx::fee`
luisschwab Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions src/api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ pub struct BlockStatus {

/// A [`Transaction`] in the format returned by Esplora.
#[derive(Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct Tx {
pub struct EsploraTx {
/// The [`Txid`] of the [`Transaction`].
pub txid: Txid,
/// The version number of the [`Transaction`].
Expand Down Expand Up @@ -358,9 +358,8 @@ pub struct MempoolFeesSubmitPackage {
pub effective_includes: Option<Vec<Wtxid>>,
}

impl Tx {
/// Convert a transaction from the format returned by Esplora into a `rust-bitcoin`
/// [`Transaction`].
impl EsploraTx {
/// Convert a transaction from the format returned by Esplora into a [`Transaction`].
pub fn to_tx(&self) -> Transaction {
Transaction {
version: transaction::Version::non_standard(self.version),
Expand Down Expand Up @@ -391,7 +390,7 @@ impl Tx {
}
}

/// Get the confirmation time from a [`Tx`].
/// Get the confirmation time from an [`EsploraTx`].
pub fn confirmation_time(&self) -> Option<BlockTime> {
match self.status {
TxStatus {
Expand All @@ -404,7 +403,7 @@ impl Tx {
}
}

/// Get a list of the [`Tx`]'s previous outputs.
/// Get a list of the [`EsploraTx`]'s previous outputs.
pub fn previous_outputs(&self) -> Vec<Option<TxOut>> {
self.vin
.iter()
Expand All @@ -417,10 +416,17 @@ impl Tx {
})
.collect()
}
}

impl From<EsploraTx> for Transaction {
fn from(tx: EsploraTx) -> Self {
tx.to_tx()
}
}

/// Get the fee paid by a [`Tx`].
pub fn fee(&self) -> Amount {
self.fee
impl From<&EsploraTx> for Transaction {
fn from(tx: &EsploraTx) -> Self {
tx.to_tx()
}
}

Expand Down
22 changes: 14 additions & 8 deletions src/async.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ use bitreq::{Client, Method, Proxy, Request, RequestExt, Response};

use crate::{
is_retryable, is_success, AddressStats, BlockInfo, BlockStatus, BlockSummary, Builder, Error,
MempoolRecentTx, MempoolStats, MerkleProof, OutputStatus, ScriptHashStats, SubmitPackageResult,
Tx, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
EsploraTx, MempoolRecentTx, MempoolStats, MerkleProof, OutputStatus, ScriptHashStats,
SubmitPackageResult, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
};

/// An async client for interacting with an Esplora API server.
Expand Down Expand Up @@ -324,7 +324,7 @@ impl<S: Sleeper> AsyncClient<S> {
}

/// Get transaction info given its [`Txid`].
pub async fn get_tx_info(&self, txid: &Txid) -> Result<Option<Tx>, Error> {
pub async fn get_tx_info(&self, txid: &Txid) -> Result<Option<EsploraTx>, Error> {
self.get_opt_response_json(&format!("/tx/{txid}")).await
}

Expand Down Expand Up @@ -466,7 +466,7 @@ impl<S: Sleeper> AsyncClient<S> {
&self,
address: &Address,
last_seen: Option<Txid>,
) -> Result<Vec<Tx>, Error> {
) -> Result<Vec<EsploraTx>, Error> {
let path = match last_seen {
Some(last_seen) => format!("/address/{address}/txs/chain/{last_seen}"),
None => format!("/address/{address}/txs"),
Expand All @@ -476,7 +476,10 @@ impl<S: Sleeper> AsyncClient<S> {
}

/// Get mempool [`Transaction`]s for the specified [`Address`], sorted with newest first.
pub async fn get_mempool_address_txs(&self, address: &Address) -> Result<Vec<Tx>, Error> {
pub async fn get_mempool_address_txs(
&self,
address: &Address,
) -> Result<Vec<EsploraTx>, Error> {
let path = format!("/address/{address}/txs/mempool");

self.get_response_json(&path).await
Expand All @@ -490,7 +493,7 @@ impl<S: Sleeper> AsyncClient<S> {
&self,
script: &Script,
last_seen: Option<Txid>,
) -> Result<Vec<Tx>, Error> {
) -> Result<Vec<EsploraTx>, Error> {
let script_hash = sha256::Hash::hash(script.as_bytes());
let path = match last_seen {
Some(last_seen) => format!("/scripthash/{script_hash:x}/txs/chain/{last_seen}"),
Expand All @@ -502,7 +505,10 @@ impl<S: Sleeper> AsyncClient<S> {

/// Get mempool [`Transaction`] history for the
/// specified [`Script`] hash, sorted with newest first.
pub async fn get_mempool_scripthash_txs(&self, script: &Script) -> Result<Vec<Tx>, Error> {
pub async fn get_mempool_scripthash_txs(
&self,
script: &Script,
) -> Result<Vec<EsploraTx>, Error> {
let script_hash = sha256::Hash::hash(script.as_bytes());
let path = format!("/scripthash/{script_hash:x}/txs/mempool");

Expand Down Expand Up @@ -555,7 +561,7 @@ impl<S: Sleeper> AsyncClient<S> {
&self,
blockhash: &BlockHash,
start_index: Option<u32>,
) -> Result<Vec<Tx>, Error> {
) -> Result<Vec<EsploraTx>, Error> {
let path = match start_index {
None => format!("/block/{blockhash}/txs"),
Some(start_index) => format!("/block/{blockhash}/txs/{start_index}"),
Expand Down
16 changes: 8 additions & 8 deletions src/blocking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ use bitcoin::{Address, Block, BlockHash, MerkleBlock, Script, Transaction, Txid}

use crate::{
is_retryable, is_success, AddressStats, BlockInfo, BlockStatus, BlockSummary, Builder, Error,
MempoolRecentTx, MempoolStats, MerkleProof, OutputStatus, ScriptHashStats, SubmitPackageResult,
Tx, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
EsploraTx, MempoolRecentTx, MempoolStats, MerkleProof, OutputStatus, ScriptHashStats,
SubmitPackageResult, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
};

/// A blocking client for interacting with an Esplora API server.
Expand Down Expand Up @@ -306,7 +306,7 @@ impl BlockingClient {
}

/// Get transaction info given its [`Txid`].
pub fn get_tx_info(&self, txid: &Txid) -> Result<Option<Tx>, Error> {
pub fn get_tx_info(&self, txid: &Txid) -> Result<Option<EsploraTx>, Error> {
self.get_opt_response_json(&format!("/tx/{txid}"))
}

Expand Down Expand Up @@ -462,7 +462,7 @@ impl BlockingClient {
&self,
address: &Address,
last_seen: Option<Txid>,
) -> Result<Vec<Tx>, Error> {
) -> Result<Vec<EsploraTx>, Error> {
let path = match last_seen {
Some(last_seen) => format!("/address/{address}/txs/chain/{last_seen}"),
None => format!("/address/{address}/txs"),
Expand All @@ -472,7 +472,7 @@ impl BlockingClient {
}

/// Get mempool [`Transaction`]s for the specified [`Address`], sorted with newest first.
pub fn get_mempool_address_txs(&self, address: &Address) -> Result<Vec<Tx>, Error> {
pub fn get_mempool_address_txs(&self, address: &Address) -> Result<Vec<EsploraTx>, Error> {
let path = format!("/address/{address}/txs/mempool");

self.get_response_json(&path)
Expand All @@ -486,7 +486,7 @@ impl BlockingClient {
&self,
script: &Script,
last_seen: Option<Txid>,
) -> Result<Vec<Tx>, Error> {
) -> Result<Vec<EsploraTx>, Error> {
let script_hash = sha256::Hash::hash(script.as_bytes());
let path = match last_seen {
Some(last_seen) => format!("/scripthash/{script_hash:x}/txs/chain/{last_seen}"),
Expand All @@ -497,7 +497,7 @@ impl BlockingClient {

/// Get mempool [`Transaction`] history for the
/// specified [`Script`] hash, sorted with newest first.
pub fn get_mempool_scripthash_txs(&self, script: &Script) -> Result<Vec<Tx>, Error> {
pub fn get_mempool_scripthash_txs(&self, script: &Script) -> Result<Vec<EsploraTx>, Error> {
let script_hash = sha256::Hash::hash(script.as_bytes());
let path = format!("/scripthash/{script_hash:x}/txs/mempool");

Expand Down Expand Up @@ -527,7 +527,7 @@ impl BlockingClient {
&self,
blockhash: &BlockHash,
start_index: Option<u32>,
) -> Result<Vec<Tx>, Error> {
) -> Result<Vec<EsploraTx>, Error> {
let path = match start_index {
None => format!("/block/{blockhash}/txs"),
Some(start_index) => format!("/block/{blockhash}/txs/{start_index}"),
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,7 +684,7 @@ mod test {
assert_eq!(tx_info.to_tx(), tx_exp);
assert_eq!(tx_info.size, tx_exp.total_size());
assert_eq!(tx_info.weight, tx_exp.weight());
assert_eq!(tx_info.fee(), tx_res.fee.unwrap().unsigned_abs());
assert_eq!(tx_info.fee, tx_res.fee.unwrap().unsigned_abs());
assert!(tx_info.status.confirmed);
assert_eq!(tx_info.status.block_height, Some(tx_block_height));
assert_eq!(tx_info.status.block_hash, tx_res.block_hash);
Expand Down
Loading