Edited blockchain README.md #19
Conversation
WalkthroughThe changes in the Changes
Sequence Diagram(s)N/A Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range and nitpick comments (1)
README.md (1)
64-64: Clarify the fee estimator description.The description "The fee estimator estimates network fees using various APIs." could be more specific by listing the APIs used.
- The fee estimator estimates network fees using various APIs. + The fee estimator estimates network fees using the Mempool API, Blockstream API, and a fixed fee rate.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (6 hunks)
Additional context used
Markdownlint
README.md
14-14: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
13-13: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
92-92: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
96-96: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
112-112: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
96-96: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
97-97: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
100-100: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
101-101: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
105-105: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
106-106: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
111-111: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
LanguageTool
README.md
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...network for the transaction. -feeRate: Minimum fee rate; actual fee may be hig...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...NewRawInputs() if unspecified. -utxos: Additional UTXOs if needed. Usenili...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~103-~103: Loose punctuation mark.
Context: ...eded. Usenilif none. -sizeUpdater: Describes UTXO size impact. It assumes ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...s with specified amounts. -changeAddr: Address for the change, usually the sen...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... ### Bitcoin scripts -MultisigScript: 2-of-2 multisig script for the [Guardia...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...llet/guardian) component. -HtlcScript: HTLC script as described in [BIP-199](h...(UNLIKELY_OPENING_PUNCTUATION)
Additional comments not posted (3)
README.md (3)
172-172: Fix loose punctuation mark.LanguageTool suggests fixing the loose punctuation mark.
- - `HtlcScript`: HTLC script as described in [BIP-199](https://github.com/bitcoin/bips/blob/e643d247c8bc086745f3031cdee0899803edea2f/bip-0199.mediawiki#L22). + - `HtlcScript`: HTLC script as described in [BIP-199](https://github.com/bitcoin/bips/blob/e643d247c8bc086745f3031cdee0899803edea2f/bip-0199.mediawiki#L22).Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...llet/guardian) component. -HtlcScript: HTLC script as described in [BIP-199](h...(UNLIKELY_OPENING_PUNCTUATION)
171-171: Fix loose punctuation mark.LanguageTool suggests fixing the loose punctuation mark.
- - `MultisigScript`: 2-of-2 multisig script for the [Guardian](https://docs.catalog.fi/catalog-accounts/instant-wallet/guardian) component. + - `MultisigScript`: 2-of-2 multisig script for the [Guardian](https://docs.catalog.fi/catalog-accounts/instant-wallet/guardian) component.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... ### Bitcoin scripts -MultisigScript: 2-of-2 multisig script for the [Guardia...(UNLIKELY_OPENING_PUNCTUATION)
70-72: Ensure the comments align with the code.The simplified comments are clear, but verify that the corresponding code accurately uses the described APIs.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (7)
README.md (7)
12-12: Add a blank line before the code block.Markdownlint suggests that fenced code blocks should be surrounded by blank lines.
- To import the `blockchain` package: + To import the `blockchain` package: ```shell $ go get github.com/catalogfi/blockchain--- `65-65`: **Clarify the fee estimator description.** The description can be made more precise by specifying the unit of the result. ```diff - The fee estimator estimates network fees using various APIs. + The fee estimator estimates network fees using various APIs. The result is in `sats/vB`.
95-95: Remove trailing spaces.Markdownlint suggests removing trailing spaces.
- We use the `BuildTransaction` function with these parameters: + We use the `BuildTransaction` function with these parameters:
97-106: Surround lists with blank lines.Markdownlint suggests that lists should be surrounded by blank lines.
- 1. General - - `network`: The network for the transaction. - - `feeRate`: Minimum fee rate; actual fee may be higher. + 1. General + - `network`: The network for the transaction. + - `feeRate`: Minimum fee rate; actual fee may be higher. - 2. Inputs - - `inputs`: UTXOs to spend. Use NewRawInputs() if unspecified. - - `utxos`: Additional UTXOs if needed. Use `nil` if none. + 2. Inputs + - `inputs`: UTXOs to spend. Use NewRawInputs() if unspecified. + - `utxos`: Additional UTXOs if needed. Use `nil` if none. - 3. Outputs - - `recipients`: Fund recipients with specified amounts. - - `changeAddr`: Address for the change, usually the sender's address. + 3. Outputs + - `recipients`: Fund recipients with specified amounts. + - `changeAddr`: Address for the change, usually the sender's address.Tools
LanguageTool
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...se parameters: 1. General -network: The network for the transaction. - `fee...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...network for the transaction. -feeRate: Minimum fee rate; actual fee may be hig...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ... may be higher. 2. Inputs -inputs: UTXOs to spend. Use NewRawInputs() if u...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...NewRawInputs() if unspecified. -utxos: Additional UTXOs if needed. Usenili...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~106-~106: Loose punctuation mark.
Context: ...eded. Usenilif none. -sizeUpdater: Describes UTXO size impact. It assumes ...(UNLIKELY_OPENING_PUNCTUATION)
115-115: Add a blank line before the code block.Markdownlint suggests that fenced code blocks should be surrounded by blank lines.
- 1. Transfer 0.1 btc + 1. Transfer 0.1 btc ```go // Fetch available utxos of the address--- `176-176`: **Remove trailing spaces.** Markdownlint suggests removing trailing spaces. ```diff - - `MultisigScript`: 2-of-2 multisig script for the [Guardian](https://docs.catalog.fi/catalog-accounts/instant-wallet/guardian) component. + - `MultisigScript`: 2-of-2 multisig script for the [Guardian](https://docs.catalog.fi/catalog-accounts/instant-wallet/guardian) component.Tools
LanguageTool
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ... ### Bitcoin scripts -MultisigScript: 2-of-2 multisig script for the [Guardia...(UNLIKELY_OPENING_PUNCTUATION)
177-177: Remove trailing spaces.Markdownlint suggests removing trailing spaces.
- - `HtlcScript`: HTLC script as described in [BIP-199](https://github.com/bitcoin/bips/blob/e643d247c8bc086745f3031cdee0899803edea2f/bip-0199.mediawiki#L22). + - `HtlcScript`: HTLC script as described in [BIP-199](https://github.com/bitcoin/bips/blob/e643d247c8bc086745f3031cdee0899803edea2f/bip-0199.mediawiki#L22).Tools
LanguageTool
[uncategorized] ~177-~177: Loose punctuation mark.
Context: ...llet/guardian) component. -HtlcScript: HTLC script as described in [BIP-199](h...(UNLIKELY_OPENING_PUNCTUATION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (6 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...se parameters: 1. General -network: The network for the transaction. - `fee...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...network for the transaction. -feeRate: Minimum fee rate; actual fee may be hig...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ... may be higher. 2. Inputs -inputs: UTXOs to spend. Use NewRawInputs() if u...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...NewRawInputs() if unspecified. -utxos: Additional UTXOs if needed. Usenili...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~106-~106: Loose punctuation mark.
Context: ...eded. Usenilif none. -sizeUpdater: Describes UTXO size impact. It assumes ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ... is empty. 3. Outputs -recipients: Fund recipients with specified amounts....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...s with specified amounts. -changeAddr: Address for the change, usually the sen...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ... ### Bitcoin scripts -MultisigScript: 2-of-2 multisig script for the [Guardia...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~177-~177: Loose punctuation mark.
Context: ...llet/guardian) component. -HtlcScript: HTLC script as described in [BIP-199](h...(UNLIKELY_OPENING_PUNCTUATION)
Summary by CodeRabbit
blockchainpackage.BuildTransactionfunction into clearer categories: General, Inputs, and Outputs.MultisigScriptandHtlcScript.