tari-project / tari / 14707544498
62%

DEFAULT BRANCH: development
Ran
Jobs 1
Files 704
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: 73.439% (+0.08%) from 73.364%
14707544498

push

github

web-flow 
Feat (Doc): Revisions to improve readability and information of gRPC methods doc, including initialising the client and adding information regarding the two new gRPC methods  (#6994)

Description
---
A revision of the API gRPC document to improve information, initialising
the client, and covering the new methods being added to wallet.proto to:

- Get balance by User Payment ID, as per
https://github.com/tari-project/tari/pull/6993
- create a method that returns one or all transactions for a transaction
ID

PR should not be approved/merged until addition of the second method to
the documentation

Motivation and Context
---

How Has This Been Tested?
---

What process can a PR reviewer use to test or verify this change?
---
@stringhandler @SWvheerden can confirm accuracy of content and new
method documentation

Breaking Changes
---

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


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

- **Documentation**
  - Updated the default gRPC server port to 18183.
  - Added detailed explanations on `.proto` files and code generation.
- Included step-by-step instructions and examples for gRPC client
instantiation in Node.js.
- Clarified dependencies of gRPC methods on their respective `.proto`
files.
- Expanded "Get Balance" method documentation with filtering options and
Node.js examples.
- Introduced a new example for retrieving completed transactions
filtered by `user_payment_id`.
- Overhauled gRPC authentication docs with configuration and client-side
examples for secure connections.
- Restructured and expanded the documentation with a comprehensive table
of contents and enhanced examples across wallet and base node methods.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

81436 of 110889 relevant lines covered (73.44%)

279284.8 hits per line

Uncovered Existing Lines

Lines Coverage ∆ File
1
86.03
 -0.04% base_layer/wallet/src/transaction_service/storage/sqlite_db.rs
1
68.81
 -0.06% base_layer/wallet/src/utxo_scanner_service/uxto_scanner_service_builder.rs
1
87.76
 0.38% comms/core/src/peer_manager/peer_storage.rs
3
63.27
 1.33% comms/core/src/connectivity/requester.rs
4
83.44
 -1.32% comms/core/src/connection_manager/manager.rs
6
84.69
 0.16% base_layer/wallet/src/utxo_scanner_service/service.rs
9
0.0
 0.0% base_layer/wallet/src/config.rs
15
62.63
 -1.55% comms/dht/src/connectivity/mod.rs
44
77.49
 0.0% base_layer/wallet/src/utxo_scanner_service/utxo_scanner_task.rs
113
0.0
 0.0% base_layer/wallet/src/wallet.rs
Jobs
ID Job ID Ran Files Coverage
1 14707544498.1 704
73.44
 GitHub Action Run
Source Files on build 14707544498