DOCUMENTATION_v2.0

Documentation

Quick starts, protocol references and operator guides for giving agents storage, identity and memory.

Quick start

🧠

Install semantic memory

Give an agent memory that survives restarts

npm install @palimesh/claw-mem
πŸͺͺ

Register a DID

Create a did:coc identity and configure guardians

npm install @palimesh/palimesh-soul
palimesh-soul register --guardians 3
πŸ“¦

Upload content

IPFS-compatible API, optional erasure coding

curl -F file=@state.tar \
  'http://127.0.0.1:5001/api/v0/add?erasure=4+2'

Core documentation

πŸ“„ Storage technical paper

Seven layers, four algorithms and the cross-continent destruction test

πŸ•ΈοΈ P2P storage mechanism

pushToK, fetchRemote, repairTick and DHT provider records

πŸͺͺ DID method specification

The W3C DID Core method definition for did:coc

🧬 Soul backup and recovery

Incremental Merkle snapshots, the Carrier network and the resurrection state machine

Developer guides

πŸ€–

Agent operations

  • βœ“OpenClaw reference integration (one reference implementation, not the only one)
  • βœ“Automatic memory capture and retrieval
  • βœ“Policy engine configuration
  • βœ“Security best practices
πŸ’Ύ

Running a storage node

  • βœ“Reuse the chain node and its $PALI bond
  • βœ“Capacity declaration and storageGb
  • βœ“Answering PoSe storage challenges
  • βœ“Claiming earnings in $MESH
πŸ”Œ

SDK reference

  • βœ“@palimesh/palimesh-soul API
  • βœ“@palimesh/claw-mem API
  • βœ“IPFS-compatible HTTP API
  • βœ“CidRegistry resolution
πŸ”—

Settlement layer

  • βœ“Chain parameters (RPC / faucet) are on Palium
  • βœ“StorageRewardManager claim flow
  • βœ“$MESH payment split 70 / 20 / 10
  • βœ“Deployed contract addresses

Implementation Status

Chain engine🟒 Complete

Block production, mempool, snapshots, finality

P2P network🟒 Complete

HTTP gossip + TCP Wire + Kademlia DHT, BFT dual transport, per-peer dedup

EVM execution🟒 Complete

EthereumJS + revm dual pipeline, Cancun/EIP-4844, LevelDB

JSON-RPC🟒 Complete

77+ standard methods, BigInt serialization, structured error codes

WebSocket RPC🟒 Complete

eth_subscribe, real-time events

PoSe protocol🟒 Complete (v1 + v2)

PoSeManagerV2, EIP-712, witness selection, fault proofs, Merkle reward tree, 9-layer receipt validation

DID / SoulRegistry🟒 Complete

W3C did:coc, capability bitmask, ≀3-hop delegation, 2/3 guardian recovery

Storage layer🟒 Complete

IPFS-compatible HTTP API + CidRegistry

Runtime services🟑 In progress

palimesh-node, palimesh-agent, palimesh-relayer integration

Test coverage🟒 Healthy

1300+ tests, 100+ files across node / services / runtime / contracts / extensions

See the project README for the full implementation status

View on GitHub

Developer Tools

πŸ’Ό CLI Wallet

Command-line wallet tool

  • β–ΈCreate addresses
  • β–ΈTransfers
  • β–ΈBalance queries

πŸ” Block Explorer

Full-featured web explorer

  • β–ΈBlock / tx lookup
  • β–ΈContract calls
  • β–ΈStorage scanner
Open tool β†’β†’

πŸ§ͺ Test Scripts

Quality-assurance tools

  • β–ΈUnit tests
  • β–ΈIntegration tests
  • β–ΈE2E tests
PaliMesh Β· Decentralized storage for AI agents