Garden Finance

https://docs.garden.finance/
Admin
Garden Finance enables cross-chain Bitcoin swaps and provides tools for developers to integrate...
Tokens:75,355
Snippets:862
Trust Score:7.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example JSON Response (From EVM)

Source: https://docs.garden.finance/api-reference/quickstart

This is an example of a JSON response when initiating an order from EVM.

```json
{
    "status": "Ok",
    "result": {
        "approval_transaction": {
            "chain_id": 11155111,
            "data": "0x095ea7b3000000000000000000000000d1e0ba2b165726b3a6051b765d4564d030fdcf50ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
            "gas_limit": "0xea60",
            "to": "0xe918a5a47b8e0afac2382bc5d1e981613e63fb07",
            "value": "0x0"
        },
        "initiate_transaction": {
            "chain_id": 11155111,
            "data": "0x97ffc7ae000000000000000000000000661ba32eb5f86cab358ddbb7f264b10c5825e2dd0000000000000000000000000000000000000000000000000000000000001c20000000000000000000000000000000000000000000000000000000000000c3507b32dd44045d8d6fc477615d0d72f42fc7696078e44724fe64c85b563fc8f306",
            "gas_limit": "0x493e0",
            "to": "0xd1e0ba2b165726b3a6051b765d4564d030fdcf50",
            "value": "0x0"
        },
        "order_id": "7e69c6514fa6c7a46b88e235e484d9958029cbe748e125add69b1ffcf7265198",
        "typed_data": {
            "domain": {
                "chainId": "0xaa36a7",
                "name": "HTLC",
                "verifyingContract": "0xd1e0ba2b165726b3a6051b765d4564d030fdcf50",
                "version": "3"
            },
            "message": {
                "amount": "0xc350",
                "redeemer": "0x661ba32eb5f86cab358ddbb7f264b10c5825e2dd"
            }
        }
    }
}
```

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

### Core dependencies

Source: https://docs.garden.finance/developers/sdk/nodejs/setup

Install the necessary packages using npm or yarn.

```bash
npm install @gardenfi/core @gardenfi/utils @gardenfi/orderbook viem @catalogfi/wallets
```

```bash
yarn add yarn add @gardenfi/core @gardenfi/utils @gardenfi/orderbook viem @catalogfi/wallets
```

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

### SDK Quickstart Steps

Source: https://docs.garden.finance/developers/overview

Steps for integrating with the Garden SDK, including getting a quote and executing the swap.

```text
getQuote()
swap()
```

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

### Get Quote (Ethereum Sepolia to Bitcoin Testnet)

Source: https://docs.garden.finance/api-reference/quickstart

Example of getting a quote to trade WBTC on Ethereum Sepolia to BTC on Bitcoin Testnet.

```bash
curl -X 'GET' \
  'https://testnet.api.garden.finance/v2/quote?from=ethereum_sepolia:wbtc&to=bitcoin_testnet:btc&from_amount=50000' \
  -H 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
  -H 'accept: application/json'
```

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

### Get Quote (Starknet to Bitcoin Testnet)

Source: https://docs.garden.finance/api-reference/quickstart

Example of getting a quote to trade WBTC on Starknet Sepolia to BTC on Bitcoin Testnet.

```bash
curl -X 'GET' 'https://testnet.api.garden.finance/v2/quote?from=starknet_sepolia:wbtc&to=bitcoin_testnet:btc&from_amount=50000' \
-H 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
-H 'accept: application/json'
```

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

### Example JSON Response (Quote)

Source: https://docs.garden.finance/api-reference/quickstart

This is an example of a JSON response when requesting a quote.

```json
{
    "status": "Ok",
    "result": [
        {
        "source": {
            "asset": "ethereum_sepolia:wbtc",
            "amount": "50000",
            "display": "0.00050000",
            "value": "58.8700"
        },
        "destination": {
            "asset": "bitcoin_testnet:btc",
            "amount": "49850",
            "display": "0.00049850",
            "value": "58.6933"
        },
        "solver_id": "0x9dd9c2d208b07bf9a4ef9ca311f36d7185749635",
        "estimated_time": 20,
        "slippage": 50,
        "fee": 30,
        "fixed_fee": "0.0"
        }
    ]
}
```

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

### API Quickstart Steps

Source: https://docs.garden.finance/developers/overview

Steps for integrating with the Garden API, including getting a quote, creating an order, initiating a swap, and monitoring its completion.

```text
GET /quote
POST /orders
Poll GET /orders/{id}
```

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

### Sign and send transaction

Source: https://docs.garden.finance/api-reference/quickstart

Example of signing and sending a transaction using a wallet.

