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 --force-reinstall

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.9-cp311-abi3-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.11+Windows x86-64

lattica-1.0.9-cp311-abi3-manylinux_2_34_x86_64.whl (10.5 MB view details)

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

lattica-1.0.9-cp311-abi3-macosx_11_0_arm64.whl (7.8 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

lattica-1.0.9-cp311-abi3-macosx_10_12_x86_64.whl (8.2 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: lattica-1.0.9-cp311-abi3-win_amd64.whl
  • Upload date:
  • Size: 7.4 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.9-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 0b9fb746a5c0447659fa6de6485f0348e5382b24b4ea8797ef43137edf4442e4
MD5 55c281c5f82c6fb23325eb97d626bc4e
BLAKE2b-256 7bbf85f43e5f5c0edda20d3f1819fc04878c32d9771b18727310b91482b90f63

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lattica-1.0.9-cp311-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 de63b8f2768ba0f790fd653f02caa2306aabddfc015d0817c391b7d549ca596d
MD5 deec319152ede40a3fb73c236ee030cf
BLAKE2b-256 ba395423fd84f441a852e3bcd12a6e151cb72232767369a33b12ee27a0e9f6db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lattica-1.0.9-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9e44d1adc823b9bab15af7afe041f33dbfdc5a597e71a566648e7289e69e572d
MD5 fde529f6536ea912fa78d70da02eec48
BLAKE2b-256 8039d6c184459aa9b3f9f5cc84c984dd8a913d6639b8fedaed0639178d24ac69

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lattica-1.0.9-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 454064fb5b0715df51693cb5686cdb8fd50e02135e8b4f4d27d0c6321bea11a3
MD5 aab396381c29ac0ccd458413b861868e
BLAKE2b-256 c6dee807d7799c85864f83e515ca156c8d809a7e3571911f2072bfaa0cef26a4

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