Files
nym/documentation/autodoc
Jędrzej Stuczyński 833114372a bugfix: key-rotation + reply SURBs (#5876)
* wip: changes to surb logic + stronger db typing

* surb invalidation logic

* chore: remove unused deps

* resolving todos

* a lot of additional bugfixes

* 1.88 clippy

* wasm fixes

* wasm clippy

* wallet clippy

* wait for epoch end when setting up new network

* split ReplyController into Sender and Receiver for easier reasoning

* additional reply surbs improvements

includes, but is not limited to: unconditionally reseting sender tag on restart, limiting number of surb re-requests, resetting stale surbs on load

* fixed calculation of number of removed surbs

* add additional calculated field to key rotation info

* DBG: 'request_reply_surbs_for_queue_clearing' temp logs

* fixes for silly mistakes

* conditionally reduce log severity
2025-07-04 16:29:03 +01:00
..
2024-11-04 11:42:56 +00:00
2025-02-17 15:05:27 +00:00
2024-11-04 11:42:56 +00:00

Autodoc

WIP command output documentation generator. Run via ../scripts/next-scripts/autodoc.sh to create a bunch of markdown files which are then moved around for importing into the documentation.

Error: Os { code: 2, kind: NotFound, message: "No such file or directory" }

If you run into this error, make sure that you have the following directory structure:

autodoc/
├── autodoc-generated-markdown/
│     └── commands/
├── Cargo.toml
├── README.md
└── src
    └── main.rs

And if you don't - create it and re-run.

If you are encountering this error with this dir structure in place, check that all Nym binaries that are listed in main.rs also exist in nym/target/release/.

Run this crate on its own with debug logging and it should panic on the missing binary:

RUST_LOG="debug" cargo run --release
    Finished `release` profile [optimized] target(s) in 0.20s
     Running `/home/______/src/nym/target/release/autodoc`
[2024-10-23T08:11:01Z DEBUG autodoc] now running Some(
        "nym-api",
    )
[2024-10-23T08:11:01Z DEBUG autodoc] stderr: " 2024-10-23T08:11:01.981Z INFO  nym_api > Starting nym api...\n"
[2024-10-23T08:11:01Z DEBUG autodoc] stderr: " 2024-10-23T08:11:01.985Z INFO  nym_api > Starting nym api...\n"
[2024-10-23T08:11:01Z INFO  autodoc] SKIPPING ../../target/release/nym-api init
[2024-10-23T08:11:01Z INFO  autodoc] creating own file for ../../target/release/nym-api init --help
[2024-10-23T08:11:01Z DEBUG autodoc] stderr: " 2024-10-23T08:11:01.993Z INFO  nym_api > Starting nym api...\n"

< snip >

[2024-10-23T08:11:02Z DEBUG autodoc] now running Some(
        "nym-cli",
    )
Error: Os { code: 2, kind: NotFound, message: "No such file or directory" }