Deprecation Notice

⚠️ This project is deprecated

This repository is no longer actively maintained and may not receive future updates or bug fixes. Please use the now maintained and developed @skip-go/core as a replacement.

Migration Guide

@skip-router/[email protected] is the same as @skip-go/[email protected]. To migrate packages with minimal disruption, please upgrade to @skip-router/[email protected] and then replace the package with @skip-go/[email protected], then upgrading to the latest version from there.

Thank you for your understanding and for using our software.

For any questions, please reach out to us in our discord if you have any questions and/or need assistance migrating!

@skip-router/core

JavaScript SDK for Skip API

Install

npm install @skip-router/core

Usage

Read more at Skip API docs website on Getting Started: TypeScript SDK.

Development

# clone repository
git clone https://github.com/skip-mev/skip-router-sdk.git
cd skip-router-sdk

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

# install dependencies
npm install

# run watch server to build on changes
npm -w @skip-router/core 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

E2E Tests

E2E tests depend on Starship to test interactions with various blockchains.

# run starship setup
npm run e2e:setup

# run starship devnets
npm run e2e:start

# run e2e tests
npm run e2e:test

# stop starship devnets
npm run e2e:stop

Documentation

• Skip API documentation
• Skip API Reference
• Skip API Reference (Swagger)