pletyvo 0.0.0a6

Implementation of the client and protocols of the Pletyvo decentralized platform in Python

[!WARNING] This is an unstable version. Changes may be backwards incompatible

py-pletyvo

Typed, async‑first Python client for the Pletyvo decentralized platform and it's protocols (Python ≥ 3.9)

Install

pip install -U pletyvo

Usage

Engine

To begin using the client, you need to create an engine — the core component responsible for all communication with the Pletyvo gateway. You can create one using http.HTTPDefault:

from pletyvo.client import http

engine: http.abc.HTTPClient = http.HTTPDefault(
    config=http.Config(
        url="http://testnet.pletyvo.osyah.com",
        network="AAEAAAAB",
    ),
)

The http.Config accepts:

• url: The gateway endpoint.
• network | None: the network identifier encoded as a base64 string. By default, has an already set network on the node side

Service

A service is a high-level interface that aggregates protocol-specific HTTP services. This top-level object internally composes http.DAppService & http.DeliveryService. The service requires a signer — an object responsible for producing cryptographic signatures over event bodies. The signer must implement the dapp.abc.Signer interface.

from pletyvo.client import http

service = http.HTTPService.di(
    engine=engine,
    signer=signer,
)

Want full control?

You can instantiate each service manually by passing required dependencies.

from pletyvo.client import http

service = http.HTTPService(
    dapp=http.DAppService(
        hash=http.HashService(...),
        event=http.EventService(...),
    ),
    delivery=http.DeliveryService(
        channel=http.ChannelService(...),
        post=http.PostService(...),
        message=http.MessageService(...),
    )
)

Dependency graph

---
config:
  layout: elk
---
flowchart LR

  subgraph Dependencies
    dapp.abc.Signer["dapp.abc.Signer"]
    http.HTTPClient["http.HTTPClient"]
  end

  subgraph Services
    http.HashService["http.HashService"]
    http.EventService["http.EventService"]
    http.ChannelService["http.ChannelService"]
    http.PostService["http.PostService"]
    http.MessageService["http.MessageService"]
    http.DAppService["http.DAppService"]
    http.DeliveryService["http.DeliveryService"]
    http.HTTPService["http.HTTPService"]
  end

  dapp.abc.Signer --> http.ChannelService & http.PostService & http.MessageService
  http.HTTPClient --> http.HashService & http.EventService & http.ChannelService & http.PostService & http.MessageService

  http.EventService --> http.ChannelService & http.PostService & http.DAppService
  http.HashService --> http.DAppService

  http.ChannelService --> http.DeliveryService
  http.PostService --> http.DeliveryService
  http.MessageService --> http.DeliveryService

  http.DAppService --> http.HTTPService
  http.DeliveryService --> http.HTTPService

dApp

Platform docs: dApp

The dApp protocol defines how signed events are created, verified, and published on the Pletyvo network. Each dapp.Event consists of dapp.EventBody and a corresponding signature, both of which are required for persistence. You can create a dApp service using either the shorthand or manual constructor:

The dApp service itself does not construct or validate signatures — it only transmits fully-formed signed events.

from pletyvo.client import http

dapp_service = http.DAppService.di(
    engine=engine,
)
dapp_service = http.DAppService(
    hash=http.HashService(...),
    event=http.EventService(...),
)

Cryptography: signing with dapp.AuthHeader

Most dApp calls that create or update data must be signed with an ED25519 keypair; read‑only requests work without it.

py‑pletyvo lets you obtain a keypair from a random seed, raw bytes, or a file. If you prefer BIP‑39 mnemonics, generate a seed with an external helper such as osyah/homin and load it into the signer.

from pletyvo.protocol import dapp

signer: dapp.abc.Signer

signer = dapp.ED25519.gen()
signer = dapp.ED25519.from_file(...)
signer = dapp.ED25519(...)

Pletyvo: decentralized applications (UA)

Delivery

Platform docs: Delivery

The delivery layer exposes three narrow services — http.ChannelService, http.PostService, and http.MessageService — bundled under http.DeliveryService.

from pletyvo.client import http

delivery_service = http.DeliveryService.di(
    engine=engine,
    signer=signer,
    event=event_service,
)
delivery_service = http.DeliveryService(
    channel=http.ChannelService(...),
    post=http.PostService(...),
    message=http.MessageService(...),
)