Skip to content

Update README.md with links to walrus #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
piratekev merged 1 commit into from
Apr 9, 2025
Merged

Update README.md with links to walrus #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Walrus Python SDK

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.
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.

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

### Initializing the Client

[List of public aggregators & publishers](https://docs.wal.app/usage/web-api.html#public-services)

```python
from walrus import WalrusClient

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


### Uploading a Blob

#### Available Parameters

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

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

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

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

#### From Bytes

Expand Down