Ondo SDK Documentation

https://leapwallet.github.io/ondo-client
Admin
Comprehensive documentation for the Ondo SDK, a set of tools for interacting with Ondo Finance...
Tokens:92,910
Snippets:175
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install All Ondo SDK Packages

Source: https://leapwallet.github.io/ondo-client/documents/Getting_Started

Installs all three core Ondo SDK packages (`@ondo-gm/core`, `@ondo-gm/evm-client`, `@ondo-gm/react-adapter`) simultaneously using npm, yarn, or pnpm for comprehensive setup.

```shell
npm install @ondo-gm/core @ondo-gm/evm-client @ondo-gm/react-adapter
```

```shell
yarn add @ondo-gm/core @ondo-gm/evm-client @ondo-gm/react-adapter
```

```shell
pnpm add @ondo-gm/core @ondo-gm/evm-client @ondo-gm/react-adapter
```

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

### Install Ondo EVM Client Package

Source: https://leapwallet.github.io/ondo-client/documents/Getting_Started

Installs the `@ondo-gm/evm-client` package, which is used for Ethereum Virtual Machine interactions. Supports installation via npm, yarn, and pnpm.

```shell
npm install @ondo-gm/evm-client
```

```shell
yarn add @ondo-gm/evm-client
```

```shell
pnpm add @ondo-gm/evm-client
```

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

### Install Ondo SDK Packages

Source: https://leapwallet.github.io/ondo-client/index

Installs the core, EVM client, and React adapter packages for the Ondo SDK using npm. This is the first step to integrate the SDK into your project.

```bash
npm install @ondo-gm/core @ondo-gm/evm-client @ondo-gm/react-adapter
```

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

### Install Ondo SDK Packages

Source: https://leapwallet.github.io/ondo-client/documents/Troubleshooting

Ensures all necessary Ondo SDK packages are installed to resolve module resolution errors. This involves running npm install with the core, EVM client, and React adapter packages.

```bash
npm install @ondo-gm/core @ondo-gm/evm-client @ondo-gm/react-adapter
```

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

### Install Ondo SDK Packages

Source: https://leapwallet.github.io/ondo-client/documents/Overview

Installs the core, EVM, and React adapter packages for the Ondo SDK using npm. These packages provide the necessary tools for interacting with Ondo Finance protocols.

```bash
npm install @ondo-gm/core @ondo-gm/evm-client @ondo-gm/react-adapter
```

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

### Install Ondo Core Package

Source: https://leapwallet.github.io/ondo-client/documents/Getting_Started

Installs the foundational `@ondo-gm/core` package using npm, yarn, or pnpm. This package provides the base API client and data management utilities.

```shell
npm install @ondo-gm/core
```

```shell
yarn add @ondo-gm/core
```

```shell
pnpm add @ondo-gm/core
```

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

### Install Ondo React Adapter Package

Source: https://leapwallet.github.io/ondo-client/documents/Getting_Started

Installs the `@ondo-gm/react-adapter` package, providing React hooks and components for seamless integration with React applications. Supports npm, yarn, and pnpm.

```shell
npm install @ondo-gm/react-adapter
```

```shell
yarn add @ondo-gm/react-adapter
```

```shell
pnpm add @ondo-gm/react-adapter
```

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

### EvmClient Initialization Example

Source: https://leapwallet.github.io/ondo-client/classes/Reference_EVMClient.EvmClient

Demonstrates how to initialize the EvmClient with different configurations, including using a provider and signer, or just a provider.

```typescript
import { EvmClient } from '@ondo-gm/evm-client';
import { ethers } from 'ethers';

const provider = new ethers.JsonRpcProvider('https://mainnet.infura.io/...');
const signer = new ethers.Wallet('private-key', provider);

const client = new EvmClient({
  provider,
  signer,
  contractAddress: '0x...', 
  feeTokenAddress: '0x...', 
  gasMultiplier: 1.2
});

// Or create with provider only
const client2 = await EvmClient.createWithProvider({
  provider,
  contractAddress: '0x...',
  feeTokenAddress: '0x...'
});
```

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

