Developer Documentation

Integrate the Ward conformance engine into your credit product.

These docs show how to select integration rails, run nine on-ledger checks, preserve the signer boundary, and export receipts for institutional review.

Quickstart

One call returns the evidence your product needs.

Ward does not replace your protocol. It gives your protocol a deterministic default-resolution path that serious counterparties can inspect.

import { WardClient } from '@wardprotocol/sdk'

const ward = new WardClient({
  chain: 'xrpl',
  network: 'altnet',
  institutionKey: process.env.WARD_INSTITUTION_KEY,
})

const result = await ward.runConformance({
  policyRef: 'NFTokenTaxon=281',
  claimantAddress: wallet.address,
  vaultId: vault.id,
  claimContext: defaultEvent.id,
})

if (result.conformant) {
  // Ward returns an unsigned settlement packet.
  // Your institution signs. The chain settles.
  assert(result.wardSigned === false)
}

Documentation map

Build the integration in four reviewable surfaces.

01

Rail setup

Select a chain lane and bind Ward to the project primitive your credit product already uses.

02

Conformance payload

Send the policy reference, claimant, vault, and default context to the Ward validation engine.

03

Validation response

Receive approved or rejected status, check-level evidence, and a deterministic reason.

04

Settlement packet

Use the unsigned packet to preserve custody and signing authority inside your institution.

Integration rail matrix

Pick the chain lane. Keep the Ward invariant.

Each rail translates a chain-native primitive into the same conformance result: approved, rejected, evidence, and unsigned settlement instructions.

Live

XRPL Altnet

XLS-66 lending vaults

Live

F01-F03 verified on Altnet; F04-F09 pending XLS-66 vault state availability

Roadmap

Flare

Coston2

Roadmap

Coston2 environment provisioned — scoped on engineering roadmap

XRPL EVM

Sidechain testnet

Roadmap

Sidechain environment provisioned — scoped on engineering roadmap

XDC

Apothem

Roadmap

Apothem environment provisioned — scoped on engineering roadmap

Polygon

Amoy

Roadmap

Amoy environment provisioned — scoped on engineering roadmap

Stellar

Testnet

Roadmap

Testnet environment provisioned — scoped on engineering roadmap

Algorand

Testnet

Roadmap

Testnet environment provisioned — scoped on engineering roadmap

Solana

Devnet

Roadmap

Devnet environment provisioned — scoped on engineering roadmap

Engineering detail: MULTICHAIN_GAPS.md

Nine-check conformance

The validation engine is explainable at check level.

01

Policy artifact located

The selected rail resolves the policy token, NFT, or contract reference before validation begins.

02

Coverage window active

Coverage dates are compared against chain time or finalized ledger state, not server time.

03

Vault binding confirmed

Claimant, vault, and policy references must agree before a claim can proceed.

04

Default signal verified

Ward treats event streams as hints and re-reads authoritative ledger state.

05

Loss math bounded

The vault loss must be greater than zero and capped before payout construction.

06

Coverage pool solvent

The pool balance, reserve rules, and coverage cap are checked before settlement.

07

Policy still live

The policy artifact has not been burned, closed, transferred, or invalidated.

08

Claimant ownership proven

Wallet ownership and claimant identity are verified through the selected integration rail.

09

Pool solvency and rate limits

Pool solvency, coverage ratio >= 1.5x, and the max 3 claims per NFT per 300s rate limit are enforced before settlement.

Receipt shape

receipt_id: WARD-7A21F0
result: WARD_CONFORMANT
checks_passed: 9/9
decision_source: on_ledger_state
settlement_packet: unsigned
signer_boundary: institution
ward_signed: false