SDK Quickstart

Use @abstraxn/warrant from your backend (or trusted server). It talks to Warrant at https://api-warrant.abstraxn.com by default.

Prerequisites

Node.js 18+
Dashboard setup complete — KYI Framework on for your app
Application API key — create mandates
Mandate API key — returned once when you create a mandate (for runtime check())

Install

npm install @abstraxn/warrant

Package: npm @abstraxn/warrant

Environment

ABSTRAXN_API_KEY=<application API key>
WARRANT_MANDATE_API_KEY=<mandate key from createMandate>

# Optional — override API host (SDK default: https://api-warrant.abstraxn.com)
# WARRANT_URL=https://api-warrant.abstraxn.com

apiUrl is optional on the Warrant client. Omit it for production, or pass apiUrl: process.env.WARRANT_URL / set WARRANT_URL in env for a custom host.

Step 1 — Create a mandate (application key)

Define rules the owner agrees to:

import {
  Warrant,
  hashMandateRules,
  mandateSealMessage,
} from '@abstraxn/warrant';

const admin = new Warrant({
  apiKey: process.env.ABSTRAXN_API_KEY!,
});

const rules = {
  rules: [
    { type: 'amount_max_per_action', value: 100, currency: 'USD' },
    {
      type: 'counterparty_allowlist',
      value: ['0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'],
    },
  ],
};

// Owner signs this message with their wallet (EIP-191)
const hash = hashMandateRules(rules);
const message = mandateSealMessage(hash);
// owner_signature = await wallet.signMessage(message)

const mandate = await admin.createMandate({
  agent_id: 'agent_web3_demo',
  principal_id: '0xYourOwnerAddress…',
  domain: 'web3',
  rules,
  owner_signature: '0x…',
  owner_pubkey_ref: 'eip155:84532:0xyourowner…',
  valid_until: null,
});

console.log('Mandate ID:', mandate.id);
console.log('Mandate API key (save once):', mandate.apiKey);

mandate.apiKey is shown only on create. Store it encrypted. Runtime agents use this key — not your application key.

Step 2 — Check before the action (mandate key)

const warrant = new Warrant({
  apiKey: process.env.WARRANT_MANDATE_API_KEY!,
});

const decision = await warrant.check({
  agent_id: 'agent_web3_demo',
  domain: 'web3',
  action_type: 'transfer',
  value: { amount: 40, currency: 'USD' },
  counterparty: {
    id: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
    type: 'evm_address',
  },
});

if (decision.verdict !== 'ALLOW') {
  throw new Error(
    `Blocked: ${decision.reasons.map((r) => r.code).join(', ')}`,
  );
}

// Safe to proceed — transfer, MCP tool, etc.
console.log('Receipt ID:', decision.receipt_id);

Step 3 — Gate an MCP or agent tool

Pattern used in production agents:

async function guardedTransfer(params: TransferParams) {
  const decision = await warrant.check({ /* action */ });
  if (decision.verdict !== 'ALLOW') {
    return { ok: false, decision };
  }
  return { ok: true, result: await realTransfer(params), receipt_id: decision.receipt_id };
}

Rule types (common)

Rule	Example
`amount_max_per_action`	Max $100 per transfer
`counterparty_allowlist`	Only these wallet addresses
`category_denylist`	Block “gambling”, “alcohol”
`time_window`	Only weekdays 9am–5pm

If Warrant is unreachable

The SDK option onError: 'deny' (default) returns a synthetic DENY so agents fail closed. Use 'escalate' or 'bypass_with_receipt' only if you understand the risk.

Package	When	Doc / npm
`@abstraxn/warrant-react`	Mandate signing UI in React	React quickstart · npm
`@abstraxn/warrant-verifier`	Audit receipts offline	Verify receipts · npm

Next steps

React quickstart — MandateForm + Readback
How it works — full product flow
API reference — REST endpoints
Verify receipts — auditor path

Getting started

Build

Audit & on-chain

Prerequisites

Install

Environment

Step 1 — Create a mandate (application key)

Step 2 — Check before the action (mandate key)

Step 3 — Gate an MCP or agent tool

Rule types (common)

If Warrant is unreachable

Next steps

​Prerequisites

​Install

​Environment

​Step 1 — Create a mandate (application key)

​Step 2 — Check before the action (mandate key)

​Step 3 — Gate an MCP or agent tool

​Rule types (common)

​If Warrant is unreachable

​Related packages

​Next steps

Prerequisites

Install

Environment

Step 1 — Create a mandate (application key)

Step 2 — Check before the action (mandate key)

Step 3 — Gate an MCP or agent tool

Rule types (common)

If Warrant is unreachable

Related packages

Next steps