### Install Basic Usage Peer Dependencies

Source: https://leapwallet.github.io/ondo-client/documents/Getting_Started

Installs peer dependencies required for basic, non-React usage of the Ondo SDK, focusing on Ethereum interaction libraries like ethers and bignumber.js.

```shell
npm install ethers bignumber.js
```

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

### Install React Integration Peer Dependencies

Source: https://leapwallet.github.io/ondo-client/documents/Getting_Started

Installs essential peer dependencies for React integration with the Ondo SDK, including React, query management, state management, and blockchain libraries.

```shell
npm install react react-dom @tanstack/react-query wagmi viem ethers mobx mobx-react-lite
```

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

### Execute Transaction with useExecuteTransaction

Source: https://leapwallet.github.io/ondo-client/documents/Examples

Provides an example of executing a transaction using the `useExecuteTransaction` hook. It manages transaction submission, displays pending status, and uses `useTransaction` to track the transaction's status and block number.

```javascript
import { useExecuteTransaction, useTransaction } from '@ondo-gm/react-adapter';
import { useState } from 'react';

function TransactionExecutor() {
  const [txHash, setTxHash] = useState<string | null>(null);
  const { mutate: executeTransaction, isPending } = useExecuteTransaction();
  const { data: transaction } = useTransaction({
    txHash: txHash || '',
    enabled: !!txHash
  });

  const handleExecute = async () => {
    executeTransaction({
      to: '0x1234567890123456789012345678901234567890',
      value: '1000000000000000000', // 1 ETH in wei
      data: '0x',
    }, {
      onSuccess: (data) => {
        setTxHash(data.hash);
      },
      onError: (error) => {
        console.error('Transaction failed:', error);
      }
    });
  };

  return (
    <div>
      <button
        onClick={handleExecute}
        disabled={isPending}
      >
        {isPending ? 'Executing...' : 'Execute Transaction'}
      </button>

      {txHash && (
        <div className="transaction-status">
          <p>Transaction Hash: {txHash}</p>
          <p>Status: {transaction?.status || 'Pending'}</p>
          {transaction?.blockNumber && (
            <p>Block: {transaction.blockNumber}</p>
          )}
        </div>
      )}
    </div>
  );
}
```

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

### Ondo SDK React Provider Setup

Source: https://leapwallet.github.io/ondo-client/documents/Overview

Demonstrates setting up the Ondo API provider in a React application. It involves creating an Api client from '@ondo-gm/core' and wrapping the application with OndoApiProvider from '@ondo-gm/react-adapter'.

```typescript
import { OndoApiProvider } from '@ondo-gm/react-adapter';
import { Api } from '@ondo-gm/core';

const apiClient = new Api({ /* config */ });

function App() {
  return (
    <OndoApiProvider apiClient={apiClient} queryClient={queryClient}>
      {/* Your app */}
    </OndoApiProvider>
  );
}
```

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

### OndoTxClient Usage Example

Source: https://leapwallet.github.io/ondo-client/classes/Reference_Core.OndoTxClient

Demonstrates how to instantiate and use the OndoTxClient for preparing, executing, and confirming transactions on the Ondo protocol. It requires an underlying chain client like EvmClient.

```typescript
import { OndoTxClient } from '@ondo-gm/core';
import { EvmClient } from '@ondo-gm/evm-client';

const evmClient = new EvmClient(config);
const ondoClient = new OndoTxClient(evmClient);

// Prepare a transaction
const prepared = await ondoClient.prepareTransaction({
  to: contractAddress,
  data: encodedData,
  value: '0'
});

// Execute the transaction
const result = await ondoClient.execute(prepared);

// Wait for confirmation
const confirmed = await ondoClient.waitForConfirmation(result.hash);
```

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

### Display Account Activity with useAccountActivity

Source: https://leapwallet.github.io/ondo-client/documents/Examples

