SaucerSwap Protocol

https://docs.saucerswap.finance
Admin
The SaucerSwap Protocol is the leading Decentralized Exchange (DEX) and liquidity hub on Hedera,...
Tokens:165,974
Snippets:1,118
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example API Response with Headers

Source: https://docs.saucerswap.finance/v/developer/rest-api/authentication

This is an example of a successful HTTP response, including rate limiting information and a snippet of the JSON body containing token data.

```http
HTTP/2 200 
date: Thu, 17 Apr 2025 11:03:06 GMT
content-type: application/json; charset=utf-8
content-length: 92697
...
...
x-ratelimit-limit: 10000
x-ratelimit-remaining: 8250
x-ratelimit-additional-total: 0
x-ratelimit-reset: 1746071999999
...
...
[
  {
    "id": "0.0.731861",
    "icon": "/images/tokens/sauce.svg",
    "symbol": "SAUCE",
    "decimals": 6,
    "price": "36806544",
    "priceUsd": 0.01760954,
    "dueDiligenceComplete": true,
    "isFeeOnTransferToken": false
  }
]
```

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

### Install Dependencies for TypeScript Bot Client

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v3/orderbook-api/typescript-client

Installs the necessary packages for the TypeScript client, including ethers@5 for signing, ws for WebSocket support, and @hiero-ledger/sdk for Hedera account key handling.

```bash
npm install ethers@5 ws @hiero-ledger/sdk
npm install --save-dev @types/ws
```

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

### Successful Response Example

Source: https://docs.saucerswap.finance/v/developer/rest-api/pools-v1/pool-conversion-rates

This is an example of a successful JSON response when fetching historical candlestick data. It includes various price and liquidity metrics for the specified interval.

```json
[
  {
    "poolId": 1,
    "open": 0.0482115316666979,
    "high": 0.0482115316666979,
    "low": 0.04819650172584323,
    "close": 0.04819650172584323,
    "avg": 118.56339424557434,
    "volume": "0",
    "liquidity": "9668737245792",
    "volumeUsd": "0",
    "liquidityUsd": "4653.53",
    "timestampSeconds": 1697618460,
    "startTimestampSeconds": 1697616000
  }
]
```

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

### TypeScript JSON RPC Example for getAmountsIn

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v1/swap-operations/swap-quote

This TypeScript example demonstrates how to call the `getAmountsIn` function using Ethers.js V6 with a JSON RPC provider. It includes setting up the provider, defining the ABI, constructing the route, and calling the contract method.

```typescript
import * as ethers from 'ethers'; //V6

const networkId = 'testnet';
const provider = new ethers.JsonRpcProvider(`https://${networkId}.hashio.io/api`, '', {
  batchMaxCount: 1,
});

//ABI data for the getAmountsIn
const abi = ['function getAmountsIn(uint amountOut, address[] calldata path) external view returns (uint[] memory amounts)'];

//Load the ABI
const abiInterfaces = new ethers.Interface(abi);

//Example route (WHBAR > SAUCE)
const tokenIn = '0x' + TokenId.fromString(whbarTokenId).toSolidityAddress();
const tokenOut = '0x' + TokenId.fromString(sauceTokenId).toSolidityAddress();
const route = [tokenIn, tokenOut];

const routerContract = new ethers.Contract(routerEvmAddress, abiInterfaces.fragments, provider);
const result = await routerContract.getAmountsIn(outputAmountInSmallestUnit, route);
const amounts = results; //uint[] amounts
const finalInputAmount = amounts[0]; //in token's smallest unit
```

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

### JavaScript SDK Example

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v1/swap-operations/swap-tokens-for-tokens

Demonstrates how to call the swapTokensForExactTokens function using the Hedera JavaScript SDK. Ensure the output token is associated and the router contract has allowance for the input token.

```typescript
import { 
  ContractFunctionParameters, 
  ContractExecuteTransaction,
  AccountAllowanceApproveTransaction,  
  TokenAssociateTransaction,
  .. 
} from '@hashgraph/sdk';

//Client pre-checks:
// - Output token is associated
// - Router contract has spender allowance for the input token

const params = new ContractFunctionParameters();
params.addUint256(amountOut); //uint amountOut
params.addUint256(amountInMax); //uint amountInMax
params.addAddressArray(tokenPath); //address[] calldata path
params.addAddress(toAddress); //address to
params.addUint256(deadline); //uint deadline
    
const response = await new ContractExecuteTransaction()
 .setContractId(routerContractId)
 .setGas(gasLim)
 .setFunction('swapTokensForExactTokens', params)
 .execute(client);
 
const record = await response.getRecord(client);
const result = record.contractFunctionResult!;
const values = result.getResult(['uint[]']);
const amounts = values[0]; //uint[] amounts
const finalInputAmount = amounts[0];
```

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

### Get Pool Reserves via JSON RPC

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v1/liquidity-operations/get-pool-reserves

Fetch HTS token balances for a pool using the `getReserves()` solidity function via Hedera's JSON RPC Relay. This example uses Ethers.js v6 to interact with the contract.

```typescript
import * as ethers from 'ethers'; //V6

