| |

⚠️ Warning

To avoid supply chain attacks, please consider not updating the packages in this repository. All current dependencies have been checked for their specific versions.

🌐 Censorless Web Router 🛡️

A censorship-resistant web application that uses blockchain technology and IPFS to dynamically route users to the correct endpoint, even if traditional DNS or domain services are blocked or compromised.

📜 Wizard

You need to have curl installed on your system to run the following command.

curl https://raw.githubusercontent.com/SystemVll/censorless-web-router/refs/heads/main/auto-setup.sh > setup.sh && chmod +x setup.sh && ./setup.sh

🤔 How It Works

The Censorless Web Router consists of two main components:

1. Smart Contract ⛓️ - A contract deployed on the Optimism blockchain that stores the current valid endpoint URL
2. Web Router 🔄 - A simple web application that queries the blockchain and redirects users to the current endpoint

When censorship occurs, the website owner can update the endpoint in the blockchain, and all users visiting the router will be automatically redirected to the new location.

🏗️ Architecture

🚀 Setup

1. Deploy the smart contract:

   cd hardhat
   bun install
   bun run test # Run tests to ensure everything is working
   bun run deploy

2. Configure the router:

   cd ../router
   bun install
   # Set contract address in .env
   echo "VITE_CONTRACT_ADDRESS=YOUR_CONTRACT_ADDRESS" > .env

3. Deploy the router:

   bun run build
   # Deploy dist folder to any static hosting service (We highly recommend using IPFS)

💻 Usage

For Website Owners 👨‍💼

1. Deploy the Censorless contract once
2. Update the endpoint URL whenever your site is censored:

   await censorlessContract.methods.setEndpoint("https://new-domain.com").send({from: ownerAddress});

For Users 👥

1. Bookmark the router URL
2. When the main site becomes inaccessible, visit the router
3. You'll be automatically redirected to the current working endpoint

🔧 Technical Details

• Blockchain: Optimism (Layer 2 Ethereum solution)
• Smart Contract: Solidity 0.8.28
• Frontend: Vanilla TypeScript with Web3.js
• Connection: WebSocket connection to Optimism public node

🛑 Limitations

• Requires the router to be accessible
• Relies on blockchain availability
• Small delay during redirection process

---

⚠️ This project is designed for legitimate websites facing unjust censorship. Always use responsibly and in accordance with applicable laws.