fix: polish crate docs, add READMEs, enforce missing_docs by kayibal · Pull Request #158 · propeller-heads/fynd

kayibal · 2026-03-26T19:00:15Z

All four Rust crates now have complete, navigable docs on docs.rs. Previously, missing_docs was not enforced, intra-doc links were broken, and the example code in fynd-client used a verbose address instantiation pattern and had a broken doctest.

What changed:

Enforce #![deny(missing_docs)] across all crates; fill every gap
Fix broken intra-doc links in fynd-core and fynd-rpc
Expand the encoding module doc with links to the tycho-execution and Fynd encoding guide
Add direct link to the API reference (docs.fynd.xyz/reference/api) in fynd-rpc
Fix fynd-client doctest: succinct address instantiation, correct Result return context, crate-relative example path
Unpin fynd-client README version ("0.35" → "0")
Add a Rust API Reference section to the GitBook sidebar linking to docs.rs for all four crates

Users integrating the Rust crates get accurate, fully linked API docs on docs.rs and can navigate from the GitBook site directly to crate-level reference.

🤖 Generated with Claude Code

clients/rust/src/lib.rs

clients/rust/README.md

kayibal · 2026-03-27T10:42:33Z

fynd-core/src/algorithm/most_liquid.rs

 pub struct DepthAndPrice {
    /// Spot price (token_out per token_in) for this edge direction.
    pub spot_price: f64,
-    /// Liquidity depth in USD (or native token terms).
+    /// Liquidity depth denominated in the chain's native token.
    pub depth: f64,
 }


@tvinagre can you confirm the denomination here please?

I've checked the code and I think we have a bug.. depth is in raw units of sell_token - which is fine if we're comparing same In-out token paths, but that is not the case. I'm investigating this further and will open a PR soon if the bug exists

fynd-core/src/encoding/mod.rs

kayibal · 2026-03-27T10:44:48Z

fynd-core/src/feed/gas.rs