Illustrates fetching and displaying an account's activity using the `useAccountActivity` hook. It supports pagination with a 'Load More' button and displays transaction type, amount, and timestamp.

```javascript
import { useAccountActivity } from '@ondo-gm/react-adapter';

function AccountDashboard({ accountId }: { accountId: string }) {
  const {
    data: activity,
    isLoading,
    fetchNextPage,
    hasNextPage
  } = useAccountActivity({
    accountId,
    limit: 10
  });

  const handleLoadMore = () => {
    if (hasNextPage) fetchNextPage();
  };

  if (isLoading) return <div>Loading activity...</div>;

  return (
    <div>
      <h2>Account Activity</h2>
      {activity?.pages.map((page, pageIndex) => (
        <div key={pageIndex}>
          {page.items.map(item => (
            <div key={item.id} className="activity-item">
              <span>{item.type}</span>
              <span>{item.amount}</span>
              <span>{new Date(item.timestamp).toLocaleDateString()}</span>
            </div>
          ))}
        </div>
      ))}

      {hasNextPage && (
        <button onClick={handleLoadMore}>Load More</button>
      )}
    </div>
  );
}
```

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

### Manage Ondo SDK Transactions

Source: https://leapwallet.github.io/ondo-client/documents/Troubleshooting

Details how to handle transaction timeouts and monitor transaction status within the Ondo SDK. It includes examples for increasing gas limits and using the `useTransaction` hook for status tracking.

```javascript
const { mutate: executeTransaction } = useExecuteTransaction();

executeTransaction({
  to: '0x...',
  value: '1000000000000000000',
  gasLimit: '21000',
});
```

```javascript
const { data: transaction } = useTransaction({
  txHash,
  refetchInterval: 2000,
});
```

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

### Fix Peer Dependency Warnings

Source: https://leapwallet.github.io/ondo-client/documents/Troubleshooting

Addresses peer dependency warnings, particularly for React, by installing development types and ensuring compatible React and React DOM versions are present. This helps maintain project stability.

```bash
npm install --save-dev @types/react @types/react-dom
npm install react@">=18.0.0" react-dom@">=18.0.0"
```

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

### Get All Prices API

Source: https://leapwallet.github.io/ondo-client/classes/Reference_SwaggerAPI.Api

Retrieves the latest prices for all supported assets. Supports pagination and sorting. Useful for getting a snapshot of market prices.

```APIDOC
GET:/v1/assets/all/prices/latest

Method: getAllPrices

Description: Retrieves the latest prices for all supported assets.

Parameters:
  query (object, optional): Query parameters.
    limit (number, optional): The maximum number of prices to return.
    offset (number, optional): The number of prices to skip.
    sort ( "desc" | "asc", optional): The order to sort the prices.
  params (RequestParams, optional): Additional request parameters.

Returns:
  Promise<HttpResponse<AssetPrice[], Error>>: A promise that resolves to an HTTP response containing an array of asset prices, or an error.

Tags: Assets
```

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

### GetTokenTransfersResponse API and Example

Source: https://leapwallet.github.io/ondo-client/interfaces/Reference_SwaggerAPI.GetTokenTransfersResponse

Defines the structure for the GetTokenTransfersResponse, detailing the 'transfers' array which contains ChainTransfer objects. Includes a JSON example of the response format.

```APIDOC
Interface GetTokenTransfersResponse
  Properties:
    transfers: ChainTransfer[]
      Description: An array of token transfer objects.
      Defined in docs-src/swagger-api.ts:525
```

```JSON
{
  "transfers": [
    {
      "transfer_id": "8613165-489",
      "transfer_timestamp": "1750700844",
      "contract": {
        "token_address": "0x78db9a0bab40f31de08ab3a24334e05fe17c4aee",
        "token_symbol": "TSLAon"
      },
      "transaction": {
        "transaction_id": "0x98bf56e31cb6453b03152687da5f987c3405618e86dd39092a17fd28552169ce"
      },
      "sender": {
        "sender_address": "0xdb63429afd672b774a1c99b9e8e78229c676c878"
      },
      "recipient": {
        "recipient_address": "0x2bb9d1eff5f09c4a1458b7314d2da0df739ab134"
      },
      "transfer_value": "4.4",
      "transfer_value_exact": "4400000000000000000"
    },
    {
      "transfer_id": "8562962-413",
      "transfer_timestamp": "1750096464",
      "contract": {
        "token_address": "0x78db9a0bab40f31de08ab3a24334e05fe17c4aee",
        "token_symbol": "TSLAon"
      },
      "transaction": {
        "transaction_id": "0x46b8d075fb2326424618286d8467f8312e479318e2d78cc8786a0a2f34114af4"
      },
      "sender": {
        "sender_address": "0xdb63429afd672b774a1c99b9e8e78229c676c878"
      },
      "recipient": {
        "recipient_address": "0x1e7f635a63b2d5c1a58a486a73aeceaaade8fa0f"
      },
      "transfer_value": "1",
      "transfer_value_exact": "1000000000000000000"
    }
  ]
}
```

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

### Fetch All Assets with useAssets Hook

Source: https://leapwallet.github.io/ondo-client/documents/Examples

Demonstrates how to fetch a list of all available assets using the `useAssets` hook from the `@ondo-gm/react-adapter`. It handles loading and error states, and displays asset details like name, symbol, and price.

```javascript
import { useAssets } from '@ondo-gm/react-adapter';

function AssetList() {
  const { data: assets, isLoading, error } = useAssets();

  if (isLoading) return <div>Loading assets...</div>;
  if (error) return <div>Error loading assets</div>;

  return (
    <div>
      {assets?.map(asset => (
        <div key={asset.id} className="asset-card">
          <h3>{asset.name}</h3>
          <p>Symbol: {asset.symbol}</p>
          <p>Current Price: ${asset.price}</p>
        </div>
      ))}
    </div>
  );
}
```

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

### Use useAssets and useAssetPrice Hooks

Source: https://leapwallet.github.io/ondo-client/documents/Project_Setup

Demonstrates how to fetch asset data and individual asset prices using the `useAssets` and `useAssetPrice` hooks from the Ondo React adapter. It includes loading state handling and displays asset names with their prices.

```javascript
import { useAssets, useAssetPrice } from '@ondo-gm/react-adapter';

function AssetComponent() {
  const { data: assets, isLoading } = useAssets();
  const { data: price } = useAssetPrice({ assetId: 'asset-id' });

  if (isLoading) return <div>Loading...</div>;

  return (
    <div>
      {assets?.map(asset => (
        <div key={asset.id}>
          {asset.name}: ${price?.price}
        </div>
      ))}
    </div>
  );
}
```

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

### Track Real-time Asset Pricing with useAssetPrice

Source: https://leapwallet.github.io/ondo-client/documents/Examples

Shows how to track the real-time price of a specific asset using the `useAssetPrice` hook. It includes an option to refetch data at a specified interval and visualizes recent price history.

```javascript
import { useAssetPrice } from '@ondo-gm/react-adapter';
import { useEffect, useState } from 'react';

function AssetPriceTracker({ assetId }: { assetId: string }) {
  const [priceHistory, setPriceHistory] = useState<number[]>([]);
  const { data: currentPrice } = useAssetPrice({
    assetId,
    refetchInterval: 5000 // Update every 5 seconds
  });

  useEffect(() => {
    if (currentPrice?.price) {
      setPriceHistory(prev => [...prev.slice(-10), currentPrice.price]);
    }
  }, [currentPrice]);

  return (
    <div>
      <h3>Current Price: ${currentPrice?.price}</h3>
      <div className="price-history">
        {priceHistory.map((price, index) => (
          <span key={index} className="price-point">
            ${price}
          </span>
        ))}
      </div>
    </div>
  );
}
```

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

### Selective Data Fetching for Assets

