Actualizar escrow

Este endpoint te permite cambiar las propiedades de un escrow siempre que se cumpla una serie de requisitos, los cuales se mencionarán en esta sección.

Requisitos para usar:

1. Solo la entidad con el rol de plataforma tiene permisos para ejecutar este endpoint

2. Si un escrow tiene fondos, lo único que la plataforma puede hacer es añadir más hitos. Las demás propiedades no pueden modificarse bajo ninguna circunstancia.

Encabezados

Nombre	Valor
Content-Type	application/json
x-api-key	<token>

Roles:

Nombre	Tipo	Descripción
approver	string	Dirección de la entidad que solicita el servicio.
serviceProvider	string	Dirección de la entidad que presta el servicio.
platformAddress	string	Dirección de la entidad que posee el escrow
releaseSigner	string	Dirección del usuario encargado de liberar los fondos del escrow al proveedor del servicio.
disputeResolver	string	Dirección encargada de resolver disputas dentro del escrow.
receiver	string	Dirección a la que se enviarán los ingresos del escrow

Hito:

Nombre	Tipo	Descripción
description	string	Texto que describe la función del hito.
status	string	Estado del hito. Ej: Aprobado, En disputa, etc...
approved	boolean	Bandera que indica si un hito ha sido aprobado por el aprobador.

Indicadores

Nombre	Tipo	Descripción
disputed	boolean	Bandera que indica que un escrow está en disputa.
released	boolean	Bandera que indica que los fondos del escrow ya han sido liberados.
resolved	boolean	Bandera que indica que un escrow en disputa ya ha sido resuelto.

Trustline

Nombre	Tipo	Descripción
address	string	Dirección pública que establece permiso para aceptar y usar un token específico.

Open API

put

Autorizaciones

Cuerpo

signerstringRequerido

Entity that signs the transaction that deploys and initializes the escrow

Example: GSIGN...XYZ

contractIdstringRequerido

ID (address) that identifies the escrow contract

Example: CAZ6UQX7...

Respuestas

200

This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.

application/json

400

Bad request

401

Unauthorized access

429

Too Many Requests

500

Possible errors:

• Escrow not found
• The platform fee cannot exceed 99%
• Amount cannot be equal to or less than zero
• Escrow initialized without milestone
• Cannot define more than 50 milestones in an escrow
• Only the platform address should be able to execute this function
• The platform address of the escrow cannot be changed
• Escrow has been opened for dispute resolution
• All flags (approved, disputed, released) must be false in order to execute this function
• The provided escrow properties do not match the stored escrow
• You can't change the escrow properties after the milestone is approved
• An unexpected error occurred

application/json

put/escrow/single-release/update-escrow

PUT /escrow/single-release/update-escrow HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 846

{
  "signer": "GAPPROVER1234567890...",
  "contractId": "CAZ6UQX7...",
  "isActive": true,
  "escrow": {
    "signer": "GAPPROVER1234567890...",
    "engagementId": "ENG12345",
    "title": "Project Title",
    "description": "This is a detailed description of the project.",
    "roles": {
      "approver": "GAPPROVER1234567890...",
      "serviceProvider": "GAPPROVER1234567890...",
      "platformAddress": "GAPPROVER1234567890...",
      "releaseSigner": "GAPPROVER1234567890...",
      "disputeResolver": "GAPPROVER1234567890...",
      "receiver": "GAPPROVER1234567890..."
    },
    "amount": 1000,
    "platformFee": 50,
    "milestones": [
      {
        "description": "test1",
        "status": "pending",
        "evidence": "Any evidence that the milestone is completed"
      },
      {
        "description": "test2",
        "status": "pending",
        "evidence": "Any evidence that the milestone is completed"
      }
    ],
    "flags": {
      "disputed": false,
      "released": false,
      "resolved": false
    },
    "trustline": {
      "address": "GAPPROVER1234567890..."
    }
  }
}

{
  "status": "SUCCESS",
  "unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}

¿Qué devuelve este Endpoint?

Este endpoint devuelve la transacción sin firmar para que la transacción pueda ser firmada mediante la cartera del cliente.

Ejemplo de uso:

import axios from "axios";

const http = axios.create({
  baseURL: "https://dev.api.trustlesswork.com",
  timeout: 10000,
  headers: {
    "Content-Type": "application/json",
    "x-api-key": your_api_key,
  },
});

export const useExample = async () => {
    // Obtener la dirección del firmante
    const { address } = await kit.getAddress();

    const response = await http.put(
      "/escrow/single-release/update-escrow",
      {
        // cuerpo solicitado para el endpoint
      },
    ); 
    
    // Obtener el hash de la transacción sin firmar
    const { unsignedTransaction } = response.data;

    // Firmar la transacción con la cartera
    const { signedTxXdr } = await signTransaction(unsignedTransaction, {
      address,
      networkPassphrase: WalletNetwork.TESTNET,
    });

    // Enviar la transacción a la Red Stellar
    const tx = await http.post("/helper/send-transaction", {
      signedXdr: signedTxXdr,
    });

    const { data } = tx;

    return data;
}