tari-project / tari / 16416202811
62%

DEFAULT BRANCH: development
Ran
Jobs 1
Files 723
Run time 2min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 57.728% (+0.005%) from 57.723%
16416202811

push

github

web-flow 
(docs): updated wallet gRPC comments on new methods (#7343)

Description
---

Have updated comments on new methods and/or some outstanding missing
comments on other methods. Validator Node RPC methods have been left
undocumented for now.

Motivation and Context
---
.proto files serve as one of the primary ways exchanges are checking how
to use specific gRPC methods. Have updated so the new methods are clear.

How Has This Been Tested?
---

What process can a PR reviewer use to test or verify this change?
---
Verify that the comments are accurate.


<!-- Checklist -->
<!-- 1. Is the title of your PR in the form that would make nice release
notes? The title, excluding the conventional commit
tag, will be included exactly as is in the CHANGELOG, so please think
about it carefully. -->


Breaking Changes
---

- [x] None
- [ ] Requires data directory on base node to be deleted
- [ ] Requires hard fork
- [ ] Other - Please specify

<!-- Does this include a breaking change? If so, include this line as a
footer -->
<!-- BREAKING CHANGE: Description what the user should do, e.g. delete a
database, resync the chain -->


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Added comprehensive documentation comments to several wallet service
RPC methods, including detailed descriptions, parameter explanations,
validation rules, response formats, and example usage for clients. No
functional changes were made.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

70096 of 121424 relevant lines covered (57.73%)

224500.71 hits per line

Uncovered Existing Lines

Lines Coverage ∆ File
1
93.35
 -0.18% base_layer/core/src/proof_of_work/monero_rx/merkle_tree.rs
1
51.31
 -0.04% base_layer/wallet/src/transaction_service/storage/sqlite_db.rs
1
75.98
 -0.22% comms/core/src/connection_manager/peer_connection.rs
2
59.84
 -0.27% comms/dht/src/connectivity/mod.rs
7
55.22
 -0.43% comms/core/src/connectivity/manager.rs
8
0.0
 0.0% base_layer/wallet/src/config.rs
19
0.0
 0.0% base_layer/p2p/src/dns/client.rs
Jobs
ID Job ID Ran Files Coverage
1 16416202811.1 723
57.73
 GitHub Action Run
Source Files on build 16416202811