{"id":20189881,"url":"https://github.com/crossbell-box/operator-sign","last_synced_at":"2026-05-29T13:31:30.799Z","repository":{"id":205379837,"uuid":"709570029","full_name":"Crossbell-Box/operator-sign","owner":"Crossbell-Box","description":"Crossbell Operator Sign Backend Service","archived":false,"fork":false,"pushed_at":"2024-03-18T18:17:52.000Z","size":503,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-03T07:28:10.066Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://op-sign.crossbell.io/docs","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Crossbell-Box.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-10-25T00:28:49.000Z","updated_at":"2023-11-03T22:43:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"e56d8cbf-bcbd-4be4-8e48-f94a1be010dd","html_url":"https://github.com/Crossbell-Box/operator-sign","commit_stats":null,"previous_names":["crossbell-box/operator-sign"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Crossbell-Box/operator-sign","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Crossbell-Box%2Foperator-sign","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Crossbell-Box%2Foperator-sign/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Crossbell-Box%2Foperator-sign/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Crossbell-Box%2Foperator-sign/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Crossbell-Box","download_url":"https://codeload.github.com/Crossbell-Box/operator-sign/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Crossbell-Box%2Foperator-sign/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33655440,"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-05-29T02:00:06.066Z","response_time":107,"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":"2024-11-14T03:39:23.400Z","updated_at":"2026-05-29T13:31:30.781Z","avatar_url":"https://github.com/Crossbell-Box.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Crossbell Operator Sign Backend Service\n\n**Operator Sign (Op Sign)** designed to enhance the user experience on the Crossbell network. Its primary goal is to streamline the interaction process by minimizing the number of manual approvals required for each transaction.\n\n## Features\n\n- **Efficient Interactions**: No need to manually approve every transaction, ensuring a smoother user experience.\n- **Secure Authentication**: Leverage the SIWE protocol to authenticate users based on their encrypted signature.\n- **Delegated Operations**: The Operator contract methods can carry out operations on the user's behalf, ensuring both convenience and security.\n\n## Getting Started\n\n#### Install deps:\n\n```bash\nnpm install\n```\n\n#### Prepare environment variables:\n\n```bash\ncopy .env.example .env\n```\n\n#### Setup wallet:\n\nYou will need to create a wallet and obtain the private key and address, then fill in the environment variables: `OP_SIGN_OPERATOR_WALLET_ADDRESS` and `OP_SIGN_OPERATOR_WALLET_PRIVATE_KEY`.\n\n#### Start Database instance:\n\n```bash\nnpm run docker:db\n```\n\n#### Migrate database and generate types in development environment:\n\n```bash\nnpm run prisma:migrate:dev\n```\n\n#### Start server:\n\n```bash\nnpm run start:dev\n```\n\n#### Access the Swagger API docs:\n\nOnce the server starts, the Swagger API docs will be available at the `/docs` path. For example, if you are running the server locally at port `3988`, you can access the docs at [http://localhost:3988/docs](http://localhost:3988/docs).\n\n## Deployment\n\nDocker:\n\n```bash\n# building new NestJS docker image\ndocker-compose build\n# or\nnpm run docker:build\n\n# start docker-compose\ndocker-compose up -d\n# or\nnpm run docker\n```\n\nIn Node.js Environment:\n\n```\nnpm install\nnpm run build\nNODE_ENV=production node dist/main\n```\n\n### Migrate database\n\nIn development:\n\n```bash\nnpm run prisma:migrate:dev\n```\n\nIn production:\n\n```bash\nnpm run prisma:migrate:deploy\n```\n\n## Customizing Endpoints in [Crossbell React Kits](https://crossbell-dev.vercel.app)\n\nCheck out the customizing guide [here](https://crossbell-dev.vercel.app/docs/customizing-endpoints).\n\n## Modules\n\n### [Siwe](src/module/siwe/)\n\nThe `Siwe` module is designed to facilitate the implementation of the Sign-In with Ethereum (SIWE) protocol. It encompasses a suite of functions essential for integrating SIWE's authentication mechanisms.\n\n### [SiweTransaction](src/module/transaction/)\n\nThe `SiweTransaction` module is responsible for managing a range of transactions, including posting, commenting, liking, and tipping activities.\n\n### [EventListeners](src/module/event-listeners/)\n\nThe `EventListeners` module is crafted to monitor and process events generated by the Operator contract. It ensures the system responds appropriately to permissions updates and other significant contract interactions.\n\n### [CsbManager](src/module/csb-manager/)\n\nThe `CsbManager` module provides utility functions that are instrumental for managing interactions with the `$CSB`.\n\n### [Contract](src/module/contract/)\n\nThe `Contract` module used to initialize the contract instance.\n\n## Feedback \u0026 Contributions\n\nWe welcome feedback and contributions from the community. Feel free to raise issues, submit pull requests, or share your insights to enhance the Operator Sign feature.\n\n\u003e 🫡 This project was initially developed by [@SongKeys](https://github.com/Songkeys). Original commit logs were deleted to protect sensitive information before open-sourcing.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrossbell-box%2Foperator-sign","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrossbell-box%2Foperator-sign","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrossbell-box%2Foperator-sign/lists"}