Source: https://leapwallet.github.io/ondo-client/documents/Examples

Illustrates selective data fetching using the `useAssets` hook with a `select` option. This pattern allows filtering or transforming the fetched asset data client-side before it's used, improving performance by only processing necessary information. The example filters assets based on a provided filter string.

```typescript
import { useAssets } from '@ondo-gm/react-adapter';
import { useMemo } from 'react';

function OptimizedAssetList({ filter }: { filter: string }) {
  const { data: assets } = useAssets({
    select: useMemo(
      () => (data: any) => data?.filter((asset: any) =>
        asset.name.toLowerCase().includes(filter.toLowerCase())
      ),
      [filter]
    ),
  });

  return (
    <div>
      {assets?.map(asset => (
        <div key={asset.id}>{asset.name}</div>
      ))}
    </div>
  );
}
```

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

### Configure Ondo API Authentication

Source: https://leapwallet.github.io/ondo-client/documents/Troubleshooting

Provides steps to resolve API authentication errors by verifying environment variables and correctly formatting credentials for basic authentication. It shows how to set up the API client with necessary headers.

```javascript
VITE_ONDO_API_BASE_URL=https://api.ondo.finance
VITE_ONDO_API_USERNAME=your_username
VITE_ONDO_API_PASSWORD=your_password
VITE_ONDO_API_KEY=your_api_key
```

```javascript
const credentials = btoa(`${username}:${password}`);
```

```javascript
const apiClient = new Api({
  baseUrl: process.env.VITE_ONDO_API_BASE_URL,
  baseApiParams: {
    headers: {
      Authorization: `Basic ${credentials}`,
      'x-api-key': process.env.VITE_ONDO_API_KEY,
      'Content-Type': 'application/json',
    },
  },
});
```

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

### Interact with EVM Chains using Ondo EvmClient

Source: https://leapwallet.github.io/ondo-client/documents/Project_Setup

Shows how to initialize and utilize the `EvmClient` from the `@ondo-gm/evm-client` package for direct interactions with Ethereum Virtual Machine (EVM) compatible blockchains. It includes setting up the client with RPC endpoints and executing transactions.

```typescript
import { EvmClient } from '@ondo-gm/evm-client';

const evmClient = new EvmClient({
  rpcUrl: 'https://mainnet.infura.io/v3/your-key',
  chainId: 1,
});

// Use the client for contract interactions
const result = await evmClient.executeTransaction({
  to: '0x...',
  data: '0x...',
  value: '0',
});
```

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

### Get All Markets API

Source: https://leapwallet.github.io/ondo-client/classes/Reference_SwaggerAPI.Api

Retrieves a list of all available markets on the platform. This endpoint provides comprehensive market data.

```APIDOC
GET:/v1/assets/all/market

Method: getAllMarkets

Description: Retrieves a list of all available markets.

Parameters:
  params (RequestParams, optional): Additional request parameters.

Returns:
  Promise<HttpResponse<Market[], Error>>: A promise that resolves to an HTTP response containing an array of market data, or an error.

Tags: Assets
```

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

### Get Latest Dividend API

Source: https://leapwallet.github.io/ondo-client/classes/Reference_SwaggerAPI.Api

Retrieves the latest dividend information for a specific asset. Requires the asset symbol as a path parameter.

```APIDOC
GET:/v1/assets/{symbol}/dividends

Method: getLatestDividend

Description: Retrieves the latest dividend information for a specific asset.

Parameters:
  symbol (string): The trading symbol of the asset.
  params (RequestParams, optional): Additional request parameters.

Returns:
  Promise<HttpResponse<DividendInfo, void | Error>>: A promise that resolves to an HTTP response containing the latest dividend information, or an error.

Tags: Assets
```

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

### Get Specific Market API

Source: https://leapwallet.github.io/ondo-client/classes/Reference_SwaggerAPI.Api

Retrieves market data for a specific asset identified by its symbol. Requires the asset symbol as a path parameter.

