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

doc: update BroadcastTransaction comment #29308

Conversation

ismaelsadeeq
Copy link
Member

@ismaelsadeeq ismaelsadeeq commented Jan 24, 2024

BroadcastTransaction is also called by submitpackage RPC.

All transactions that are accepted into the mempool post package processing are broadcasted to peers individually here

const auto err = BroadcastTransaction(node, tx, err_string, /*max_tx_fee=*/0, /*relay=*/true, /*wait_callback=*/true);

It's not maintainable to list all the callers of a function.

@DrahtBot
Copy link
Contributor

DrahtBot commented Jan 24, 2024

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type Reviewers
ACK stickies-v, kristapsk, naumenkogs
Stale ACK vasild, BrandonOdiwuor, willcl-ark, shaavan

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

@DrahtBot DrahtBot added the Docs label Jan 24, 2024
@ismaelsadeeq ismaelsadeeq changed the title doc: clarify that BroadcastTransaction comment doc: clarify BroadcastTransaction comment Jan 24, 2024
@ismaelsadeeq ismaelsadeeq force-pushed the 01-2024-clarify-BroadcastTransaction-comment branch from 2272c3a to cca20d9 Compare January 24, 2024 15:38
Copy link
Contributor

@vasild vasild left a comment

Choose a reason for hiding this comment

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

ACK cca20d9

I was looking at the same comment and was thinking it needs an update. Thanks!

Copy link
Contributor

@BrandonOdiwuor BrandonOdiwuor left a comment

Choose a reason for hiding this comment

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

lgtm ACK cca20d9

Copy link
Contributor

@kristapsk kristapsk left a comment

Choose a reason for hiding this comment

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

ACK cca20d9

Copy link
Member

@willcl-ark willcl-ark left a comment

Choose a reason for hiding this comment

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

ACK cca20d9

@ismaelsadeeq ismaelsadeeq force-pushed the 01-2024-clarify-BroadcastTransaction-comment branch from cca20d9 to 437e8eb Compare January 26, 2024 09:40
@ismaelsadeeq ismaelsadeeq changed the title doc: clarify BroadcastTransaction comment doc: update BroadcastTransaction comment Jan 26, 2024
Copy link
Contributor

@shaavan shaavan left a comment

Choose a reason for hiding this comment

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

ACK 437e8eb

Following the discussion in the PR so far, I agree that it is more logical and maintainable not to detail which function calls (or can call) a particular function since this information is easily accessible through other methods (e.g. by using an IDE)
That's why I think it's best to remove the comment.

@DrahtBot DrahtBot requested review from willcl-ark, kristapsk, vasild and BrandonOdiwuor and removed request for kristapsk and BrandonOdiwuor January 26, 2024 12:51
BroadcastTransaction is also called by submitpackage RPC.

It's not maintainable to list all the callers of a function.
@ismaelsadeeq ismaelsadeeq force-pushed the 01-2024-clarify-BroadcastTransaction-comment branch from 437e8eb to 31cce4a Compare January 29, 2024 12:10
Copy link
Contributor

@stickies-v stickies-v left a comment

Choose a reason for hiding this comment

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

ACK 31cce4a

Copy link
Contributor

@kristapsk kristapsk left a comment

Choose a reason for hiding this comment

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

ACK 31cce4a

@DrahtBot DrahtBot requested review from BrandonOdiwuor and shaavan and removed request for shaavan and BrandonOdiwuor January 29, 2024 13:09
Copy link
Member

@naumenkogs naumenkogs left a comment

Choose a reason for hiding this comment

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

ACK 31cce4a

@DrahtBot DrahtBot requested review from BrandonOdiwuor and shaavan and removed request for BrandonOdiwuor and shaavan January 30, 2024 09:04
@glozow glozow merged commit cad2df2 into bitcoin:master Jan 30, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

10 participants