```typescript
const buffer = Buffer.from(response.result.versioned_tx, 'base64');
const transaction = VersionedTransaction.deserialize(buffer);

// Sign and send using your wallet.
const signature = await wallet.signAndSendTransaction(transaction);
```

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

### Create a swap

Source: https://docs.garden.finance/developers/sdk/nodejs/quickstart

Creates a swap by first getting a quote for the desired amount and then initiating the swap with the obtained parameters. Replace '<YOUR_BITCOIN_ADDRESS' with the recipient's Bitcoin address.

```javascript
import { Quote, SwapParams } from '@gardenfi/core';
import { Assets, ChainAsset } from '@gardenfi/orderbook';

const fromAsset = ChainAsset.from(Assets.ethereum_sepolia.WBTC);
const toAsset = ChainAsset.from(Assets.bitcoin_testnet.BTC);

const sendAmount = '1000000'; // 0.01 WBTC

// Get the quote for the send amount
const quote = await garden.quote.getQuote(
    fromAsset,
    toAsset,
    sendAmount,
    false,
    {},
);

const receiveAmount = quote.val?.[0].destination.amount;
const solverId = quote.val?.[0].solver_id;
const sourceAddress = ethereumAccount.address;
const destinationAddress = '<YOUR_BITCOIN_ADDRESS';

const swapParams: SwapParams = {
    fromAsset,
    toAsset,
    sendAmount,
    receiveAmount,
    solverId,
    sourceAddress,
    destinationAddress
};

// Create the swap
const swapResult = await garden.createSwap(swapParams);

if (!swapResult.ok) {
    throw new Error(swapResult.error);
}

console.log('Order created and initiated ✅', swapResult.val);
```

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

### Quote Response from Bitcoin Testnet

Source: https://docs.garden.finance/api-reference/quickstart

This is an example response when getting a quote for a swap from Bitcoin Testnet.

```json
{
    "status": "Ok",
    "result": [
        {
            "source": {
                "asset": "bitcoin_testnet:btc",
                "amount": "49850",
                "display": "0.00049850",
                "value": "10.81"
            },
            "destination": {
                "asset": "arbitrum_sepolia:wbtc",
                "amount": "49850",
                "display": "0.00049850",
                "value": "49.85"
            },
            "solver_id": "0x90eb912279ee8a3c56f784a44dedffae4487524d",
            "estimated_time": 12,
            "slippage": 0,
            "fee": 30,
            "fixed_fee": "0"
        }
    ]
}
```

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

### Submit Order (Starknet to Bitcoin Testnet)

Source: https://docs.garden.finance/api-reference/quickstart

Example of submitting an order after receiving a quote for trading WBTC on Starknet Sepolia to BTC on Bitcoin Testnet.

```bash
curl --location 'https://testnet.api.garden.finance/v2/orders' \
        --header 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
        --header 'Content-Type: application/json' \
        --data '{ 
            "source": {
                "asset": "starknet_sepolia:wbtc",
                "owner": "0x00609190b1348bcc06da44d58c79709495c11a5a6f0b9e154e1209f2a17dd933",
                "amount": "50000"
            },
            "destination": {
                "asset": "bitcoin_testnet:btc",
                "owner": "tb1p4pr78swsn60y4ushe05v28mqpqppxxkfkxu2wun5jw6duc8unj3sjrh4gd",
                "amount": "49850"
            }
        }'
```

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

### Get Quote

Source: https://docs.garden.finance/api-reference/quickstart

Get a quote to trade 0.0005 BTC on Bitcoin Testnet4 to WBTC on Base Sepolia.

```bash
curl -X 'GET' 'https://testnet.api.garden.finance/v2/quote?from=bitcoin_testnet:btc&to=base_sepolia:wbtc&from_amount=50000' \
-H 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
-H 'accept: application/json'
```

```json
{
    "status": "Ok",
    "result": [
        {
        "source": {
            "asset": "bitcoin_testnet:btc",
            "amount": "50000",
            "display": "0.00050000",
            "value": "58.8200"
        },
        "destination": {
            "asset": "base_sepolia:wbtc",
            "amount": "49850",
            "display": "0.00049850",
            "value": "58.6435"
        },
        "solver_id": "0x9dd9c2d208b07bf9a4ef9ca311f36d7185749635",
        "estimated_time": 600,
        "slippage": 50,
        "fee": 30,
        "fixed_fee": "0.0"
        }
    ]
}
```

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

### Get Quote (From EVM)

Source: https://docs.garden.finance/api-reference/quickstart

Get a quote to trade WBTC on Ethereum Sepolia to BTC on Bitcoin Testnet4.

