Swap token

A 토큰을 B 토큰으로 Swap하게 되면, A 토큰은 fromToken이, B 토큰은 toToken이 됩니다.

setSlippage#

함수 이름#

setSlippage()

Slippage를 적용합니다. 단위는 0.01% 단위이며 100을 입력하면 slippage가 1%로 설정됩니다.

함수 실행 인자값#

함수 반환값#

undefined

함수 예제#

/* slippage 설정 N%, 정수만 됩니다. */
x2easy.swap.setSlippage(10); // slippage가 0.1%로 설정됩니다.

estimationDestinationPrice#

함수 이름#

estimationDestinationPrice()

Swap 결과 가격을 구해옵니다. (slippage 적용된 계산식)

함수 실행 인자값#

함수 반환값#

Result

함수 예제#

/* fromToken을 toToken으로 Swap하는데, 0.05 fromToken을 넣었을 때 toToken의 예상가격을 불러오는 코드 */
const price = await x2easy.swap.estimationDestinationPrice(
  0.05, // amount
  true, // isBaseFromAmount (default: true)
  false, // reverse (default: false)
  fromTokenAddress, // fromTokenAddress (default: '')
  toTokenAddress // toTokenAddress (default: new X2Easy(contractAddress) 할때 넣었던 파라미터 값.)
);
console.log(price); // 500

estimationGas#

함수 이름#

estimationGas()

swapTransaction 함수와 똑같은 Parameter를 가집니다.

해당 Parameter 그대로 swapTransaction를 불러올 때 발생한 가스비를 계산합니다.

함수 실행 인자값#

함수 반환값#

함수 예제#

const gasFee = await x2easy.swap.estimationGas(
  500, // amount
  '123456', // password
  false, // isBaseFromAmount (default: true)
  true, // reverse (default: false)
  fromTokenAddress, // fromTokenAddress (default: '')
  toTokenAddress, // toTokenAddress (default: new X2Easy(contractAddress) 할때 넣었던 파라미터 값.)
);
console.log(gasFee);
/*
{
    "gasUsed": "195730" // 가스 사용량
    "gasPrice": "64238640917" // 가스 가격 (gwei 단위)
    "paidGas": " "12573429186684410" // 총 지불 가스량 (gasUsed * gasPrice)
    "paidGasToEther": "0.01257342918668441" // 총 지불 가스량 (ether 단위)
}
*/

swapTransaction#

함수 이름#

swapTransaction()

Swap을 진행합니다. 반환값으로 여러 값들이 나오는데, 문서에 적힌 트랜잭션 해시 값 외에는 잘 사용하지 않습니다.

함수 실행 인자값#

const txResult = await x2easy.swap.swapTransaction(
  500, // amount
  '123456', // password
  false, // isBaseFromAmount (default: true)
  true, // reverse (default: false)
  fromTokenAddress, // fromTokenAddress (default: '')
  toTokenAddress, // toTokenAddress (default: new X2Easy(contractAddress) 할때 넣었던 파라미터 값.)
);
console.log(txResult);
/*
{
    more data... // 생략
    "hash": "0x0fb7ff39d9acd1e8528b09e58fd853965471044cbb539ea55b81ab72085b0c00", // 트랜잭션 해시
    "from": "0x92029B49f67785FFFF41a5E36B1A9afB4AC2497d", // 보낸사람
    ... more data // 생략
}
*/

함수 반환값#

응용 예제#

estimationDestinationPrice와 swapTrnasaction를 사용해서 예측값을 넣습니다.

(실제로 이렇게 사용하면 안됩니다. 예를 들기 위해 보여준 코드입니다.)

/*
아래 코드 설명 (조건들)
1. fromToken -> toToken 으로 reverse가 없이 정방향으로 swap함.
2. price는 toToken 기준의 price이다.
아래 코드는 fromToken(0.05) -> toToken(계산해야함) 으로 swap을 진행하는 코드입니다.
swap함수 하나만 사용해도 되는데, estimationDestinationPrice 함수의 사용 예를 보여주기 위함입니다.
*/
const price = await x2easy.swap.estimationDestinationPrice(
  0.05, // amount
  true, // isBaseFromAmount (default: true)
  false // reverse (default: false)
);
// 트랜잭션 실행시킴, 반환값으로 실행된 트랜잭션 해시 반환
const txResult = await x2easy.swap.swapTransaction(
  price, // amount
  '123456', // password
  false, // fromToken로 계산된 toToken의 price를 가져오는 거니까 swap 기준값이 toToken이 된다.
  false // reverse (default: false)
);