//Set one of Hedera's JSON RPC Relay as the provider
const provider = new ethers.JsonRpcProvider(hederaJsonRelayUrl, '', {
  batchMaxCount: 1, //workaround for V6
});

//load abi data containing Pair's getReserves() function
const interfaces = new ethers.Interface(abi);

const poolContract = new ethers.Contract(poolAddress, interfaces.fragments, provider);
const result = await poolContract.getReserves();
const reserve0 = result.reserve0; //in token's smallest unit
const reserve1 = result.reserve1; //in token's smallest unit
const block = result.blockTimestampLast;
```

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

### Connecting to the REST API

Source: https://docs.saucerswap.finance/v/developer/rest-api/authentication

Example of how to make a request to the REST API using an API key in the request header.

```APIDOC
## Connecting to the REST API

### Description
Once our team has provisioned an API key, you can start making requests to our REST API over HTTPS. API Key authentication is done via HTTP headers.

### Method
GET

### Endpoint
https://api.saucerswap.finance/tokens

### Parameters
#### Request Headers
- **x-api-key** (string) - Required - Your API key for authentication.

### Request Example
```bash
curl -i -H "x-api-key: 875e1017-87b8-4b12-8301-6aa1f1aa073b" \
  --url https://api.saucerswap.finance/tokens
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the token.
- **icon** (string) - URL path to the token's icon.
- **symbol** (string) - The trading symbol for the token.
- **decimals** (integer) - The number of decimal places for the token.
- **price** (string) - The current price of the token as a string.
- **priceUsd** (number) - The current price of the token in USD.
- **dueDiligenceComplete** (boolean) - Indicates if due diligence has been completed for the token.
- **isFeeOnTransferToken** (boolean) - Indicates if the token is a fee-on-transfer token.

#### Response Example
```json
[
  {
    "id": "0.0.731861",
    "icon": "/images/tokens/sauce.svg",
    "symbol": "SAUCE",
    "decimals": 6,
    "price": "36806544",
    "priceUsd": 0.01760954,
    "dueDiligenceComplete": true,
    "isFeeOnTransferToken": false
  }
]
```

### Understanding Authentication Headers

#### Request Headers

1. `x-api-key`
   You will use this header to pass your API key to our system for validation and authorization with every request. The key is a 32 character string we provision for you.

#### Response Headers

1. `x-ratelimit-limit`
   This response header communicates the total number of requests you can make in a month. This limit is determined by conversations you have with our team at time of provisioning.
2. `x-ratelimit-remaining`
   As you make requests throughout the month this value will go down. You can use this value programmatically to, for example, alert your team of potentially a need for a higher limit or to self-throttle.
3. `x-ratelimit-additional-total`
   There are circumstances where, perhaps, you may need more requests than what was discussed with our team at time of API key provisioning. If you think this might happen on occasion, please bring this up with our team. When that happens, you will see this value increase with each request over the limit.
4. `x-ratelimit-reset`
   This header value represents the time in milliseconds when usage statistics will reset. This typically points to the end of the current month.
```

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

### Get User Positions (V2)

Source: https://docs.saucerswap.finance/llms.txt

Get all liquidity positions for an account.

```APIDOC
## GET /v2/accounts/{accountId}/positions

### Description
Get all liquidity positions for an account.

### Method
GET

### Endpoint
/v2/accounts/{accountId}/positions

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The Hedera account ID.

### Response
#### Success Response (200)
- **positions** (array) - An array of liquidity position objects.

#### Response Example
```json
{
  "positions": [
    {
      "poolId": "0xpool1",
      "liquidity": "1000",
      "amountA": "500000",
      "amountB": "250000"
    }
  ]
}
```
```

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

### TypeScript SDK Example for Exact Output Swap

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v2/swap-operations/swap-hbar-for-tokens

Demonstrates how to use the Hedera JavaScript SDK with Ethers.js to perform an exact output swap via multicall, including refunding excess HBAR.

