README.md

@skip-go/client

TypeScript library that streamlines interaction with the Skip Go API, enabling cross-chain swaps and transfers across multiple ecosystems.

Install

npm install @skip-go/client

yarn add @skip-go/client

Usage

Follow the Getting Started guide to begin your integration.

Development

# clone repository
git clone https://github.com/skip-mev/skip-go.git
cd skip-go/packages/client

# prepare submodules
git submodule update --init --recursive

# install dependencies
npm install

# run watch server to build on changes
npm -w @skip-go/client run watch

# build packages
npm run build

Unit Tests

# run unit tests
npm run test

# run unit tests in watch mode
npm run test -- --watch

# run unit tests with coverage
npm run test -- --coverage

Documentation

• Skip Go API documentation
• Skip Go API Reference