@@ -7,6 +7,7 @@ use tycho_simulation::{tycho_core::traits::FeePriceGetter, tycho_ethereum::gas::
 use crate::feed::{market_data::SharedMarketDataRef, DataFeedError};

 // TODO: Refactor gas price fetching into a `DerivedComputation`.


@tvinagre is this still a TODO?

Unless we think it's irrelevant.
It's a discussion if gas should be treated as derived data or not - and if it should block solving or not

fynd-rpc/src/lib.rs

fynd-rpc/README.md

dianacarvalho1

Thank you @kayibal ! 🙏🏼 only have smol comments

dianacarvalho1 · 2026-03-27T11:48:35Z

clients/rust/src/lib.rs

-//!     "https://rpc.fynd.exchange",
-//!     "https://mainnet.infura.io/v3/YOUR_KEY",
+//!     "http://localhost:3000",
+//!     "https://reth-ethereum.ithaca.xyz/rpc",


I think in other places we are using https://eth.llamarpc.com. Should we be consistent?

dianacarvalho1 · 2026-03-27T11:49:28Z

clients/rust/README.md

+```toml
+[dependencies]
+fynd-client = "0"  # see crates.io for the latest version
+```


maybe just cargo add fynd-client then? 👀

dianacarvalho1 · 2026-03-27T11:50:36Z

fynd-core/src/encoding/mod.rs

+/// Route encoder: converts solver output into ABI-encoded on-chain calldata.
+///
+/// Wraps [tycho-execution](https://docs.propellerheads.xyz/tycho/for-solvers/execution) to
+/// produce ABI-encoded calldata for single and sequential swaps, with and without Permit2. See


single, sequential and split swaps

I know we don't have an algo that does splits yet but the encoding already supports it

…itSingle::new Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Add a Workflow section pointing to the swap_erc20 example, add a build_quote_only example, and replace placeholder address bytes with real mainnet addresses via alloy::primitives::address!. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Also adds field-level docs to FyndError::Api named fields, which were the only items not yet covered. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Replace placeholder https://rpc.fynd.exchange URLs with http://localhost:3000 (default Fynd) and http://localhost:8545 (Anvil). Add docs.fynd.xyz link in the crate intro and workflow section. Add README.md for crates.io. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

…README Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Add docs.fynd.xyz link in crate intro. Add doc comments to all previously undocumented public items: module declarations, defaults constants, ApiDoc/ExperimentalApiDoc structs, StaleData::age_ms field, IncludeField variants, FyndRPCBuilder::build, and parse_chain. Add README.md for crates.io. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Add docs.fynd.xyz link and workflow description in crate intro. Add declarations, defaults constants, BellmanFordAlgorithm, AlgorithmError named fields, price_guard types, SolveError named fields, RouteValidationError/OrderValidationError variants and fields, QuoteRequest, WorkerPoolBuilder::new, FyndBuilder::chain, and test_utils helpers. Add README.md for crates.io. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Remove inline code examples from all READMEs. Each README now contains a brief description, install snippet, and links to docs.fynd.xyz instead of duplicating workflow steps and examples. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Rustdoc resolves //! inner docs in the parent module's scope, not the submodule's own scope. Fixed by using fully-qualified crate paths. Also fixed backtick display text in [`text`](path) links, which rustdoc treats as an additional intra-doc link resolution target. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

- Use succinct address!().to_vec().into() form in fynd-client doctest - Fix broken doctest (missing Result return context for ?) - Fix workspace-relative example path to crate-relative in lib.rs docs - Unpin fynd-client version in README (0.35 -> 0) - Expand encoding module docs with links to tycho-execution and encoding guide - Add direct link to API reference (docs.fynd.xyz/reference/api) in fynd-rpc Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Resolve review feedback: use `cargo add` in README, use ithaca RPC URL consistently, add split swaps to encoding docs, fix depth doc to raw sell_token units. Add missing doc comments for new public items introduced after rebase (FailedItemError variants, PriceGuard, HyperliquidProvider, Bytes methods). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add `RUSTDOCFLAGS="-D warnings" cargo doc` to check.sh so broken doc links and code blocks are caught locally before CI. Fix unresolved intra-doc links in price_guard module (use crate-absolute paths) and a malformed code block in fynd-client lib.rs. Update knowledge docs with the new check.sh step. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

propellerci · 2026-04-01T11:37:40Z

This PR is included in version 0.43.1 🎉

kayibal changed the title ~~docs: polish crate docs, add READMEs, enforce missing_docs~~ fix: polish crate docs, add READMEs, enforce missing_docs Mar 26, 2026

kayibal commented Mar 27, 2026

View reviewed changes

kayibal force-pushed the docs/polish-crate-docs branch from 2c7492d to b17e39d Compare March 27, 2026 11:15

dianacarvalho1 approved these changes Mar 27, 2026

View reviewed changes

kayibal and others added 15 commits April 1, 2026 10:33

docs(client): add missing doc comments to PermitDetails::new and Perm…

00b31bf

…itSingle::new Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

docs(client): add #![deny(missing_docs)] to enforce documentation

7600921

Also adds field-level docs to FyndError::Api named fields, which were the only items not yet covered. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

docs(client): use public Ithaca RPC URL in examples

fdcbe0c

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

docs(fynd-rpc-types): link canonical docs, enforce missing_docs, add …

419c60c

…README Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

docs(ts-client): expand README with install instructions and quick start

966960d

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

docs: fix min_tvl and depth denominations — native token, not USD

9ff626e

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

docs: add Rust SDK Reference section linking to docs.rs

887ca58

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

kayibal force-pushed the docs/polish-crate-docs branch from b17e39d to 4281989 Compare April 1, 2026 09:40

kayibal merged commit aeb7f3f into main Apr 1, 2026
18 checks passed

kayibal deleted the docs/polish-crate-docs branch April 1, 2026 11:32

propellerci bot added the true label Apr 1, 2026

		@@ -7,6 +7,7 @@ use tycho_simulation::{tycho_core::traits::FeePriceGetter, tycho_ethereum::gas::
		use crate::feed::{market_data::SharedMarketDataRef, DataFeedError};

		// TODO: Refactor gas price fetching into a `DerivedComputation`.

Conversation

kayibal commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dianacarvalho1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

propellerci bot commented Apr 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kayibal commented Mar 26, 2026 •

edited

Loading