```typescript
import * as ethers from 'ethers'; //V6
import {
  ContractExecuteTransaction, 
  TokenAssociateTransaction,
  .. 
} from '@hashgraph/sdk';

//Client pre-checks:
// - Output token is associated

//load ABI data containing SwapRouter, PeripheryPayments and Multicall functions
const abiInterfaces = new ethers.Interface(abi); 

//ExactOutputParams
const params = {
  path: routeDataWithFee, //'0x...' (reversed route path)
  recipient: recipientAddress, //'0x...' - user's recipient address
  deadline: deadline, //Unix seconds
  amountOut: outputAmount, //in token's smallest unit
  amountInMaximum: inputTinybarMax //in Tinybar
};

//encode each function individually
const swapEncoded = abiInterfaces.encodeFunctionData('exactOutput', [params]);
const refundHBAREncoded = abiInterfaces.encodeFunctionData('refundETH');

//multi-call parameter: bytes[]
const multiCallParam = [swapEncoded, refundHBAREncoded];

//get encoded data for the multicall involving both functions
const encodedData = abiInterfaces.encodeFunctionData('multicall', [multiCallParam]);  

//get encoded data as Uint8Array
const encodedDataAsUint8Array = hexToUint8Array(encodedData);

const response = await new ContractExecuteTransaction()
 .setPayableAmount(Hbar.from(inputTinybarMax, HbarUnit.Tinybar))
 .setContractId(swapRouterContractId)
 .setGas(gasLim)
 .setFunctionParameters(encodedDataAsUint8Array)
 .execute(client);
 
const record = await response.getRecord(client);
const result = record.contractFunctionResult!;
const values = result.getResult(['uint256']);
const amountIn = values[0]; //uint256 amountIn
```

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

### Get Pool Reserves (V1)

Source: https://docs.saucerswap.finance/llms.txt

Get current reserves for one or many pools.

```APIDOC
## GET /pools/reserves

### Description
Get current reserves for one or many pools.

### Method
GET

### Endpoint
/pools/reserves

### Parameters
#### Query Parameters
- **poolIds** (string) - Optional - A comma-separated list of pool IDs for which to fetch reserves.

### Response
#### Success Response (200)
- **reserves** (object) - An object where keys are pool IDs and values are their respective reserves.

#### Response Example
```json
{
  "reserves": {
    "0xpool1": {"reserveA": "1000000", "reserveB": "500000"},
    "0xpool2": {"reserveA": "2000000", "reserveB": "1000000"}
  }
}
```
```

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

### authenticate

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v3/orderbook-api/typescript-client

Runs the challenge and verify flow to authenticate the user and stores the JWT. This is the first step in establishing a secure session.

```APIDOC
## authenticate

### Description
Runs the challenge and verify flow; store the JWT.

### Method
`authenticate(accountId, privateKey)`

### Parameters
- **accountId** (string) - Required - The account ID for authentication.
- **privateKey** (string) - Required - The private key for signing the challenge.

### Response
- **jwt** (string) - The JSON Web Token for subsequent authenticated requests.
```

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

### OpenAPI Specification for GET /tokens

Source: https://docs.saucerswap.finance/v/developer/rest-api/tokens/tokens

This OpenAPI specification defines the GET /tokens endpoint, which retrieves compact token data. It includes details on parameters, responses, and the schema for token objects. Use this endpoint to get a list of all available tokens on the network.

```yaml
openapi: 3.0.4
info:
  title: SaucerSwap REST API
  version: 1.0.0
servers:
  - url: https://api.saucerswap.finance
  - url: https://test-api.saucerswap.finance
security: []
paths:
  /tokens:
    get:
      tags:
        - Tokens
      summary: Get compact token data
      parameters:
        - $ref: '#/components/parameters/ApiKeyParam'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TokenCompact'
components:
  parameters:
    ApiKeyParam:
      name: x-api-key
      in: header
      required: true
      schema:
        type: string
        default: 875e1017-87b8-4b12-8301-6aa1f1aa073b
      description: >-
        API key for authentication. The demo api key provided is globally rate
        limited. Do not use in production.
  schemas:
    TokenCompact:
      type: object
      properties:
        id:
          type: string
          description: Token id (shard.realm.num)
          example: 0.0.731861
        icon:
          type: string
          description: Relative path to token icon
          example: /images/tokens/sauce.svg
        symbol:
          type: string
          description: Token symbol
          example: SAUCE
        decimals:
          type: integer
          description: Token decimal places
          example: 6
        price:
          type: string
          example: '36806544'
          description: Token price in tinybar
        priceUsd:
          type: number
          format: float
          description: Token price in USD
          example: 0.01760954
        dueDiligenceComplete:
          type: boolean
          description: Token due diligence completed?
          example: true
        isFeeOnTransferToken:
          type: boolean
          description: Token has fees on transfer?
          example: false
      required:
        - id
        - name
        - icon
        - symbol
        - decimals
        - price
        - priceUsd
        - dueDiligenceComplete
        - isFeeOnTransferToken

```

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

### addLiquidityETH Implementation (UniswapV2Router02)

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v1/liquidity-operations/adding-liquidity

The implementation of addLiquidityETH in UniswapV2Router02, handling token and HBAR transfers, pair creation, and liquidity minting. It refunds any excess HBAR.

