For the complete documentation index, see llms.txt. This page is also available as Markdown.

withdrawRemainingFunds

Withdraw remaining funds after resolution / completion.

Withdraw remaining funds after resolution / completion.

Import

import { TrustlessWorkClient } from "@trustless-work/escrow-js";

Signature

client.rest.withdrawRemainingFunds(
  payload: SingleReleaseWithdrawRemainingFundsPayload | MultiReleaseWithdrawRemainingFundsPayload,
  type: EscrowType,
): Promise<BuildTransactionResponse>

Returns BuildTransactionResponse: { unsignedXdr, txHash }.

Same shape as resolve dispute distributions. See Payloads.

Example

import { TrustlessWorkClient, development } from "@trustless-work/escrow-js";

const client = new TrustlessWorkClient({
  baseURL: development,
  apiKey: process.env.API_KEY,
});

// see signature above

See Operate and sendTransaction.