Skip to content

d4mr/zkrail

Repository files navigation

ZKRails

Decentralized UPI Payments powered by Zero Knowledge Proofs

image

FeaturesArchitectureQuick StartDevelopment

Base Sepolia USDC Payments AI Powered

🌟 Overview

ZKRail is a revolutionary payment infrastructure that bridges traditional UPI payments with blockchain technology using zero-knowledge proofs. It enables secure, private, and efficient cross-border payments while maintaining the simplicity of UPI transactions.

🎯 Use Cases

  • Cross-Border Remittances: Send money internationally using UPI
  • Private Business Payments: Keep transaction details confidential
  • Decentralized Payment Networks: Build on top of our intent-based architecture
  • AI-Enhanced Payments: Natural language payment processing

✨ Features

  • UPI Integration: Send payments to any UPI ID directly from your crypto wallet
  • Zero-Knowledge Privacy: Transaction details are kept private using ZK proofs
  • AI-Powered CLI: Natural language interface for initiating payments
  • Cross-Border Support: Seamless international payments using USDC
  • Intent-Based Architecture: Decentralized intent matching for optimal payment routing
  • Bond-Based Security: Solver bonding mechanism ensures payment reliability

🏗 Architecture

image

🚀 Technical Stack

  • Smart Contracts: Solidity, Foundry
  • Backend: TypeScript, Node.js
  • AI Integration: GPT-4, LangChain
  • Blockchain: Base Sepolia Network
  • Payment: USDC, UPI
  • Privacy: Zero Knowledge Proofs
  • SDK: Coinbase Cloud CDP

🚀 Quick Start

  1. Install dependencies:
yarn install
  1. Set up your environment variables:
cp .env.example .env
# Add your API keys and configuration
  1. Start the payment CLI:
yarn cli
  1. Make your first payment:
transfer 100 rs to user@upi

🛠 Development

Prerequisites

  • Node.js >= v18.18
  • Yarn
  • Foundry
  • Coinbase Cloud API Keys

Environment Variables

CDP_API_KEY_NAME=your_api_key_name
CDP_API_KEY_PRIVATE_KEY=your_private_key
OPENAI_API_KEY=your_openai_key

Local Setup

  1. Clone the repository:
git clone https://github.com/your-username/zkrail.git
cd zkrail
  1. Install dependencies:
yarn install
  1. Start local blockchain:
yarn chain
  1. Deploy contracts:
yarn deploy
  1. Run the development server:
yarn dev

📜 License

MIT License - see LICENSE for details


🏗 Scaffold-ETH 2

🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.

⚙️ Built using NextJS, RainbowKit, Foundry, Wagmi, Viem, and Typescript.

  • Contract Hot Reload: Your frontend auto-adapts to your smart contract as you edit it.
  • 🪝 Custom hooks: Collection of React hooks wrapper around wagmi to simplify interactions with smart contracts with typescript autocompletion.
  • 🧱 Components: Collection of common web3 components to quickly build your frontend.
  • 🔥 Burner Wallet & Local Faucet: Quickly test your application with a burner wallet and local faucet.
  • 🔐 Integration with Wallet Providers: Connect to different wallet providers and interact with the Ethereum network.

Debug Contracts tab

Requirements

Before you begin, you need to install the following tools:

Quickstart

To get started with Scaffold-ETH 2, follow the steps below:

  1. Install dependencies if it was skipped in CLI:
cd my-dapp-example
yarn install
  1. Run a local network in the first terminal:
yarn chain

This command starts a local Ethereum network using Foundry. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in packages/foundry/foundry.toml.

  1. On a second terminal, deploy the test contract:
yarn deploy

This command deploys a test smart contract to the local network. The contract is located in packages/foundry/contracts and can be modified to suit your needs. The yarn deploy command uses the deploy script located in packages/foundry/script to deploy the contract to the network. You can also customize the deploy script.

  1. On a third terminal, start your NextJS app:
yarn start

Visit your app on: http://localhost:3000. You can interact with your smart contract using the Debug Contracts page. You can tweak the app config in packages/nextjs/scaffold.config.ts.

Run smart contract test with yarn foundry:test

  • Edit your smart contracts in packages/foundry/contracts
  • Edit your frontend homepage at packages/nextjs/app/page.tsx. For guidance on routing and configuring pages/layouts checkout the Next.js documentation.
  • Edit your deployment scripts in packages/foundry/script

Documentation

Visit our docs to learn how to start building with Scaffold-ETH 2.

To know more about its features, check out our website.

Contributing to Scaffold-ETH 2

We welcome contributions to Scaffold-ETH 2!

Please see CONTRIBUTING.MD for more information and guidelines for contributing to Scaffold-ETH 2.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •