SwapKit

Integrate Blockchains easily

Usage

Documentation

• Getting Started

• Packages

• Wallets

• Toolboxes

Packages

This repo contains packages around SwapKit sdk and its integrations with different blockchains.

Contributing

Pre-requisites

1.

curl -fsSL https://bun.sh/install | bash

2.

Copy .env.example to .env and fill it with data

Installation

bun bootstrap

Branches

• develop - development branch - start from here in case of contribution
• nightly - branch for nightly builds - can be used for testing purposes
• docs - branch for documentation
• feat/* - branches for features
• chore/* - branches for smaller tasks

Testing

To run tests use bun test command.

Pull requests

• PRs should be created from develop branch
• PRs should be reviewed by at least Code Owner (see CODEOWNERS file)
• PRs should have scope in commit message (see commit messages section)
• PRs should have tests if it's possible
• PRs should have changeset file if it's needed (see release section)

Release and publish

Packages are automatically published to npm when new PR is merged to main & develop branches. To automate and handle process we use changesets and github action workflows.

Before running bun changeset you have to pull main & develop

To release new version of package you need to create PR with changes and add changeset file to your commit.

bun changeset

After PR is merged to develop branch with changeset file, github action will create new PR with updated versions of packages and changelogs.