soroswap-router-sdk v1.4.6

Soroswap Router SDK

This repository contains routing logic for the Soroswap.Finance protocol.

It searches for the most efficient way to swap token A for token B, considering the reserves available in the protocol's liquidity pools.

Useful links:

• Documentation: https://soroswap-router-sdk.soroswap.finance/
• NPM Package: https://www.npmjs.com/package/soroswap-router-sdk
• Github Repo: https://github.com/soroswap/soroswap-router-sdk
• Soroswap.Finance Discord Server

Install

npm i soroswap-router-sdk

or

yarn add soroswap-router-sdk

How to use

import {
  Router,
  Token,
  CurrencyAmount,
  TradeType,
  Networks,
} from "soroswap-router-sdk";

const XLM_ADDRESS = "CDMLFMKMMD7MWZP3FKUBZPVHTUEDLSX4BYGYKH4GCESXYHS3IHQ4EIG4";
const USDC_ADDRESS = "CAMZFR4BHDUMT6J7INBBBGJG22WMS26RXEYORKC2ERZL2YGDIEEKTOJB";

const XLM_TOKEN = new Token(
  Networks.TESTNET,
  XLM_ADDRESS,
  7,
  "XLM",
  "Stellar Lumens"
);

const USDC_TOKEN = new Token(
  Networks.TESTNET,
  USDC_ADDRESS,
  7,
  "USDC",
  "USD Coin"
);

const amount = 10000000;

const router = new Router({
  pairsCacheInSeconds: 20, // pairs cache duration
  protocols: [Protocols.SOROSWAP], // protocols to be used
  network: Networks.TESTNET, // network to be used
});

const currencyAmount = CurrencyAmount.fromRawAmount(USDC_TOKEN, amount);
const quoteCurrency = XLM_TOKEN;

const route = await router.route(
  currencyAmount,
  quoteCurrency,
  TradeType.EXACT_INPUT
);

console.log(route.trade.path);

//Output: ['0x...', '0x...', '0x...']

Development

Test

bash docker/run.sh
yarn
yarn test

Document

1.- Generate Documentation

bash docker/run.sh
yarn
yarn docs

Publish

bash docker/run.sh
git config --global --add safe.directory /workspace
git config --global user.email "you@example.com"
git config --global user.name "Your Name"
npm login

yarn
yarn build
yarn publish

For beta versions you can use yarn publish --tag beta