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. Somente a entidade com a função de plataforma tem permissão para executar este endpoint

2. Se um escrow (depósito em garantia) tiver fundos, a única coisa que a plataforma pode fazer é adicionar mais marcos. As outras propriedades não podem ser modificadas sob nenhuma circunstância.

Cabeçalhos

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

Funções:

Nome	Tipo	Descrição
aprovador	string	Endereço da entidade que solicita o serviço.
prestadorDeServiço	string	Endereço da entidade que presta o serviço.
endereçoDaPlataforma	string	Endereço da entidade que possui o escrow
assinanteDeLiberação	string	Endereço do usuário responsável por liberar os fundos do escrow para o prestador de serviço.
resolvedorDeDisputa	string	Endereço responsável por resolver disputas dentro do escrow.
recetor	string	Endereço para o qual os recursos do escrow serão enviados

Marco:

Nome	Tipo	Descrição
descrição	string	Texto que descreve a função do marco.
status	string	Status do marco. Ex: Aprovado, Em disputa, etc...
quantia	booleano	Valor do marco

Trustline

Nome	Tipo	Descrição
endereço	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:

• The platform fee cannot exceed 99%
• Escrow initialized without milestone
• Cannot define more than 50 milestones in an escrow
• Amount cannot be zero
• Escrow not found
• Only the platform address should be able to execute this function
• The platform address of the escrow cannot be changed
• The provided escrow properties do not match the stored escrow
• All flags (approved, disputed, released) must be false in order to execute this function

application/json

put/escrow/multi-release/update-escrow

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

{
  "signer": "GAPPROVER1234567890...",
  "contractId": "CAZ6UQX7...",
  "isActive": true,
  "escrow": {
    "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..."
    },
    "platformFee": 1,
    "milestones": [
      {
        "description": "test1",
        "status": "pending",
        "evidence": "Any evidence that the milestone is completed",
        "amount": 1000,
        "receiver": "GAPPROVER1234567890..."
      },
      {
        "description": "test2",
        "status": "pending",
        "evidence": "Any evidence that the milestone is completed",
        "amount": 1000,
        "receiver": "GAPPROVER1234567890..."
      }
    ],
    "flags": {
      "disputed": false,
      "released": false,
      "resolved": false,
      "approved": 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 da 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 () => {
    // Obter o endereço do signatário
    const { address } = await kit.getAddress();

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

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

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

    const { data } = tx;

    return data;
}