Trustless Work

https://docs.trustlesswork.com/trustless-work/
Admin
Trustless Work is an escrow infrastructure platform that enables developers to integrate...
Tokens:279,680
Snippets:2,471
Trust Score:5.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Querying Documentation Example

Source: https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/withdraw-remaining-funds

This example shows how to perform an HTTP GET request to query the documentation dynamically. Use the `ask` parameter for your question and the optional `goal` parameter for your end goal.

```http
GET https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/withdraw-remaining-funds.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### API Query Example

Source: https://docs.trustlesswork.com/trustless-work/api-rest/deploy-1/change-milestone-flag.md

This example shows how to query the documentation dynamically using an HTTP GET request. It includes the `ask` parameter for a specific question and an optional `goal` parameter for broader context.

```http
GET https://docs.trustlesswork.com/trustless-work/api-rest/deploy-1/change-milestone-flag.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Example

Source: https://docs.trustlesswork.com/trustless-work/introduction/technology-overview/escrow-types.md

Demonstrates how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' parameters.

```http
GET https://docs.trustlesswork.com/trustless-work/introduction/technology-overview/escrow-types.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.trustlesswork.com/trustless-work/api-rest/indexer/get-multiple-escrow-balance.md

This example shows how to query the documentation dynamically using an HTTP GET request. It includes the base URL and query parameters for asking a question and optionally specifying a broader goal.

```http
GET https://docs.trustlesswork.com/trustless-work/api-rest/indexer/get-multiple-escrow-balance.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with Parameters

Source: https://docs.trustlesswork.com/trustless-work/api-rest/introduction.md

This example demonstrates how to query the documentation dynamically using GET requests with 'ask' and optional 'goal' parameters.

```http
GET https://docs.trustlesswork.com/trustless-work/api-rest/introduction.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation API Example

Source: https://docs.trustlesswork.com/trustless-work/introduction/developer-resources/types/payloads/fund-escrow.md

Demonstrates how to perform an HTTP GET request to query documentation dynamically using the 'ask' and 'goal' query parameters. This is useful for retrieving information not explicitly present on a page.

```http
GET https://docs.trustlesswork.com/trustless-work/introduction/developer-resources/types/payloads/fund-escrow.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.trustlesswork.com/trustless-work/introduction/developer-resources/types/payloads/approve-milestone.md

Demonstrates how to query documentation dynamically using an HTTP GET request. This is useful for retrieving specific information or clarification not explicitly present on a page.

```http
GET https://docs.trustlesswork.com/trustless-work/introduction/developer-resources/types/payloads/approve-milestone.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation API

Source: https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/withdraw-remaining-funds

This example shows how to dynamically query the documentation using an HTTP GET request. You can ask specific questions or provide a broader goal to get tailored answers from the documentation.

```http
GET https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/withdraw-remaining-funds.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation API

Source: https://docs.trustlesswork.com/trustless-work/v2-en/oss-dapps/escrow-lab/wallet-setup

This example shows how to query the documentation dynamically using an HTTP GET request. It includes parameters for asking a question and specifying an end goal.

```http
GET https://docs.trustlesswork.com/trustless-work/v2-en/oss-dapps/escrow-lab/wallet-setup.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with `ask` Parameter

Source: https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/resolving-disputes

This example shows how to query the documentation dynamically using an HTTP GET request. You can ask specific questions by including the `ask` query parameter and optionally provide a broader `goal` for context. This mechanism is useful for retrieving information not explicitly present on the current page.

```http
GET https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/resolving-disputes.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Initialize Escrow and Sign Transaction

Source: https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/initialize-escrow

This example demonstrates how to initialize a multi-release escrow contract. It shows the process of creating an axios instance, calling the deploy endpoint to get an unsigned transaction, signing it with a wallet, and submitting the signed transaction to the Stellar network.

