example

/agirails:example

Generate ready-to-run code examples for AGIRAILS SDK integration.

What This Command Does

1. Show available use cases
2. Generate complete, runnable code example
3. Optionally save to file

Step-by-Step Instructions

Step 1: Select Use Case

If argument provided, match against known use cases.

Otherwise, present options:

"What would you like to build?"
Options:
  [Basic Payment] - Simple pay and release flow
  [Full Lifecycle] - Complete transaction with all states
  [Dispute Handling] - Handle disputes and resolutions
  [Event Monitoring] - Listen for transaction events
  [Batch Operations] - Multiple transactions efficiently
  [Agent Integration] - Integrate with AI agent framework

Step 2: Generate Example

Basic Payment (TypeScript)

/**
 * AGIRAILS Basic Payment Example
 *
 * This example demonstrates the simplest payment flow:
 * 1. Create client
 * 2. Make payment
 * 3. Provider delivers
 * 4. Release funds
 *
 * Run: npx ts-node basic-payment.ts
 */

import { ACTPClient, IMockRuntime } from '@agirails/sdk';
import { ethers } from 'ethers';

// Configuration
const PROVIDER_ADDRESS = '0x2222222222222222222222222222222222222222';
const PAYMENT_AMOUNT = 10.00; // USDC

async function main() {
  console.log('=== AGIRAILS Basic Payment ===\n');

  // 1. Create client in mock mode (no real funds needed)
  const client = await ACTPClient.create({ mode: 'mock' });
  const myAddress = client.getAddress();
  console.log('✓ Client created in mock mode\n');

  // 2. Mint test USDC (mock mode only)
  // Mint uses USDC wei (6 decimals): 1000 USDC = 1_000_000_000
  await client.mintTokens(myAddress, '1000000000');
  const balance = await client.getBalance(myAddress);
  console.log(`✓ Balance (wei): ${balance}\n`);

  // 3. Create payment
  const result = await client.basic.pay({
    to: PROVIDER_ADDRESS,
    amount: PAYMENT_AMOUNT,
    deadline: '+24h',
  });
  console.log('✓ Payment created');
  console.log(`  Transaction ID: ${result.txId}`);
  console.log(`  State: ${result.state}`);
  console.log('');

  // 4. Simulate provider delivering (in production, provider calls this)
  // IN_PROGRESS is REQUIRED before DELIVERED
  await client.standard.transitionState(result.txId, 'IN_PROGRESS');
  // DELIVERED requires ABI-encoded dispute window proof
  const abiCoder = ethers.AbiCoder.defaultAbiCoder();
  const proof = abiCoder.encode(['uint256'], [172800]); // 2 days
  await client.standard.transitionState(result.txId, 'DELIVERED', proof);
  console.log('✓ Provider delivered\n');

  // 5. Release payment (after dispute window)
  await (client.advanced as IMockRuntime).time.advanceTime(172801); // 2 days + 1s
  await client.standard.releaseEscrow(result.txId);
  console.log('✓ Payment released to provider\n');

  // 6. Verify final state
  const status = await client.basic.checkStatus(result.txId);
  console.log(`Final state: ${status.state}\n`);

  console.log('=== Example Complete ===');
}

main().catch(console.error);