@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)