Merge pull request #467 from chenyukang/yukang-fix-doc-issue

chore: Fix RPC document issues

Makefile

@@ -55,8 +55,8 @@ coverage: coverage-run-unittests coverage-collect-data coverage-generate-report
 
 .PHONY: gen-rpc-doc
 gen-rpc-doc:
-	$(if $(shell command -v fiber-rpc-gen),,cargo install fiber-rpc-gen --force)
-	fiber-rpc-gen ./src/rpc
+	$(if $(shell command -v fiber-rpc-gen),,cargo install fiber-rpc-gen --version 0.1.6 --force)
+	fiber-rpc-gen ./src/
 	if grep -q "TODO: add desc" ./src/rpc/README.md; then \
         echo "Warning: There are 'TODO: add desc' in src/rpc/README.md, please add documentation comments to resolve them"; \
 		exit 1; \

src/cch/order.rs

@@ -12,6 +12,7 @@ use crate::{
     invoice::{Currency, InvoiceBuilder},
 };
 
+/// The status of a cross-chain hub order, will update as the order progresses.
 #[derive(Debug, Copy, Clone, Serialize, Deserialize, Eq, PartialEq)]
 #[serde(rename_all = "snake_case")]
 pub enum CchOrderStatus {

src/ckb/config.rs

@@ -187,6 +187,7 @@ pub struct UdtArgInfo {
     pub cell_deps: Vec<UdtCellDep>,
 }
 
+/// The UDT configurations
 #[derive(Serialize, Deserialize, Clone, Debug, Default, Eq, PartialEq, Hash)]
 pub struct UdtCfgInfos(pub Vec<UdtArgInfo>);
 

src/fiber/graph.rs

@@ -1105,15 +1105,16 @@ pub trait NetworkGraphStateStore {
     fn get_payment_history_results(&self) -> Vec<(OutPoint, Direction, TimedResult)>;
 }
 
+/// The status of a payment, will update as the payment progresses.
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 pub enum PaymentSessionStatus {
-    // initial status, payment session is created, no HTLC is sent
+    /// initial status, payment session is created, no HTLC is sent
     Created,
-    // the first hop AddTlc is sent successfully and waiting for the response
+    /// the first hop AddTlc is sent successfully and waiting for the response
     Inflight,
-    // related HTLC is successfully settled
+    /// related HTLC is successfully settled
     Success,
-    // related HTLC is failed
+    /// related HTLC is failed
     Failed,
 }
 

src/fiber/hash_algorithm.rs

@@ -4,12 +4,15 @@ use ckb_types::packed;
 use serde::{Deserialize, Serialize};
 use thiserror::Error;
 
+/// HashAlgorithm is the hash algorithm used in the hash lock.
 #[repr(u8)]
 #[derive(Copy, Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Default, Hash)]
 #[serde(rename_all = "snake_case")]
 pub enum HashAlgorithm {
+    /// The default hash algorithm, CkbHash
     #[default]
     CkbHash = 0,
+    /// The sha256 hash algorithm
     Sha256 = 1,
 }
 

src/fiber/types.rs

@@ -135,6 +135,7 @@ impl AsRef<[u8; 32]> for Privkey {
     }
 }
 
+/// A 256-bit hash digest, used as identifier of channnel, payment, transaction hash etc.
 #[serde_as]
 #[derive(Copy, Clone, Serialize, Deserialize, Hash, Eq, PartialEq, Default)]
 pub struct Hash256(#[serde_as(as = "SliceHex")] [u8; 32]);
@@ -267,6 +268,7 @@ impl Privkey {
     }
 }
 
+/// The public key for a Node
 #[derive(Copy, Clone, Debug, PartialOrd, Ord, PartialEq, Eq, Hash, Serialize, Deserialize)]
 pub struct Pubkey(pub PublicKey);
 

src/invoice/invoice_impl.rs

@@ -59,8 +59,11 @@ impl Display for CkbInvoiceStatus {
 /// The currency of the invoice, can also used to represent the CKB network chain.
 #[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)]
 pub enum Currency {
+    /// The mainnet currency of CKB.
     Fibb,
+    /// The testnet currency of the CKB network.
     Fibt,
+    /// The devnet currency of the CKB network.
     Fibd,
 }
 
@@ -136,10 +139,14 @@ pub struct InvoiceData {
 #[serde_as]
 #[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
 pub struct CkbInvoice {
+    /// The currency of the invoice
     pub currency: Currency,
     #[serde_as(as = "Option<U128Hex>")]
+    /// The amount of the invoice
     pub amount: Option<u128>,
+    /// The signature of the invoice
     pub signature: Option<InvoiceSignature>,
+    /// The invoice data, including the payment hash, timestamp and other attributes
     pub data: InvoiceData,
 }
 

src/rpc/cch.rs

@@ -116,7 +116,6 @@ pub(crate) struct ReceiveBTCResponse {
 }
 
 /// RPC module for cross chain hub demonstration.
-/// This is the seccond line
 #[rpc(server)]
 trait CchRpc {
     /// Send BTC to a address.

src/rpc/invoice.rs

@@ -13,6 +13,7 @@ use serde_with::serde_as;
 use std::time::Duration;
 use tentacle::secio::SecioKeyPair;
 
+/// The parameter struct for generating a new invoice.
 #[serde_as]
 #[derive(Serialize, Deserialize)]
 pub(crate) struct NewInvoiceParams {

src/rpc/payment.rs

@@ -1,6 +1,6 @@
 use crate::fiber::{
     channel::ChannelActorStateStore,
-    graph::PaymentSessionStatus as InnerPaymentSessionStatus,
+    graph::PaymentSessionStatus,
     network::{HopHint as NetworkHopHint, SendPaymentCommand},
     serde_utils::{U128Hex, U64Hex},
     types::{Hash256, Pubkey},
@@ -24,30 +24,6 @@ pub struct GetPaymentCommandParams {
     pub payment_hash: Hash256,
 }
 
-/// The status of a payment, will update as the payment progresses.
-#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
-pub enum PaymentSessionStatus {
-    /// initial status, payment session is created, no HTLC is sent
-    Created,
-    /// the first hop AddTlc is sent successfully and waiting for the response
-    Inflight,
-    /// related HTLC is successfully settled
-    Success,
-    /// related HTLC is failed
-    Failed,
-}
-
-impl From<InnerPaymentSessionStatus> for PaymentSessionStatus {
-    fn from(status: InnerPaymentSessionStatus) -> Self {
-        match status {
-            InnerPaymentSessionStatus::Created => PaymentSessionStatus::Created,
-            InnerPaymentSessionStatus::Inflight => PaymentSessionStatus::Inflight,
-            InnerPaymentSessionStatus::Success => PaymentSessionStatus::Success,
-            InnerPaymentSessionStatus::Failed => PaymentSessionStatus::Failed,
-        }
-    }
-}
-
 #[serde_as]
 #[derive(Serialize, Deserialize, Clone)]
 pub struct GetPaymentCommandResult {
@@ -130,6 +106,7 @@ pub(crate) struct SendPaymentCommandParams {
     dry_run: Option<bool>,
 }
 
+/// A hop hint is a hint for a node to use a specific channel.
 #[serde_as]
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct HopHint {