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

Uploaded CPython 3.11+Windows x86-64

lattica-1.0.3-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.3-cp311-abi3-macosx_11_0_arm64.whl (7.2 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

lattica-1.0.3-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.3-cp311-abi3-win_amd64.whl.

File metadata

  • Download URL: lattica-1.0.3-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.3-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 14d3dfd550049869a1f3627adfb4e5af271849750ea2891c04f49f41ed4c3952
MD5 56d0ecbe0b9759bfdaccf34aebdc9222
BLAKE2b-256 87ef956c16ee1aa095d094c116ee5d4aa2c8d1cfa5038abb0c40a7dd38a99859

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lattica-1.0.3-cp311-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 ba1027e27c5a6d0b9f017d5d9b1bb391a8d755bfdbc32343795ecefefedebba8
MD5 11af62b89022d1e057a95bc0d8d9ff8d
BLAKE2b-256 f39464223b306c7bbefc48726bf4942ae1b1924f8a45832ac980ddbf3ccf601c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lattica-1.0.3-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1d6c389c94e0313b3646bbddbb261e1c6d06f9d78760d432a16e7e27453c4aa4
MD5 6810c614d78cfc01c44e1dedb51798c7
BLAKE2b-256 4baee5760bd729effebd5726e957c7b9fcde27d518908d6539a3efa0377310e9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lattica-1.0.3-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a754c2ebafd4c7f801b3e63cbf1d4e28631c6050b3f597736104517908c0a6c9
MD5 040a4d3d8fee727255182b53c343e842
BLAKE2b-256 223cfc8283e42bd288375a7e7f68e7e336ac7973c7ad6c72cf234b7e1a6326d4

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