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.

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

Update list_balances documentation #421

Closed

Conversation

arik-so
Copy link

@arik-so arik-so commented Dec 18, 2024

No description provided.

@@ -1368,6 +1368,8 @@ impl Node {
}

/// Retrieves an overview of all known balances.
///
/// Note that to retrieve the latest on-chain balance, you need to call [`Node::sync_wallets`] first.
Copy link
Collaborator

Choose a reason for hiding this comment

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

No, actually use of sync_wallets is more or less discouraged. Users should use the background syncing whenever possible.

Copy link
Author

Choose a reason for hiding this comment

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

Noted. Do you think we should document that in the README? With a local experiment, sync_wallet was the only way I was able to get it to update the on-chain balance.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Noted. Do you think we should document that in the README?

Mhh, so it is already noted on the sync_wallet docs. I guess that should be sufficient? It's surely not so important that it needs to go into the README?

With a local experiment, sync_wallet was the only way I was able to get it to update the on-chain balance.

Huh, I'd be interested to learn more about that. You should get the update eventually, on Esplora the default onchain_wallet_sync_interval_secs is 80 seconds to avoid hitting rate-limiting. So you should see updates after that the latest, or can of course try to reduce the interval as long as you don't see a lot of HTTP 429 errors popping up.

@arik-so arik-so closed this Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants