Primeros pasos

Descripción general

El Trustless Work React SDK es una colección de hooks y entidades tipadas.

Utiliza Axios para solicitudes HTTP.

Los flujos de escritura requieren una clave de API (NEXT_PUBLIC_API_KEY). Las llamadas de solo lectura pueden funcionar sin una.

Enlaces rápidos

Título

Paquete NPM

Enlace

https://www.npmjs.com/package/@trustless-work/escrow

Título

Conceptos básicos de la API (URLs base, Swagger, límites)

Enlace

Introducción

Título

Enviar transacciones firmadas (XDR)

Enlace

useSendTransaction

Configuración

Instalación

Instala el SDK.

npm install "@trustless-work/escrow"

yarn add "@trustless-work/escrow"

Configura el proveedor

Configurarás 2 cosas:

baseURL: usa development (testnet) o mainNet (mainnet).
apiKey: desde el dApp BackOffice.

El SDK exporta TrustlessWorkConfig. Envuelve tu aplicación con él para habilitar todos los hooks.

src/trustless-work-provider.tsx

"use client"; // asegúrate de que este sea un componente cliente

import React from "react";
import {
  // entorno de desarrollo = "https://dev.api.trustlesswork.com"
  development,

  // entorno mainnet = "https://api.trustlesswork.com"
  mainNet,
  TrustlessWorkConfig,
} from "@trustless-work/escrow";

interface TrustlessWorkProviderProps {
  children: React.ReactNode;
}

export function TrustlessWorkProvider({
  children,
}: TrustlessWorkProviderProps) {
  const apiKey = process.env.NEXT_PUBLIC_API_KEY || "";

  return (
    <TrustlessWorkConfig baseURL={development} apiKey={apiKey}>
      {children}
    </TrustlessWorkConfig>
  );
}

Si renderizas este proveedor en el servidor, los hooks fallarán. Mantenlo en un componente cliente.

Envuelve tu aplicación

Elige el fragmento que coincida con tu configuración.

app/layout.tsx

import { TrustlessWorkProvider } from "@/trustless-work-provider";
 
export default function RootLayout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="en">
      <body>
        <TrustlessWorkProvider>{children}</TrustlessWorkProvider>
      </body>
    </html>
  );
}

src/app.tsx

import { TrustlessWorkProvider } from "./trustless-work-provider";
 
export function App() {
  return (
    <TrustlessWorkProvider>
      <YourApp />
    </TrustlessWorkProvider>
  );
}

Usa hooks y entidades

Ahora puedes llamar a los hooks del SDK desde cualquier componente bajo el proveedor.

Flujo típico:

Llama a un hook para obtener un XDR sin firmar.
Firma el XDR con la wallet del rol correcto.
Envíalo con useSendTransaction.

Leer: useSendTransaction.

Este SDK soporta single-release y multi-release escrows. Usa el hook y el tipo de payload correctos para cada flujo.

AnteriorIntroducción

SiguienteuseSendTransaction

Última actualización hace 7 meses