Skip to content

w3hc/ref

Repository files navigation

Ref

A minimalist on-chain referral tracking system.

Overview

This contract allows tracking referral relationships between addresses. Any address can register a referrer-referee relationship.

Features

  • Register referrer-referee relationships
  • Track referral counts per address
  • Query all referrals made by an address
  • Get total registered users

Development

# Install dependencies
bun install

# Compile
forge build

# Test
forge test

# Deploy locally
forge script script/Deploy.s.sol --broadcast --fork-url http://localhost:8545

Deployment

Update your .env file with your configuration:

cp .env.example .env
# Edit .env with your own keys
forge script script/Deploy.s.sol --rpc-url op_sepolia --private-key <YOUR_PRIVATE_KEY> --broadcast --verify

Example deployment to OP Sepolia: https://sepolia-optimism.etherscan.io/address/0x03917205bfef0692fae6e26dd87fcc7f96123af2#code

Support

Feel free to reach out to Julien on Farcaster, Element, Status, Telegram, Twitter, Discord, or LinkedIn.

License

This project is licensed under the GNU General Public License v3.0.

built-with-ethereum-w3hc