@teleportdao/teleswap-contracts
v1.1.0
Published
Trustless protocol for bridging and trading Bitcoin
Downloads
6
Keywords
Readme
TeleSwap protocol v1
This repository contains the smart contracts for the TeleSwap protocol. The repository uses Hardhat as a development environment for compilation, testing, and deployment tasks.
What is TeleSwap?
TeleSwap is a fully decentralized protocol for bridging and exchanging BTC between Bitcoin and EVM chains securely.
Documentation
See the links below:
Audits
- Quantstamp report (Feb 2023)
Community
- Follow us on Twitter.
- Join our discord channel.
Install dependencies
To start, clone the codes and install the required packages using:
yarn
Compile contracts
To compile the codes, use the below command:
yarn clean
& yarn build
Run tests
You can run the entire test suite with the following command:
yarn test
Deploy contracts
You can deploy contracts on supported networks (mumbai and polygon) with the following command:
NETWORK= yarn deploy
Config contracts
After deployment, some variables need to be set using the following commands:
NETWORK= yarn init_config
Run the below command with a different private key to config upgradable contracts:
NETWORK= yarn config_upgradables