proof-of-intent

TypeScript SDK for the Proof-of-Intent Protocol — on-chain intent registration, cryptographic delegation, and scope-enforced execution on Ethereum Sepolia. Uses ethers v6.

Install

npm install proof-of-intent

Environment variables

# Required: your wallet private key (Sepolia testnet only)
PRIVATE_KEY=0x...

# Optional: only needed if you call compileIntent()
CLAUDE_API_KEY=sk-ant-...

Five-line quickstart

import { ContractClient, usdc, inHours, UNISWAP_V3 } from 'proof-of-intent';

// Instantiate — all contract addresses default to deployed Sepolia contracts
const client = new ContractClient({ privateKey: process.env.PRIVATE_KEY! });

// Register an intent (build + EIP-712 sign + on-chain register in one call)
const intentId = await client.createIntent({
  tokenIn:          '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238', // Sepolia USDC
  maxAmountIn:      usdc(100),      // 100 USDC
  minAmountOut:     1n,
  allowedProtocols: ['Uniswap-V3'],
  deadline:         inHours(1),
});
console.log('intent registered:', intentId);

// Delegate execution rights to an agent address
import { buildScope } from 'proof-of-intent';
const delegationId = await client.delegateFromRoot(
  intentId,
  buildScope({ maxAmountIn: usdc(100), minAmountOut: 1n, allowedProtocols: ['Uniswap-V3'], deadline: inHours(1) }),
  client.wallet.address,   // delegate to self for demo
);
console.log('delegation created:', delegationId);

Helpers

import { usdc, weth, inMinutes, inHours, UNISWAP_V3 } from 'proof-of-intent';

usdc(500)          // → 500_000_000n   (500 USDC in raw units)
weth(0.15)         // → 150_000_000_000_000_000n
inMinutes(60)      // → Unix timestamp 60 minutes from now (bigint)
inHours(1)         // → Unix timestamp 1 hour from now (bigint)
UNISWAP_V3         // → '0x1cc...'  (bytes32 protocol ID as hex string)

Overriding defaults

const client = new ContractClient({
  privateKey: process.env.PRIVATE_KEY!,
  rpcUrl:     'https://my-node.example.com',
  chainId:    11155111,
  // intentRegistryAddress, delegationRegistryAddress, executionGateAddress...
});

Building from source

npm install
npm run build   # produces dist/ with .js and .d.ts

Contributors

• @adityabelgaonkar05
• @akankshaagroya