dweb 0.2.0

No project description provided

dweb

dweb → use the Autonomi network as a global datalake where you can just throw in data and retrieve it from anywhere.

Wrapper around autonomi-client to simplify fetching immutable public data with async and sync APIs, and to publish data using a convenient wallet flow driven by an Ethereum private key (SECRET_KEY).

• Async: dweb.aio
• Sync: dweb
• Networks: from dweb import network → network.mainnet (default) or network.alpha

Install

poetry install --with test,notebooks

Usage

Sync (read)

from dweb import autonomi, network
content = autonomi.get("a7d2fdbb975efaea25b7ebe3d38be4a0b82c1d71e9b89ac4f37bc9f8677826e0", network=network.alpha)
with open("dogfile.jpg", "wb") as f:
    f.write(content)

Async (read)

import asyncio
from dweb.aio import autonomi
from dweb import network

async def main():
    data = await autonomi.get("a7d2fdbb975efaea25b7ebe3d38be4a0b82c1d71e9b89ac4f37bc9f8677826e0", network=network.mainnet)
    print(len(data))

asyncio.run(main())

Sync (write)

from dweb import autonomi, network

data = b"this is some test data"
cost, addr = autonomi.put(data, network=network.alpha)  # public by default
print(cost, addr)

# private upload (no datamap)
cost_private, _ = autonomi.put(data, network=network.alpha, private=True)

Async (write)

import asyncio
from dweb.aio import autonomi
from dweb import network

async def main():
    data = b"this is some test data"
    cost, addr = await autonomi.put(data, network=network.alpha)
    print(cost, addr)

asyncio.run(main())

Wallet & balances

Wallet initialization follows this hierarchy:

1. If a .env in the current working directory defines SECRET_KEY (mainnet) and/or SECRET_KEY_ALPHA (alpha), those keys are used accordingly
2. Else if the environment defines SECRET_KEY and/or SECRET_KEY_ALPHA, they are used
3. Else you will be prompted via masked input to enter SECRET_KEY

You can also set the key programmatically (highest priority, overrides the above for both networks):

from dweb import autonomi
autonomi.set_secret_key("0xABCDEF...")

Check balances:

from dweb import autonomi, network

aut_balance = autonomi.balance  # AUTONOMI token (float)
eth_arb_balance = autonomi.gas  # ETH(Arb) (float)

# or explicitly per network / with timeout
aut_balance_alpha = autonomi.get_balance(network=network.alpha)
eth_arb_balance_alpha = autonomi.get_gas(network=network.alpha)

# wallet address (string)
addr = autonomi.wallet
addr_alpha = autonomi.get_wallet_address(network=network.alpha)

Notes:

• Balances are normalized to human units by dividing raw on-chain values by 1e18
• If either AUTONOMI or ETH(Arb) balance is zero, a warning is emitted; uploads may fail
• Costs returned by put are floats (AUTONOMI), addresses are hex strings

Autocomplete:

• The package ships with type stubs and a py.typed marker so that IDEs can offer completions for autonomi.balance, autonomi.gas, and autonomi.wallet. If completion doesn’t appear, reindex the project or ensure your environment uses the installed package (not an untyped copy).

Tests (Alpha network)

• Provide .env with AUTONOMI_TEST_ADDRESS.
• Run unit tests: poetry run pytest -m "not alpha"
• Run alpha tests: poetry run pytest -m alpha

Reference: https://pypi.org/project/autonomi-client/

What is dweb (decentralized web)?

"dweb" is a small, ergonomic wrapper that lets your application interact with the decentralized Autonomi network as if it were a single, global data service. You can read from and (soon) write to globally addressable immutable data without running servers, without coordinating networks between participants, and without account-bound storage quotas or subscriptions. Producers and consumers of data do not need to be in the same local network or share infrastructure.

Key ideas:

• Global addressing via deterministic content/data map addresses
• Public, immutable data fetch with a single call (sync or async)
• No app servers to manage for reads; the network serves the data
• Writers and readers can be completely decoupled in time and space

How it works (high level)

flowchart LR
    A[Your App] -- sync/async --> B[dweb wrapper]
    B -- uses --> C[autonomi-client]
    C -- connects --> D{Autonomi Network}
    D -- mainnet/alpha --> E[(Immutable Data)]

    subgraph Notes
    N1[Data is addressed by its data map address (64-hex)]
    N2[Readers do not need to know writers or share infra]
    N3[No app server required for public reads]
    end
    B -. future .-> F[[Convenience writes]]
    F -. put helpers .-> D

With dweb, fetching public content by its data map address is one call. Think of it as pulling a blob from a global, decentralized datastore.

Concept: storing and retrieving data

• Reading (available today): Provide a 64-hex data map address and the network (default mainnet). You receive raw bytes of the immutable object.
• Writing (planned convenience): The wrapper will expose simple helpers to publish immutable data via the underlying autonomi-client so your app can store content without handling low-level details.

Properties:

• Decentralized: No single server you own or operate for public reads
• Global: Any participant can read the same address anywhere
• Durable: Immutable data is content-addressed; readers get the exact bytes referenced

Note: Actual network policies and costs are determined by the Autonomi network and client library. The wrapper does not impose subscription fees or quotas itself.

Notebook display example

from IPython.display import Image, display
from dweb import autonomi, network

addr = "a7d2fdbb975efaea25b7ebe3d38be4a0b82c1d71e9b89ac4f37bc9f8677826e0"
content = autonomi.get(addr, network=network.alpha)
display(Image(data=content))