Nado TypeScript SDK

https://docs.nado.xyz/developer-resources/typescript-sdk/
Admin
The Nado TypeScript SDK provides a collection of packages to interact with the Nado Protocol,...
Tokens:19,673
Snippets:162
Trust Score:5.6
Update:8 months ago
Show doc for...
Tokens:
Raw
### Full Example: Nado Client Initialization

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/create-a-nado-client

A complete TypeScript example demonstrating the import of dependencies, creation of Viem clients, and initialization of the Nado client. This serves as a comprehensive guide for setting up the Nado SDK.

```typescript
import { createNadoClient } from '@nadohq/client';
import { CHAIN_ENV_TO_CHAIN } from '@nadohq/shared';
import { createPublicClient, createWalletClient, http } from 'viem';
import { privateKeyToAccount } from 'viem/accounts';

function main() {
  const chainEnv = 'inkTestnet';

  const walletClient = createWalletClient({
    account: privateKeyToAccount('0x...'),
    chain: CHAIN_ENV_TO_CHAIN[chainEnv],
    transport: http(),
  });

  const publicClient = createPublicClient({
    chain: CHAIN_ENV_TO_CHAIN[chainEnv],
    transport: http(),
  });

  const nadoClient = createNadoClient(chainEnv, {
    walletClient,
    publicClient,
  });
}

main();
```

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

### Full Deposit and Withdraw Example using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/withdraw-funds

A comprehensive example demonstrating the complete deposit and withdrawal flow using the Nado XYZ TypeScript SDK. It includes minting mock tokens, approving allowances, executing deposits, checking balances, performing withdrawals, and verifying balances after withdrawal. This example requires setup for testnet operations.

```typescript
import { addDecimals } from '@nadohq/shared';
import { getNadoClient, prettyPrintJson } from './common';

async function main() {
  const nadoClient = getNadoClient();
  const { walletClient, publicClient } = nadoClient.context;

  const address = walletClient!.account.address;
  const subaccountName = 'default';
  const depositAmount = addDecimals(10, 6);

  const mintTxHash = await nadoClient.spot._mintMockERC20({
    amount: depositAmount,
    productId: 0,
  });
  await publicClient.waitForTransactionReceipt({
    hash: mintTxHash,
  });

  const approveTxHash = await nadoClient.spot.approveAllowance({
    amount: depositAmount,
    productId: 0,
  });

  await publicClient.waitForTransactionReceipt({
    hash: approveTxHash,
  });

  const depositTxHash = await nadoClient.spot.deposit({
    subaccountName: 'default',
    amount: depositAmount,
    productId: 0,
  });

  await publicClient.waitForTransactionReceipt({
    hash: depositTxHash,
  });
  
  await new Promise((resolve) => setTimeout(resolve, 10000));


  const subaccountData =
    await nadoClient.subaccount.getSubaccountSummary({
      subaccountOwner: address,
      subaccountName,
    });
  prettyPrintJson('Subaccount Data After Deposit', subaccountData);

  const withdrawTx = await nadoClient.spot.withdraw({
    amount: depositAmount - addDecimals(1, 6),
    productId: 0,
    subaccountName,
  });
  prettyPrintJson('Withdraw Tx', withdrawTx);

  const subaccountDataAfterWithdraw =
    await nadoClient.subaccount.getSubaccountSummary({
      subaccountOwner: address,
      subaccountName,
    });
  prettyPrintJson(
    'Subaccount Data After Withdrawal',
    subaccountDataAfterWithdraw,
  );
}

main();
```

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

### Get Funding Rate using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-funding-rate

Demonstrates how to initialize the Nado client and call the `getFundingRate` method to retrieve funding rate data. Requires the `@nadohq/client` package.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getFundingRate(...);
```

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

### Get Product Snapshots using Nado TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-product-snapshots

This snippet shows how to initialize the Nado client and call the getProductSnapshots method. It requires the '@nadohq/client' package and assumes a valid network and credentials are provided.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getProductSnapshots(...);
```

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

### Get Market Liquidity using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-market-liquidity

Demonstrates how to fetch market liquidity data by initializing the Nado client and calling the getMarketLiquidity method. Requires the '@nadohq/client' package.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getMarketLiquidity(...);
```

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

### Full Example: Querying Nado Market Data (TypeScript)

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/query-markets-and-products

A comprehensive example demonstrating how to use the Nado TypeScript SDK to fetch all markets, the latest market price for a product, and market liquidity. It includes necessary imports and utility functions for pretty printing JSON output.

```typescript
import {getNadoClient, prettyPrintJson} from './common';

