{"id":32479841,"url":"https://github.com/zkemail/ens-backend","last_synced_at":"2026-07-08T08:31:15.454Z","repository":{"id":308750111,"uuid":"998755507","full_name":"zkemail/ens-backend","owner":"zkemail","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-10T16:47:43.000Z","size":198,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-27T01:32:07.270Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zkemail.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-09T07:43:06.000Z","updated_at":"2025-10-10T16:47:42.000Z","dependencies_parsed_at":"2025-09-17T18:16:22.092Z","dependency_job_id":"473dd25f-5919-42d7-a94d-63c358df90f0","html_url":"https://github.com/zkemail/ens-backend","commit_stats":null,"previous_names":["zkemail/ens-backend"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zkemail/ens-backend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Fens-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Fens-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Fens-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Fens-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zkemail","download_url":"https://codeload.github.com/zkemail/ens-backend/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Fens-backend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35258965,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-08T02:00:06.796Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-27T01:28:05.765Z","updated_at":"2026-07-08T08:31:15.450Z","avatar_url":"https://github.com/zkemail.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ENS Backend\n\nThis is the backend server for an email-based ENS (Ethereum Name Service) system. It handles incoming emails, generates proofs, and interacts with the Ethereum blockchain to manage ENS subdomains.\n\n## Prerequisites\n\nBefore you begin, ensure you have the following installed:\n\n- **Rust**: Version 1.88 or later. We recommend using [rustup](https://rustup.rs/) to manage your Rust installation.\n- **Build Tools**: A C compiler and development tools are required.\n  - On Debian/Ubuntu: `sudo apt-get update \u0026\u0026 sudo apt-get install build-essential pkg-config libssl-dev`\n  - On macOS: `xcode-select --install`\n  - On Windows: You can use the \"Build Tools for Visual Studio\".\n- **Docker and Docker Compose (Optional)**: For running the complete stack, including SMTP and IMAP servers.\n\n## Getting Started\n\n1.  **Clone the repository:**\n\n    ```bash\n    git clone https://github.com/zkemail/ens-backend.git\n    cd ens-backend\n    ```\n\n2.  **Install Rust toolchain:**\n    If you don't have Rust, install it via rustup:\n    ```bash\n    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n    ```\n    The project uses the 2024 edition, so a recent compiler is needed.\n\n## Configuration\n\nThe server requires a `config.json` file in the root directory. A sample is provided.\n\n1.  **Copy the sample configuration:**\n\n    ```bash\n    cp config.sample.json config.json\n    ```\n\n2.  **Edit `config.json`:**\n    Open `config.json` and fill in the required values:\n\n    - `prover.apiKey`: Your API key for the proving service.\n    - `prover.blueprintId`: The blueprint ID for the circuit.\n    - `rpc[].url`: An RPC endpoint for the desired Ethereum network (e.g., from Alchemy or Infura).\n    - `rpc[].privateKey`: The private key of the account that will be used to send transactions. **Warning**: Do not commit this file with your private key.\n\n## Build\n\nTo build the application, run:\n\n```bash\ncargo build --release\n```\n\nThe compiled binary will be located at `target/release/ens-backend`.\n\n## Run\n\nAfter building, you can start the server:\n\n```bash\n./target/release/ens-backend\n```\n\nThe server will start and listen on port 4500 by default.\n\n## Running with Docker (Recommended for full system)\n\nThe easiest way to run the backend along with its dependencies (like SMTP and IMAP servers) is by using Docker Compose.\n\n1.  **Ensure Docker is running.**\n\n2.  **Configure `config.json`** as described in the \"Configuration\" section.\n\n3.  **Create a `.env` file for Docker Compose:**\n    The `docker-compose.yaml` file uses environment variables to configure the `smtp` and `imap` services. Create a `.env` file in the root of the project:\n\n    ```bash\n    touch .env\n    ```\n\n    Add the following variables to the `.env` file, replacing the placeholder values with your actual configuration:\n\n    ```env\n    # SMTP Server Configuration\n    SMTP_INTERNAL_SERVER_HOST=0.0.0.0\n    SMTP_INTERNAL_SERVER_PORT=3000\n    SMTP_PORT=3000\n    SMTP_DOMAIN_NAME=yourdomain.com\n    SMTP_LOGIN_ID=test\n    SMTP_LOGIN_PASSWORD=test\n    SMTP_MESSAGE_ID_DOMAIN=yourdomain.com\n\n    # IMAP Server Configuration\n    IMAP_LOGIN_ID=test\n    IMAP_LOGIN_PASSWORD=test\n    IMAP_DOMAIN_NAME=yourdomain.com\n    IMAP_PORT=143\n    IMAP_AUTH_TYPE=PLAIN\n    ```\n\n4.  **Start the services:**\n    ```bash\n    docker-compose up --build\n    ```\n\nThis command will build the backend image and start the `backend`, `smtp`, and `imap` services. The backend will be available on port 4500 of your local machine.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkemail%2Fens-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzkemail%2Fens-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkemail%2Fens-backend/lists"}