Bidirectional payment channel protocol on top of EVM-compatible chains for instant & private payments
Important: The smart contracts is not audited, please be extra caution when use them in production
- Git
- You'll know you've done it right if you can run
git --version
- You'll know you've done it right if you can run
- Node.js
- Hardhat for JS integration tests & deployment
- Foundry / Foundryup for unit testing
- Optional. Docker. Run docker if you want to use dev container
note: For windows os you'll need to install make. For instance via choco: sh choco install make
make- All commands/aliases are declared in the Makefile.
- use forge as solidity formatter in your IDE settings
- For VS it's recommended to use Juan Blanco Plugin and have the next sittings.json
{
"solidity.formatter": "forge",
"solidity.packageDefaultDependenciesContractsDirectory": "src",
"solidity.packageDefaultDependenciesDirectory": ["node_modules", "lib"],
"solidity.remappings": [
"@std=lib/forge-std/src/",
"forge-std/=lib/forge-std/src/",
"@openzeppelin/=node_modules/@openzeppelin/",
"src=src/"
],
"solidity.defaultCompiler": "localNodeModule",
"[solidity]": {
"editor.defaultFormatter": "JuanBlanco.solidity"
}
}Contributions are always welcome! Open a PR or an issue!