Change Milestone Flag

Responsible for modifying the "flag" property of a specific milestone in the escrow to approve that milestone.

POST escrow/change-milestone-flag

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
contractId	string	ID (address) that identifies the escrow contract
milestoneIndex	string	Position that identifies the milestone within the group of milestones in the escrow
newFlag	boolean	New value for the "flag" property within the escrow milestone
client	string	Address of the client who will approve the milestone

Example of Request Body:

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

Possible Responses

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"
}

What this Endpoint returns?

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.

Use example (Using 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;
}