@xswap.link/xswap-common v0.1.0

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.

Getting Started

To get the library follow these simple example steps.

Prerequisites

• npm

  npm install pnpm@latest -g

Installation

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

1. Install the library in your project

   npm i @xswap.link/xswap-common

Usage

Simply import the stuff from the library.

Contribution

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

Prerequisites

• pnpm

  npm install pnpm@latest -g

1. Get the project and install dependencies

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

cd xswap-common

pnpm i   

2. Create new branch based on the develop one

Github workflow will fail if you skip it

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

pnpm changeset