Skip to main content

API Reference

All public exports from p2pass.

UI Components​

import { P2Pass, P2PassPanel } from 'p2pass';
// React
import { P2Pass, P2PassPanel } from 'p2pass/react';

Identity​

import { IdentityService, detectSigningMode, getStoredSigningMode } from 'p2pass';
ExportDescription
IdentityServiceClass — WebAuthn identity orchestrator
detectSigningMode(options?)Auto-detect hardware vs worker signing mode
getStoredSigningMode(registryDb?)Get cached mode without biometric prompt

UCAN / Storacha Auth​

import {
  createStorachaClient,
  parseDelegation,
  storeDelegation,
  loadStoredDelegation,
  clearStoredDelegation,
} from 'p2pass';
ExportDescription
createStorachaClient(principal, delegation)Create authenticated Storacha client
parseDelegation(proofString)Parse delegation (multibase, base64, CAR)
storeDelegation(base64, registryDb?, spaceDid?)Persist delegation
loadStoredDelegation(registryDb?)Load persisted delegation
clearStoredDelegation(registryDb?, base64?)Remove delegation(s)

Device Registry​

import {
  openDeviceRegistry,
  registerDevice,
  listDevices,
  getDeviceByCredentialId,
  getDeviceByDID,
  grantDeviceWriteAccess,
  revokeDeviceAccess,
  storeDelegationEntry,
  listDelegations,
  getDelegation,
  removeDelegation,
  storeArchiveEntry,
  getArchiveEntry,
  storeKeypairEntry,
  getKeypairEntry,
  listKeypairs,
  hashCredentialId,
  coseToJwk,
} from 'p2pass';

Multi-Device Manager​

import { MultiDeviceManager } from 'p2pass';

Pairing Protocol​

import {
  LINK_DEVICE_PROTOCOL,
  registerLinkDeviceHandler,
  unregisterLinkDeviceHandler,
  sendPairingRequest,
  detectDeviceLabel,
} from 'p2pass';

P2P Stack​

import { setupP2PStack, createLibp2pInstance, createHeliaInstance, cleanupP2PStack } from 'p2pass';
ExportDescription
setupP2PStack(credential?, options?)Full stack: libp2p + Helia + OrbitDB
createLibp2pInstance()libp2p only (before auth)
createHeliaInstance(libp2p)Helia IPFS node
cleanupP2PStack(stack)Shutdown everything

Recovery​

import {
  deriveIPNSKeyPair,
  computeDeterministicPrfSalt,
  recoverPrfSeed,
  createManifest,
  publishManifest,
  resolveManifest,
  resolveManifestByName,
  uploadArchiveToIPFS,
  fetchArchiveFromIPFS,
} from 'p2pass';

Backup​

import { backupRegistryDb, restoreRegistryDb } from 'p2pass';

Storacha Utilities​

import { listSpaces, getSpaceUsage, listStorachaFiles } from 'p2pass';