agirails-typescript

AGIRAILS TypeScript SDK v4

Complete TypeScript SDK reference for integrating ACTP into Node.js and TypeScript projects.

Installation

npm install @agirails/sdk
# or
yarn add @agirails/sdk
# or
pnpm add @agirails/sdk

Requirements:

• Node.js >= 18.0.0
• TypeScript >= 5.0 (if using TypeScript)
• ethers.js v6 (included as dependency)

The SDK ships as CommonJS. It works with require() and with bundlers (webpack, esbuild, Rollup). ESM projects can import CJS modules via Node.js auto-interop.

---

Quick Start (Copy-Paste-Run)

Save as quickstart.js and run with node quickstart.js — no wallet, no keys:

const { ACTPClient } = require('@agirails/sdk');

async function main() {
  // Mock mode: no blockchain, no keys needed
  const client = await ACTPClient.create({ mode: 'mock' });
  console.log('Address:', client.getAddress());

  // Mint test USDC (mock starts with 0 balance)
  await client.mintTokens(client.getAddress(), '10000000000'); // 10,000 USDC

  // Pay a provider (escrow flow)
  const result = await client.pay({
    to: '0x0000000000000000000000000000000000000001',
    amount: '5.00', // 5 USDC (human-readable, not wei)
  });
  console.log('Payment:', result.txId, '| State:', result.state);
  console.log('Release required:', result.releaseRequired);
}

main().catch(console.error);

For testnet/mainnet: Replace mock with testnet or mainnet. Set ACTP_PRIVATE_KEY env var or use the keystore (actp init).

// TypeScript with keystore auto-detect
import { ACTPClient } from '@agirails/sdk';

async function main() {
  // Checks: ACTP_PRIVATE_KEY env -> .actp/keystore.json + ACTP_KEY_PASSWORD
  const client = await ACTPClient.create({ mode: 'testnet' });
  const result = await client.basic.pay({
    to: '0xProviderAddress',
    amount: '100.00',
    deadline: '+24h',
  });
  console.log('Transaction ID:', result.txId);
}

main().catch(console.error);

---

API Levels

The SDK provides three abstraction levels. Use the simplest one that fits your needs.