Skip to content

Commit a76da26

Browse files
committed
update readme
1 parent 7ebce77 commit a76da26

File tree

1 file changed

+10
-19
lines changed

1 file changed

+10
-19
lines changed

ipc-storage/README.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50,19 +50,13 @@ export SECRET_KEY_FILE=./test-network/keys/alice.sk
5050
./target/release/gateway --bls-key-file $BLS_KEY_FILE --secret-key-file $SECRET_KEY_FILE --iroh-path ./iroh_gateway --objects-listen-addr 0.0.0.0:8080
5151

5252
```
53-
## 6. Download the Blob
5453

55-
Download via HTTP API:
54+
## 3. Launch ipc-dropbox
55+
Launch `ipc-dropbox` in `ipc-storage/ipc-dropbox` with `npm run dev`.
5656

57-
```bash
58-
# Download the blob
59-
curl $NODE_OPERATION_OBJECT_API/v1/blobs/${BLOB_HASH#0x}/content
60-
# You should see the original file
61-
```
57+
Alternatively, run the below bash script to go through the steps one by one.
6258

63-
---
64-
65-
## 1. Create a Bucket
59+
## 3. Create a Bucket
6660

6761
First, create a bucket via the ADM (Actor Deployment Manager):
6862

@@ -90,10 +84,7 @@ echo "Bucket created at: $BUCKET_ADDR"
9084
export BUCKET_ADDR
9185
```
9286

93-
## 2. Upload and Register an Object
94-
95-
### Step 2a: Upload file to Iroh (same as basic flow)
96-
87+
## 4. Upload and Register an Object
9788
```bash
9889
# Create a test file
9990
echo "Hello from bucket storage!" > myfile.txt
@@ -147,7 +138,7 @@ echo "Metadata Hash: $METADATA_HASH"
147138
echo "Source Node: $SOURCE_NODE"
148139
```
149140

150-
### Step 2b: Register object in bucket with a path
141+
### Register object in bucket with a path
151142

152143
```bash
153144
# Add object with a path-based key
@@ -162,7 +153,7 @@ cast send $BUCKET_ADDR "addObject(bytes32,string,bytes32,bytes32,uint64)" \
162153
--rpc-url $ETH_RPC
163154
```
164155

165-
## 3. Query Objects
156+
## 5. Query Objects
166157

167158
### Get a single object by path
168159

@@ -231,7 +222,7 @@ cast call $BUCKET_ADDR "queryObjects(string,string,string,uint64)" \
231222

232223
---
233224

234-
## 4. Update Object Metadata
225+
## 6. Update Object Metadata
235226

236227
```bash
237228
# Update metadata for an existing object
@@ -245,7 +236,7 @@ cast send $BUCKET_ADDR "updateObjectMetadata(string,(string,string)[])" \
245236

246237
---
247238

248-
## 5. Delete an Object
239+
## 7. Delete an Object
249240

250241
```bash
251242
# Delete object by path
@@ -256,7 +247,7 @@ cast send $BUCKET_ADDR "deleteObject(string)" "documents/myfile.txt" \
256247

257248
---
258249

259-
## 6. Download Content
250+
## 8. Download Content
260251

261252
Downloads still go through the Iroh/Objects API using the blob hash:
262253

0 commit comments

Comments
 (0)