Trading

Looking for a quickstart?

The SDK cannot execute trades or send transactions on your behalf. Rather, it offers utility classes and functions which make it easy to calculate the data required to safely interact with Hermes. Nearly everything you need to safely transact with Hermes is provided by the Trade entity. However, it is your responsibility to use this data to send transactions in whatever context makes sense for your application.

This guide will focus exclusively on sending a transaction to the currently recommended Hermes Dex router

Sending a Transaction to the Router

Let's say we want to trade 1 WETH for as much DAI as possible:

import {
  ChainId,
  Token,
  WETH,
  Fetcher,
  Trade,
  Route,
  TokenAmount,
  TradeType,
} from '@hermesdefiofficial/sdk';

const DAI = new Token(
  ChainId.MAINNET,
  '0xEf977d2f931C1978Db5F6747666fa1eACB0d0339',
  18
);

// note that you may want/need to handle this async code differently,
// for example if top-level await is not an option
const pair = await Fetcher.fetchPairData(DAI, WETH[DAI.chainId]);

const route = new Route([pair], WETH[DAI.chainId]);

const amountIn = '1000000000000000000'; // 1 WETH

const trade = new Trade(
  route,
  new TokenAmount(WETH[DAI.chainId], amountIn),
  TradeType.EXACT_INPUT
);

So, we've constructed a trade entity, but how do we use it to actually send a transaction? There are still a few pieces we need to put in place.

Before going on, we should explore how ONE works in the context of trading. Internally, the SDK uses WONE, as all Hermes Dex pairs use WONE under the hood. However, it's perfectly possible for you as an end user to use ETH, and rely on the router to handle converting to/from WONE. So, let's use ETH.

The first step is selecting the appropriate router function. The names of router functions are intended to be self-explanatory; in this case we want swapExactONEForTokens, because we're swapping an exact amount of ONE for tokens.

That Solidity interface for this function is:

function swapExactONEForTokens(uint amountOutMin, address[] calldata path, address to, uint deadline)
  external
  payable
  returns (uint[] memory amounts);

Jumping back to our trading code, we can construct all the necessary parameters:

import { Percent } from '@hermesdefiofficial/sdk';

const slippageTolerance = new Percent('50', '10000'); // 50 bips, or 0.50%

const amountOutMin = trade.minimumAmountOut(slippageTolerance).raw; // needs to be converted to e.g. hex
const path = [WETH[DAI.chainId].address, DAI.address];
const to = ''; // should be a checksummed recipient address
const deadline = Math.floor(Date.now() / 1000) + 60 * 20; // 20 minutes from the current Unix time
const value = trade.inputAmount.raw; // // needs to be converted to e.g. hex

The slippage tolerance encodes how large of a price movement we're willing to tolerate before our trade will fail to execute. Since Ethereum transactions are broadcast and confirmed in an adversarial environment, this tolerance is the best we can do to protect ourselves against price movements. We use this slippage tolerance to calculate the minumum amount of DAI we must receive before our trade reverts, thanks to minimumAmountOut. Note that this code calculates this worst-case outcome assuming that the current price, i.e the route's mid price, is fair (usually a good assumption because of arbitrage).

The path is simply the ordered list of token addresses we're trading through, in our case WETH and DAI (note that we use the WETH address, even though we're using ETH).

The to address is the address that will receive the DAI.

The deadline is the Unix timestamp after which the transaction will fail, to protect us in the case that our transaction takes a long time to confirm and we wish to rescind our trade.

The value is the amount of ETH that must be included as the msg.value in our transaction.