logos-storage/logos-storage-nim
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-nim.git synced 2026-07-27 12:03:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: updates AGENTS files in tools

Browse Source
This commit is contained in:
Marcin Czenko 2026-06-29 17:49:45 +02:00
parent 1a9eb0a662
commit 39595ad035
No known key found for this signature in database
GPG Key ID: F6CB3ED4082ED433
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
tools/libstorage-cpp/AGENTS.md
View File

@ -76,7 +76,11 @@ Keep daemon commands low-level:
- `stream-sink`
- `manifest`
- `connect`
- `start`
- `stop`
- `close`
- `shutdown`
- `destroy`
Do not add scenario commands like `roundtrip`, `many`, or cross-target tests to the daemon unless explicitly requested. Put scenario orchestration in `tools/storage-test/storage-test.sh` so the same scenario can run against REST targets and the libstorage daemon target.
@ -102,6 +106,16 @@ The protocol currently does not support paths or arguments containing spaces. If
`storage_lib_ctl` should return nonzero when the daemon responds with `"ok":false`.
Lifecycle IPC commands are daemon-level state controls over the libstorage C API:
- Initial daemon state is `RUNNING` after startup calls `StorageClient::start()`.
- `stop` works only from `RUNNING`; repeated `stop` reports the node is not started.
- `start` works only from `STOPPED`; it is rejected after `close` because restarting after close is not supported.
- `close` works only from `STOPPED`; calling it while `RUNNING` tells the caller to stop first.
- `shutdown` and `destroy` are aliases; both stop the daemon loop and process exit triggers `StorageClient` destructor cleanup (`stop` if needed, `close` if needed, then `storage_destroy`).
- In `STOPPED`, normal storage commands are rejected with available commands: `start`, `close`, `shutdown`, `destroy`.
- In `CLOSED`, all commands except `shutdown`/`destroy` are rejected with available commands: `shutdown`, `destroy`.
`stream-sink <cid> [local]` uses released libstorage download primitives: `storage_download_init` followed by `storage_download_stream` with an empty output path. It discards progress bytes while counting transferred byte lengths and waits for terminal completion.
File paths sent over IPC are resolved by the daemon process. Callers that run from a different working directory, such as `tools/storage-test/storage-test.sh`, should send absolute paths.

7
tools/storage-test/AGENTS.md
View File

@ -111,6 +111,7 @@ Lib-only target commands:
- `spr`
- `debug`
- `peers`
- `manifest <cid>`
- `connect <peer-id> [addr...]`
@ -134,6 +135,12 @@ Important: lib daemon file paths are resolved in the daemon process working dire
`--timeout-ms 0` means wait indefinitely in libstorage C++ tooling.
Lib-only utility behavior:
- `debug` calls daemon `debug` and pretty-prints the returned JSON with `jq .`.
- `peers` calls daemon `debug` and prints `.table.nodes | length`, giving the number of peers known to the node.
- Lifecycle commands (`start`, `stop`, `close`, `shutdown`, `destroy`) intentionally remain out of `storage-test.sh`; use `tools/libstorage-cpp/storage_lib_ctl` directly for lifecycle testing.
## Test Scenario
`storage-test.sh <local|lib> test` currently runs the remote-to-local scenario: