Skip to content
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

refactor(wallet): rename get_balance() to balance() #1455

Merged
merged 1 commit into from
Jun 4, 2024
Merged

refactor(wallet): rename get_balance() to balance() #1455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion crates/wallet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ fn main() {

<!-- wallet.sync(&blockchain, SyncOptions::default())?; -->

<!-- println!("Descriptor balance: {} SAT", wallet.get_balance()?); -->
<!-- println!("Descriptor balance: {} SAT", wallet.balance()?); -->

<!-- Ok(()) -->
<!-- } -->
Expand Down
2 changes: 1 addition & 1 deletion crates/wallet/src/wallet/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1216,7 +1216,7 @@ impl Wallet {

/// Return the balance, separated into available, trusted-pending, untrusted-pending and immature
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Return the balance, separated into available, trusted-pending, untrusted-pending and immature
/// Returns the balance, separated into available, trusted-pending, untrusted-pending and immature

Since we are fixing this anyways let's adjust the docstring?

/// values.
pub fn get_balance(&self) -> Balance {
pub fn balance(&self) -> Balance {
self.indexed_graph.graph().balance(
&self.chain,
self.chain.tip().block_id(),
Expand Down
2 changes: 1 addition & 1 deletion crates/wallet/tests/psbt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ fn test_psbt_multiple_internalkey_signers() {
let keypair = Keypair::from_secret_key(&secp, &prv.inner);

let (mut wallet, _) = get_funded_wallet(&desc);
let to_spend = wallet.get_balance().total();
let to_spend = wallet.balance().total();
let send_to = wallet.peek_address(KeychainKind::External, 0);
let mut builder = wallet.build_tx();
builder.drain_to(send_to.script_pubkey()).drain_wallet();
Expand Down
6 changes: 3 additions & 3 deletions crates/wallet/tests/wallet.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ fn test_get_funded_wallet_balance() {
// The funded wallet contains a tx with a 76_000 sats input and two outputs, one spending 25_000
// to a foreign address and one returning 50_000 back to the wallet as change. The remaining 1000
// sats are the transaction fee.
assert_eq!(wallet.get_balance().confirmed, Amount::from_sat(50_000));
assert_eq!(wallet.balance().confirmed, Amount::from_sat(50_000));
}

#[test]
Expand Down Expand Up @@ -3711,7 +3711,7 @@ fn test_spend_coinbase() {
let not_yet_mature_time = confirmation_height + COINBASE_MATURITY - 1;
let maturity_time = confirmation_height + COINBASE_MATURITY;

let balance = wallet.get_balance();
let balance = wallet.balance();
assert_eq!(
balance,
Balance {
Expand Down Expand Up @@ -3762,7 +3762,7 @@ fn test_spend_coinbase() {
hash: BlockHash::all_zeros(),
})
.unwrap();
let balance = wallet.get_balance();
let balance = wallet.balance();
assert_eq!(
balance,
Balance {
Expand Down
4 changes: 2 additions & 2 deletions example-crates/wallet_electrum/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ fn main() -> Result<(), anyhow::Error> {
let address = wallet.next_unused_address(KeychainKind::External)?;
println!("Generated Address: {}", address);

let balance = wallet.get_balance();
let balance = wallet.balance();
println!("Wallet balance before syncing: {} sats", balance.total());

print!("Syncing...");
Expand Down Expand Up @@ -65,7 +65,7 @@ fn main() -> Result<(), anyhow::Error> {
wallet.apply_update(update)?;
wallet.commit()?;

let balance = wallet.get_balance();
let balance = wallet.balance();
println!("Wallet balance after syncing: {} sats", balance.total());

if balance.total() < SEND_AMOUNT {
Expand Down
4 changes: 2 additions & 2 deletions example-crates/wallet_esplora_async/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ async fn main() -> Result<(), anyhow::Error> {
let address = wallet.next_unused_address(KeychainKind::External)?;
println!("Generated Address: {}", address);

let balance = wallet.get_balance();
let balance = wallet.balance();
println!("Wallet balance before syncing: {} sats", balance.total());

print!("Syncing...");
Expand Down Expand Up @@ -78,7 +78,7 @@ async fn main() -> Result<(), anyhow::Error> {
wallet.commit()?;
println!();

let balance = wallet.get_balance();
let balance = wallet.balance();
println!("Wallet balance after syncing: {} sats", balance.total());

if balance.total() < SEND_AMOUNT {
Expand Down
4 changes: 2 additions & 2 deletions example-crates/wallet_esplora_blocking/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ fn main() -> Result<(), anyhow::Error> {
let address = wallet.next_unused_address(KeychainKind::External)?;
println!("Generated Address: {}", address);

let balance = wallet.get_balance();
let balance = wallet.balance();
println!("Wallet balance before syncing: {} sats", balance.total());

print!("Syncing...");
Expand All @@ -55,7 +55,7 @@ fn main() -> Result<(), anyhow::Error> {
wallet.commit()?;
println!();

let balance = wallet.get_balance();
let balance = wallet.balance();
println!("Wallet balance after syncing: {} sats", balance.total());

if balance.total() < SEND_AMOUNT {
Expand Down
4 changes: 2 additions & 2 deletions example-crates/wallet_rpc/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ fn main() -> anyhow::Result<()> {
start_load_wallet.elapsed().as_secs_f32()
);

let balance = wallet.get_balance();
let balance = wallet.balance();
println!("Wallet balance before syncing: {} sats", balance.total());

let wallet_tip = wallet.latest_checkpoint();
Expand Down Expand Up @@ -163,7 +163,7 @@ fn main() -> anyhow::Result<()> {
}
}
let wallet_tip_end = wallet.latest_checkpoint();
let balance = wallet.get_balance();
let balance = wallet.balance();
println!(
"Synced {} blocks in {}s",
blocks_received,
Expand Down
Loading