EscrowManager: Drive Milestone Escrow Contract Lifecycle

import { EscrowManager, MilestoneStatus } from "@ankarachain/sdk";

new EscrowManager(adapter: IAdapter, escrowAddress: string)

import { EscrowManager } from "@ankarachain/sdk";

const escrow = new EscrowManager(factory.adapter, "0xEscrowContractAddress");

getPayer(): Promise<string>

getPayee(): Promise<string>

getArbiter(): Promise<string>

getToken(): Promise<string>

getTotalAmount(): Promise<bigint>

isFunded(): Promise<boolean>

isCancelled(): Promise<boolean>

milestoneCount(): Promise<number>

getMilestone(milestoneId: number): Promise<Milestone>

const milestone = await escrow.getMilestone(0);
console.log("Status:", MilestoneStatus[milestone.status]);
console.log("Amount:", milestone.amount);
console.log("Funded:", milestone.funded);

getAllMilestones(): Promise<Milestone[]>

const milestones = await escrow.getAllMilestones();
milestones.forEach((m, i) => {
  console.log(`Milestone ${i}: ${MilestoneStatus[m.status]} — ${m.amount} wei`);
});

remainingBalance(): Promise<bigint>

getActivity(): Promise<EscrowActivityEvent[]>

const activity = await escrow.getActivity();
activity.forEach(event => {
  const scope = event.milestoneId != null ? ` (milestone ${event.milestoneId})` : "";
  console.log(`[${event.type}]${scope} — tx: ${event.txHash}`);
});

fund(milestoneId: number): Promise<string>

// EVM: approve first
const token = new ethers.Contract(tokenAddress, ERC20_ABI, signer);
await token.approve(escrowAddress, milestoneAmount);

// Then fund
const txHash = await escrow.fund(0);

markDelivered(milestoneId: number): Promise<string>

const txHash = await escrow.markDelivered(0);

approveMilestone(milestoneId: number): Promise<string>

const txHash = await escrow.approveMilestone(0);

raiseDispute(milestoneId: number): Promise<string>

resolveDispute(milestoneId: number, releaseToPayee: boolean): Promise<string>

// Arbiter resolves in the payee's favour
const txHash = await escrow.resolveDispute(1, true);

claimTimelockRelease(milestoneId: number): Promise<string>

voteCancel(): Promise<string>

setArbiter(newArbiter: string): Promise<string>

setIdentityVerifier(verifierAddress: string): Promise<string>

pause(): Promise<string>

unpause(): Promise<string>

escrow.address  // The escrowAddress passed to the constructor

import {
  TokenFactory,
  EscrowManager,
  MilestoneStatus,
} from "@ankarachain/sdk";
import { ethers } from "ethers";

// ── 1. Deploy escrow ──────────────────────────────────────────────────────
const factory = new TokenFactory({ network: "polygon-amoy", signer: payerSigner });

const { escrowAddress } = await factory.deployEscrow({
  payer:    payerAddress,
  payee:    payeeAddress,
  token:    usdcAddress,
  milestones: [
    { amount: ethers.parseUnits("5000", 6) },   // milestone 0
    { amount: ethers.parseUnits("5000", 6) },   // milestone 1
    { amount: ethers.parseUnits("10000", 6) },  // milestone 2
  ],
  arbiter: arbitratorAddress,
});

// ── 2. Payer: approve and fund milestone 0 ────────────────────────────────
const usdc = new ethers.Contract(usdcAddress, ERC20_ABI, payerSigner);
await usdc.approve(escrowAddress, ethers.parseUnits("5000", 6));

const payerEscrow = new EscrowManager(factory.adapter, escrowAddress);
await payerEscrow.fund(0);

// ── 3. Payee: mark milestone 0 as delivered ───────────────────────────────
const payeeFactory = new TokenFactory({ network: "polygon-amoy", signer: payeeSigner });
const payeeEscrow  = new EscrowManager(payeeFactory.adapter, escrowAddress);
await payeeEscrow.markDelivered(0);

// ── 4. Payer: approve and release funds ───────────────────────────────────
await payerEscrow.approveMilestone(0);

// ── 5. Check remaining balance ────────────────────────────────────────────
const remaining = await payerEscrow.remainingBalance();
console.log("Remaining locked:", ethers.formatUnits(remaining, 6), "USDC");

// ── 6. Review full activity log ───────────────────────────────────────────
const activity = await payerEscrow.getActivity();
console.log("Events:", activity.map(e => e.type));

enum MilestoneStatus {
  PENDING   = 0,
  DELIVERED = 1,
  DISPUTED  = 2,
  RELEASED  = 3,
  REFUNDED  = 4,
}

interface Milestone {
  amount:          bigint;
  descriptionHash: string;   // bytes32 hex
  status:          MilestoneStatus;
  deliveredAt:     bigint;   // unix seconds; 0 if not yet delivered
  funded:          boolean;
}

interface EscrowMilestoneInput {
  amount:           bigint;
  descriptionHash?: string;  // defaults to zero hash if omitted
}

type EscrowActivityType =
  | "funded" | "delivered" | "released"
  | "disputed" | "resolved" | "refunded"
  | "cancel-vote" | "cancelled" | "arbiter-changed";

interface EscrowActivityEvent {
  type:         EscrowActivityType;
  milestoneId?: number;
  txHash:       string;
  timestamp:    number;
  data?:        Record<string, unknown>;
}

interface DeployEscrowOptions {
  payer:                    string;
  payee:                    string;
  token:                    string;
  milestones:               EscrowMilestoneInput[];
  arbiter?:                 string;
  identityVerifier?:        string;
  timelockDurationSeconds?: number;
  admin?:                   string;
}

interface EscrowDeployResult {
  escrowAddress: string;
  txHash:        string;
  payer:         string;
  payee:         string;
  token:         string;
  totalAmount:   bigint;
  network:       SupportedNetwork;
  deployedAt:    number;
}