Atualizar escrow

Este endpoint permite alterar as propriedades de um escrow desde que uma série de requisitos seja atendida, os quais serão mencionados nesta seção.

Requisitos para usar:

1. Apenas a entidade com o papel de plataforma tem permissão para executar este endpoint

2. Se um escrow tiver fundos, a única coisa que a plataforma pode fazer é adicionar mais marcos. As outras propriedades não podem ser modificadas em hipótese alguma.

Cabeçalhos

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

Papéis:

Nome	Tipo	Descrição
approver	string	Endereço da entidade que solicita o serviço.
serviceProvider	string	Endereço da entidade que fornece o serviço.
platformAddress	string	Endereço da entidade que possui o escrow
releaseSigner	string	Endereço do usuário responsável por liberar os fundos do escrow para o prestador de serviços.
disputeResolver	string	Endereço responsável por resolver disputas dentro do escrow.
receiver	string	Endereço para o qual os recursos do escrow serão enviados

Marco:

Nome	Tipo	Descrição
description	string	Texto descrevendo a função do marco.
status	string	Status do marco. Ex: Aprovado, Em disputa, etc...
approved	boolean	Flag indicando se um marco foi aprovado pelo aprovador.

Flags

Nome	Tipo	Descrição
disputed	boolean	Flag indicando que um escrow está em disputa.
released	boolean	Flag indicando que os fundos do escrow já foram liberados.
resolved	boolean	Flag indicando que um escrow em disputa já foi resolvido.

Trustline

Nome	Tipo	Descrição
address	string	Endereço público que estabelece permissão para aceitar e usar um token específico.

Open API

put

Autorizações

Corpo

signerstringObrigatório

Entity that signs the transaction that deploys and initializes the escrow

Example: GSIGN...XYZ

contractIdstringObrigatório

ID (address) that identifies the escrow contract

Example: CAZ6UQX7...

Respostas

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

O que este endpoint retorna?

Este endpoint retorna a transação não assinada para que a transação possa ser assinada por meio de uma carteira do cliente.

Exemplo 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 () => {
    // Obtenha o endereço do assinante
    const { address } = await kit.getAddress();

    const response = await http.put(
      "/escrow/single-release/update-escrow",
      {
        // corpo solicitado para o endpoint
      },
    ); 
    
    // Obtenha o hash da transação não assinada
    const { unsignedTransaction } = response.data;

    // Assine a transação pela carteira
    const { signedTxXdr } = await signTransaction(unsignedTransaction, {
      address,
      networkPassphrase: WalletNetwork.TESTNET,
    });

    // Envie a transação para a Rede Stellar
    const tx = await http.post("/helper/send-transaction", {
      signedXdr: signedTxXdr,
    });

    const { data } = tx;

    return data;
}