{"id":22624014,"url":"https://github.com/TxnLab/reti","last_synced_at":"2025-08-05T22:30:59.005Z","repository":{"id":231151838,"uuid":"746871825","full_name":"algorandfoundation/reti","owner":"algorandfoundation","description":"Contracts, Node Daemon, and UI for Algorand 'The Reti' consensus incentives","archived":false,"fork":false,"pushed_at":"2024-10-26T03:41:32.000Z","size":17899,"stargazers_count":24,"open_issues_count":4,"forks_count":13,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-26T05:42:56.683Z","etag":null,"topics":["algorand","pooling","staking"],"latest_commit_sha":null,"homepage":"https://reti.vercel.app/","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/algorandfoundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["TxnLab"]}},"created_at":"2024-01-22T20:49:50.000Z","updated_at":"2024-10-25T15:26:21.000Z","dependencies_parsed_at":"2024-04-30T23:38:43.462Z","dependency_job_id":"6f457d58-e240-49f0-af97-aaef25fca1d0","html_url":"https://github.com/algorandfoundation/reti","commit_stats":null,"previous_names":["txnlab/reti","algorandfoundation/reti"],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Freti","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Freti/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Freti/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Freti/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algorandfoundation","download_url":"https://codeload.github.com/algorandfoundation/reti/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228810863,"owners_count":17975604,"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":["algorand","pooling","staking"],"created_at":"2024-12-09T00:08:18.797Z","updated_at":"2025-08-05T22:30:58.971Z","avatar_url":"https://github.com/algorandfoundation.png","language":"TypeScript","funding_links":["https://github.com/sponsors/TxnLab"],"categories":["Infrastructure \u0026 Ecosystem Services"],"sub_categories":["Nodes \u0026 Consensus Participation"],"readme":"# Réti Open Pooling\n\nWelcome to the Réti Open Pooling monorepo. This README provides instructions for running the protocol and its accompanying example UI in a local environment. Detailed protocol information and its objectives can be found in the [Gitbook documentation](https://txnlab.gitbook.io/reti-open-pooling).\n\n## Overview\n\nThe Réti Open Pooling protocol enables the creation of decentralized staking pools on the Algorand network, promoting broader participation and enhancing network security through diversification. It is designed to be open-source, non-custodial, and fully decentralized, allowing for the creation and joining of staking pools to meet the minimum stake required for node rewards on Algorand.\n\n## Prerequisites\n\nBefore starting, ensure you have the following installed:\n- **Docker**: Required for running AlgoKit. [Installation guide](https://www.docker.com/get-started).\n- **AlgoKit**: Version 2.0 or later is required. [Installation guide](https://github.com/algorandfoundation/algokit-cli#install). Verify by running `algokit --version`.\n- **PNPM**: Version 8.0 or later for package management. [Installation guide](https://pnpm.io/installation). Verify by running `pnpm --version`.\n\n## Quick Start\n\nThis section provides instructions for running the protocol and UI in a local AlgoKit sandbox environment.\n\n- **Clone the repository**\n\n\t```bash\n\tgit clone https://github.com/algorandfoundation/reti.git\n\t```\n\n- **Navigate to the `reti` directory**\n\n\t```bash\n\tcd reti\n\t```\n\n- **Install dependencies**\n\n\t```bash\n\tpnpm install\n\t```\n\n- **Start the local (fnet compatible) test network**\n\n\t```bash\n\tcd contracts; pnpm run localnet\n\t```\n\n- **Bootstrap the validator**\n\t\n\tThis command bootstraps a new master validator and funds two new test accounts. It also sets environment variables for LocalNet that will be used by the front-end.\n\t```bash\n\tcd contracts/boostrap; pnpm run bootstrap\n\t```\n\n- **Launch the UI**\n\n\t```bash\n\tcd ui; pnpm run dev:localnet\n\t```\n\n## FNet Development\n\n- **Navigate to the `ui` directory**\n\n\t```bash\n\tcd ui\n\t```\n\n- **Create a `.env.fnet` file**\n\n\tCopy the fnet variables from the [`.env.template`](./ui/.env.template) file into a new `.env.fnet` file. Check back often to make sure you're using the latest master validator app ID, set to `VITE_RETI_APP_ID`.\n\n- **Launch the UI**\n\n\t```bash\n\tpnpm run dev:fnet\n\t```\n\n## Documentation\n- The documentation is currently available online at https://txnlab.gitbook.io/reti-open-pooling\n- The content is synced with the docs/gitbook branch of this repo inside the ./docs directory.\n  - The changes in that branch should periodically be merged into main but the docs/gitbook branch is the source of truth for the public docs site currently hosted at: https://txnlab.gitbook.io/reti-open-pooling\n\n## Additional Resources\n\n- **TEALScript Contracts**: Explore the smart contracts that power the protocol. [Read more](./contracts/README.md)\n- **Node Daemon**: Learn about the CLI / service daemon which node runners will run as a background service. [Read more](https://txnlab.gitbook.io/reti-open-pooling/technical-implementation/reti-node-daemon)\n- **Example UI**: A Vite React project that serves as a dashboard for staking and validator management. [Read more](./ui/README.md)\n\n## Discord\n\nFor questions or technical support, you can reach us in the **#reti** channel on NFD's Discord: https://discord.gg/w6vSwG5bFK\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTxnLab%2Freti","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTxnLab%2Freti","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTxnLab%2Freti/lists"}