npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@getsafle/safle-swaps-v2

v1.2.9

Published

Safle Swaps V2 SDK

Downloads

27

Readme

Safle Swaps SDK

Safle swaps v2 SDK.

Installation and Usage

Installation

Install the package by running the command,

npm install @getsafle/safle-swaps-v2

Import the package into your project using,

const Swap = require('@getsafle/safle-swaps-v2');

Initialise the swap class,

const swap = new Swap({ dex, rpcURL,chain });

  • dex  - The name of DEX using which you want to swap tokens.
  • rpcURL  - The rpc url to connect to a blockchain node.
  • chain  - The chain name of the blockchain. Supported for now - ethereum

Auxiliary Methods

Get supported DEX’s: Returns the list of all the supported DEX’s.

const supportedDex = await Swap.getDex();

Class Methods

  1. Change DEX: This method updates the DEX through which the swap will be executed

    await swap.setDex(dex);

    • dex - The name of DEX using which you want to swap tokens.
  2. Get Supported Tokens: This method returns list of tokens supported on the dex

    const supportedToken = await swap.getSupportedTokens();

  3. Get Exchange Rates: This method returns exchange rates for a token pair

    await swap.getExchangeRates({ toContractAddress, toContractDecimal, fromContractAddress, fromContractDecimal, fromQuantity, slippageTolerance });

    • toContractAddress - contract address of the destination token
    • toContractDecimal - decimal of destination token
    • fromContractAddress - contract address of source token
    • fromContractDecimal - decimal of source token
    • fromQuantity - source quantity in wei
    • slippageTolerance - Slippage tolerance percentage in integer
  4. Get Estimated Gas: This method returns estimated gas for the swap transaction

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

    • toContractAddress - contract address of the destination token
    • toContractDecimal - decimal of destination token
    • fromContractAddress - contract address of source token
    • fromContractDecimal - decimal of source token
    • fromQuantity - source quantity in wei
    • slippageTolerance - Slippage tolerance percentage in integer
  5. Get Raw Transaction: This method returns the raw transaction

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

    • toContractAddress - contract address of the destination token
    • toContractDecimal - decimal of destination token
    • fromContractAddress - contract address of source token
    • fromContractDecimal - decimal of source token
    • fromQuantity - source quantity in wei
    • walletAddress - public address of the wallet for the transaction
    • slippageTolerance - Slippage tolerance percentage in integer
    • toQuantity - Quantity of the tokens received post swapping. This value can be obtained from the getExchangeRates function.
  6. Get Rates: This method returns exchange rates for a token pair accross all supported DEX's

    await swap.getRates({ toContractAddress, toContractDecimal, fromContractAddress, fromContractDecimal, fromQuantity, slippageTolerance });

    • toContractAddress - contract address of the destination token
    • toContractDecimal - decimal of destination token
    • fromContractAddress - contract address of source token
    • fromContractDecimal - decimal of source token
    • fromQuantity - source quantity in wei
    • slippageTolerance - Slippage tolerance percentage in integer
  7. Get approval transaction: This method returns the approval transaction

    await swap.getRatesapprovalRawTransaction({ walletAddress, fromContractAddress, fromQuantity });

    • walletAddress - public address of the wallet for the transaction
    • fromContractAddress - contract address of source token
    • fromQuantity - source quantity in wei