Skip to content

Commit d02945d

Browse files
authored
Update README.md with links to walrus
1 parent 8854b6d commit d02945d

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Walrus Python SDK
22

3-
The walrus-python SDK provides a Python client for interacting with the Walrus HTTP API. Walrus is a decentralized storage system built on the Sui blockchain, allowing you to store and retrieve blobs efficiently.
3+
The walrus-python SDK provides a Python client for interacting with the [Walrus HTTP API](https://docs.wal.app/usage/web-api.html). [Walrus](https://www.walrus.xyz/) is a decentralized storage system built on the Sui blockchain, allowing you to store and retrieve blobs efficiently.
44

55
[![PyPI](https://img.shields.io/pypi/v/walrus-python.svg)](https://pypi.org/project/walrus-python/)
66
[![License](https://img.shields.io/pypi/l/walrus-python.svg)](https://pypi.org/project/walrus-python/)
@@ -16,6 +16,8 @@ pip install walrus-python
1616

1717
### Initializing the Client
1818

19+
[List of public aggregators & publishers](https://docs.wal.app/usage/web-api.html#public-services)
20+
1921
```python
2022
from walrus import WalrusClient
2123

@@ -25,18 +27,17 @@ aggregator_url = "https://aggregator.walrus-testnet.walrus.space"
2527
client = WalrusClient(publisher_base_url=publisher_url, aggregator_base_url=aggregator_url)
2628
```
2729

28-
2930
### Uploading a Blob
3031

3132
#### Available Parameters
3233

3334
- `encoding_type` (*Optional[str]*): Specifies the encoding used for the blob.
3435

35-
- `epochs` (*Optional[int]*): Number of epochs ahead of the current one to store the blob.
36+
- `epochs` (*Optional[int], default: 1*): Number of epochs ahead of the current one to store the blob.
3637

37-
- `deletable` (*Optional[bool]*): Determines whether the blob can be deleted later (True) or is permanent (False).
38+
- `deletable` (*Optional[bool], default: False*): Determines whether the blob can be deleted later (True) or is permanent (False).
3839

39-
- `send_object_to` (*Optional[str]*): If provided, sends the Blob object to the specified Sui address.
40+
- `send_object_to` (*Optional[str]*): If provided, sends the Blob object to the specified Sui address. Default:
4041

4142
#### From Bytes
4243

0 commit comments

Comments
 (0)