Skip to main content

A unified Python SDK for P2P networking with integrated DHT and NAT capabilities

Project description

Lattica Python SDK

A unified Python SDK for P2P networking with integrated DHT and NAT capabilities, built on top of libp2p.

Features

  • Distributed Hash Table (DHT): Store and retrieve key-value pairs across the network
  • Remote Procedure Call (RPC): Execute remote functions with support for complex data types
  • Streaming RPC: Handle large data transfers with streaming capabilities
  • NAT Traversal: Automatic NAT traversal with UPnP support
  • Peer Discovery: mDNS and rendezvous-based peer discovery
  • High Performance: Built with Rust for optimal performance

Installation

You can install the released versions

pip install lattica

Or you can install from source using:

pip install git+https://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@github.com/OpenEdgeHQ/p2p-lattica.git#subdirectory=bindings/python

Quick Start

Basic Usage

from lattica import Lattica

# Create a Lattica instance
lattica = Lattica.builder().build()

# Get your peer ID
peer_id = lattica.peer_id()
print(f"My peer ID: {peer_id}")

Examples

1. DHT Operations

The DHT example demonstrates basic key-value storage and retrieval with subkey support.

from lattica import Lattica

# Create client1 as bootstrap node
lattica = Lattica.builder()
    .build()

# Create client2 with bootstrap nodes
lattica = Lattica.builder() \
    .with_bootstraps(["/ip4/127.0.0.1/tcp/54282/p2p/QmServerPeerId"]) \
    .build()

# Store a simple key-value pair with default expiration 10 minute
lattica.store("name", "alice")

# get the value
result = lattica.get("name")
if result:
    print(f"Value: {result.value}")
    print(f"Expires: {result.expiration_time}")


# Store values with subkeys (useful for voting, user data, etc.)
key = "peer_list"
peers = ["alice", "bob", "carol"]

# Each peer stores their vote with a subkey
lattica.store(key, "yes", expiration_time, subkey="alice")
lattica.store(key, "no", expiration_time, subkey="bob")
lattica.store(key, "maybe", expiration_time, subkey="carol")

# get all votes
votes_result = lattica.get(key)
if votes_result:
    for peer, vote_info in votes_result.value.items():
        print(f"{peer}: {vote_info.value}")

2. RPC Operations

The RPC example demonstrates remote procedure calls with support for complex data types and streaming.

from lattica import Lattica, rpc_method, rpc_stream, rpc_stream_iter, ConnectionHandler



class MyService(ConnectionHandler):
    @rpc_method
    def add(self, a: int, b: int) -> int:
        """Simple addition"""
        return a + b
    
    @rpc_stream
    def process_data(self, data: list) -> list:
        return data
    
    @rpc_stream_iter
    def stream_rpc_iter(self):
        while True:
            text = "hello world"
            yield text
            
# Create client1 as RPC server and bootstrap node
lattica = Lattica.builder()
    .build()
service = MyService(lattica)

# Create client2 with bootstrap nodes
lattica = Lattica.builder() \
    .with_bootstraps(["/ip4/127.0.0.1/tcp/54282/p2p/QmServerPeerId"]) \
    .build()
client_service = MyService(client_lattica)

# Make RPC calls
stub = client_service.get_stub(server_peer_id)
result = stub.add(10, 20)  # Returns 30

# Handle complex data types
num_floats = int(2 * 1024 * 1024 * 1024) // 8 #2GB
test_data = [random.random() for _ in range(num_floats)]
result = stub.process_data(test_data)

# stream iter call
for text in stub.stream_rpc_iter():
    print(f"recv: {text}")

Configuration

Builder Pattern

lattica = Lattica.builder() \
    .with_bootstraps([
        "/ip4/127.0.0.1/tcp/8080/p2p/QmBootstrap1",
        "/ip4/127.0.0.1/tcp/8081/p2p/QmBootstrap2"
    ]) \
    .with_listen_addrs(["/ip4/0.0.0.0/tcp/0", "/ip4/0.0.0.0/udp/0/quic-v1"])
    .with_external_addrs(["/ip4/0.0.0.0/tcp/0"])
    .with_mdns(True) \
    .with_upnp(True) \
    .build()

Configuration Options

  • with_bootstraps(nodes): Set bootstrap nodes for network discovery
  • with_listen_addrs(addrs): Set listening address
  • with_mdns(enabled): Enable/disable mDNS peer discovery
  • with_upnp(enabled): Enable/disable UPnP NAT traversal
  • with_relay_servers(servers): Set relay servers for network relay
  • with_autonat(enabled): Enable/disable AutoNAT detect[need relay servers]
  • with_dcutr(enabled): Enable/disable TCP/QUIC NAT travelsal[need relay servers]
  • with_external_addrs(addrs): Set external address
  • with_storage_path: Persistent storage path
  • with_key_path: Set Keypair path

Development

Building from Source

# Install maturin
pip install maturin

# Build the package
cd bindings/python
pip install .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

lattica-1.0.2-cp311-abi3-win_amd64.whl (6.9 MB view details)

Uploaded CPython 3.11+Windows x86-64

lattica-1.0.2-cp311-abi3-manylinux_2_34_x86_64.whl (9.8 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.34+ x86-64

lattica-1.0.2-cp311-abi3-macosx_11_0_arm64.whl (7.2 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

lattica-1.0.2-cp311-abi3-macosx_10_12_x86_64.whl (7.6 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

Details for the file lattica-1.0.2-cp311-abi3-win_amd64.whl.

File metadata

  • Download URL: lattica-1.0.2-cp311-abi3-win_amd64.whl
  • Upload date:
  • Size: 6.9 MB
  • Tags: CPython 3.11+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for lattica-1.0.2-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 1c40363d08c92c1506044b815146d4f33d8866fc352dd51b5280e87e80497649
MD5 2b60ea38be8776432a562989d6badfd6
BLAKE2b-256 b627f21bde1f688c34a79ab1456fbbb16aa403ce6a09d1fcbda911543794fdd6

See more details on using hashes here.

File details

Details for the file lattica-1.0.2-cp311-abi3-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for lattica-1.0.2-cp311-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 9231b880aa559013f9c286052df188094985aca59bb22016f2d9895b5afabd9d
MD5 787e016f9adcb070276bf470f367b0ed
BLAKE2b-256 8c0e7cbf87844e6a4ffac27a9e37a085bddb7aa43883ea24c54a25a3339ad0cd

See more details on using hashes here.

File details

Details for the file lattica-1.0.2-cp311-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for lattica-1.0.2-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 98a948bd55a8a75e7001375f365d07627df40e793839de3d5c714f81203daf6c
MD5 9f91b85630129b380a8f1908592192a4
BLAKE2b-256 a432eae1f56c80f3af4a883a0fbf36007c4068b3bac00c523b3dc1477da0871f

See more details on using hashes here.

File details

Details for the file lattica-1.0.2-cp311-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for lattica-1.0.2-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 2973ff78f175b2205936326acf750cfe1d9dcac08dd3851cb46f48a4eedd5e89
MD5 5b2e0b31fe25884787a8f06e90ca6b37
BLAKE2b-256 d694ea97aaba86ebc559a14a88a2eb12ab0edc27240fa1ab504e8cd024f05f92

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page