Installing the SDK

How to integrate the SDK into your app

The Shogun SDK package enables seamless interaction with the Shogun API, allowing you to discover and execute optimal routes across all the chains we support.

Installation

To get started, install the latest version of Shogun SDK.

yarn add @{PLACEHOLDER}/sdk

npm install @{PLACEHOLDER}/sdk

Initial Setup

The first step to integration is generating a config using the generateConfig function. The most basic info you'll need is your affiliateName, which is used for tracking fee shares.

import { generateConfig } from '@{PLACEHOLDER}/sdk'

generateConfig({
  affiliateName: 'affiliate-example',
})

After you've installed the SDK, you can configure your settings:

Last updated 7 months ago