Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thorswap/SwapKit
SwapKit SDK - Integrate blockchains easily. Docs - https://docs.thorswap.finance/swapkit-docs
https://github.com/thorswap/SwapKit
avalanche-c-chain binance binance-smart-chain bitcoin bitcoin-cash blockchain cosmos dogecoin ethereum evm hdwallet ledger litecoin metamask swapkit-sdk thorchain utxo web3 xdefi
Last synced: about 1 month ago
JSON representation
SwapKit SDK - Integrate blockchains easily. Docs - https://docs.thorswap.finance/swapkit-docs
- Host: GitHub
- URL: https://github.com/thorswap/SwapKit
- Owner: thorswap
- License: apache-2.0
- Created: 2023-01-10T20:40:16.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-07-05T12:52:26.000Z (2 months ago)
- Last Synced: 2024-07-08T10:43:15.104Z (2 months ago)
- Topics: avalanche-c-chain, binance, binance-smart-chain, bitcoin, bitcoin-cash, blockchain, cosmos, dogecoin, ethereum, evm, hdwallet, ledger, litecoin, metamask, swapkit-sdk, thorchain, utxo, web3, xdefi
- Language: TypeScript
- Homepage: https://swapkit.dev
- Size: 18.3 MB
- Stars: 42
- Watchers: 4
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# SwapKit
### _Integrate Blockchains easily_
## Usage
### Documentation
- [Getting Started](https://docs.thorswap.finance/swapkit-docs)
- [Packages](https://docs.thorswap.finance/swapkit-docs/swapkit-sdk/packages)
- [Wallets](https://docs.thorswap.finance/swapkit-docs/swapkit-sdk/wallets)
- [Toolboxes](https://docs.thorswap.finance/swapkit-docs/swapkit-sdk/toolboxes)
## Packages
This repo contains packages around SwapKit sdk and its integrations with different blockchains.
## Contributing
#### Pre-requisites
1.
```bash
curl -fsSL https://bun.sh/install | bash
```
2.
```pre
Copy .env.example to .env and fill it with data
```
### Installation
```bash
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](https://github.com/changesets/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.
```bash
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.