```solidity
function addLiquidityETH(
    address token,
    uint amountTokenDesired,
    uint amountTokenMin,
    uint amountETHMin,
    address to,
    uint deadline
  ) external virtual override payable ensure(deadline) returns (uint amountToken, uint amountETH, uint liquidity) {
    (amountToken, amountETH) = _addLiquidity(
      token,
      whbar,
      amountTokenDesired,
      msg.value,
      amountTokenMin,
      amountETHMin
    );

    address pair = IUniswapV2Factory(factory).getPair(token, whbar);
    require(pair != address(0), "UniswapV2Router: PAIR DOES NOT EXIST");

    safeTransferToken(
      token, msg.sender, pair, amountToken
    );
    IWHBAR(WHBAR).deposit{value: amountETH}(msg.sender, pair);
    liquidity = IUniswapV2Pair(pair).mint(to);
    // refund dust eth, if any
    if (msg.value > amountETH) TransferHelper.safeTransferETH(msg.sender, msg.value - amountETH);
  }
```

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

### GET /farms OpenAPI Specification

Source: https://docs.saucerswap.finance/v/developer/rest-api/farms/farms

This OpenAPI specification defines the GET /farms endpoint for retrieving a list of active farms. It includes details on parameters, responses, and schemas for farm data.

```yaml
openapi: 3.0.4
info:
  title: SaucerSwap REST API
  version: 1.0.0
servers:
  - url: https://api.saucerswap.finance
  - url: https://test-api.saucerswap.finance
security: []
paths:
  /farms:
    get:
      tags:
        - Farms
      summary: Get list of active farms
      parameters:
        - $ref: '#/components/parameters/ApiKeyParam'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Farm'
components:
  parameters:
    ApiKeyParam:
      name: x-api-key
      in: header
      required: true
      schema:
        type: string
        default: 875e1017-87b8-4b12-8301-6aa1f1aa073b
      description: >-
        API key for authentication. The demo api key provided is globally rate
        limited. Do not use in production.
  schemas:
    Farm:
      type: object
      properties:
        id:
          description: SaucerSwap farm id
          type: integer
          example: 14
        poolId:
          description: SaucerSwap pool id
          type: integer
          example: 35
        sauceEmissions:
          type: number
          format: float
          example: 2.3062
          description: >-
            The amount of SAUCE emitted per second to the pool if the farm
            exists
        hbarEmissions:
          type: number
          format: float
          example: 0.0103
          description: The amount of HBAR emitted per second to the pool if the farm exists
        totalStaked:
          type: string
          example: '955338445589'
          description: Total staked LP amount in its smallest unit
      required:
        - id
        - poolId
        - sauceEmissions
        - hbarEmissions
        - totalStaked

```

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

### GET /tokens/full OpenAPI Specification

Source: https://docs.saucerswap.finance/v/developer/rest-api/tokens/tokens-full

This OpenAPI specification defines the GET /tokens/full endpoint. It includes details on parameters, responses, and the schema for token objects. Use this to understand the structure of the data returned.

```yaml
openapi: 3.0.4
info:
  title: SaucerSwap REST API
  version: 1.0.0
servers:
  - url: https://api.saucerswap.finance
  - url: https://test-api.saucerswap.finance
security: []
paths:
  /tokens/full:
    get:
      tags:
        - Tokens
      summary: Get detailed token data
      parameters:
        - $ref: '#/components/parameters/ApiKeyParam'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Token'
components:
  parameters:
    ApiKeyParam:
      name: x-api-key
      in: header
      required: true
      schema:
        type: string
        default: 875e1017-87b8-4b12-8301-6aa1f1aa073b
      description: >-
        API key for authentication. The demo api key provided is globally rate
        limited. Do not use in production.
  schemas:
    Token:
      type: object
      properties:
        id:
          type: string
          description: Token id (shard.realm.num)
          example: 0.0.731861
        name:
          type: string
          description: Token name
          example: SAUCE
        symbol:
          type: string
          description: Token symbol
          example: SAUCE
        icon:
          type: string
          description: Relative path to the token icon
          example: /images/tokens/sauce.svg
        decimals:
          type: integer
          description: Token decimal places
          example: 6
        price:
          type: string
          example: '36806544'
          description: Token price in tinybar
        priceUsd:
          type: number
          description: Token price in terms of USD
          example: 0.01763457
        dueDiligenceComplete:
          type: boolean
          description: Token due diligence completed?
          example: true
        isFeeOnTransferToken:
          type: boolean
          description: Token has fees on transfer?
          example: false
        description:
          type: string
          description: Token description
          example: >-
            SaucerSwap is an open source and non-custodial AMM protocol native
            to Hedera.
        website:
          type: string
          description: Token website link
          example: https://www.saucerswap.finance/
        sentinelReport:
          type: string
          description: Token sentinel report link
          example: https://sentinel.headstarter.org/details/saucerswap
        twitterHandle:
          type: string
          description: Token sentinel report link
          example: SaucerSwapLabs
      required:
        - id
        - name
        - symbol
        - icon
        - decimals
        - price
        - priceUsd
        - dueDiligenceComplete
        - isFeeOnTransferToken
        - description
        - website
        - sentinelReport
        - twitterHandle

```

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

### Fetch All Pools using Axios

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v1/liquidity-operations/fetch-all-pools