```bash
curl -X 'GET' 'https://testnet.api.garden.finance/v2/quote?from=ethereum_sepolia:wbtc&to=bitcoin_testnet:btc&from_amount=50000' \
        -H 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
        -H 'accept: application/json'
```

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

### Order Response from Bitcoin Testnet

Source: https://docs.garden.finance/api-reference/quickstart

This is an example response after submitting an order to initiate a swap from Bitcoin Testnet.

```json
{
    "status": "Ok",
    "result": {
        "swap_id": "tb1peepw3gum369qfu7zgnd6jq5sk77q5wyuzmznlpavzmeq8x72kcyqr66rxg",
        "chain": "bitcoin_testnet",
        "asset": "bitcoin_testnet:btc",
        "initiator": "460f2e8ff81fc4e0a8e6ce7796704e3829e3e3eedb8db9390bdc51f4f04cf0a6",
        "redeemer": "tb1p4pr78swsn60y4ushe05v28mqpqppxxkfkxu2wun5jw6duc8unj3sjrh4gd",
        "delegate": "03f4776668ef95e35ff2d51d8c59eb7a461bb2354b540553d8455dbec91087c1",
        "timelock": 12,
        "filled_amount": "0",
        "asset_price": 108107,
        "amount": "49850",
        "secret_hash": "7b32dd44045d8d6fc477615d0d72f42fc7696078e44724fe64c85b563fc8f306",
        "secret": "",
        "initiate_tx_hash": "",
        "redeem_tx_hash": "",
        "refund_tx_hash": "",
        "initiate_block_number": "0",
        "redeem_block_number": "0",
        "refund_block_number": "0",
        "required_confirmations": 0,
        "current_confirmations": 0,
        "initiate_timestamp": null,
        "redeem_timestamp": null,
        "refund_timestamp": null
    },
    "nonce": "4326423548464636342",
    "order_id": "7e69c6514fa6c7a46b88e235e484d9958029cbe748e125add69b1ffcf7265198",
    "affiliate_fees": [],
    "integrator": "DocsTesting",
    "version": "v3",
    "solver_id": "0x90eb912279ee8a3c56f784a44dedffae4487524d"
}

```

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

### Order Response

Source: https://docs.garden.finance/api-reference/quickstart

This is an example of the response received after submitting an order.

```json
{
    "status": "Ok",
    "result": {
        "order_id": "353e76a02a46c493a600f0a35e7e873dab370633f16f1d27af2570fc12ada3e8",
        "to": "tltc1p9am469q2d6mfpkgrlgpd4c7tzv2lv5rug2yn9vz6vx0myj9jr5kqrc76rt",
        "amount": "1000000"
    }
}
```

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

### Starknet Dependencies

Source: https://docs.garden.finance/developers/sdk/react/setup

Install Starknet-specific dependencies using npm or yarn.

```bash
npm install @starknet-react/core starknet starknetkit
```

```bash
yarn add @starknet-react/core starknet starknetkit
```

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

### Submit Order (Ethereum Sepolia to Bitcoin Testnet)

Source: https://docs.garden.finance/api-reference/quickstart

Example of submitting an order after receiving a quote for trading WBTC on Ethereum Sepolia to BTC on Bitcoin Testnet.

```bash
curl --location 'https://testnet.api.garden.finance/v2/orders' \
    --header 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
    --header 'Content-Type: application/json' \
    --data '{ 
        "source": {
            "asset": "ethereum_sepolia:wbtc",
            "owner": "0x00609190b1348bcc06da44d58c79709495c11a5a6f0b9e154e1209f2a17dd933",
            "amount": "50000"
        },
        "destination": {
            "asset": "bitcoin_testnet:btc",
            "owner": "tb1p4pr78swsn60y4ushe05v28mqpqppxxkfkxu2wun5jw6duc8unj3sjrh4gd",
            "amount": "49850"
        }
    }'
```

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

### Solana Dependencies

Source: https://docs.garden.finance/developers/sdk/react/setup

Install Solana-specific dependencies using npm or yarn.

```bash
npm install @coral-xyz/anchor @solana/wallet-adapter-react
```

```bash
yarn add @coral-xyz/anchor @solana/wallet-adapter-react
```

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

### Get Quote from Solana

Source: https://docs.garden.finance/api-reference/quickstart

This bash command retrieves a quote for swapping SOL on Solana Testnet to BTC on Bitcoin Testnet4.

```bash
curl -X 'GET' 'https://testnet.api.garden.finance/v2/quote?from=solana_testnet:sol&to=bitcoin_testnet:btc&from_amount=354608265' \
-H 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
-H 'accept: application/json'
```

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

### Core Garden Protocol Packages

Source: https://docs.garden.finance/developers/sdk/react/setup

Install the core Garden Protocol packages using npm or yarn.