```typescript
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 () => {
    // Get the signer address
    const { address } = await kit.getAddress();

    // Execute the endpoint
    const response = await http.post(
      "/escrow/multi-release/v2/deploy",
      {
        // body requested for the endpoint
      },
    );
    
    // Get the unsigned transaction hash
    const { unsignedTransaction } = response.data;

    // Sign the transaction by wallet
    const { signedTxXdr } = await signTransaction(unsignedTransaction, {
      address,
      networkPassphrase: WalletNetwork.TESTNET,
    });

    // Send the transaction to Stellar Network
    const tx = await http.post("/stellar/submit-transaction", {
      signedXdr: signedTxXdr,
    });

    const { data } = tx;

    return data; 
}
```

--------------------------------

### Install SDK with npm

Source: https://docs.trustlesswork.com/trustless-work/escrow-react-sdk/getting-started.md

Install the Trustless Work SDK using npm. This is the first step in setting up the SDK.

```sh
npm install "@trustless-work/escrow"
```

--------------------------------

### Initialize Single Release Escrow

Source: https://docs.trustlesswork.com/trustless-work/api-rest/deploy/initialize-escrow.md

This example demonstrates how to call the /deployer/single-release endpoint to get an unsigned transaction for initializing an escrow. It includes setting up an Axios instance, executing the POST request, and handling the response to obtain the unsigned transaction for subsequent signing and network submission.

```typescript
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 () => {
    // Get the signer address
    const { address } = await kit.getAddress();

    // Execute the endpoint
    const response = await http.post(
      "/deployer/single-release",
      {
        // body requested for the endpoint
      },
    );
    
    // Get the unsigned transaction hash
    const { unsignedTransaction } = response.data;

    // Sign the transaction by wallet
    const { signedTxXdr } = await signTransaction(unsignedTransaction, {
      address,
      networkPassphrase: WalletNetwork.TESTNET,
    });

    // Send the transaction to Stellar Network
    const tx = await http.post("/helper/send-transaction", {
      signedXdr: signedTxXdr,
    });

    const { data } = tx;

    return data; 
}
```

--------------------------------

### Install All Escrow Blocks

Source: https://docs.trustlesswork.com/trustless-work/escrow-blocks-sdk/introduction.md

Use this command to install all available escrow blocks from the Trustless Work SDK. This is a broad installation command for the entire escrow functionality.

```bash
npx trustless-work add escrows
```

--------------------------------

### Trustless Work React Library Setup

Source: https://docs.trustlesswork.com/trustless-work/v2-en/ai/vibe-coding-or-react-sdk

Instructions for installing and configuring the Trustless Work React library in a Next.js application. Includes dependency installation, provider setup, and ensuring correct imports and types.

```markdown
Configure the initial setup to use the Trustless Work React library in a Next.js app.

- Install the required dependency.
- Set up the provider at the app root.
- Ensure all imports are correct.
- Use TypeScript if types are available in the documentation.
```

--------------------------------

### Install Trustless Work AI Skill

Source: https://docs.trustlesswork.com/trustless-work/ai/skill.md

Install the Trustless Work skill directly into your supported AI agent using npx. This command handles the necessary setup for your AI.

```bash
npx skills add trustless-work/trustless-work-dev-skill
```

--------------------------------

### Install Core and Listing Dependencies via CLI

Source: https://docs.trustlesswork.com/trustless-work/escrow-blocks-sdk/dependent-blocks.md

Use this CLI command to install core dependencies like wallet-kit, tanstack, and providers, along with specific escrow release modules needed for listings.

```sh
npx trustless-work add wallet-kit
npx trustless-work add tanstack
npx trustless-work add providers

npx trustless-work add escrows/single-release
# npx trustless-work add escrows/multi-release
# npx trustless-work add escrows/single-multi-release

npx trustless-work add handle-errors
npx trustless-work add helpers
```

--------------------------------

### Install Dependencies for Listings (CLI)

Source: https://docs.trustlesswork.com/trustless-work/v2-en/escrow-blocks-sdk/dependent-blocks

Use these CLI commands to install the core and action-specific dependencies required for Listings blocks like 'Escrows by Signer' and 'Escrows by Role'. Include all providers for listings as they open dialogs and need context.

