Skip to content

Commit 2ae9b94

Browse files
devops-talusafarukcalitmsdkeys
authored
Docs update from nexus-sdk (#74)
* Update docs from nexus-sdk (commit: 76e90dcb319db06b2347e7029fd46d9af7d22745) * undo broken link --------- Co-authored-by: afarukcali <[email protected]> Co-authored-by: Thomas Dekeyser <[email protected]>
1 parent cb22aff commit 2ae9b94

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

tools/storage-walrus/README.md

+50
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,56 @@ The blob upload failed.
5555

5656
---
5757

58+
# `xyz.taluslabs.storage.walrus.upload-file@1`
59+
60+
Standard Nexus Tool that uploads a file to Walrus and returns the blob ID.
61+
62+
## Input
63+
64+
**`file_path`: [`String`]**
65+
66+
The path to the file to upload.
67+
68+
_opt_ **`publisher_url`: [`Option<String>`]** _default_: [`None`]
69+
70+
The walrus publisher URL.
71+
72+
_opt_ **`epochs`: [`u64`]** _default_: [`1`]
73+
74+
Number of epochs to store the file.
75+
76+
_opt_ **`send_to`: [`Option<String>`]** _default_: [`None`]
77+
78+
Optional address to which the created Blob object should be sent.
79+
80+
## Output Variants & Ports
81+
82+
**`newly_created`**
83+
84+
A new blob was created and uploaded successfully.
85+
86+
- **`newly_created.blob_id`: [`String`]** - The unique identifier for the uploaded blob
87+
- **`newly_created.end_epoch`: [`u64`]** - The epoch at which the blob will expire
88+
- **`newly_created.sui_object_id`: [`String`]** - Sui object ID of the newly created blob
89+
90+
**`already_certified`**
91+
92+
The blob was already certified in the blockchain.
93+
94+
- **`already_certified.blob_id`: [`String`]** - The unique identifier for the blob
95+
- **`already_certified.end_epoch`: [`u64`]** - The epoch at which the blob will expire
96+
- **`already_certified.tx_digest`: [`String`]** - Transaction digest of the certified blob
97+
98+
**`err`**
99+
100+
The file upload failed.
101+
102+
- **`err.reason`: [`String`]** - A detailed error message describing what went wrong
103+
- **`err.kind`: [`UploadErrorKind`]** - Type of error that occurred
104+
- Possible kinds:
105+
- `network` - Error during HTTP requests or network connectivity issues
106+
- `validation` - Invalid file data or file validation failures
107+
58108
# `xyz.taluslabs.storage.walrus.read-json@1`
59109

60110
Standard Nexus Tool that reads a JSON file from Walrus and returns the JSON data. The tool can also validate the JSON data against a provided schema.

0 commit comments

Comments
 (0)