quickswap-dex-controller

This SDK houses the functions to interact with the Quickswap Contracts.

Installation

To install this SDK,

npm install --save @getsafle/quickswap-controller

Initialization

Initialize the constructor,

const Quickswap = require('@getsafle/quickswap-controller');

const controller = new Quickswap(chain);

Get supported tokens

This function will give us the list of all tokens supported by Quickswap.

await controller.getSupportedTokens()

Get Exchange Rate

This will give us the exchange rate of 2 tokens. Amount of fromContractAddress the user will receive for fromQuantity of toContractAddress.

await controller.getExchangeRate({ toContractAddress, toContractDecimal, fromContractAddress, fromContractDecimal, fromQuantity, slippageTolerance, walletAddress })

Get Estimated gas

This will give us the estimated amount of gas needed to do the swap.

await controller.getEstimatedGas({ toContractAddress, toContractDecimal, fromContractAddress, fromContractDecimal, fromQuantity, slippageTolerance, walletAddress })

Get Raw Transaction

This will give us the raw transaction to swap the tokens on quickswap.

await controller.getRawTransaction({ walletAddress, toContractAddress, toContractDecimal, fromContractAddress, fromContractDecimal, toQuantity, fromQuantity, slippageTolerance })

Get Approval Transaction

This function will call the approval smart contract function to approve spending fromQuantity for the fromContractAddress from the walletAddress.

await controller.approvalRawTransaction({ fromContractAddress, walletAddress, fromQuantity })