```bash
npm install @gardenfi/core @gardenfi/orderbook @gardenfi/react-hooks @tanstack/react-query wagmi
```

```bash
yarn add @gardenfi/core @gardenfi/orderbook @gardenfi/react-hooks @tanstack/react-query wagmi
```

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

### Check Order Status

Source: https://docs.garden.finance/api-reference/quickstart

Example using curl to check the status of an order.

```bash
curl -X 'GET' \
'https://testnet.api.garden.finance/v2/orders/ee54521431fd3b7c01f46f2aaec086362d8cf2d6a7d3b31233c66c31bed9e4eb' \
-H 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
-H 'accept: application/json'
```

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

### Example JSON Response for a completed swap

Source: https://docs.garden.finance/api-reference/quickstart

This JSON object shows the structure of a response after a swap has been completed, including transaction hashes and block numbers.

```json
{
                    "secret": "f1a5f527cdffa795cd571b833e726a67df4ecfa77f5b01cbecd6c35c1e74eca4",
                    "initiate_tx_hash": "0xc520b684eb9376b83622fb12871a8a96b5cdf4be68914abd426d24850ccf310f",
                    "redeem_tx_hash": "0x1abd4e96badd88915547c0c67bea14de545fc78dc4e034aa37dc3ee94243bbf5",
                    "refund_tx_hash": "",
                    "initiate_block_number": "233982423",
                    "redeem_block_number": "233982458",
                    "refund_block_number": "0",
                    "required_confirmations": 0,
                    "current_confirmations": 0,
                    "initiate_timestamp": "2026-01-16T11:17:59Z",
                    "redeem_timestamp": "2026-01-16T11:18:07Z",
                    "refund_timestamp": null
                },
                "nonce": "1768562205873",
                "order_id": "b0d73ffcc814f4b6476be779d588985aeb178ba6eeee27a5cf4d9d33461b4005",
                "affiliate_fees": [],
                "integrator": "DocsTesting",
                "version": "v3",
                "solver_id": "0x90eb912279ee8a3c56f784a44dedffae4487524d"
            }
        }
```

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

### Get Quote (Sui Testnet to Bitcoin Testnet)

Source: https://docs.garden.finance/api-reference/quickstart

This bash command retrieves a quote for trading Sui on Sui Testnet to BTC on Bitcoin Testnet4.

```bash
curl -X 'GET' 'https://testnet.api.garden.finance/v2/quote?from=sui_testnet:sui&to=bitcoin_testnet:btc&from_amount=3000000000' \
-H 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
-H 'accept: application/json'
```

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

### Initialize wallets and providers

Source: https://docs.garden.finance/developers/sdk/nodejs/quickstart

Initializes Ethereum, Starknet, and Solana wallets and providers. Replace placeholders like '<YOUR_EVM_PRIVATE_KEY>' with your actual private keys and addresses.

```typescript
import {
    BitcoinProvider,
    BitcoinNetwork,
    BitcoinWallet,
} from '@gardenfi/core';
import { with0x } from '@gardenfi/utils';
import { createWalletClient, http } from 'viem';
import { privateKeyToAccount } from 'viem/accounts';
import { arbitrumSepolia } from 'viem/chains';
import { RpcProvider, Account } from 'starknet';
import * as anchor from '@coral-xyz/anchor';
import { web3 } from '@coral-xyz/anchor';

// Ethereum wallet setup
const ethereumAccount = privateKeyToAccount(with0x('<YOUR_EVM_PRIVATE_KEY>'));
const ethereumWalletClient = createWalletClient({
    account: ethereumAccount,
    chain: arbitrumSepolia,
    transport: http(),
});

// Starknet wallet setup
const starknetProvider = new RpcProvider(); // Using default RPC URL
const starknetWallet = new Account({
    provider: starknetProvider,
    signer: <YOUR_STARKNET_PRIVATE_KEY>,
    address: <YOUR_STARKNET_ADDRESS>,
});

// Solana wallet setup
const solanaPrivKeyBytes = new Uint8Array('<YOUR_SOLANA_PRIVATE_KEY_IN_BYTES>');
const solanaUser = web3.Keypair.fromSecretKey(solanaPrivKeyBytes);
const solanaConnection = new web3.Connection(RPC_URL, { commitment: 'confirmed' });
const solanaWallet = new anchor.Wallet(solanaUser);
const solanaProvider = new anchor.AnchorProvider(solanaConnection, solanaWallet);
```

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

### GET /apps/earnings OpenAPI Specification

Source: https://docs.garden.finance/api-reference/endpoint/affiliate/get-earnings

OpenAPI 3.1.0 specification for the GET /apps/earnings endpoint, detailing request and response structures, including example data.

