@xswap-link/xswap-common/README.md

JavaScript library for xSwap common components

<a name="readme-top"></a>

<!-- PROJECT LOGO -->
<br />
<div align="center">

  <h1 align="center">XSwap Common</h1>

  <p align="center">
    XSwap Common exposes a variety of models and tools for other projects to use.
    <br />
  </p>
</div>

<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
  </ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project

XSwap Common exposes a variety of models and tools for other projects to use. The main things you will find in this repo are models, smart contract abis, util functions, and, constant variables.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->

## Getting Started

To get the library follow these simple example steps.

### Prerequisites

- npm
  ```sh
  npm i pnpm@latest -g
  ```

### Installation

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

1. Install the library in your project
   ```sh
   npm i @xswap-link/xswap-common
   ```

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- USAGE EXAMPLES -->

## Usage

Simply import the stuff from the library.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Contribution

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

### Prerequisites

- pnpm
  ```sh
  npm i pnpm@latest -g
  ```

#### 1. Get the project and install dependencies

```sh
git clone git@github.com:xswap-link/xswap-common.git

cd xswap-common

pnpm i
```

#### 2. Create new branch based on the `develop` one

```sh
git checkout -b feature/<your_feature_name>
```

#### 3. Commit changes

#### 4. Create PR to `develop` branch

### Publishing changes

#### Create changeset file and include into PR to `main`

Github workflow will fail to publish if you skip it

```sh
pnpm changeset
```

<p align="right">(<a href="#readme-top">back to top</a>)</p>