Getting Started

Overview

The Trustless Work React SDK is a collection of hooks and typed entities.

It uses Axios for HTTP requests.

Write flows require an API key (NEXT_PUBLIC_API_KEY). Read-only calls can work without one.

Quick links

Title

NPM package

Link

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

Title

API basics (base URLs, Swagger, limits)

Link

Introduction

Title

Send signed transactions (XDR)

Link

useSendTransaction

Setup

Installation

Install the SDK.

npm install "@trustless-work/escrow"

yarn add "@trustless-work/escrow"

Configure the provider

You’ll configure 2 things:

baseURL: use development (testnet) or mainNet (mainnet).
apiKey: from the BackOffice dApp.

The SDK exports TrustlessWorkConfig. Wrap your app with it to enable all hooks.

src/trustless-work-provider.tsx

"use client"; // make sure this is a client component

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

  // mainnet environment = "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>
  );
}

If you render this provider on the server, hooks will break. Keep it in a client component.

Wrap your app

Pick the snippet that matches your setup.

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>
  );
}

Use hooks and entities

You can now call SDK hooks from any component under the provider.

Typical flow:

Call a hook to get an unsigned XDR.
Sign the XDR with the correct role wallet.
Submit it with useSendTransaction.

Read: useSendTransaction.

This SDK supports single-release and multi-release escrows. Use the correct hook + payload type for each flow.

PreviousIntroduction

NextuseSendTransaction

Last updated 7 months ago