Get Started with Ordex

Choose your role, install the pinned SDK, and execute your first mock purchase preflight in under five minutes.

Personalize by Your Role

Reorders recommended guides and recipes. Stored locally without an account. Never hides full docs.

1. Prerequisites & Installation

Node.js 24 LTS Pin

Ordex uses exact pinned dependencies and the Node.js native test runner. Install the client SDK:

npm install @bitcoinuniverse/ordex-sdk@1.0.0

2. First Verification (Deterministic Mock)

Runs Offline

Verify a portable public ask settlement transaction locally using the reference verifier rules:

import { verifyPurchaseArrangement } from '@bitcoinuniverse/ordex-sdk/verifier';

// Example order terms
const order = {
  offeredOutpoint: { txid: '7b28f7a9...29', vout: 0 },
  priceSats: '150000',
  sellerPaymentScriptHex: '001438924b8923489123049182309481230948120394'
};

// Verification runs synchronously in milliseconds with zero network requests
const verdict = verifyPurchaseArrangement(sampleTx, order);
console.log('Result:', verdict.ok ? 'ACCEPTED' : verdict.code);

Test in Live Playground →Browse Step-by-Step Recipes →

Guided Wizards (12 Workflows)

Step-by-step decision trees for publishing asks, batch buying, and setting up SafeOps.

Starter Repositories

Generate a full Node.js, Browser, or Cloudflare Worker starter repo with tests and CI.

Ordex Protocol Lab

Inspect sat flow diagrams, PSBT inputs and outputs, and test custom transaction plans.

Was this documentation helpful?

Privacy-first feedback. Your feedback is never shared with third parties.