From 864a8ce42d5bcd6c439f1513bfb7bbfb362d9235 Mon Sep 17 00:00:00 2001 From: afarukcali <28007392+afarukcali@users.noreply.github.com> Date: Fri, 16 May 2025 09:02:15 +0000 Subject: [PATCH 1/2] Update docs from nexus-sdk (commit: a12039219c3b3acaf4eb9c3ab526675c0117da68) --- nexus-sdk/guides/math-branching-with-chat.md | 2 +- tools/storage-walrus/README.md | 46 +++++++++++++++++--- 2 files changed, 40 insertions(+), 8 deletions(-) diff --git a/nexus-sdk/guides/math-branching-with-chat.md b/nexus-sdk/guides/math-branching-with-chat.md index dddc283..b4e388a 100644 --- a/nexus-sdk/guides/math-branching-with-chat.md +++ b/nexus-sdk/guides/math-branching-with-chat.md @@ -621,5 +621,5 @@ This extended DAG demonstrates how to combine mathematical computation with natu -[math-branching-entry-guide]: ./math-branching-dag-entry.md +[math-branching-entry-guide]: ./math_branching-dag-entry.md [llm-openai-chat-prep-tool]: ./llm-openai-chat-prep-tool.md diff --git a/tools/storage-walrus/README.md b/tools/storage-walrus/README.md index a2a4d92..7691dd0 100644 --- a/tools/storage-walrus/README.md +++ b/tools/storage-walrus/README.md @@ -10,11 +10,11 @@ The JSON data to upload. _opt_ **`publisher_url`: [`Option`]** _default_: [`None`] -The walrus publisher URL. +The Walrus publisher URL. Must be a valid URL with http:// or https:// scheme. If not provided, the default Walrus configuration will be used. _opt_ **`aggregator_url`: [`Option`]** _default_: [`None`] -The URL of the Walrus aggregator to upload the JSON to. +The Walrus aggregator URL. Must be a valid URL with http:// or https:// scheme. If not provided, the default Walrus configuration will be used. _opt_ **`epochs`: [`u64`]** _default_: [`1`] @@ -67,7 +67,7 @@ The path to the file to upload. _opt_ **`publisher_url`: [`Option`]** _default_: [`None`] -The walrus publisher URL. +The Walrus publisher URL. Must be a valid URL with http:// or https:// scheme. If not provided, the default Walrus configuration will be used. _opt_ **`epochs`: [`u64`]** _default_: [`1`] @@ -117,7 +117,7 @@ The blob ID of the JSON file to read. _opt_ **`aggregator_url`: [`Option`]** _default_: [`None`] -The URL of the Walrus aggregator to read the JSON from. +The Walrus aggregator URL. Must be a valid URL with http:// or https:// scheme. If not provided, the default Walrus configuration will be used. _opt_ **`json_schema`: [`Option`]** _default_: [`None`] @@ -152,6 +152,40 @@ The JSON read operation failed. --- +# `xyz.taluslabs.storage.walrus.read-file@1` + +Standard Nexus Tool that reads a file from Walrus and returns its content as bytes. + +## Input + +**`blob_id`: [`String`]** + +The unique identifier of the blob to read. + +_opt_ **`aggregator_url`: [`Option`]** _default_: [`None`] + +The Walrus aggregator URL. Must be a valid URL with http:// or https:// scheme. If not provided, the default Walrus configuration will be used. + +## Output Variants & Ports + +**`ok`** + +The file was read successfully. + +- **`ok.bytes`: [`Vec`]** - The file content as a byte array + +**`err`** + +The file read operation failed. + +- **`err.reason`: [`String`]** - A detailed error message describing what went wrong +- **`err.kind`: [`ReadErrorKind`]** - Type of error that occurred + - Possible kinds: + - `network` - Error during HTTP requests or network connectivity issues +- **`err.status_code`: [`Option`]** - HTTP status code if available (for network errors) + +--- + # `xyz.taluslabs.storage.walrus.verify-blob@1` Standard Nexus Tool that verifies a blob in Walrus. @@ -164,7 +198,7 @@ The ID of the blob to verify. _opt_ **`aggregator_url`: [`Option`]** _default_: [`None`] -The URL of the Walrus aggregator to verify the blob against. +The Walrus aggregator URL. Must be a valid URL with http:// or https:// scheme. If not provided, the default Walrus configuration will be used. ## Output Variants & Ports @@ -189,5 +223,3 @@ An error occurred during verification. - Possible kinds: - `server` - Server-side errors during verification - **`err.status_code`: [`Option`]** - HTTP status code if available (for API errors) - ---- From d751020335d10576d80331ee0a9ed364f8adc90b Mon Sep 17 00:00:00 2001 From: Thomas Dekeyser Date: Fri, 16 May 2025 16:24:02 +0200 Subject: [PATCH 2/2] fix workflow and undo broken link --- .github/workflows/add_new_files_summary.yml | 1 - nexus-sdk/guides/math-branching-with-chat.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/add_new_files_summary.yml b/.github/workflows/add_new_files_summary.yml index 6775270..dbb5c9b 100644 --- a/.github/workflows/add_new_files_summary.yml +++ b/.github/workflows/add_new_files_summary.yml @@ -117,7 +117,6 @@ jobs: if: env.new_entries != '' uses: actions/github-script@v6 with: - github-token: ${{ secrets.GH_ACCESS_TOKEN }} script: | const issue_number = context.payload.pull_request.number; const body = `⚠️ **TODO:** These new files need to be categorized properly in \`SUMMARY.md\`! diff --git a/nexus-sdk/guides/math-branching-with-chat.md b/nexus-sdk/guides/math-branching-with-chat.md index b4e388a..dddc283 100644 --- a/nexus-sdk/guides/math-branching-with-chat.md +++ b/nexus-sdk/guides/math-branching-with-chat.md @@ -621,5 +621,5 @@ This extended DAG demonstrates how to combine mathematical computation with natu -[math-branching-entry-guide]: ./math_branching-dag-entry.md +[math-branching-entry-guide]: ./math-branching-dag-entry.md [llm-openai-chat-prep-tool]: ./llm-openai-chat-prep-tool.md