```yaml
GET /apps/earnings
openapi: 3.1.0
info:
  title: Garden API
  version: 2.0.0
  description: API specification for various endpoints.
servers:
  - url: https://{environment}.garden.finance/v2
    variables:
      environment:
        default: api
        enum:
          - api
          - testnet.api
security:
  - garden-app-id: []
paths:
  /apps/earnings:
    get:
      summary: Get affiliate earnings.
      responses:
        '200':
          description: List of affiliate earnings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffiliateEarningsResponse'
              example:
                status: Ok
                result:
                  - total_earnings: '15075000000'
                    total_earnings_usd: '15075'
                    affiliate: '0x004Cc75ACF4132Fc08cB6a252E767804F303F729'
                    asset: ethereum:usdc
                    token_address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
                    claim_amount: '5075000000'
                    claim_amount_usd: '5075'
                    claim_signature: >-
                      0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1b
                    claim_contract: '0x5EbEC4D8DA437b2BAD656D43d40fE412bA5D217a'
                  - total_earnings: '30000000'
                    total_earnings_usd: '30000'
                    affiliate: '0x004Cc75ACF4132Fc08cB6a252E767804F303F729'
                    asset: ethereum:cbbtc
                    token_address: '0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf'
components:
  schemas:
    AffiliateEarningsResponse:
      allOf:
        - $ref: '#/components/schemas/Response'
        - type: object
          required:
            - result
          properties:
            result:
              type: array
              items:
                $ref: '#/components/schemas/AffiliateEarningsItem'
    Response:
      type: object
      properties:
        status:
          type: string
          enum:
            - Ok
            - Error
        error:
          type: string
          nullable: true
    AffiliateEarningsItem:
      type: object
      properties:
        total_earnings:
          type: string
          description: Total earnings in asset units for the affiliate.
        total_earnings_usd:
          type: string
          description: Total earnings in USD for the mentioned asset for the affiliate.
        affiliate:
          type: string
          description: The address that will receive the earnings.
        asset:
          $ref: '#/components/schemas/AffiliateFeeAsset'
        token_address:
          type: string
          description: Contract address for the affiliate fee asset.
        claim_amount:
          type: string
          description: >-
            Amount available for claiming in asset units. Only included if the
            affiliate has not yet claimed their earnings.
        claim_amount_usd:
          type: string
          description: >-
            Amount available for claiming in USD. Only included if the affiliate
            has not yet claimed their earnings.
        claim_signature:
          type: string
          description: >-
            Signature for claiming earnings. Only included if the affiliate has
            not yet claimed their earnings.
        claim_contract:
          type: string
          description: >-
            Contract address for claiming earnings. Only included if the
            affiliate has not yet claimed their earnings.
      required:
        - total_earnings
        - total_earnings_usd
        - affiliate
        - asset
        - token_address
    AffiliateFeeAsset:
      oneOf:
        - type: string
          title: mainnet
          description: Mainnet
          enum:
            - arbitrum:usdc
            - arbitrum:cbbtc
            - base:usdc
            - base:cbbtc
            - ethereum:usdc
            - ethereum:cbbtc
        - type: string
          title: testnet
          description: Testnet
          enum:
            - arbitrum_sepolia:usdc
            - base_sepolia:usdc
            - citrea_testnet:usdc
            - citrea_testnet:cbbtc
            - ethereum_sepolia:usdc
            - monad_testnet:usdc
            - monad_testnet:cbbtc
  securitySchemes:
    garden-app-id:
      type: apiKey
      name: garden-app-id
      in: header
      description: >-
        If you do not yet have an app ID, please follow these
        [steps](/api-reference/setup).
```

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

### Configure Garden instance with default wallet clients

Source: https://docs.garden.finance/developers/sdk/nodejs/quickstart

Configures the Garden instance using the default wallet clients initialized in the previous step. Replace '<YOUR_API_KEY>' with your actual API key.

```javascript
import { Garden } from '@gardenfi/core';
import { Network } from '@gardenfi/utils';

const garden = Garden.fromWallets({
    environment: Network.TESTNET,
    apiKey: '<YOUR_API_KEY>',
    wallets: {
        evm: ethereumWalletClient,
        starknet: starknetWallet,
        solana: solanaProvider
    }
});
```

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

### Initiate a swap

Source: https://docs.garden.finance/api-reference/quickstart

This snippet shows how to initiate a swap by constructing and signing a typed data message.

```typescript
await window.ethereum.request({
    method: 'eth_sendTransaction',
    params: [response.result.transaction]
});
```