```APIDOC
GET:/v1/assets/{symbol}/market

Method: getMarket

Description: Retrieves market data for a specific asset.

Parameters:
  symbol (string): The trading symbol of the asset.
  params (RequestParams, optional): Additional request parameters.

Returns:
  Promise<HttpResponse<Market, void | Error>>: A promise that resolves to an HTTP response containing the market data for the specified asset, or an error.

Tags: Assets
```

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

### EvmClient API Reference

Source: https://leapwallet.github.io/ondo-client/classes/Reference_EVMClient.EvmClient

Detailed API documentation for the EvmClient class, covering its constructor, properties, and methods for interacting with the Ethereum Virtual Machine.

```APIDOC
EvmClient:
  Constructor:
    new EvmClient(config: EthereumConfig): EvmClient
    Description: Creates a new EvmClient instance with the provided configuration.
    Parameters:
      config: EthereumConfig - Ethereum configuration including provider, signer, and contract addresses.
    Returns: EvmClient

  Static Method: createWithProvider:
    static createWithProvider(config: Omit<EthereumConfig, "signer"> & { signerAddress?: string | number; provider: JsonRpcProvider; }): Promise<EvmClient>
    Description: Creates an EvmClient instance using a provider and optional signer address. This factory method is useful when you have a provider but need to get a signer from it rather than providing one directly.
    Parameters:
      config: Omit<EthereumConfig, "signer"> & { signerAddress?: string | number; provider: JsonRpcProvider; } - Configuration with provider and optional signer address.
    Returns: Promise<EvmClient> - Promise resolving to a new EvmClient instance.

  Method: prepareTransaction:
    prepareTransaction(params: TransactionParams): Promise<PreparedTransaction<EthTransactionArg>>
    Description: Prepares a transaction for execution.
    Parameters:
      params: TransactionParams - Parameters for the transaction.
    Returns: Promise<PreparedTransaction<EthTransactionArg>> - A promise that resolves with the prepared transaction.

  Method: execute:
    execute(transaction: PreparedTransaction): Promise<TransactionResult>
    Description: Executes a prepared transaction.
    Parameters:
      transaction: PreparedTransaction - The transaction to execute.
    Returns: Promise<TransactionResult> - A promise that resolves with the result of the transaction execution.

  Method: getBalance:
    getBalance(address: AddressLike): Promise<string>
    Description: Retrieves the balance of a given address.
    Parameters:
      address: AddressLike - The address to query.
    Returns: Promise<string> - A promise that resolves with the balance as a string.

  Method: getTransactionStatus:
    getTransactionStatus(txHash: string): Promise<any>
    Description: Retrieves the status of a transaction using its hash.
    Parameters:
      txHash: string - The hash of the transaction.
    Returns: Promise<any> - A promise that resolves with the transaction status.

  Method: getGasPrice(): Promise<string>
    Description: Retrieves the current gas price for the network.
    Returns: Promise<string> - A promise that resolves with the gas price as a string.

  Method: getNetworkId(): Promise<string>
    Description: Retrieves the network ID of the connected Ethereum network.
    Returns: Promise<string> - A promise that resolves with the network ID.

  Method: getSignerAddress(): Promise<string>
    Description: Retrieves the address of the currently configured signer.
    Returns: Promise<string> - A promise that resolves with the signer's address.
```

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

### Get All Asset Addresses API

Source: https://leapwallet.github.io/ondo-client/classes/Reference_SwaggerAPI.Api

Retrieves a list of all asset addresses supported by the platform. This endpoint provides mapping for asset symbols to their respective addresses.

```APIDOC
GET:/v1/assets/all/addresses

Method: getAllAssetAddresses

Description: Retrieves a list of all asset addresses.

Parameters:
  params (RequestParams, optional): Additional request parameters.

Returns:
  Promise<HttpResponse<SymbolAssetAddresses[], Error>>: A promise that resolves to an HTTP response containing an array of symbol-to-address mappings, or an error.

Tags: Assets
```
Tokens:
Raw