Implantar

Implemente o contrato de escrow e defina as propriedades do escrow.

Cabeçalhos

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

Marco

Nome	Tipo	Descrição
descrição	string	Texto descrevendo a função do marco
status	string (Valor padrão: "peding")	Status do marco. Ex: Aprovado, Em disputa, etc...
aprovado	booleano (Valor padrão: false)	Indicador que informa se um marco foi aprovado pelo aprovador

Papéis:

Nome	Tipo	Descrição
aprovador	string	Endereço da entidade que exige o serviço.
fornecedorDeServico	string	Endereço da entidade que fornece o serviço.
enderecoPlataforma	string	Endereço da entidade que possui o escrow
assinanteDeLiberacao	string	Endereço do usuário responsável por liberar os fundos do escrow para o prestador de serviço.
resolutorDeDisputa	string	Endereço responsável por resolver disputas dentro do escrow.
recebedor	string	Endereço para o qual os recursos do escrow serão enviados

Trustline:

Nome	Tipo	Descrição
endereço	string	Endereço público que estabelece permissão para aceitar e usar um token específico.
símbolo	string	Abreviação oficial que representa o token em carteiras, exchanges e documentação.

Inicializar Escrow

post

Autorizações

x-api-key

Corpo

application/json

signerstringObrigatório

Entity that signs the transaction that deploys and initializes the escrow

Example: GABC...XYZ

engagementIdstringObrigatório

Unique identifier for the escrow

Example: ENG12345

titlestringObrigatório

Name of the escrow

Example: Escrow Test

descriptionstringObrigatório

Text describing the function of the escrow

Example: Escrow Test description

rolesobject[]Obrigatório

Roles that make up the escrow structure

amountnumberObrigatório

Amount to be transferred upon completion of escrow milestones

Example: 1000

platformFeenumberObrigatório

Commission that the platform will receive when the escrow is completed

Example: 5

milestonesobject[]Obrigatório

Objectives to be completed to define the escrow as completed. (In this case it is not necessary to send the properties “approvedFlag” and “status” inside the objects of these milestones)

trustlineobject[]Obrigatório

Information on the trustline that will manage the movement of funds in escrow

Respostas

201

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:

• Amount cannot be zero
• Escrow already initialized
• The platform fee cannot exceed 99%
• Escrow initialized without milestone
• Cannot define more than 50 milestones in an escrow
• All flags (approved, disputed, released) must be false in order to execute this function
• An unexpected error occurred

application/json

post

/deployer/single-release

HTTPcURLJavaScriptPython

POST /deployer/single-release HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 603

{
  "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": "Initial phase of the project"
    },
    {
      "description": "Completion of design work"
    }
  ],
  "trusline": {
    "symbol": "USDC",
    "address": "GBBD47IF6LWK7P7MDEVSC..."
  }
}

{
  "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 assinante
    const { address } = await kit.getAddress();

    // Executar o endpoint
    const response = await http.post(
      "/deployer/single-release",
      {
        // corpo solicitado 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; 
}