Skip to content

quickstart.md

Latest commit

 

History

History
76 lines (50 loc) · 2.24 KB

quickstart.md

File metadata and controls

76 lines (50 loc) · 2.24 KB

MPCP Quickstart (5 minutes)

Get the full MPCP artifact chain running locally in under 5 minutes.

Prerequisites

  • Node.js 18+
  • npm

1. Clone and Install

git clone https://github.com/mpcp-protocol/mpcp-reference.git
cd mpcp-reference
npm install

2. Build

npm run build

3. Generate the Artifact Chain

Run the parking session example. This creates ephemeral keys, generates the full MPCP chain, writes artifacts to disk, and runs verification.

npm run example:parking

You should see verification pass (exit 0). The script writes artifacts to examples/parking/.

4. The Artifact Chain Produced

The example generates the MPCP authorization chain:

File Artifact Description
policy-grant.json PolicyGrant Permission envelope (allowedRails, allowedPurposes, policyHash, expiresAt, budgetMinor)
budget-auth.json BudgetAuthorization Unsigned spending envelope
signed-budget-auth.json SignedBudgetAuthorization (SBA) Signed budget for this payment (maxAmountMinor)
settlement.json Settlement Executed settlement record (via Trust Gateway → XRPL)
settlement-bundle.json Bundle All artifacts combined for verification

Chain flow: PolicyGrant → SBA → Trust Gateway → XRPL Settlement → Verification

5. Verify the Bundle

Verify the settlement bundle with the CLI:

npx mpcp verify examples/parking/settlement-bundle.json --explain

The --explain flag shows step-by-step diagnostics. The bundle is self-contained (includes public keys), so verification works without env vars.

6. Policy Summary (Optional)

View fleet policy constraints:

npx mpcp policy-summary examples/machine-commerce/fleet-policy.json

Or validate against a reference profile:

npx mpcp policy-summary examples/machine-commerce/fleet-policy.json --profile parking

Next Steps