Payloads

Operate payloads — deploy, update, fund, release, dispute, and milestone management.

What you pass into deploy / update / fund / release / dispute hooks. Amounts here are human numbers.

Milestone payloads for deploy are leaner than full entity milestones.

Milestone payloads (deploy / manage)

type SingleReleaseMilestonePayload = {
  description: string;
  status?: string;
  approvalsTarget: number;
};

type MultiReleaseMilestonePayload = {
  description: string;
  status?: string;
  approvalsTarget: number;
  amount: number;
  receiver: string;
};

Deploy

Single-release

type DeploySingleReleaseEscrowPayload = {
  signer: string;
  engagementId: string;
  title: string;
  description: string;
  amount: number;
  platformFee: number;
  roles: Roles;
  milestones: SingleReleaseMilestonePayload[];
  trustline: DeployTrustline;
};

Multi-release

type DeployMultiReleaseEscrowPayload = {
  signer: string;
  engagementId: string;
  title: string;
  description: string;
  platformFee: number;
  roles: MultiReleaseRoles;
  milestones: MultiReleaseMilestonePayload[];
  trustline: DeployTrustline;
};

Optional attribution headers (platform-scoped calls):

type AttributionHeaders = {
  platformId?: string; // → X-TW-Platform
  subjectId?: string;  // → X-TW-Subject
};

Update (full replace)

type UpdateSingleReleaseEscrowPayload = {
  contractId: string;
  admin: string;
  escrow: {
    engagementId: string;
    title: string;
    description: string;
    amount: number;
    platformFee: number;
    roles: Roles;
    milestones: SingleReleaseMilestonePayload[];
    trustline: Trustline;
  };
};

type UpdateMultiReleaseEscrowPayload = {
  contractId: string;
  admin: string;
  escrow: {
    engagementId: string;
    title: string;
    description: string;
    platformFee: number;
    roles: MultiReleaseRoles;
    milestones: MultiReleaseMilestonePayload[];
    trustline: Trustline;
  };
};

Fund

type FundEscrowPayload = {
  amount: number;
  contractId: string;
  signer: string;
};

Change milestone status

type ChangeMilestoneStatusPayload = {
  contractId: string;
  serviceProvider: string;
  updates: Array<{
    index: number;
    newStatus: string;
    newEvidence?: string;
  }>;
};

Approve milestones

type ApproveMilestonesPayload = {
  contractId: string;
  approver: string;
  milestoneIndexes: number[];
};

Approve and release (multi convenience)

type ApproveAndReleaseMilestonesPayload = {
  contractId: string;
  signer: string;
  milestoneIndexes: number[];
};

Manage milestones (add / edit descriptions)

type ManageSingleReleaseMilestonesPayload = {
  contractId: string;
  admin: string;
  newMilestones: SingleReleaseMilestonePayload[];
  milestoneUpdates: Array<{
    index: number;
    newDescription?: string;
  }>;
};

type ManageMultiReleaseMilestonesPayload = {
  contractId: string;
  admin: string;
  newMilestones: MultiReleaseMilestonePayload[];
  milestoneUpdates: Array<{
    index: number;
    newDescription?: string;
    newAmount?: number;
  }>;
};

Release funds

Single-release

type SingleReleaseReleaseFundsPayload = {
  contractId: string;
  releaseSigner: string;
};

Multi-release

type MultiReleaseReleaseFundsPayload = {
  contractId: string;
  releaseSigner: string;
  milestoneIndexes: number[];
};

Start dispute

Single-release

type SingleReleaseStartDisputePayload = {
  contractId: string;
  signer: string;
  reason: string;
};

Multi-release

type MultiReleaseStartDisputePayload = {
  contractId: string;
  signer: string;
  reason: string;
  milestoneIndexes: number[];
};

Resolve dispute / withdraw remaining

Shared distribution entry:

type Distribution = {
  address: string;
  amount: number;
};

Resolve — single

type SingleReleaseResolveDisputePayload = {
  contractId: string;
  disputeResolver: string;
  distributions: Distribution[];
};

Resolve — multi

type MultiReleaseResolveDisputePayload = {
  contractId: string;
  disputeResolver: string;
  distributions: Distribution[];
  milestoneIndexes: number[];
};

Withdraw remaining

type SingleReleaseWithdrawRemainingFundsPayload = {
  contractId: string;
  disputeResolver: string;
  distributions: Distribution[];
};

type MultiReleaseWithdrawRemainingFundsPayload = {
  contractId: string;
  disputeResolver: string;
  distributions: Distribution[];
};

See Entities for Roles, Trustline, and DeployTrustline.