About The Project

XSwap SDK exposes a functions to access the advanced cross-chain routing solution offered by XSwap.

Getting Started

To get the library follow these simple example steps.

Prerequisites

• npm / pnpm npm i pnpm@latest -g

Installation

Below you will find a step-by-step installation guide.

1. Install the library in your project

   npm/pnpm i @xswap-link/sdk

Usage

Simply import the stuff from the library.

Optional configuration

You can create xswap.config.local.ts to override default configuration. Local file should look like this:

import { XSwapConfig } from "@src/models";

const xSwapConfig: Partial<XSwapConfig> = {
    // Props you want to override. Example:
    apiUrl: "http://127.0.0.1:5001/api",
};

export default xSwapConfig;

Contribution

This is open-source library and below you will find a step-by-step contribution guide.

Prerequisites

• pnpm

  npm i pnpm@latest -g

1. Get the project and install dependencies

git clone [email protected]:xswap-link/xswap-sdk.git

cd xswap-sdk

pnpm i

2. Create new branch based on the develop one

git checkout develop
git checkout -b feature/<your_feature_name>

3. Create changeset

pnpm changeset and follow instructions to describe your changes

4. Commit changes

including changeset: git commit -m "feat: <your desc>>"

5. Create PR to develop branch