Installation

cairn is available for five languages. Pick yours and follow the steps below.

Prerequisites

Language	Version	Package Manager	Install Command
Rust	1.75+	Cargo	cargo add cairn-p2p
TypeScript	Node 18+	npm	npm install cairn-p2p
Go	1.24+	Go modules	go get github.com/moukrea/cairn/packages/go/cairn-p2p
Python	3.11+	pip	pip install cairn-p2p
PHP	8.2+	Composer	composer require moukrea/cairn-p2p

Install

Rust

cargo add cairn-p2p

TypeScript

npm install cairn-p2p

Go

go get github.com/moukrea/cairn/packages/go/cairn-p2p

Python

pip install cairn-p2p

PHP

composer require moukrea/cairn-p2p

Verify Your Installation

Create a node and print your peer ID to confirm everything is working:

Rust

use cairn_p2p::{Node, CairnConfig, create};

let node = create(CairnConfig::default())?;
node.start().await?;
println!("Peer ID: {}", node.peer_id());

TypeScript

import { Node } from 'cairn-p2p';

const node = await Node.create();
console.log(`Peer ID: ${node.peerId}`);

Go

import cairn "github.com/moukrea/cairn/packages/go/cairn-p2p"

node, err := cairn.Create()
if err != nil { log.Fatal(err) }
fmt.Println("Peer ID:", node.PeerID())

Python

from cairn import create

node = await create()
print(f"Peer ID: {node.peer_id}")

PHP

use Cairn\Node;

$node = Node::create();
echo "Peer ID: " . $node->peerId() . "\n";

Common Issues

Rust

• Minimum edition: cairn requires Rust edition 2021 or later. Make sure your Cargo.toml has edition = "2021" or newer.
• Async runtime: cairn uses Tokio. Ensure you have tokio as a dependency with the full feature enabled.

TypeScript

• Node version: cairn requires Node.js 18 or later. Run node --version to check.
• ESM vs CJS: cairn ships as ESM. If your project uses CommonJS, you may need to adjust your tsconfig.json or use dynamic import().

Go

• Module proxy: If go get fails, try setting GOPROXY=https://proxy.golang.org,direct.
• Go version: cairn requires Go 1.24+. Run go version to check.

Python

• Async required: cairn uses async/await. You need Python 3.11+ and an async runtime like asyncio.
• Virtual environment: It is recommended to install cairn inside a virtual environment (python -m venv .venv).

PHP

• PHP version: cairn requires PHP 8.2+. Run php --version to check.
• FFI extension: cairn uses PHP FFI to call the native Rust core. Make sure the ffi extension is enabled in your php.ini.