```sh
# Core
npx trustless-work add wallet-kit
npx trustless-work add tanstack
npx trustless-work add providers

# Actions (pick what you need)
npx trustless-work add escrows/single-release
# npx trustless-work add escrows/multi-release
# npx trustless-work add escrows/single-multi-release

# Optional utility modules
npx trustless-work add handle-errors
npx trustless-work add helpers
```

--------------------------------

### HTTP GET Request Example for Querying Documentation

Source: https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/release-funds

Illustrates how to query the TrustlessWork documentation dynamically using an HTTP GET request. This is useful for retrieving specific information not immediately apparent on the page or for clarification.

```http
GET https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/release-funds.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### TypeScript Axios Example for Get Escrows

Source: https://docs.trustlesswork.com/trustless-work/api-rest/indexer/get-escrow-by-contract-id.md

This TypeScript code snippet demonstrates how to use Axios to make a GET request to the /helper/get-escrows-by-signer endpoint. It shows how to configure the base URL, headers, and pass query parameters.

```typescript
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 () => {

    const data = await http.get(
      "/escrow/single-release/get-escrows-by-signer?signer=GPUACN...." 
    ); 
  
    return data;
}
```

--------------------------------

### Platform Address vs. Receiver Example

Source: https://docs.trustlesswork.com/trustless-work/introduction/technology-overview/roles-in-trustless-work.md

Illustrates the distinction between the Platform Address, which collects fees, and the Receiver, which gets the escrow payout. This example clarifies that the Platform Address is for fees while the Receiver is for the actual escrow funds.

```plaintext
Receiver = freelancerPlatform Address = marketplace fee wallet
```

--------------------------------

### Use Example: Manage Milestones API

Source: https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/manage-milestones

This example demonstrates how to interact with the Manage Milestones API to get an unsigned transaction, sign it with a wallet, and submit it to the Stellar Network. Ensure you have your API key and wallet integration set up.

```typescript
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 () => {
      // Get the signer address
      const { address } = await kit.getAddress();

      const response = await http.post(
        "/escrow/single-release/v2/manage-milestones",
        {
          // body requested for the endpoint
        },
      );

      // Get the unsigned transaction hash
      const { unsignedTransaction } = response.data;

      // Sign the transaction by wallet
      const { signedTxXdr } = await signTransaction(unsignedTransaction, {
        address,
        networkPassphrase: WalletNetwork.TESTNET,
      });

      // Send the transaction to Stellar Network
      const tx = await http.post("/stellar/submit-transaction", {
        signedXdr: signedTxXdr,
      });

      const { data } = tx;

      return data;

```

--------------------------------

### TypeScript Example for Fetching Escrows

Source: https://docs.trustlesswork.com/trustless-work/api-rest/indexer/get-escrow-by-contract-id-1.md

This TypeScript example demonstrates how to use the axios library to make a GET request to the /escrow/single-release/get-escrows-by-role endpoint. Ensure you replace 'your_api_key' with your actual API key and 'GPUACN....' with a valid role address.

```typescript
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 () => {

    const data = await http.get(
      "/escrow/single-release/get-escrows-by-role?role=approver?roleAddress=GPUACN...." 
    ); 
  
    return data;
}
```

--------------------------------

### Querying Documentation with `ask` and `goal` Parameters

Source: https://docs.trustlesswork.com/trustless-work/introduction/developer-resources/types/responses.md

Demonstrates how to query documentation dynamically using GET requests with `ask` and optional `goal` query parameters.

```http
GET https://docs.trustlesswork.com/trustless-work/introduction/developer-resources/types/responses.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Update Escrow Properties TypeScript Example

Source: https://docs.trustlesswork.com/trustless-work/api-rest/deploy-1/update-escrow-properties.md

This example demonstrates how to use the `axios` library to call the update escrow properties endpoint. It includes steps for getting the signer address, sending the update request, and then signing and sending the resulting transaction.

```typescript
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 () => {
    // Get the signer address
    const { address } = await kit.getAddress();

    const response = await http.put(
      "/escrow/multi-release/update-escrow",
      {
        // body requested for the endpoint
      },
    ); 
    
    // Get the unsigned transaction hash
    const { unsignedTransaction } = response.data;

    // Sign the transaction by wallet
    const { signedTxXdr } = await signTransaction(unsignedTransaction, {
      address,
      networkPassphrase: WalletNetwork.TESTNET,
    });

    // Send the transaction to Stellar Network
    const tx = await http.post("/helper/send-transaction", {
      signedXdr: signedTxXdr,
    });

    const { data } = tx;

    return data;
}
```

--------------------------------

### Add Providers

Source: https://docs.trustlesswork.com/trustless-work/escrow-blocks-sdk/single-release-lifecycle.md

Installs necessary providers for your application, useful if the init command was skipped.

```bash
npx trustless-work add providers
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.trustlesswork.com/trustless-work/oss-dapps/escrow-lab/trustlines

Demonstrates how to query the documentation dynamically using a GET request. Include the 'ask' query parameter for your question and optionally the 'goal' parameter to tailor the response.

```http
GET https://docs.trustlesswork.com/trustless-work/oss-dapps/escrow-lab/trustlines.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Install Wallet Kit using npm

Source: https://docs.trustlesswork.com/trustless-work/escrow-blocks-sdk/wallet-kit.md

Execute this command to add the Wallet Kit code component to your project.

```shell
npx trustless-work add wallet-kit
```

--------------------------------

### TypeScript Example: Fetching Escrows by Contract IDs

Source: https://docs.trustlesswork.com/trustless-work/api-rest/indexer/get-escrow-by-contract-ids.md

This example demonstrates how to use Axios in TypeScript to call the GET /helper/get-escrow-by-contract-ids endpoint. It includes setting up the Axios instance with base URL, timeout, and headers, and constructing the query parameters for contract IDs and on-chain validation.

```typescript
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 () => {
  const contractIds = [
    "CCR6HLU3LQMXOESNA6TOS2RZKGEBWQG3EN5FMZNC43RVXZWTTDCZ...",
    "CCA7WTCVCQ5JPKNIFSHPSJLJ3FJ3GKPNEVAIHP6T..."
  ];
  const validateOnChain = true;

  const params = new URLSearchParams();
  contractIds.forEach(id => params.append("contractIds[]", id));
  params.append("signer", signer);
  params.append("validateOnChain", validateOnChain.toString());

  const response = await http.get(`/helper/get-escrow-by-contract-ids?${params.toString()}`);
  return response;
}
```

--------------------------------

### Clone and Set Up Repository

Source: https://docs.trustlesswork.com/trustless-work/community-and-contribution/get-involved.md

Clone your forked repository and add the upstream remote for syncing with the main project.

```sh
git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
cd REPOSITORY_NAME
git remote add upstream https://github.com/TrustlessWork/REPOSITORY_NAME.git
```

--------------------------------

### Import and Basic Usage of useGetMultipleEscrowBalances

Source: https://docs.trustlesswork.com/trustless-work/escrow-react-sdk/indexer/usegetmultipleescrowbalances.md

Demonstrates how to import and use the useGetMultipleEscrowBalances hook to get escrow balances. It shows the initial setup and the call to the getMultipleBalances function with a payload.

```typescript
import { useGetMultipleEscrowBalances } from "@trustless-work/escrow/hooks";
import { GetBalanceParams } from "@trustless-work/escrow/types";

/*
 *  useGetEscrow
*/
const { getMultipleBalances } = useGetMultipleEscrowBalances();

/* 
 * It returns the balances of the escrows
 * payload should be of type `GetBalanceParams`
*/
await getMultipleBalances(payload);
```

--------------------------------

### Initialize Escrow and Sign Transaction

Source: https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/initialize-escrow

This example demonstrates how to call the escrow deployment endpoint, retrieve the unsigned transaction, sign it using a wallet, and submit it to the Stellar network. Ensure you have your API key and wallet integration set up.

```typescript
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 () => {
    // Get the signer address
    const { address } = await kit.getAddress();

    // Execute the endpoint
    const response = await http.post(
      "/escrow/single-release/v2/deploy",
      {
        // body requested for the endpoint
      },
    );
    
    // Get the unsigned transaction hash
    const { unsignedTransaction } = response.data;

    // Sign the transaction by wallet
    const { signedTxXdr } = await signTransaction(unsignedTransaction, {
      address,
      networkPassphrase: WalletNetwork.TESTNET,
    });

    // Send the transaction to Stellar Network
    const tx = await http.post("/stellar/submit-transaction", {
      signedXdr: signedTxXdr,
    });

    const { data } = tx;

    return data; 
}
```

--------------------------------

### API Querying Instructions

Source: https://docs.trustlesswork.com/trustless-work/api-rest/deploy/release-funds.md

Instructions on how to query the documentation dynamically using HTTP GET requests. It explains the use of 'ask' and optional 'goal' query parameters for retrieving specific information.

```http
GET https://docs.trustlesswork.com/trustless-work/api-rest/deploy/release-funds.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Full Withdrawal Flow with useWithdrawRemainingFunds

Source: https://docs.trustlesswork.com/trustless-work/v2-en/escrow-react-sdk/escrows/usewithdrawremainingfunds

Illustrates a complete workflow for withdrawing remaining funds, including using useWithdrawRemainingFunds to get an unsigned transaction, signing it with a wallet, and sending it via useSendTransaction. This example is suitable for form submissions.

```typescript
import {
  useWithdrawRemainingFunds,
  useSendTransaction,
} from "@trustless-work/escrow/hooks";
import {
  WithdrawRemainingFundsPayload
} from "@trustless-work/escrow/types";

export const useStartDisputeForm = () => {

 /*
  *  useWithdrawRemainingFunds
 */
 const { withdrawRemainingFunds } = useWithdrawRemainingFunds();
 
 /*
  *  useSendTransaction
 */
 const { sendTransaction } = useSendTransaction();

/*
 * onSubmit function, this could be called by form button
*/
 const onSubmit = async (payload: WithdrawRemainingFundsPayload) => {

    try {
      /**
       * API call by using the trustless work hooks
       * @Note:
       * - We need to pass the payload to the withdrawRemainingFunds function
       * - The result will be an unsigned transaction
       */
      const { unsignedTransaction } = await withdrawRemainingFunds (
        payload
      );

      if (!unsignedTransaction) {
        throw new Error(
          "Unsigned transaction is missing from withdrawRemainingFunds."
        );
      }

      /**
       * @Note:
       * - We need to sign the transaction using your [private key] such as wallet
       * - The result will be a signed transaction
       */
      const signedXdr = await signTransaction({ /* This method should be provided by the wallet */
        unsignedTransaction,
        address: walletAddress || "",
      });

      if (!signedXdr) {
        throw new Error("Signed transaction is missing.");
      }

      /**
       * @Note:
       * - We need to send the signed transaction to the API
       * - The data will be an SendTransactionResponse
       */
      const data = await sendTransaction(signedXdr);

      /**
       * @Responses:
       * data.status === "SUCCESS"
       * - Dispute resolved successfully
       * - Show a success toast
       *
       * data.status == "ERROR"
       * - Show an error toast
       */
      if (data.status === "SUCCESS") {
         toast.success("Withdrawal successful");
      }
    } catch (error: unknown) {
      // catch error logic
    }
  };
}
```

--------------------------------

### Query Documentation with AI Agent

Source: https://docs.trustlesswork.com/trustless-work/v2-en/oss-dapps/escrow-lab/forms/change-milestone-status

Perform an HTTP GET request to query documentation dynamically. Use the `ask` parameter for specific questions and the optional `goal` parameter to guide the AI's response towards a broader objective.

```http
GET https://docs.trustlesswork.com/trustless-work/v2-en/oss-dapps/escrow-lab/forms/change-milestone-status.md?ask=<question>&goal=<endgoal>
```
Tokens:
Raw