Skip to content

Commit 53d2895

Browse files
committed
docs: add readme
1 parent 916e4ab commit 53d2895

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
## About
2+
3+
`blobscan-agent` is a hybrid data agent built at the intersection of ao compute, HyperBEAM's temporal S3 data storage, and Arweave's permanent storage.
4+
5+
The agent stores Ethereum's blobs temporarily on the [~s3@1.0 HyperBEAM device](https://github.com/loadnetwork/load_hb/tree/s3-edge/native/s3_nif), serialized as [ANS-104 DataItems](https://github.com/ArweaveTeam/arweave-standards/blob/master/ans/ANS-104.md). Based on need/demand, DataItems can be deterministically pushed to Arweave while maintaining integrity and provenance.
6+
7+
DataItems stored on the `~s3@1.0` device can be retrieved from the Hybrid Gateway as if they are Arweave txs: https://github.com/loadnetwork/load_hb/tree/s3-edge/native/s3_nif#hybrid-gateway
8+
19
## Build & Run
210

311
```bash
@@ -8,20 +16,25 @@ cd blobscan-agent
816
cargo +nightly fmt && cargo clippy --all-targets --all-features && cargo run --release
917
```
1018

11-
## Server Methods
19+
## Agent Server Methods
1220

13-
### Retrieve blob versioned hash and the associated ANS-104 dataitem id by VersionedHash
21+
### Retrieve blob versioned hash and the associated ANS-104 dataitem id by versioned hash
1422

1523
```bash
1624
curl -X GET https://blobscan.load.rs/v1/blob/$BLOB_VERSIONED_HASH
1725
```
1826

19-
2027
### Retrieve Indexer stats
2128

2229
```bash
2330
curl -X GET https://blobscan.load.rs/v1/stats
2431
```
2532

33+
### Agent's server info
34+
35+
```bash
36+
curl -X GET https://blobscan.load.rs/v1/info
37+
```
38+
2639
## License
2740
This project is licensed under the [MIT License](./LICENSE)

0 commit comments

Comments
 (0)