```typescript
// Sign typed data.
const signature = await window.ethereum.request({
    method: 'eth_signTypedData_v4',
    params: [userAddress, JSON.stringify(response.result.typed_data)]
});

// Initiate the swap with the signature.
await fetch(`https://testnet.api.garden.finance/v2/orders/${response.result.order_id}?action=initiate`, {
    method: 'PATCH',
    headers: {
        'garden-app-id': 'f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({ signature })
});
```

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

### Initiate a swap

Source: https://docs.garden.finance/api-reference/quickstart

This code snippet shows how to initiate a swap by constructing the necessary transaction data.

```typescript
await account.execute([
                {
                    contractAddress: response.result.transaction.to,
                    entrypoint: response.result.transaction.selector,
                    calldata: response.result.transaction.calldata
                }
            ]);

```

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

### Submit Order

Source: https://docs.garden.finance/api-reference/quickstart

Submit the order once a quote is received. Use `amount` and `asset` from the quote response. Use your wallet addresses for `owner`.

```bash
curl --location 'https://testnet.api.garden.finance/v2/orders' \
    --header 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
    --header 'Content-Type: application/json' \
    --data '{
                "source": {
                    "asset": "bitcoin_testnet:btc",
                    "owner": "tb1p4pr78swsn60y4ushe05v28mqpqppxxkfkxu2wun5jw6duc8unj3sjrh4gd",
                    "amount": "50000"
                },
                "destination": {
                    "asset": "base_sepolia:wbtc",
                    "owner": "0x004Cc75ACF4132Fc08cB6a252E767804F303F729",
                    "amount": "49850"
                }
            }'
```

```json
{
    "status": "Ok",
    "result": {
        "order_id": "f8a12d1320fce93c5888b6014abeb5f5de85ecc8c0eef8133f3da03822592121",
        "to": "tb1ptt49v22dcst7mquwfsmcu2t56xjg07whtcgufvhjuj5zu89y6q0qn8fvfp",
        "amount": "50000"
    }
}
```

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

### Initiate Swap from Bitcoin Testnet

Source: https://docs.garden.finance/api-reference/quickstart

This code snippet shows how to initiate a swap from Bitcoin Testnet to Arbitrum Sepolia.

```bash
curl -X 'POST' \
  'https://testnet.api.garden.finance/v2/orders' \
  -H 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "source": {
        "asset": "bitcoin_testnet:btc",
        "owner": "tb1peepw3gum369qfu7zgnd6jq5sk77q5wyuzmznlpavzmeq8x72kcyqr66rxg",
        "amount": "49850"
    },
    "destination": {
        "asset": "arbitrum_sepolia:wbtc",
        "owner": "0xA39ABb978cfd2ba459163ad1EaB6E8940Fbf4359",
        "amount": "49850"
    }
}'
```

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

### Submit Order (From EVM)

Source: https://docs.garden.finance/api-reference/quickstart

Submit an order after receiving a quote, using the amount and asset from the quote response and your wallet addresses for owner.

```bash
curl --location 'https://testnet.api.garden.finance/v2/orders' \
        --header 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
        --header 'Content-Type: application/json' \
        --data '{ \
            "source": { \
                "asset": "ethereum_sepolia:wbtc", \
                "owner": "0x4cD3FB4a504cc978f316a81Dc5165D2C5b30592d", \
                "amount": "50000" \
            }, \
            "destination": { \
                "asset": "bitcoin_testnet:btc", \
                "owner": "tb1p4pr78swsn60y4ushe05v28mqpqppxxkfkxu2wun5jw6duc8unj3sjrh4gd", \
                "amount": "49850" \
            } \
        }'
