Merge pull request #291 from chenyukang/yukang-fix-rpc-doc

Add RPC documentation generator

.github/workflows/ci.yml

@@ -10,7 +10,9 @@ jobs:
       - uses: actions/checkout@v2
       - uses: Swatinem/rust-cache@v2
       - uses: dsherret/rust-toolchain-file@v1
-      - run: cargo check
+      - run: |
+          cargo check
+          make check-dirty-rpc-doc
 
   cargo-shear:
     name: Cargo Shear

Makefile

@@ -52,3 +52,16 @@ coverage-generate-report:
 	genhtml --ignore-errors inconsistent --ignore-errors corrupt --ignore-errors range --ignore-errors unmapped -o "${GRCOV_OUTPUT:.info=}" "${GRCOV_OUTPUT}"
 
 coverage: coverage-run-unittests coverage-collect-data coverage-generate-report
+
+.PHONY: gen-rpc-doc
+gen-rpc-doc:
+	cargo install fiber-rpc-gen
+	fiber-rpc-gen ./src/rpc
+	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; \
+    fi
+
+.PHONY: check-dirty-rpc-doc
+check-dirty-rpc-doc: gen-rpc-doc
+	git diff --exit-code ./src/rpc/README.md

src/fiber/network.rs

@@ -284,7 +284,6 @@ pub struct SendPaymentCommand {
     // the amount of the payment
     pub amount: Option<u128>,
     // The hash to use within the payment's HTLC
-    // FIXME: this should be optional when AMP is enabled
     pub payment_hash: Option<Hash256>,
     // the encoded invoice to send to the recipient
     pub invoice: Option<String>,

src/invoice/invoice_impl.rs

@@ -30,10 +30,15 @@ pub(crate) const SIGNATURE_U5_SIZE: usize = 104;
 /// The currency of the invoice, can also used to represent the CKB network chain.
 #[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize)]
 pub enum CkbInvoiceStatus {
+    /// The invoice is open and can be paid.
     Open,
+    /// The invoice is cancelled.
     Cancelled,
+    /// The invoice is expired.
     Expired,
+    /// The invoice is received, but not settled yet.
     Received,
+    /// The invoice is paid.
     Paid,
 }