Parly SDK

What the SDK is

The SDK exists so developers can use Parly without rebuilding deterministic authentication, recovery identity derivation, note-envelope handling, note reconstruction, private-send construction, exact approval logic, indexed history reads, and outcome handling from scratch. It is intended for backend services, operator tooling, automation systems, and AI-agent stacks that need Parly-compatible private execution behavior.

Install

npm install @parly/sdk
pnpm add @parly/sdk

Initialize the SDK

import { ParlySDK, ParlyMppAdapter } from "@parly/sdk"

const sdk = new ParlySDK({
  privateKeyHex: integrationPrivateKey,
  tempoRpcUrl,
  tempoChainId: 4217,
  tempoLzEid: 4217,
  ponderGraphqlUrl
  privateKeyHex: process.env.AGENT_PRIVATE_KEY,
  tempoRpcUrl: process.env.TEMPO_RPC_URL,
  tempoChainId: 4217,
  tempoLzEid: 4217,
  ponderGraphqlUrl: process.env.PONDER_GRAPHQL_URL,
  proofAssetsBasePath: process.env.PARLY_SDK_ASSETS_PATH
})

const mpp = new ParlyMppAdapter(sdk, {
  serviceName,
  serviceVersion
})

Use credentials scoped to the integration or agent. Do not reuse treasury credentials, relayer credentials, or other privileged operational credentials inside application integrations.

What the SDK handles

The SDK includes support for:

deterministic recovery key derivation from the fixed auth message
note-envelope decryption
reconstruction of private state from indexed history
private payment flow construction
direct send path construction
private execution flow construction
direct execution path construction
same-chain batch send construction for up to 10 payout lanes
exact-amount approval handling
clear handling of uncertain or pending execution outcomes
optional MPP-compatible wrappers above the same send engine

MPP-compatible integration

Parly supports MPP compatibility through an adapter that wraps the existing execution engine. Create a session:

const session = await mpp.createSession({
  sessionId: "invoice-2026-03-27",
  counterparty: "0x1111111111111111111111111111111111111111",
  assetId: 1,
  spendLimit: "25.0",
  destinationEid,
  poolAddress
})

Settle from a session:

const outcome = await mpp.settleFromSession(
  {
    sessionId: session.sessionId,
    destination: "0x1111111111111111111111111111111111111111",
    amount: "25.0"
  },
  session
)

Preflight before settlement:

const preflight = mpp.preflightSessionPayment(
  {
    sessionId: session.sessionId,
    destination: "0x1111111111111111111111111111111111111111",
    amount: "25.0"
  },
  session
)

MPP session payments are bounded to the session counterparty and spend limit before proof generation or transaction submission. MPP sessions are counterparty-locked and spend-limit checked before proof work or settlement.

Batch sends

Use sendShieldedBatchPayment() for up to 10 same-chain payout lanes from a recovered private note. Cross-chain deposits are handled by Parly payment-route APIs. Cross-chain private sends should be used only where the active public route supports them.

Who the SDK is for

The SDK is intended for:

backend services
developer integrations
operator tooling
automation systems
machine-payment environments
agent stacks that integrate through the SDK

Getting Started

Product

Campaigns

Operators

Developers

Legal

What the SDK is

Install

Initialize the SDK

What the SDK handles

MPP-compatible integration

Batch sends

Who the SDK is for

​What the SDK is

​Install

​Initialize the SDK

​What the SDK handles

​MPP-compatible integration

​Batch sends

​Who the SDK is for

What the SDK is

Install

Initialize the SDK

What the SDK handles

MPP-compatible integration

Batch sends

Who the SDK is for