```

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

### Order Status Response

Source: https://docs.garden.finance/api-reference/quickstart

This is an example of the response when checking an order's status.

```json
{
    "status": "Ok",
    "result": {
        "created_at": "2026-01-08T06:03:46.125199Z",
        "source_swap": {
            "created_at": "2026-01-08T06:03:46.125199Z",
            "swap_id": "tltc1pqujpwdy2syf0agyyeg8xn0nwhy8qjxe9sqchmv563q7up9cgzc5q5cdl6s",
            "chain": "litecoin_testnet",
            "asset": "litecoin_testnet:ltc",
            "initiator": "c3989e1d1359c83db04785c14ee84f05210acc3bb4d270619559632869c15c3b",
            "redeemer": "2623c14333640ab262b4dda40382e64da8c20e78e98d597e218568fb5fe3e283",
            "timelock": 144,
            "filled_amount": "1000000",
            "asset_price": 81.64041962329875,
            "amount": "1000000",
            "secret_hash": "81e8dd7fd72d336f2ac3fbdece4d046054d0d114c511bf831cf4df61097c9aa5",
            "secret": "197b2e1e1105c9bec013e9a081dd13378855bd7a3b65b3fcd396a0d965bc506f",
            "initiate_tx_hash": "6dc881199ce0fac5287cf55761dceec7347bbb328fe6fc7f13207afe06f5f3f6:4512211",
            "redeem_tx_hash": "c6d176a2be224686e43cc837bd70f05b64711b314aa91015c42b8a31a7f35ce1",
            "refund_tx_hash": "",
            "initiate_block_number": "4512211",
            "redeem_block_number": "4512212",
            "refund_block_number": "0",
            "required_confirmations": 1,
            "current_confirmations": 1,
            "initiate_timestamp": "2026-01-08T06:08:10Z",
            "redeem_timestamp": "2026-01-08T06:12:39Z",
            "refund_timestamp": null
        },
        "destination_swap": {
            "created_at": "2026-01-08T06:03:46.125199Z",
            "swap_id": "8334288fa1924abe3c89bbc709e95f8caae605534a6cd268315f943d6bd72c19",
            "chain": "base_sepolia",
            "asset": "base_sepolia:wbtc",
            "initiator": "0x133C4FCaBf1e79AE04100da0cDEC281a82ca226C",
            "redeemer": "0xf519fa84c50E3459a570a1a514d2eaA960AFf934",
            "timelock": 3600,
            "filled_amount": "896",
            "asset_price": 90802.0,
            "amount": "896",
            "secret_hash": "81e8dd7fd72d336f2ac3fbdece4d046054d0d114c511bf831cf4df61097c9aa5",
            "secret": "197b2e1e1105c9bec013e9a081dd13378855bd7a3b65b3fcd396a0d965bc506f",
            "initiate_tx_hash": "0xa28991ceecde416fd5acec5863ce0688d6e2500af2f94156ed4baf22a3b04f36",
            "redeem_tx_hash": "0x2c4c740be46277f4ac9b12b438f9278fd49ca403c742a0860ad0cd10ab04d381",
            "refund_tx_hash": "",
            "initiate_block_number": "36042112",
            "redeem_block_number": "36042116",
            "refund_block_number": "0"
        }
    }
}
```

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

### Configure Garden instance with custom client configuration

Source: https://docs.garden.finance/developers/sdk/nodejs/quickstart

Initializes the Garden instance with custom HTLC client implementations. This requires knowledge of the specific HTLC interfaces for each blockchain.

```javascript
import { Garden } from '@gardenfi/core';
import { Network } from '@gardenfi/utils';

const garden = new Garden({
    environment: Network.TESTNET,
    apiKey: '<YOUR_API_KEY>',
    htlc: {
        evm: <IEVMHTLC>,
        starknet: <IStarknetHTLC>,
        solana: <ISolanaHTLC>
    },
});
```

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

### Submit Order (Sui Testnet to Bitcoin Testnet)

Source: https://docs.garden.finance/api-reference/quickstart

This bash command submits an order to trade Sui on Sui Testnet to BTC on Bitcoin Testnet4.

```bash
curl --location 'https://testnet.api.garden.finance/v2/orders' \
    --header 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
    --header 'Content-Type: application/json' \
    --data '{ \
        "source": { \
            "asset": "sui_testnet:sui", \
            "owner": "0x79a1582388c16d0ab85904f320eb0527481391a9b9ab4b2ab46adc4c2564f9d0", \
            "amount": "3000000000" \
        }, \
        "destination": { \
            "asset": "bitcoin_testnet:btc", \
            "owner": "tb1p4pr78swsn60y4ushe05v28mqpqppxxkfkxu2wun5jw6duc8unj3sjrh4gd", \
            "amount": "9079" \
        } \
    }'
```

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

### Get Quote

Source: https://docs.garden.finance/api-reference/quickstart

This `curl` command demonstrates how to get a quote for trading 0.01 LTC on Litecoin Testnet to WBTC on Base Sepolia. It includes the API endpoint, asset details, and required headers.

```bash
curl -X 'GET' 'https://testnet.api.garden.finance/v2/quote?from=litecoin_testnet:ltc&to=base_sepolia:wbtc&from_amount=1000000' \
-H 'garden-app-id: f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796' \
-H 'accept: application/json'
```

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

### OpenAPI Specification for GET /policy

Source: https://docs.garden.finance/api-reference/endpoint/blockchain/get-policy

This OpenAPI 3.1.0 specification defines the GET /policy endpoint, including request parameters, response schemas, and example data for route policy configuration.

```yaml
GET /policy
openapi: 3.1.0
info:
  title: Garden API
  version: 2.0.0
  description: API specification for various endpoints.
servers:
  - url: https://{environment}.garden.finance/v2
    variables:
      environment:
        default: api
        enum:
          - api
          - testnet.api
