TypeScript SDK Quickstart

npm install

npm run generate:gateway-keys

NODE_ENV=test \
  PARMANA_STORAGE=memory \
  PARMANA_POLICY_DIR=/absolute/path/to/policies \
  npm run dev

curl http://localhost:3000/health
# {"status":"UP"}

curl http://localhost:3000/version -H "Authorization: Bearer my-secret-api-key"
# {"name":"Parmana","version":"0.4.0","api":"v1"}

npm install @parmana/sdk

import {
  ParmanaClient,
  HttpTransport,
  createBusinessTransaction,
  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 }),
});

const transaction = createBusinessTransaction({
  principalId: "typescript-sdk-quickstart",
  purpose: "Quickstart demo",
  action: "test:fixture-execute",
  target: "vendor://payments",
  parameters: { amount: 1000, currency: "USD" },
  policy: { name: "vendor-payment", version: "2.0.0", schemaVersion: "1.0.0" },
  signals: {
    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("Business Transaction ID:", transaction.businessTransactionId);
    console.log("Trust Record ID:        ", trustRecord.trustRecordId);
    console.log("Signature Algorithm:    ", trustRecord.signature.algorithm);
    console.log(JSON.stringify(trustRecord, null, 2));
  } catch (error) {
    if (error instanceof ExecutionRejectedError) {
      console.error("Rejected:", error.message);
      process.exitCode = 1;
      return;
    }
    throw error;
  }
}

main();

npx tsx quickstart.ts

{
  "trustRecordId": "2d26aaec-e274-4255-8415-d93b672747b4",
  "businessTransactionId": "435e1c86-d2ed-4f4d-8549-aee574d1c77d",
  "transaction": {
    "businessTransactionId": "435e1c86-d2ed-4f4d-8549-aee574d1c77d",
    "authority": {
      "authorityId": "5c6df777-3685-4b5e-9378-3433388cf9d6",
      "authorityType": "SERVICE",
      "principalId": "alice@example.com",
      "issuedAt": "2026-09-14T17:12:04.538Z"
    },
    "intent": {
      "action": "test:fixture-execute",
      "target": "vendor/vendor-123",
      "parameters": { "amount": 100, "currency": "USD" }
    },
    "policy": {
      "name": "vendor-payment",
      "version": "2.0.0",
      "schemaVersion": "1.0.0"
    },
    "status": "RECEIVED"
  }
}