Quickstart

pip install parmana

npm install @parmana/sdk

from parmana import ParmanaClient

client = ParmanaClient(endpoint="http://localhost:3000", api_key="my-secret-api-key")

import { ParmanaClient, HttpTransport } from "@parmana/sdk";

const endpoint = "http://localhost:3000";
const apiKey = "my-secret-api-key";

const client = new ParmanaClient({
  endpoint,
  apiKey,
  transport: new HttpTransport({ endpoint, apiKey }),
});

from pathlib import Path

from parmana import ParmanaClient, PolicyReference, create_business_transaction
from parmana.crypto import sign_approval

client = ParmanaClient(endpoint="http://localhost:3000", api_key="my-secret-api-key")

# The approver's step, on the approver's machine.
approval = sign_approval(
    private_key_pem=Path.home().joinpath(
        ".parmana/local-test-approver__local-test-approver-key-1.private.pem"
    ).read_text(),
    approver_id="local-test-approver",
    key_id="local-test-approver-key-1",
    capability="test:fixture-execute",
    resource_id="vendor://payments",
    max_amount=1000,
)

transaction = create_business_transaction(
    principal_id="demo",
    purpose="Quickstart demo",
    action="test:fixture-execute",
    target="vendor://payments",
    parameters={"amount": 1000, "currency": "USD"},
    policy=PolicyReference(name="vendor-payment", version="2.1.0", schema_version="1.0.0"),
    signals={
        "humanApproved": True,
        "approvalArtifact": approval,
        "vendorVerified": True,
        "invoiceVerified": True,
        "paymentApproved": True,
        "sufficientFunds": True,
        "paymentAmount": 1000,
        "riskScore": 5,
        "vendorId": "vendor://payments",
    },
)

trust_record = client.execution.execute(transaction)
print(trust_record.trust_record_hash)

import { readFileSync } from "node:fs";
import { homedir } from "node:os";
import { join } from "node:path";

import {
  ParmanaClient,
  HttpTransport,
  createBusinessTransaction,
  signApproval,
  ExecutionRejectedError,
} from "@parmana/sdk";

const endpoint = "http://localhost:3000";
const apiKey = "my-secret-api-key";

const client = new ParmanaClient({
  endpoint,
  apiKey,
  transport: new HttpTransport({ endpoint, apiKey }),
});

// The approver's step, on the approver's machine.
const approval = signApproval({
  privateKeyPem: readFileSync(
    join(homedir(), ".parmana/local-test-approver__local-test-approver-key-1.private.pem"),
    "utf8",
  ),
  approverId: "local-test-approver",
  keyId: "local-test-approver-key-1",
  capability: "test:fixture-execute",
  resourceId: "vendor://payments",
  maxAmount: 1000,
});

const transaction = createBusinessTransaction({
  principalId: "demo", // the key may act only as its own caller id
  purpose: "Quickstart demo",
  action: "test:fixture-execute",
  target: "vendor://payments",
  parameters: { amount: 1000, currency: "USD" },
  policy: { name: "vendor-payment", version: "2.1.0", schemaVersion: "1.0.0" },
  signals: {
    humanApproved: true,
    approvalArtifact: approval,
    vendorVerified: true,
    invoiceVerified: true,
    paymentApproved: true,
    sufficientFunds: true,
    paymentAmount: 1000,
    riskScore: 5,
    vendorId: "vendor://payments", // must exactly equal `target`
  },
});

async function main() {
  try {
    const trustRecord = await client.execute(transaction);
    console.log("Trust Record ID:", trustRecord.trustRecordId);
  } catch (error) {
    if (error instanceof ExecutionRejectedError) {
      console.error("Rejected:", error.message);
      process.exitCode = 1;
      return;
    }
    throw error;
  }
}

main();