Demonstrates how to fetch all V1 liquidity pools from the SaucerSwap API using the axios library and log pool details to the console. Ensure axios is installed and imported.

```typescript
const url = 'https://api.saucerswap.finance/pools/';  
const response = await axios.get(url);
const pools = response.data;
for (const pool of pools as ApiLiquidityPool[] ) {
 
  const symbolA = pool.tokenA.symbol;
  const symbolB = pool.tokenB.symbol;

  let output = '';
  output += `Pool id: ${pool.id}`;
  output += ` - ${poolcontractId} (${symbolA}/${symbolB})`;

  console.log(output);
}
```

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

### Get daily price, volume and liquidity for all tokens

Source: https://docs.saucerswap.finance/v/developer/rest-api/tokens/tokens-daily

Fetches daily price, volume, and liquidity for all tokens. This endpoint requires an API key for authentication.

```APIDOC
## GET /tokens/daily

### Description
Retrieves daily price, volume, and liquidity data for all tokens. This endpoint is useful for tracking historical token performance and market activity.

### Method
GET

### Endpoint
/tokens/daily

### Parameters
#### Header Parameters
- **x-api-key** (string) - Required - API key for authentication. The demo api key provided is globally rate limited. Do not use in production.

### Response
#### Success Response (200)
- **timestampSeconds** (integer) - Unix seconds
- **tokenId** (string) - Token id (shard.realm.num)
- **price** (string) - Token price in tinybar
- **liquidity** (string) - Token liquidity in its smallest unit
- **volume** (string) - Token volume in its smallest unit

#### Response Example
```json
[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]
```
```

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

### Get Default Listed Pool Data

Source: https://docs.saucerswap.finance/v/developer/rest-api/pools-v1/pools-known

Retrieves a list of all default pools currently listed on SaucerSwap. This endpoint is useful for getting an overview of available trading pairs and their current liquidity status.

```APIDOC
## GET /pools/known

### Description
Get default listed pool data.

### Method
GET

### Endpoint
/pools/known

### Parameters
#### Header Parameters
- **x-api-key** (string) - Required - API key for authentication. The demo api key provided is globally rate limited. Do not use in production.

### Responses
#### Success Response (200)
- **Pool** (array) - An array of pool objects, each containing details about a specific liquidity pool.

### Response Example
```json
[
  {
    "id": 213,
    "contractId": "0.0.1465865",
    "lpToken": {
      "id": "0.0.1465866",
      "name": "SS-LP SAUCE - XSAUCE",
      "symbol": "SAUCE - XSAUCE",
      "decimals": 8,
      "priceUsd": 3.7760690082569948
    },
    "lpTokenReserve": "23490447137584",
    "tokenA": {
      "id": "0.0.731861",
      "name": "SAUCE",
      "symbol": "SAUCE",
      "decimals": 6,
      "priceUsd": 0.01760954,
      "description": "SaucerSwap is an open source and non-custodial AMM protocol native to Hedera.",
      "website": "https://www.saucerswap.finance/",
      "sentinelReport": "https://sentinel.headstarter.org/details/saucerswap",
      "twitterHandle": "SaucerSwapLabs"
    },
    "tokenReserveA": "25185652046087",
    "tokenB": {
      "id": "0.0.1460200",
      "name": "xSAUCE",
      "symbol": "XSAUCE",
      "decimals": 6,
      "priceUsd": 0.01959459,
      "description": "SaucerSwap is an open source and non-custodial AMM protocol native to Hedera.",
      "website": "https://www.saucerswap.finance/",
      "sentinelReport": "https://sentinel.headstarter.org/details/saucerswap",
      "twitterHandle": "SaucerSwapLabs"
    },
    "tokenReserveB": "22634187941347"
  }
]
```
```

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

### JavaScript: Constructing and Executing Increase Liquidity Transaction

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v2/liquidity-operations/increasing-liquidity

This snippet demonstrates the complete process of increasing liquidity in a SauceSwap V2 pool using JavaScript. It includes calculating minimum amounts with slippage, constructing the `increaseLiquidity` parameters, encoding them for a multicall, granting spender allowance, executing the transaction, and fetching/decoding the results.

