Documentation

Shield Integration Guide

Get your agent screening transactions in under 30 minutes. Shield checks every target address and contract before your agent signs.

Quick Start

1. Install the SDK
npm install @agent-armor/shield
2. Screen before signing
import { Shield } from "@agent-armor/shield";

const shield = new Shield({
  walletAddress: "0xYourAgentWallet",
  // x402 micropayment: $0.005/call, paid from agent wallet
});

// Before every transaction:
const result = await shield.screen({
  target: "0xContractAddress",
  chain: "base",
});

if (result.recommendation === "block") {
  console.log("Threat detected:", result.threats);
  // Skip this transaction
} else {
  // Proceed with signing
}

Risk Score Schema

Score RangeRecommendationAction
0.0 – 0.3proceedSafe to sign
0.3 – 0.7cautionAgent decides based on threshold config
0.7 – 1.0blockDo not sign — high threat confidence

Threat Detection

Rug Pull Patterns
Detects liquidity removal patterns, ownership renounce fakes, and token supply manipulation.
Honeypot Analysis
Simulates sell transactions to detect contracts that allow buys but block sells.
Address Reputation
Cross-references deployer addresses against known scammer databases and flagged wallets.
Liquidity Health
Checks pool depth, lock status, and concentration. Flags thin liquidity that enables price manipulation.

x402 Micropayment Setup

Shield uses x402 micropayments on Base. Your agent pays $0.005 per screening call directly from its wallet — no accounts, no API keys, no billing cycles.

Requirements:

  • Agent wallet on Base with USDC balance
  • x402 protocol support (built into the SDK)
  • Minimum balance: $0.10 recommended for first 20 calls

AgentKit Plugin

import { AgentKit } from "@coinbase/agentkit";
import { ShieldPlugin } from "@agent-armor/shield/agentkit";

const agent = new AgentKit({
  plugins: [
    new ShieldPlugin({
      mode: "advisory",     // "advisory" = score only, "enforce" = auto-block
      threshold: 0.7,       // Block transactions above this score
    }),
  ],
});

// Shield automatically screens every transaction
// before AgentKit signs it