README.md

Helix Bridge Solidity

Protocol Detail

Packages

.
├── contracts
│   └── helix
└── packages
    └── addresses

Install dependencies

Make sure you are using Yarn v1.22.10. To install using brew:

brew install [email protected]

Then install dependencies

yarn install

Environment variables

.env example:

MAINNET_RPC_URL="https://eth-mainnet.alchemyapi.io/v2/your-api-key"
RINKEBY_RPC_URL="https://eth-rinkeby.alchemyapi.io/v2/your-api-key" 
ROPSTEN_RPC_URL="https://eth-ropsten.alchemyapi.io/v2/your-api-key"
KOVAN_RPC_URL="https://eth-kovan.alchemyapi.io/v2/your-api-key" 
PRIVATE_KEY=your private key 
ETHERSCAN_API_KEY="your etherscan API key" (optional)

Build

To build all packages:

yarn build

To build a specific package:

PKG=@helix/bridge yarn build

To build all contracts packages:

yarn build:contracts

Clean

Clean all packages:

yarn clean

Clean a specific package

PKG=@helix/bridge yarn clean

Rebuild

To re-build (clean & build) all packages:

yarn rebuild

To re-build (clean & build) a specific package & it's deps:

PKG=@helix/bridge yarn rebuild