Code Monkey home page Code Monkey logo

uniswap-v2-sdk's Introduction

Custom Uniswap V2 SDK

Unit Tests Lint code style: prettier npm version npm bundle size (scoped version)

In-depth documentation on original SDK is available at uniswap.org.

Most blockchain with EVM compatibility will use Uniswap solutions to build a decentralized crypto exchange. However, the original Uniswap SDK has a factory address contract and the init code hash (used for getCreate2Address etherjs method) is locked in the source code.

The result is that everyone is cloning and creates their own version. And as a result, their own SDK is outdated with Uniswap latest fixes, upgrade and hard to check what changes with the original Uniswap SDK.

I forked and changes some code, so we can reuse Uniswap SDK without cloning and create our own.

Install

npm i custom-uniswap-v2-sdk

or

yarn add custom-uniswap-v2-sdk

Changes

  • The forked SDK won't export FACTORY_ADDRESS and INIT_CODE_HASH anymore.

  • Exported computePairAddress method will require factory address, and init code hash.

// Example interface
interface ComputePairAddressArg {
  factoryAddress: string
  initCodeHash: string
  tokenA: Token
  tokenB: Token
}

export function computePairAddress(arg: ComputePairAddressArg) {
  // Example
}
  • Exported class Pair constructor will require factory address, and init code hash.
new Pair(currencyAmountA, tokenAmountB, factoryAddress, initCodeHash)
  • Exported class Pair static method getAddress will require factory address, and init code hash.
 public static getAddress(tokenA: Token, tokenB: Token, factoryAddress: string, initCodeHash: string): string {
    //
}
  • Exported class Pair constructor now support custom fees numerator and fees denominator (v3.1.0)

In the Uniswap SDK , feesNumerator and feesDenominator are constant JSBI.BigInt(997) and JSBI.BigInt(1000)

export const _997 = JSBI.BigInt(997)

export const _1000 = JSBI.BigInt(1000)

In PancakeSwap they change this to support different fee

export const FEES_NUMERATOR = JSBI.BigInt(9975)

export const FEES_DENOMINATOR = JSBI.BigInt(10000)

So in the custom SDK, ThePair class now can change the fees. If you do not add to the constructor, default fees will be used.

new Pair(currencyAmountA, tokenAmountB, factoryAddress, initCodeHash, feesNumerator, feesDenominator)
  • Router.swapCallParameters support custom contract method name that have ETH name in it.

For example, in the Avalance chain some contracts are using swapExactAVAXForTokens instead swapExactETHForTokens

Router.swapCallParameters(trade, {
  feeOnTransfer: false,
  allowedSlippage: new Percent(JSBI.BigInt(Math.floor(slippageTolerance)), JSBI.BigInt(10000)),
  recipient: wallet.account,
  ttl: deadline,
  etherMethods: {
    wapETHForExactTokens: 'swapAVAXForExactTokens',
    swapExactETHForTokens: 'swapExactAVAXForTokens',
    swapExactETHForTokensSupportingFeeOnTransferTokens: 'swapExactAVAXForTokensSupportingFeeOnTransferTokens',
    swapExactTokensForETH: 'swapExactTokensForAVAX',
    swapExactTokensForETHSupportingFeeOnTransferTokens: 'swapExactTokensForAVAXSupportingFeeOnTransferTokens',
    swapTokensForExactETH: 'swapTokensForExactAVAX'
  }
})

uniswap-v2-sdk's People

Contributors

noahzinsmeister avatar moodysalem avatar gndplayground avatar dependabot[bot] avatar lint-action avatar jfrankfurt avatar willpote avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.