async function main() {
  const nadoClient = getNadoClient();

  const allMarkets = await nadoClient.market.getAllMarkets();
  prettyPrintJson('All Markets', allMarkets);

  const latestMarketPrice = await nadoClient.market.getLatestMarketPrice({
    productId: 1,
  });
  prettyPrintJson('Latest Market Price (Product ID 1)', latestMarketPrice);

  const marketLiquidity = await nadoClient.market.getMarketLiquidity({
    productId: 1,
    // Per side of the book
    depth: 2,
  });
  prettyPrintJson('Market Liquidity (Product ID 1)', marketLiquidity);
}

main();
```

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

### Full Example: Nado XYZ SDK Operations in TypeScript

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/manage-orders

A comprehensive example demonstrating a typical workflow using the Nado XYZ TypeScript SDK. It includes minting mock tokens, approving allowances, depositing funds, placing an order, querying open orders, cancelling the order, and finally withdrawing funds.

```typescript
import { PlaceOrderParams } from '@nadohq/client';
import { nowInSeconds, addDecimals, packOrderAppendix } from '@nadohq/shared';
import { getNadoClient, prettyPrintJson } from './common';

async function main() {
  const nadoClient = getNadoClient();
  const { walletClient, publicClient } = nadoClient.context;

  const address = walletClient!.account.address;
  const subaccountName = 'default';
  const depositAmount = addDecimals(1000, 6);

  const mintTxHash = await nadoClient.spot._mintMockERC20({
    amount: depositAmount,
    productId: 0,
  });
  await publicClient.waitForTransactionReceipt({
    hash: mintTxHash,
  });

  const approveTxHash = await nadoClient.spot.approveAllowance({
    amount: depositAmount,
    productId: 0,
  });
  await publicClient.waitForTransactionReceipt({
    hash: approveTxHash,
  });

  const depositTxHash = await nadoClient.spot.deposit({
    subaccountName: 'default',
    amount: depositAmount,
    productId: 0,
  });
  await publicClient.waitForTransactionReceipt({
    hash: depositTxHash,
  });

  await new Promise((resolve) => setTimeout(resolve, 10000));

  const orderParams: PlaceOrderParams['order'] = {
    subaccountName,
    expiration: nowInSeconds() + 60,
    appendix: packOrderAppendix({
      orderExecutionType: 'post_only',
    }),
    price: 80000,
    // Setting order amount to 10**16
    amount: addDecimals(0.01, 18),
  };

  const placeOrderResult = await nadoClient.market.placeOrder({
    order: orderParams,
    productId: 2,
    // Used for spot orders to enable/disable borrowing
    spotLeverage: undefined,
  });

  prettyPrintJson('Place Order Result', placeOrderResult);

  const openOrders = await nadoClient.market.getOpenSubaccountOrders({
    subaccountOwner: address,
    subaccountName,
    productId: 2,
  });

  prettyPrintJson('Subaccount Open Orders', openOrders);

  const cancelOrderResult = await nadoClient.market.cancelOrders({
    digests: [placeOrderResult.data.digest],
    productIds: [2],
    subaccountName: 'default',
  });

  prettyPrintJson('Cancel Order Result', cancelOrderResult);

  await nadoClient.spot.withdraw({
    productId: 0,
    amount: depositAmount - addDecimals(1, 6),
    subaccountName,
  });
}

main();
```

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

### Get Open Subaccount Orders using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-open-subaccount-orders

Demonstrates how to initialize the Nado client and call the getOpenSubaccountOrders method to retrieve open orders for a subaccount. Requires the '@nadohq/client' package.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getOpenSubaccountOrders(...);
```

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

### Get Token Allowance using Nado TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/spot/get-token-allowance

This snippet demonstrates how to fetch the token allowance for a given product and address using the Nado TypeScript SDK. It requires the '@nadohq/client' package and initializes the Nado client with network and credentials.

```typescript
import { createNadoClient } from '@nadohq/client';

const productId = 1;
const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.spot.getTokenAllowance({
  productId,
  address: '0xad432...',
});
```

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

### Get Subaccount Fee Rates with TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/subaccount/get-subaccount-fee-rates

