{"id":22362973,"url":"https://github.com/mining-pool/open-grin-pool","last_synced_at":"2025-07-30T15:30:54.531Z","repository":{"id":64307289,"uuid":"207044194","full_name":"mining-pool/open-grin-pool","owner":"mining-pool","description":"Open-sourcing pool for grin. Easy to depoly and keep KISS in design. Avaliable to epic (epicash, a grin forkcoin) too.","archived":false,"fork":false,"pushed_at":"2023-02-25T06:13:51.000Z","size":146,"stargazers_count":23,"open_issues_count":5,"forks_count":21,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-11-29T17:49:54.340Z","etag":null,"topics":["epic","grin","pool","proxy"],"latest_commit_sha":null,"homepage":"","language":"Go","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/mining-pool.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}},"created_at":"2019-09-08T01:06:04.000Z","updated_at":"2024-10-27T19:34:19.000Z","dependencies_parsed_at":"2023-07-12T14:50:01.858Z","dependency_job_id":null,"html_url":"https://github.com/mining-pool/open-grin-pool","commit_stats":null,"previous_names":["maoxs2/open-grin-pool"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining-pool%2Fopen-grin-pool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining-pool%2Fopen-grin-pool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining-pool%2Fopen-grin-pool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining-pool%2Fopen-grin-pool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mining-pool","download_url":"https://codeload.github.com/mining-pool/open-grin-pool/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228154024,"owners_count":17877704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["epic","grin","pool","proxy"],"created_at":"2024-12-04T17:12:45.426Z","updated_at":"2024-12-04T17:12:46.038Z","avatar_url":"https://github.com/mining-pool.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# open-grin-pool\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmaoxs2%2Fopen-grin-pool.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmaoxs2%2Fopen-grin-pool?ref=badge_shield) [![Build Status](https://travis-ci.org/maoxs2/open-grin-pool.svg?branch=master)](https://travis-ci.org/maoxs2/open-grin-pool) [![Go Report Card](https://goreportcard.com/badge/github.com/maoxs2/open-grin-pool)](https://goreportcard.com/report/github.com/maoxs2/open-grin-pool)\n\nThis is originally designed for the epic (=[epicash](http://epic.tech)). And the codebase of the epic is grin so it can be generally used as the grin pool.\n\nLatest is tested under grin's usernet.  \n\n### features\n- relay the miner conn to the grin node, totally native experience\n- expose the TUI miner detail to Http API\n- backup the share(submit) histories per specific time interval\n- record the miner's pay method (manually sent coin by pool maintainer)\n- pool status\n\n### Usage\n\n```bash\n# if grin\ngrin server run \n# if epic\nepic server run\n\n# ready\ngit clone https://github.com/maoxs2/open-grin-pool.git pool\ncd pool \u0026\u0026 go build .\n\n# config\nvi config.json\n\n# start\n./open-grin-pool \n\n```\n\nWebAPI:\n- `/pool` basic pool status\n- `/revenue` the revenue **last day**, which the pool maintainer has to sent **today**\n- `/shares` the all miners' shares **today**\n- `/miner/{miner_login}` GET is the miner status\nPOST upload the payment method. e.g. ` curl 127.0.0.1:3333/miner/Hello` will get the json of \"Hello\"'s status. `curl  -X POST -d \"{'pass': 'passwordOfHello', 'pm': 'http://\u003cIP\u003e:\u003cPORT\u003e'}\" 127.0.0.1:3333/miner/Hello`\n\nThe maintainer can manually use this command to send the coin `grin wallet send -d http://\u003cIP\u003e:\u003cPORT\u003e`. Note, ensure the receiver online before your sending.\n\nWebPage:\n- replace the API address to your API in the web/config.js\n- move all files in web to your Nginx/Apache folder\n\n### Config\n\n#### For server\n\nIf you are using epic you can keep all default except `auth_pass`. The password can be found in the `.api_secret` file. \n    \nknowledge about this, check [here](https://github.com/mimblewimble/grin/blob/master/doc/api/api.md)\n\nThe `diff` should be the same difficulty to what you configured in server's (not pool's) `.toml` config file.\n\n\n#### For miner\n\nIn miner's config(a `.toml` config file), these 2 params are **required**\n\n```toml\n# login for the stratum server (if required)\nstratum_server_login = \"loginName\"\n\n# password for the stratum server (if required)\nstratum_server_password = \"loginPass\"\n```\n\nThe `agent` is optional. Pool treat it as the miner's rig name.\n\n**or the miner will not be able to connect to the server and the sol will not be relayed to the node!**\n\n### TODO\n- Web UI\n- More accurate hash rate\n- Administration based on web\n- multi Backend (failover)\n- multi Port (with different difficulties)\n\nPlease **donation**:\n**LTC: LXxqHY4StG79nqRurdNNt1wF2yCf4Mc986**\n\n## License\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmaoxs2%2Fopen-grin-pool.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmaoxs2%2Fopen-grin-pool?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmining-pool%2Fopen-grin-pool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmining-pool%2Fopen-grin-pool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmining-pool%2Fopen-grin-pool/lists"}