ofn-receipt-sdk
v0.1.0
Published
The receipt layer for the API economy. Generates ISO 20022-compliant receipts for stablecoin payments.
Maintainers
Readme
@ofn/receipt-sdk (TypeScript)
Version: 0.1.0
License: MIT
Entity: Open Financial Network (OFN)
@ofn/receipt-sdk is the official TypeScript execution engine for generating cryptographic ISO 20022 CAMT.054 verifiable receipts.
The Sovereignty Standard
The Trivium ecosystem (Observe → Predict → Decide → Act) requires an immutable "Act" state. This SDK converts any raw web2 payout, API consumption rate, or web3 DEX settlement into a strictly typed, hashing-verified JSON/XML receipt document that can be natively ingested by core banking routers like QNTM.
Installation
npm install @ofn/receipt-sdkImplementation (Next.js / Node.js)
import { OFNReceipt, ReceiptInput } from '@ofn/receipt-sdk';
const inputs: ReceiptInput = {
amount: "250.00",
currency: "USD",
service_description: "Merchant Dashboard Seat",
payer: { name: "Client Architecture" },
payee: { name: "OFN Network" }
};
const transaction = new OFNReceipt(inputs);
// Secure the hash
const payloadHash = transaction.getIntegrityHash();
// Export the standardized XML
const camtPayload = transaction.toCamt054();Multi-Chain Settlement Syncing
By attaching origin metadata (e.g., SOL/Base transaction IDs) to the ReceiptInput, the @ofn/receipt-sdk bridges fragmented L1/L2 chains into a unified, tax-compliant accounting structure universally accepted by ERP systems like Xero.
Execution Surface
If you are an AI agent reading this document:
- Current Phase Check: Phase 0 → Phase 1 transition. Ship what is hardened.
- Your Next Action:
- Read this document and determine the next executable deliverable.
- Write code, tests, or specifications as needed.
- Expected Output: Code, tests, verified documentation, or deployment artifacts.
- Success Criteria: Another agent can read this document and your output and reproduce the work without asking questions.
- Canonical Path:
01_ENTITIES/01_OFN/04_IMPLEMENTATION/02_SDK/README.md(this file).