```javascript
    //Calculate the minimum amounts factoring in the price slippage % and range
    const priceSlippagePercent = new Percent(1, 100); //1% price slippage
    const minAmounts = position.mintAmountsWithSlippage(priceSlippagePercent);
    const amount0Min = minAmounts.amount0.toString();
    const amount1Min = minAmounts.amount1.toString();

    //IncreaseLiquidityParams struct
    const params = {
      tokenSN: tokenSN,
      fee: feeTier, //500, 1500, 3000 or 10000
      tickLower: tickLower, //lower tick of the range
      tickUpper: tickUpper, //upper tick of the range
      amount0Desired: amount0Mint, //in smallest unit
      amount1Desired: amount1Mint, //in smallest unit
      amount0Min: amount0Min, //in smallest unit
      amount1Min: amount1Min, //in smallest unit
      deadline: deadline, //Unix seconds
    };

    //Construct encoded data for each function
    const increaseLiquidityEncoded = nftManagerInterfaces.encodeFunctionData('increaseLiquidity', [params]);  
    const refundEthEncoded = nftManagerInterfaces.encodeFunctionData('refundETH');

    //Build encoded data for multicall
    const encodedData = abiInterfaces.encodeFunctionData('multicall', 
      [[mintEncoded, refundEthEncoded]]);  
    const encodedDataAsUint8Array = hexToUint8Array(encodedData.substring(2));

    //Give spender allowance for both tokens to the NFT Manager contract if needed.
    //To avoid having to ask for allowance each time, request max allowance.
    //If the token is HBAR, no spender allowance is required.
    //Use Hedera's REST API to get current allowances for an account.
    await yourGrantSpenderAllowanceFunc(..);

    //Execute the contract call
    const response = await new ContractExecuteTransaction()
      .setPayableAmount(inputHbar) //mint fee + HBAR token amount if used
      .setContractId(nftManagerContractId)
      .setGas(gasGwei)
      .setFunctionParameters(encodedDataAsUint8Array)
      .execute(client);

    //Fetch the result
    const record = await response.getRecord(client);    
    const result = record.contractFunctionResult!;
    const results = abiInterfaces.decodeFunctionResult('multicall', result.bytes)[0];
    const mintResult = abiInterfaces.decodeFunctionResult('increaseLiquidity', results[0]);

    //Retrieve the newly minted liquidity and amounts for informative purposes
    const liquidity = BigNumber(mintResult.liquidity);
    const amount0 = BigNumber(mintResult.amount0);
    const amount1 = BigNumber(mintResult.amount1);
```

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

### Stake SAUCE for xSAUCE using Hedera SDK

Source: https://docs.saucerswap.finance/v/developer/staking-operations/single-sided-staking

This TypeScript example demonstrates how to call the 'enter' function on the Mothership contract using the Hedera JavaScript SDK. Pre-checks include ensuring the xSAUCE token is associated and the Mothership contract has a spender allowance for the SAUCE token.

```typescript
import { 
  ContractFunctionParameters, 
  ContractExecuteTransaction,
  AccountAllowanceApproveTransaction,
  TokenAssociateTransaction,  
  .. 
} from '@hashgraph/sdk';

//Client pre-checks:
// - XSAUCE token is associated
// - Mothership contract has spender allowance for the SAUCE token

const params = new ContractFunctionParameters();
params.addUint256(sauceAmountTiny); //uint _amount
    
await new ContractExecuteTransaction()
 .setContractId(mothershipContractId)
 .setGas(gasLim)
 .setFunction('enter', params)
 .execute(client);
```

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

### OpenAPI Specification for Get Token Data

Source: https://docs.saucerswap.finance/v/developer/rest-api/tokens/token

This OpenAPI specification defines the GET /tokens/{tokenId} endpoint for retrieving detailed token information. It includes parameters, request/response schemas, and server URLs for mainnet and testnet.

```yaml
openapi: 3.0.4
info:
  title: SaucerSwap REST API
  version: 1.0.0
servers:
  - url: https://api.saucerswap.finance
  - url: https://test-api.saucerswap.finance
security: []
paths:
  /tokens/{tokenId}:
    get:
      tags:
        - Tokens
      summary: Get detailed token data by id
      parameters:
        - $ref: '#/components/parameters/ApiKeyParam'
        - name: tokenId
          description: Token id (shard.realm.num)
          in: path
          required: true
          schema:
            type: string
            example: 0.0.731861
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
                type: object
components:
  parameters:
    ApiKeyParam:
      name: x-api-key
      in: header
      required: true
      schema:
        type: string
        default: 875e1017-87b8-4b12-8301-6aa1f1aa073b
      description: >-
        API key for authentication. The demo api key provided is globally rate
        limited. Do not use in production.
  schemas:
    Token:
      type: object
      properties:
        id:
          type: string
          description: Token id (shard.realm.num)
          example: 0.0.731861
        name:
          type: string
          description: Token name
          example: SAUCE
        symbol:
          type: string
          description: Token symbol
          example: SAUCE
        icon:
          type: string
          description: Relative path to the token icon
          example: /images/tokens/sauce.svg
        decimals:
          type: integer
          description: Token decimal places
          example: 6
        price:
          type: string
          example: '36806544'
          description: Token price in tinybar
        priceUsd:
          type: number
          description: Token price in terms of USD
          example: 0.01763457
        dueDiligenceComplete:
          type: boolean
          description: Token due diligence completed?
          example: true
        isFeeOnTransferToken:
          type: boolean
          description: Token has fees on transfer?
          example: false
        description:
          type: string
          description: Token description
          example: >-
            SaucerSwap is an open source and non-custodial AMM protocol native
            to Hedera.
        website:
          type: string
          description: Token website link
          example: https://www.saucerswap.finance/
        sentinelReport:
          type: string
          description: Token sentinel report link
          example: https://sentinel.headstarter.org/details/saucerswap
        twitterHandle:
          type: string
          description: Token sentinel report link
          example: SaucerSwapLabs
      required:
        - id
        - name
        - symbol
        - icon
        - decimals
        - price
        - priceUsd
        - dueDiligenceComplete
        - isFeeOnTransferToken
        - description
        - website
        - sentinelReport
        - twitterHandle

```

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

