Cambiar el Flag del Hito (Milestone)

Permite modificar la propiedad "flag" de un hito específico dentro del contrato de escrow.

POST escrow/change-milestone-flag

Encabezados

Nombre	Valor
Content-Type	application/json
Authorization	Bearer <token>

Cuerpo

Nombre	Tipo	Descripción
contractId	string	ID (dirección) que identifica al contrato de escrow.
milestoneIndex	string	Posición que identifica el hito dentro del grupo de hitos en el escrow.
newFlag	boolean	Nuevo valor para la propiedad de flag dentro del hito del escrow.
client	string	Dirección del cliente que aprobará el hito.

Ejemplo de cuerpo de solicitud (request body)

{
	"contractId": "GC3DJY4LLQYJHEONXFDLQVVRCFZQCPFX7VD33KP4P7QSVZY3SJHQBZGV",
	"milestoneIndex": "0", 
	"newFlag": true,
	"client": "GBY3PAJY5R3ZIXTYBGFW4URB4RINEXQBC3T4RWDDKJ5TZXQYZUN6A4TP"
}

Respuestas posibles

200 OK

{    
    "status": "SUCCESS",
    "unsignedTransaction": "AAAAAgAAAABfQAm/gS..."  // XDR Hash Transaction
}

500 Server Error

Not Found

{
  "status": "FAILED"
  "messgae": "Escrow not found"
}

Only the approver can change the

{
  "status": "FAILED"
  "messgae": "Only the approver can change milestone flag"
}

No milestones defined

{
  "status": "FAILED"
  "messgae": "Escrow initialized without milestone"
}

Invalid milestone index

{
  "status": "FAILED"
  "messgae": "Invalid milestone index"
}

500

{
  "status": "500"
  "messgae": "An unexpected error occurred"
}

400 Bad Request

{
    "message": "Message",
    "error": "Bad Request",
    "statusCode": 400
}

401 Unauthorized

{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

429 Rate Limit

{
    "statusCode": 429,
    "message": "ThrottlerException: Too Many Requests"
}

¿Qué retorna este endpoint?

Este endpoint retorna la transacción sin firmar, para que pueda ser firmada mediante una billetera del usuario.

Ejemplo de uso (usando axios)

import axios from "axios";

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

export const useExample = async () => {
    // Get the signer address
    const { address } = await kit.getAddress();

    const response = await http.post(
      "/escrow/change-milestone-approved-flag",
      {
        // body requested for the endpoint
      },
    ); 
    
    // Get the unsigned transaction hash
    const { unsignedTransaction } = response.data;

    // Sign the transaction by wallet
    const { signedTxXdr } = await signTransaction(unsignedTransaction, {
      address,
      networkPassphrase: WalletNetwork.TESTNET,
    });

    // Send the transaction to Stellar Network
    const tx = await http.post("/helper/send-transaction", {
      signedXdr: signedTxXdr,
      returnValueIsRequired: true,
    });

    const { data } = tx;

    return data;
}