Demonstrates how to initialize the Nado client and call the getSubaccountFeeRates function. Requires the '@nadohq/client' package. Returns fee rate data for subaccounts.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.subaccount.getSubaccountFeeRates(...);
```

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

### GET /products

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves product snapshot data from the Indexer API.

```APIDOC
## GET /products

### Description
Retrieves product snapshot data from the Indexer API.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getProductSnapshots(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Get Token Wallet Balance with Nado TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/spot/get-token-wallet-balance

This snippet demonstrates how to initialize the Nado client and call the `getTokenWalletBalance` function to retrieve a token's balance for a given product ID and wallet address. It requires the '@nadohq/client' package.

```typescript
import { createNadoClient } from '@nadohq/client';

const productId = 1;
const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.spot.getTokenWalletBalance({
  productId,
  address: '0x34w...',
});
```

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

### Get Token Contract for Product using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/spot/get-token-contract-for-product

This snippet demonstrates how to instantiate the Nado client and call the `getTokenContractForProduct` method to retrieve the token contract for a specified product ID. It requires the `@nadohq/client` package and network configuration.

```typescript
import { createNadoClient } from '@nadohq/client';

const productId = 1;
const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.spot.getTokenContractForProduct({ productId });
```

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

### Get Latest Market Price using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-latest-market-price

This snippet shows how to import the Nado client and use the `getLatestMarketPrice` function to retrieve market data. It requires the `@nadohq/client` package and assumes a Nado client has been initialized.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getLatestMarketPrice(...);
```

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

### Get On-chain Subaccount Summary with TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/subaccount/get-subaccount-summary

Retrieves a summary for a subaccount by querying the on-chain Querier contract. This method requires initializing the Nado client and converting the subaccount details to a bytes32 format. It interacts directly with the blockchain.

```typescript
import { createNadoClient } from '@nadohq/client';
import { subaccountToBytes32 } from '@nadohq/shared';

const nadoClient = createNadoClient('inkTestnet', ...);
const subaccount = subaccountToBytes32({
  subaccountOwner: '0x...',
  subaccountName: 'default',
});

const res = await nadoClient.context.contracts.querier.read.getSubaccountInfo([
  subaccount,
]);
```

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

### Get Max Order Size with TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-max-order-size

This snippet demonstrates how to instantiate the Nado client and call the `getMaxOrderSize` method from the market query API. It requires the '@nadohq/client' package and takes network configuration and potentially other parameters for the client creation and the API call.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getMaxOrderSize(...);
```

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

### GET /perp-prices

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves perpetual prices from the Indexer API.

```APIDOC
## GET /perp-prices

### Description
Retrieves perpetual prices from the Indexer API.

### Method
GET

### Endpoint
/perp-prices

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getPerpPrices(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### GET /oracle-prices

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves oracle prices from the Indexer API.

```APIDOC
## GET /oracle-prices

### Description
Retrieves oracle prices from the Indexer API.

### Method
GET

### Endpoint
/oracle-prices

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getOraclePrices(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### GET /all-products

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Retrieves a list of all available products (markets) on the Nado platform. This endpoint provides a comprehensive overview of tradable assets.

```APIDOC
## GET /all-products

### Description
Retrieves a list of all available products (markets) on the Nado platform.

### Method
GET

### Endpoint
/all-products

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getAllMarkets()
```

### Response
#### Success Response (200)
- **products** (array) - A list of product objects, each representing a market.

#### Response Example
```json
{
  "products": [
    {
      "id": "BTC-USD",
      "baseAsset": "BTC",
      "quoteAsset": "USD"
    }
  ]
}
```
```

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

### GET /nlp-snapshots

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves NLP snapshot data from the Indexer API.

```APIDOC
## GET /nlp-snapshots

### Description
Retrieves NLP snapshot data from the Indexer API.

### Method
GET

### Endpoint
/nlp-snapshots

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getNlpSnapshots(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Get All Markets (Off-chain Engine) - TypeScript

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-all-markets

Retrieves all available markets from the off-chain engine using the Nado XYZ TypeScript SDK. This function requires an initialized Nado client and returns market data.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getAllMarkets();
```

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

### GET /funding-rate

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves funding rate data from the Indexer API.

```APIDOC
## GET /funding-rate

### Description
Retrieves funding rate data from the Indexer API.

### Method
GET

### Endpoint
/funding-rate

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getFundingRate(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Get Max Mint NLP Amount using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/spot/get-max-mint-nlp-amount

This snippet demonstrates how to initialize the Nado client and call the `getMaxMintNlpAmount` function to retrieve the maximum NLP mintable amount. It requires the `@nadohq/client` package and network configuration.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.spot.getMaxMintNlpAmount(...);
```

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

### Fetch Perpetual Prices using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/perp/get-perp-prices

This snippet demonstrates how to use the Nado XYZ TypeScript SDK to retrieve perpetual prices for a given product ID. It requires the '@nadohq/client' package and an initialized Nado client instance.

```typescript
import { createNadoClient } from '@nadohq/client';

const productId = 2;
const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.perp.getPerpPrices({ productId });
```

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

### Get Off-chain Subaccount Summary with TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/subaccount/get-subaccount-summary

Fetches the subaccount state from the off-chain engine. This method utilizes the SDK's subaccount API to make a call to the Nado REST API. It provides a quicker way to access subaccount data without direct blockchain interaction.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.subaccount.getSubaccountSummary(...);
```

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

### GET /orders

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves order data from the Indexer API.

```APIDOC
## GET /orders

### Description
Retrieves order data from the Indexer API.

### Method
GET

### Endpoint
/orders

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getOrders(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### GET /matches

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves match event data from the Indexer API.

```APIDOC
## GET /matches

### Description
Retrieves match event data from the Indexer API.

### Method
GET

### Endpoint
/matches

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getMatchEvents(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### GET /subaccount-snapshots

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves subaccount snapshot data from the Indexer API.

```APIDOC
## GET /subaccount-snapshots

### Description
Retrieves subaccount snapshot data from the Indexer API.

### Method
GET

### Endpoint
/subaccount-snapshots

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getMultiSubaccountSnapshots(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Get Product Snapshots using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Fetches product snapshot data by making a call to the Indexer API's Products endpoint. This function is available through the IndexerBaseClient of the Nado TypeScript SDK.

```typescript
const res = await nadoClient.context.indexerClient.getProductSnapshots(...)
```

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

### GET /events

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves event data from the Indexer API.

```APIDOC
## GET /events

### Description
Retrieves event data from the Indexer API.

### Method
GET

### Endpoint
/events

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getEvents(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### GET /subaccount-info

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Fetches a summary of information for a given subaccount. This includes details like balances, order counts, and other relevant metrics.

```APIDOC
## GET /subaccount-info

### Description
Fetches a summary of information for a given subaccount.

### Method
GET

### Endpoint
/subaccount-info

### Parameters
#### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount to retrieve information for.

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getSubaccountSummary({ subaccountId: "your_subaccount_id" })
```

### Response
#### Success Response (200)
- **summary** (object) - An object containing the subaccount summary details.

#### Response Example
```json
{
  "summary": {
    "balance": "1000.00",
    "openOrders": 5
  }
}
```
```

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

### GET /market-price

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Fetches the current price for a specified market. This endpoint is essential for real-time trading and market analysis.

```APIDOC
## GET /market-price

### Description
Fetches the current price for a specified market.

### Method
GET

### Endpoint
/market-price

### Parameters
#### Query Parameters
- **marketId** (string) - Required - The ID of the market.

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getMarketPrice({ marketId: "BTC-USD" })
```

### Response
#### Success Response (200)
- **price** (string) - The current price of the market.

#### Response Example
```json
{
  "price": "50050.50"
}
```
```

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

### GET /market-liquidity

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Fetches the liquidity information for a specific market. This data is crucial for understanding the depth and tradability of a market.

```APIDOC
## GET /market-liquidity

### Description
Fetches the liquidity information for a specific market.

### Method
GET

### Endpoint
/market-liquidity

### Parameters
#### Query Parameters
- **marketId** (string) - Required - The ID of the market.

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getMarketLiquidity({ marketId: "BTC-USD" })
```

### Response
#### Success Response (200)
- **liquidity** (object) - An object containing bid and ask liquidity details.

#### Response Example
```json
{
  "liquidity": {
    "bids": [
      {"price": "49900.00", "size": "10.0"}
    ],
    "asks": [
      {"price": "50100.00", "size": "12.0"}
    ]
  }
}
```
```

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

### Get Subaccount Linked Signer with Rate Limit using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/subaccount/get-subaccount-linked-signer-with-rate-limit

This snippet demonstrates how to call the `getSubaccountLinkedSignerWithRateLimit` function from the Nado TypeScript SDK. It requires initializing the Nado client with appropriate credentials and network configuration. The function returns signer information, potentially with rate limit details.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.subaccount.getSubaccountLinkedSignerWithRateLimit(...);
```

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

### GET /contracts

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Fetches information about the available contracts within the Nado ecosystem. This is essential for understanding the smart contracts interacting with the engine.

```APIDOC
## GET /contracts

### Description
Fetches information about the available contracts within the Nado ecosystem.

### Method
GET

### Endpoint
/contracts

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getContracts()
```

### Response
#### Success Response (200)
- **contracts** (array) - A list of contract objects, each containing details about a specific contract.

#### Response Example
```json
{
  "contracts": [
    {
      "address": "0x123...",
      "name": "ExampleContract"
    }
  ]
}
```
```

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

### GET /fee-rates

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Retrieves the fee rates applicable to a specific subaccount. This endpoint helps users understand the trading costs associated with their account.

```APIDOC
## GET /fee-rates

### Description
Retrieves the fee rates applicable to a specific subaccount.

### Method
GET

### Endpoint
/fee-rates

### Parameters
#### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getSubaccountFeeRates({ subaccountId: "your_subaccount_id" })
```

### Response
#### Success Response (200)
- **feeRates** (object) - An object containing various fee rates.

#### Response Example
```json
{
  "feeRates": {
    "takerFee": "0.001",
    "makerFee": "0.0005"
  }
}
```
```

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

### Get All Nado Markets using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Fetches a list of all available markets. This function interacts with the Nado REST API's Queries All Products endpoint. Ensure you have an initialized Nado client.

```typescript
const res = await nadoClient.context.engineClient.getAllMarkets(...)
```

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

### GET /nonces

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Retrieves nonces for transaction signing. This endpoint is crucial for ensuring transaction uniqueness and preventing replay attacks.

```APIDOC
## GET /nonces

### Description
Retrieves nonces for transaction signing.

### Method
GET

### Endpoint
/nonces

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getNonces()
const res = await nadoClient.context.engineClient.getTxNonce()
```

### Response
#### Success Response (200)
- **nonce** (string) - The current nonce value.

#### Response Example
```json
{
  "nonce": "12345"
}
```
```

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

### GET /linked-signer-rate-limit

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves linked signer rate limit data from the Indexer API.

```APIDOC
## GET /linked-signer-rate-limit

### Description
Retrieves linked signer rate limit data from the Indexer API.

### Method
GET

### Endpoint
/linked-signer-rate-limit

### Parameters
#### Query Parameters
- **(Type)** - Required/Optional - Description

### Request Example
```typescript
const res = await nadoClient.context.indexerClient.getLinkedSignerWithRateLimit(...)
```

### Response
#### Success Response (200)
- **(Type)** - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Retrieve Historical Orders with Nado TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-historical-orders

Demonstrates how to initialize the Nado client and call the getHistoricalOrders method to retrieve past order data. Requires the '@nadohq/client' package.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getHistoricalOrders(...);
```

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

### GET /max-order-size

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Retrieves the maximum order size allowed for a given market. This helps users comply with platform trading limits.

```APIDOC
## GET /max-order-size

### Description
Retrieves the maximum order size allowed for a given market.

### Method
GET

### Endpoint
/max-order-size

### Parameters
#### Query Parameters
- **marketId** (string) - Required - The ID of the market.

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getMaxOrderSize({ marketId: "BTC-USD" })
```

### Response
#### Success Response (200)
- **maxSize** (string) - The maximum order size.

#### Response Example
```json
{
  "maxSize": "100.0"
}
```
```

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

### GET /max-nlp-mintable

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Calculates the maximum amount of NLP (Native Liquidity Protocol) that can be minted. This is relevant for users participating in liquidity provision programs.

```APIDOC
## GET /max-nlp-mintable

### Description
Calculates the maximum amount of NLP that can be minted.

### Method
GET

### Endpoint
/max-nlp-mintable

### Parameters
#### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getMaxMintNlpAmount({ subaccountId: "your_subaccount_id" })
```

### Response
#### Success Response (200)
- **maxAmount** (string) - The maximum NLP amount that can be minted.

#### Response Example
```json
{
  "maxAmount": "10000.00"
}
```
```

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

### Create Viem Wallet and Public Clients

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/create-a-nado-client

Initializes a Viem WalletClient and PublicClient. The WalletClient is optional and needed for write operations, while the PublicClient is for read operations. Both require a chain environment and transport configuration.

```typescript
const chainEnv = 'inkTestnet';

const walletClient = createWalletClient({
  account: privateKeyToAccount('0x...'),
  chain: CHAIN_ENV_TO_CHAIN[chainEnv],
  transport: http(),
});

const publicClient = createPublicClient({
  chain: CHAIN_ENV_TO_CHAIN[chainEnv],
  transport: http(),
});
```

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

### Get NLP Snapshots using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves NLP snapshot data by querying the Indexer API's NLP Snapshots endpoint. This method is provided by the IndexerBaseClient in the Nado TypeScript SDK.

```typescript
const res = await nadoClient.context.indexerClient.getNlpSnapshots(...)
```

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

### GET /subaccount-orders

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Retrieves a list of orders associated with a specific subaccount. This endpoint is useful for tracking open, filled, or cancelled orders.

```APIDOC
## GET /subaccount-orders

### Description
Retrieves a list of orders associated with a specific subaccount.

### Method
GET

### Endpoint
/subaccount-orders

### Parameters
#### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.
- **status** (string) - Optional - Filter orders by status (e.g., 'open', 'filled').

#### Request Body
None

### Request Example
```typescript
const res = await nadoClient.context.engineClient.getSubaccountOrders({ subaccountId: "your_subaccount_id", status: "open" })
```

### Response
#### Success Response (200)
- **orders** (array) - A list of order objects.

#### Response Example
```json
{
  "orders": [
    {
      "id": "order_123",
      "symbol": "BTC-USD",
      "side": "buy",
      "price": "50000.00"
    }
  ]
}
```
```

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

### Get Funding Rate using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Fetches funding rate data by calling the Indexer API's Funding Rate endpoint. This functionality is provided by the IndexerBaseClient in the Nado TypeScript SDK.

```typescript
const res = await nadoClient.context.indexerClient.getFundingRate(...)
```

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

### Import Nado SDK Dependencies

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/create-a-nado-client

Imports necessary functions and types from the Nado SDK packages for client creation and chain configuration. It also imports utilities from 'viem' for creating blockchain clients.

```typescript
import { createNadoClient } from '@nadohq/client';
import { CHAIN_ENV_TO_CHAIN } from '@nadohq/shared';
import { createPublicClient, createWalletClient, http } from 'viem';
import { privateKeyToAccount } from 'viem/accounts';
```

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

### Get Current Time in Seconds using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/utilities/utils

Demonstrates how to import and use the `nowInSeconds` function from the `@nadohq/shared` module to retrieve the current time in seconds. This function has no external dependencies beyond the SDK itself.

```typescript
import { nowInSeconds } from '@nadohq/shared';

console.log(nowInSeconds());
```

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

### Get Nado Subaccount Info using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Retrieves a summary of subaccount information. This function interacts with the Nado REST API's Queries Subaccount Info endpoint. It requires an active Nado client.

```typescript
const res = await nadoClient.context.engineClient.getSubaccountSummary(...)
```

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

### Get Orders using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Fetches order data by making a call to the Indexer API's Orders endpoint. This function is part of the IndexerBaseClient in the Nado TypeScript SDK.

```typescript
const res = await nadoClient.context.indexerClient.getOrders(...)
```

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

### Create and Use Indexer Client (TypeScript)

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client

Demonstrates how to import and create an instance of the Nado client, specifically for interacting with the indexer. It shows a typical call to retrieve multi-subaccount snapshots. Requires the '@nadohq/client' package.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.context.indexerClient.getMultiSubaccountSnapshots(...)
```

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

### Place Order using Nado TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/place-order

Demonstrates how to initialize the Nado client and place an order. This function relies on the '@nadohq/client' package. It takes configuration parameters for the client and order details as input, and returns the result of the order placement operation.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.placeOrder(...);
```

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

### Get Perpetual Prices using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves perpetual price data by querying the Indexer API's Perp Prices endpoint. This method is available through the IndexerBaseClient of the Nado TypeScript SDK.

```typescript
const res = await nadoClient.context.indexerClient.getPerpPrices(...)
```

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

### Get Events using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Fetches general event data by calling the Indexer API's Events endpoint. This functionality is provided by the IndexerBaseClient in the Nado TypeScript SDK.

```typescript
const res = await nadoClient.context.indexerClient.getEvents(...)
```

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

### Get Subaccount Snapshots using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Retrieves subaccount snapshot data via the Indexer API's Subaccount Snapshots endpoint. This method is part of the IndexerBaseClient in the Nado TypeScript SDK.

```typescript
const res = await nadoClient.context.indexerClient.getMultiSubaccountSnapshots(...)
```

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

### Get Nado Fee Rates using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Retrieves the fee rates for a subaccount. This function corresponds to the Nado REST API's Queries Fee Rates endpoint. It requires an active Nado client instance.

```typescript
const res = await nadoClient.context.engineClient.getSubaccountFeeRates(...)
```

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

### Withdraw Funds using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/withdraw-funds

Initiates a withdrawal transaction using the Nado XYZ TypeScript SDK. This function requires the amount to withdraw (exclusive of fees), the product ID, and the subaccount name. Ensure you have followed the deposit funds example prior to withdrawal.

```typescript
const withdrawTx = await nadoClient.spot.withdraw({
  amount: depositAmount - addDecimals(1, 6),
  productId: 0,
  subaccountName: 'default',
});

prettyPrintJson('Withdraw Tx', withdrawTx);
```

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

### Get Candlesticks Data using Nado TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-candlesticks

Fetches candlestick data by making a call to the Indexer API via the Nado TypeScript SDK. Requires initializing the Nado client with appropriate network and credentials.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getCandlesticks(...);
```

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

### Get Nado Contracts using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Fetches information about Nado contracts. This function calls the Nado REST API's Queries Contracts endpoint. Ensure you have a properly configured Nado client instance.

```typescript
const res = await nadoClient.context.engineClient.getContracts(...)
```

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

### Get Nado Nonces using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Retrieves nonces for transactions from the Nado system. This function corresponds to the Nado REST API's Queries Nonces endpoint. It can be used to get transaction nonces.

```typescript
const res = await nadoClient.context.engineClient.getNonces(...)
const res = await nadoClient.context.engineClient.getTxNonce(...)
```

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

### Place an Order Using SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/manage-orders

Places an order on the Nado XYZ market using the defined order parameters and product ID. The `spotLeverage` parameter can be used to enable/disable borrowing for spot orders. The result of the order placement is then printed.

```typescript
const placeOrderResult = await nadoClient.market.placeOrder({
  order: orderParams,
  productId: 2,
  // Used for spot orders to enable/disable borrowing
  spotLeverage: undefined,
});

prettyPrintJson("Place Order Result", placeOrderResult);
```

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

### Get Nado Market Liquidity using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Retrieves market liquidity data. This function corresponds to the Nado REST API's Queries Market Liquidity endpoint. It requires a configured Nado client.

```typescript
const res = await nadoClient.context.engineClient.getMarketLiquidity(...)
```

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

### Get Nado Linked Signer using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Fetches the linked signer for a subaccount. This function interacts with the Nado REST API's Queries Linked Signer endpoint. Ensure the Nado client is initialized.

```typescript
const res = await nadoClient.context.engineClient.getLinkedSigner(...)
```

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

### Initialize Nado Client

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/create-a-nado-client

Creates an instance of the Nado client using the `createNadoClient` function. This function requires the chain environment and an object containing the initialized wallet and public clients.

```typescript
const nadoClient = createNadoClient(chainEnv, {
  walletClient,
  publicClient,
});
```

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

### Get Nado Subaccount Orders using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Fetches order details for a specific subaccount. This function calls the Nado REST API's Queries Subaccount Orders endpoint. Ensure the Nado client is initialized.

```typescript
const res = await nadoClient.context.engineClient.getSubaccountOrders(...)
```

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

### Get Oracle Prices using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/indexer-client/base-queries

Fetches oracle price data by making a call to the Indexer API's Oracle Price endpoint. This function is part of the IndexerClient in the Nado TypeScript SDK.

```typescript
const res = await nadoClient.context.indexerClient.getOraclePrices(...)
```

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

### Get Subaccount Linked Signer with Rate Limit

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/subaccount/get-subaccount-linked-signer-with-rate-limit

This endpoint retrieves the rate limit details for a specific linked signer associated with a subaccount. It acts as a wrapper for the Indexer API's Linked Signer Rate Limit endpoint.

```APIDOC
## GET /subaccount/linked_signer/rate_limit

### Description
Retrieves the rate limit information for a linked signer within a subaccount.

### Method
GET

### Endpoint
/subaccount/linked_signer/rate_limit

### Parameters
#### Query Parameters
- **subaccountId** (string) - Required - The ID of the subaccount.
- **linkedSignerAddress** (string) - Required - The address of the linked signer.

### Request Example
```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.subaccount.getSubaccountLinkedSignerWithRateLimit({
  subaccountId: 'your_subaccount_id',
  linkedSignerAddress: 'your_linked_signer_address'
});
```

### Response
#### Success Response (200)
- **rateLimit** (object) - An object containing rate limit details.
  - **limit** (number) - The maximum number of requests allowed.
  - **remaining** (number) - The number of requests remaining.
  - **resetTime** (string) - The time when the rate limit will reset (ISO 8601 format).

#### Response Example
```json
{
  "rateLimit": {
    "limit": 1000,
    "remaining": 950,
    "resetTime": "2023-10-27T10:00:00Z"
  }
}
```
```

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

### Initialize and Use Nado Client for Contract Operations (TypeScript)

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/utilities/contracts

Demonstrates how to initialize the Nado client and use it to interact with smart contracts. This involves creating a client instance for a specific network and then performing read and write operations on contracts.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const queryRes = await nadoClient.context.contracts.querier.read(...);
const txHash = await nadoClient.context.contracts.querier.write(...);
```

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

### Get Nado Max Order Size using TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client/queries

Fetches the maximum order size allowed for a market. This function corresponds to the Nado REST API's Queries Max Order Size endpoint. Ensure the Nado client is properly set up.

```typescript
const res = await nadoClient.context.engineClient.getMaxOrderSize(...)
```

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

### Get Max Withdrawable using Nado TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/spot/get-max-withdrawable

This snippet demonstrates how to import the Nado client, create an instance, and call the getMaxWithdrawable function. It requires the '@nadohq/client' package and assumes the Nado client has been initialized with appropriate network and authentication details.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.spot.getMaxWithdrawable(...);
```

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

### Initialize and Liquidate Subaccount with Nado Engine Client (TypeScript)

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/engine-client

Demonstrates how to initialize the Nado client and use the engine client to liquidate a subaccount. Requires the '@nadohq/client' package. The function takes network and other parameters, and returns a result object after the liquidation operation.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.context.engineClient.liquidateSubaccount(...)
```

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

### Mint NLP via TypeScript SDK

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/spot/mint-nlp

This snippet demonstrates how to initialize the Nado client and call the mintNlp function using the TypeScript SDK. It requires the '@nadohq/client' package and assumes the client is configured with appropriate credentials and network settings.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.spot.mintNlp(...);
```

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

### Scaffold Subaccount with Funds for Orders

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/how-to/manage-orders

Sets up a subaccount with sufficient funds (1000 USDT0) to place orders. This involves minting mock ERC20 tokens, approving allowance, and depositing funds into the subaccount. A delay is included to ensure transaction finality.

```typescript
const nadoClient = getNadoClient();
const { walletClient, publicClient } = nadoClient.context;

const address = walletClient!.account.address;
const subaccountName = 'default';
const depositAmount = addDecimals(1000, 6);

const mintTxHash = await nadoClient.spot._mintMockERC20({
  amount: depositAmount,
  productId: 0,
});
await publicClient.waitForTransactionReceipt({
  hash: mintTxHash,
});

const approveTxHash = await nadoClient.spot.approveAllowance({
  amount: depositAmount,
  productId: 0,
});
await publicClient.waitForTransactionReceipt({
  hash: approveTxHash,
});

const depositTxHash = await nadoClient.spot.deposit({
  subaccountName: 'default',
  amount: depositAmount,
  productId: 0,
});
await publicClient.waitForTransactionReceipt({
  hash: depositTxHash,
});

await new Promise((resolve) => setTimeout(resolve, 10000));
```

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

### Get All Markets (Edge Multi-chain) - TypeScript

Source: https://docs.nado.xyz/developer-resources/typescript-sdk/user-guide/client/market/get-all-markets

Retrieves all available markets across multiple chains from the edge engine using the Nado XYZ TypeScript SDK. This function requires an initialized Nado client and returns cross-chain market data.

```typescript
import { createNadoClient } from '@nadohq/client';

const nadoClient = createNadoClient('inkTestnet', ...);
const res = await nadoClient.market.getEdgeAllMarkets();
```
Tokens:
Raw