### OpenAPI Specification for Get All Pools

Source: https://docs.saucerswap.finance/v/developer/rest-api/pools-v1/pools-full

This OpenAPI 3.0.4 specification defines the GET /pools/full endpoint. It details the request parameters, including an API key, and the structure of the successful JSON response, which is an array of Pool objects.

```yaml
openapi: 3.0.4
info:
  title: SaucerSwap REST API
  version: 1.0.0
servers:
  - url: https://api.saucerswap.finance
  - url: https://test-api.saucerswap.finance
security: []
paths:
  /pools/full:
    get:
      tags:
        - Pools
      summary: Get detailed data for all pools
      parameters:
        - $ref: '#/components/parameters/ApiKeyParam'
      responses:
        '200': 
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Pool'
components:
  parameters:
    ApiKeyParam:
      name: x-api-key
      in: header
      required: true
      schema:
        type: string
        default: 875e1017-87b8-4b12-8301-6aa1f1aa073b
      description: >-
        API key for authentication. The demo api key provided is globally rate
        limited. Do not use in production.
  schemas:
    Pool:
      type: object
      properties:
        id:
          type: integer
          example: 213
          description: Pool id
        contractId:
          type: string
          example: 0.0.1465865
          description: Contract id (shard.realm.num)
        lpToken:
          $ref: '#/components/schemas/LPToken'
        lpTokenReserve:
          type: string
          description: LP token reserve in its smallest unit
          example: '23490447137584'
        tokenA:
          $ref: '#/components/schemas/TokenA'
        tokenReserveA:
          type: string
          description: Token A reserve in its smallest unit
          example: '25185652046087'
        tokenB:
          $ref: '#/components/schemas/TokenB'
        tokenReserveB:
          type: string
          description: Token B reserve in its smallest unit
          example: '22634187941347'
      required:
        - id
        - contractId
        - lpToken
        - lpTokenReserve
        - tokenA
        - tokenReserveA
        - tokenB
        - tokenReserveB
    LPToken:
      allOf:
        - $ref: '#/components/schemas/TokenSimple'
      example:
        id: 0.0.1465866
        name: SS-LP SAUCE - XSAUCE
        symbol: SAUCE - XSAUCE
        decimals: 8
        priceUsd: 3.7760690082569948
    TokenA:
      allOf:
        - $ref: '#/components/schemas/Token'
      example:
        id: 0.0.731861
        name: SAUCE
        symbol: SAUCE
        decimals: 6
        priceUsd: 0.01760954
        description: >-
          SaucerSwap is an open source and non-custodial AMM protocol native to
          Hedera.
        website: https://www.saucerswap.finance/
        sentinelReport: https://sentinel.headstarter.org/details/saucerswap
        twitterHandle: SaucerSwapLabs
    TokenB:
      allOf:
        - $ref: '#/components/schemas/Token'
      example:
        id: 0.0.1460200
        name: xSAUCE
        symbol: XSAUCE
        decimals: 6
        priceUsd: 0.01959459
        description: >-
          SaucerSwap is an open source and non-custodial AMM protocol native to
          Hedera.
        website: https://www.saucerswap.finance/
        sentinelReport: https://sentinel.headstarter.org/details/saucerswap
        twitterHandle: SaucerSwapLabs
    TokenSimple:
      type: object
      properties:
        id:
          type: string
          description: Token id (shard.realm.num)
          example: 0.0.731861
        name:
          type: string
          description: Token name
          example: SAUCE
        symbol:
          type: string
          description: Token syymbol
          example: SAUCE
        decimals:
          type: integer
          description: Token decimal places
          example: 6
        priceUsd:
          type: number
          description: Token price in terms of USD
          format: float
          example: 0.01760954
      required:
        - id
        - name
        - symbol
        - decimals
        - priceUsd
    Token:
      type: object
      properties:
        id:
          type: string
          description: Token id (shard.realm.num)
          example: 0.0.731861
        name:
          type: string
          description: Token name
          example: SAUCE
        symbol:
          type: string

```

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

### Get weekly price, volume and liquidity for all tokens

Source: https://docs.saucerswap.finance/v/developer/rest-api/tokens/tokens-weekly

Fetches a list of all tokens and their aggregated weekly price, volume, and liquidity data. Requires an API key for authentication.

