Getting Started
Prerequisites
Before getting started, users need:
A Web3 wallet (e.g. MetaMask)
A GitHub account with access to a public repository
Test tokens (mUSD) for creating or claiming bounties
A public GitHub repository with issues enabled
These requirements reflect standard developer tooling and introduce minimal friction.
Step 1 — Connect Wallet
Users begin by connecting their Web3 wallet to the zkPull application.
Wallet authentication is required to:
Create bounties
Submit claims
Receive rewards
The connected wallet becomes the on-chain identity for all interactions.
Step 2 — Obtain Test Tokens (mUSD)
For demo and testing purposes, zkPull provides a faucet.
Users can request mUSD from the faucet
Tokens are used to:
Fund bounties
Pay protocol fees
This removes the need for external token acquisition during onboarding
Step 3 — Choose Your Role
After onboarding, users can participate in zkPull in two ways:
As a Project Owner
Create GitHub bounties
Define reward amount and rules
Lock funds on-chain
As a Contributor
Browse available bounties
Select issues aligned with their expertise
Submit pull requests on GitHub
The same wallet can act in both roles without additional setup.
Step 4 — Explore or Create a Bounty
Users can:
Browse existing bounties via Explore Bounty
Or create a new bounty via Create Bounty
Each bounty displays:
Repository and issue details
Reward amount
Deadline and claim limits
This ensures transparency before any contribution begins.
What Happens Next?
After completing the Getting Started steps:
Contributors proceed to Generate Proof after their PR is merged
Project owners wait for verified claims
The protocol handles validation and enforcement automatically
No off-chain coordination is required.
Last updated