Sync is a decentralized payment protocol enabling instant fiat-to-crypto transactions on StarkNet. By combining non-custodial wallets, automated liquidity bridging, and StarkNet's ZK-rollup efficiency, Sync allows users to spend fiat (e.g., NGN, USD) while seamlessly tapping into crypto liquidity for settlements.
Requirements:
- Rust
- Cairo
- Starknet foundry
- Node
- Yarn
Step 1:
-
Fork the repo
-
Clone the forked repo to your local machine
git clone https://github.com/your-user-name/sync-contracts- Setup contract:
// Install asdf scarb and starknet foundry:
curl --proto '=https' --tlsv1.2 -sSf https://sh.starkup.dev | sh// Method 2:
Install asdf and install scarb, and starknet foundry: https://foundry-rs.github.io/starknet-foundry/getting-started/installation.html
- Add development tools
asdf set --home scarb 2.11.4
asdf set --home starknet-foundry 0.43.0
- Ensure installed properly
snforge --version
scarb --version- Build
scarb build- Test
snforge testWe welcome contributions! Please follow these steps:
- Fork the repository
- Create your feature branch (
git checkout -b feature/your-feature-name) - Commit your changes with meaningful messages (
git commit -m 'feat: add new capability') - Test your changes thoroughly before submission
Before submitting your PR:
- All tests must pass locally before proceeding
- Ensure your branch is up to date with main (
git pull origin main) - Include comprehensive test cases covering your changes
- Update documentation to reflect your modifications
- Provide a detailed description in your PR explaining:
- The problem solved
- Implementation approach
- Any potential impacts
- Request review from project maintainers
- Follow the existing code style and conventions
- Write clean, readable, and maintainable code
- Include comments for complex logic
- Keep commits focused and atomic
Need help with your contribution? You can:
- Open an issue in the GitHub repository
- Join our Telegram channel for community assistance
- Check existing documentation and discussions
We aim to review all contributions promptly and appreciate your efforts to improve the project!