```APIDOC
## GET /tokens/weekly

### Description
Retrieves weekly price, volume, and liquidity data for all tokens. This endpoint is useful for analyzing token performance over a week.

### Method
GET

### Endpoint
/tokens/weekly

### Parameters
#### Header Parameters
- **x-api-key** (string) - Required - API key for authentication. The demo api key provided is globally rate limited. Do not use in production.

### Response
#### Success Response (200)
Returns an array of token data objects, each containing timestamp, token ID, price, liquidity, and volume.
- **timestampSeconds** (integer) - Unix seconds
- **tokenId** (string) - Token id (shard.realm.num)
- **price** (string) - Token price in tinybar
- **liquidity** (string) - Token liquidity in its smallest unit
- **volume** (string) - Token volume in its smallest unit

#### Response Example
```json
[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]
```
```

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

### Place a Minimal Limit Order

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v3/orderbook-api/typescript-client

Demonstrates how to authenticate, build, sign, and save a limit order using the OrderbookApiClient. Ensure you have your private key set in the environment variable PRIVATE_KEY.

```typescript
const client = new OrderbookApiClient({ environment: 'testnet' })

async function placeLimitOrder() {
  await client.authenticate('0.0.123456', process.env.PRIVATE_KEY!)

  const domain = await client.getDomain()

  const requests = [
    {
      orderbookId: '3',
      type: 'LIMIT' as const,
      deadline: String(Math.floor(Date.now() / 1000) + 3600),
      inputToken: '0xbase-token-evm-address',
      inputAmount: '1000000',
      outputToken: '0xquote-token-evm-address',
      outputAmount: '950000',
      isAMMEnabled: true,
    },
  ]

  const builtOrders = await client.buildOrders(requests)

  const items = []
  for (let i = 0; i < builtOrders.length; i++) {
    const signature = await client.signOrder(
      builtOrders[i],
      process.env.PRIVATE_KEY!,
      domain,
    )

    items.push({
      order: builtOrders[i],
      signature,
      orderbookId: requests[i].orderbookId,
      type: requests[i].type,
    })
  }

  const { orders: saved } = await client.saveOrders(items)
  for (const order of saved) {
    console.log(
      `order ${order.meta?.id}: status=${order.meta?.status} nonce=${order.info.nonce}`,
    )
  }
}

placeLimitOrder().catch(console.error)
```

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

### Get Swap Quote via JSON RPC

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v2/swap-operations/swap-quote

Use this snippet to get a swap quote by calling the QuoterV2 contract directly through a Hedera JSON RPC Relay. Ensure you have the necessary ABI data and contract IDs.

```typescript
import * as ethers from 'ethers'; //V6

//Set one of Hedera's JSON RPC Relay as the provider
const provider = new ethers.JsonRpcProvider(hederaJsonRelayUrl, '', {
  batchMaxCount: 1, //workaround for V6
});

//load ABI data containing QuoterV2 functions
const abiInterfaces = new ethers.Interface(abi);

//QuoterV2.sol contract
const quoterEvmAddress = `0x${ContractId.fromString(quoterContractId).toSolidityAddress()}`;  

//swap path
const pathData:string[] = [];
pathData.push(inputToken.toSolidityAddress());  
pathData.push(feeHexStr);
pathData.push(outputToken.toSolidityAddress());

//reverse the path
pathData.reverse();

//get encoded Uint8Array data for path hex
const encodedPathData = hexToUint8Array(pathData.join(''));

const data = abiInterfaces.encodeFunctionData('quoteExactOutput', [
  encodedPathData, 
  outputAmountInSmallestUnit
]);

//Send a call to the JSON-RPC provider directly
const result = await provider.call({
  to: quoterEvmAddress,
  data: data,
});

const decoded = abiInterfaces.decodeFunctionResult('quoteExactOutput', result); 
const finalAmountIn = decoded.amountIn; //in token's smallest unit
```

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

### Authentication

Source: https://docs.saucerswap.finance/v/developer/saucerswap-v3/orderbook-api

Initiates the authentication process by obtaining a challenge and then verifying it.

```APIDOC
## POST /auth/challenge

### Description
Obtain a challenge to sign for wallet authentication.

### Method
POST

### Endpoint
/auth/challenge

### Response
#### Success Response (200)
- **challenge** (string) - The challenge to be signed by the user's wallet.

### Response Example
{
  "challenge": "a_unique_challenge_string"
}

## POST /auth/verify

### Description
Verify the signed challenge to obtain a JWT for API access.

### Method
POST

### Endpoint
/auth/verify

### Parameters
#### Request Body
- **signature** (string) - Required - The signature of the challenge from the user's wallet.
- **publicKey** (string) - Required - The public key of the user's wallet.

### Request Example
{
  "signature": "user_signed_challenge",
  "publicKey": "user_wallet_public_key"
}

### Response
#### Success Response (200)
- **token** (string) - A short-lived JWT for authenticated API requests.

#### Response Example
{
  "token": "a_short_lived_jwt_token"
}
```
Tokens:
Raw