security:
  - garden-app-id: []
paths:
  /policy:
    get:
      summary: Get route policy configuration.
      responses:
        '200':
          description: Route policy configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyResponse'
              example:
                status: Ok
                result:
                  default: open
                  isolation_groups:
                    - ethereum:SEED <-> arbitrum:SEED
                  blacklist_pairs:
                    - bitcoin:BTC -> starknet:*
                  whitelist_overrides: []
components:
  schemas:
    PolicyResponse:
      allOf:
        - $ref: '#/components/schemas/Response'
        - type: object
          properties:
            result:
              $ref: '#/components/schemas/RoutePolicy'
    Response:
      type: object
      properties:
        status:
          type: string
          enum:
            - Ok
            - Error
        error:
          type: string
          nullable: true
    RoutePolicy:
      type: object
      title: Route Policy Configuration
      properties:
        default:
          type: string
          enum:
            - open
            - closed
          default: open
          description: Default policy for routes not covered by specific rules.
        isolation_groups:
          type: array
          items:
            type: string
          example:
            - ethereum:SEED <-> arbitrum:SEED
          description: >-
            Assets in an isolation group can ONLY trade with other assets in the
            same group.
        blacklist_pairs:
          type: array
          items:
            type: string
          example:
            - bitcoin:BTC -> starknet:*
            - '*:USDC -> bitcoin:*'
          description: Explicitly forbidden trading pairs using pattern matching.
        whitelist_overrides:
          type: array
          items:
            type: string
          example:
            - ethereum:USDC -> bitcoin:BTC
          description: Explicit overrides that bypass other restrictions.
  securitySchemes:
    garden-app-id:
      type: apiKey
      name: garden-app-id
      in: header
      description: >-
        If you do not yet have an app ID, please follow these
        [steps](/api-reference/setup).
```

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

### Solana Provider Configuration

Source: https://docs.garden.finance/developers/sdk/react/quickstart

Configuration for the Solana provider, including network selection and RPC endpoint.

```typescript
interface SolanaProviderProps {
    children: ReactNode;
}

export const SolanaProvider: FC<SolanaProviderProps> = ({ children }) => {
    const rpcEndpoint =
        network === Network.MAINNET
        ? "https://solana-rpc.publicnode.com"
        : "https://api.devnet.solana.com";

    return (
        <ConnectionProvider endpoint={rpcEndpoint}>
            <WalletProvider wallets={[]} autoConnect>
                { children }
            </WalletProvider>
        </ConnectionProvider>
    );
};

```

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

### Get Merry Version Info

Source: https://docs.garden.finance/developers/localnet

Displays the currently installed version of the Merry CLI tool.

```bash
merry version
```

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

### Order Response from Tron Shasta

Source: https://docs.garden.finance/api-reference/quickstart

Example response after submitting an order for a swap originating from Tron Shasta.

```json
{
    "status": "Ok",
    "result": {
        "approval_transaction": {
            "chain_id": 2494104990,
            "data": "0x095ea7b30000000000000000000000001ce431493d15db597bbc1c74ae09407a76f19458ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
            "gas_limit": "500000000",
            "to": "TCbyHXPZ2o3qPfQUSrqPoS3NkwEJ94P3AS",
            "value": "0"
        },
        "initiate_transaction": {
            "chain_id": 2494104990,

```

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

### Vite Polyfill Dependencies

Source: https://docs.garden.finance/developers/sdk/react/setup

Install Vite plugins for WASM and Node.js polyfills using npm or yarn.

```bash
npm install --save-dev vite-plugin-wasm vite-plugin-top-level-await vite-plugin-node-polyfills
```

```bash
yarn add --dev vite-plugin-wasm vite-plugin-top-level-await vite-plugin-node-polyfills
```

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

### Gasless submission

Source: https://docs.garden.finance/api-reference/quickstart

Example of gasless submission for Solana SPL orders, including signing, serialization, and API call.

```typescript
// Note the use of `versioned_tx_gasless`
const buffer = Buffer.from(response.result.versioned_tx_gasless, 'base64');
const transaction = VersionedTransaction.deserialize(buffer);

// Sign using your wallet
const signedTransaction = await wallet.signTransaction(transaction);

// Serialize and base64 encode the signed transaction
const encodedTx = Buffer.from(signedTransaction.serialize()).toString('base64');

// Pass this encoded transaction to the garden API
await fetch(`https://testnet.api.garden.finance/v2/orders/${response.result.order_id}?action=initiate`, {
    method: 'PATCH',
    headers: {
        'garden-app-id': 'f242ea49332293424c96c562a6ef575a819908c878134dcb4fce424dc84ec796',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({ signature: encodedTx })
});
```
Tokens:
Raw