# Usage

[**View on GitHub**](https://github.com/orbs-network/liquidity-hub-sdk)

### **Creating SDK Instance**

To use the SDK, create an instance of the liquidity hub SDK. This instance provides the primary functionality to interact with Orbs Liquidity Hub.

```javascript
import { constructSDK } from "@orbs-network/liquidity-hub-sdk";

const liquidityHubSDK = constructSDK({
  chainId: 1, // The connected chain ID (1 for mainnet)
  partner: "partnerName", // Your partner name
});
```

### Fetching a Quote

Use the `getQuote` function to retrieve a real-time token swap quote. For native tokens, use the wrapped token address in the `fromToken` field.

```javascript
const quoteArgs = {
  fromToken: "0xTokenA", // Address of the input token
  toToken: "0xTokenB", // Address of the output token
  inAmount: "1000000000000000000", // Input token amount in wei (1 token)
  account: "0xYourWalletAddress", // User's wallet address
  slippage: "0.5", // Slippage tolerance percentage
  dexMinAmountOut: "1000000000000000000", // Minimum output from DEX in wei
  signal, // Optional: Abort signal
  timeout, // Optional: Timeout in milliseconds, default is 10 seconds
};

const quote = await liquidityHubSDK.getQuote(quoteArgs);
```

### Comparing Minimum Output Amounts

After fetching a quote, you can compare the Liquidity Hub quote's `minAmountOut` with the DEX’s `dexMinAmountOut` to decide which is better for the swap.

```javascript
const isLiquidityHubBetter =
  BigInt(quote.minAmountOut) > BigInt(dexMinAmountOut);

const onSwap = () => {
  if (isLiquidityHubBetter) {
    // Swap using Liquidity Hub
  } else {
    // Swap using DEX
  }
};
```

### Performing a Swap

1. If the input token is a native token, wrap the token first.
2. Approve allowance for the input token. Use the `permit2` contract at `0x000000000022D473030F116dDEE9F6B43aC78BA3`. (Permit2 contract address)
3. Sign the permit data using the EIP-712 sign function.
4. Call the swap function with the quote and signature.

```javascript
const txHash = await liquidityHubSDK.swap(
  quote, // The quote obtained from `getQuote`
  "signature" // A valid EIP-712 signature for the quote's permitData
);
```

### Fetching Transaction Details

Once a swap is completed, you can fetch the transaction details using the `getTransactionDetails` function. This function checks the on-chain status of the transaction and returns details once it has been successfully mined.

```javascript
const txHash = "0xYourTransactionHash";  // Replace with your actual transaction hash you got from swap function

const txDetails = await liquidityHubSDK.getTransactionDetails(txHash, quote);
---
```

### Analytics

The SDK provides built-in analytics to help track the performance of your swaps. When performing operations such as wrapping, approving, or signing, you can use the analytics callbacks.

```javascript
const analytics = await liquidityHubSDK.analytics;

try {
  analytics.onWrapRequest(); // Trigger when wrap is requested
  wrap(); // Perform the wrap operation
  analytics.onWrapSuccess(); // Trigger on successful wrap
} catch (error) {
  analytics.onWrapFailure(error.message); // Trigger on wrap failure
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.orbs.network/orbs-integrations/liquidity-hub-sdk/usage.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.