txnlab / reti

Contracts, Node Daemon, and UI for Algorand 'The Reti' consensus incentives

Réti Open Pooling

Welcome 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.

Overview

The 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.

Prerequisites

Before starting, ensure you have the following installed:

• Docker: Required for running AlgoKit. Installation guide.
• AlgoKit: Version 2.0 or later is required. Installation guide. Verify by running algokit --version.
• PNPM: Version 8.0 or later for package management. Installation guide. Verify by running pnpm --version.

Quick Start

This section provides instructions for running the protocol and UI in a local AlgoKit sandbox environment.

• Clone the repository

   git clone https://github.com/TxnLab/reti.git

• Navigate to the reti directory

   cd reti

• Install dependencies

   pnpm install

• Start the local network

   algokit localnet start

• Bootstrap the validator

  This 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.

   pnpm run bootstrap

• Launch the UI

   pnpm run dev

TestNet Development

• Navigate to the ui directory

   cd ui

• Create a .env.testnet file

  Copy the TestNet variables from the .env.template file into a new .env.testnet file. Check back often to make sure you're using the latest master validator app ID, set to VITE_RETI_APP_ID.

• Launch the UI

   pnpm run dev:testnet

Additional Resources

• TEALScript Contracts: Explore the smart contracts that power the protocol. Read more
• Node Daemon: Learn about the CLI / service daemon which node runners will run as a background service. Read more
• Example UI: A Vite React project that serves as a dashboard for staking and validator management. Read more

Discord

For questions or technical support, you can reach us in the #reti channel on NFD's Discord: https://discord.gg/w6vSwG5bFK

reti's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: renovate.json
Error type: The renovate configuration file contains some invalid settings
Message: npm.packageRules[4]: packageRules cannot combine both matchUpdateTypes and rangeStrategy. Rule: {"matchFileNames":["ui/package.json"],"assignees":["drichar"],"schedule":["before 4am on Monday"],"semanticCommitScope":"ui","rangeStrategy":"pin","matchUpdateTypes":["pin"],"groupName":"dependency ranges","automerge":true}

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Attempting to use non-git url for git operations
• WARN: Package lookup failures

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(ui): update eslint/prettier to v8 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)

---

Warning

Renovate failed to look up the following dependencies: Failed to look up git-tags package gh:algorandfoundation/algokit-react-frontend-template.

Files affected: ui/.copier-answers.yml

---

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(ui): update dependency axios to v1.7.4 [security]
• chore(deps): update non-major dependencies (@algorandfoundation/algokit-client-generator, @algorandfoundation/algokit-utils, @algorandfoundation/tealscript, vitest)
• chore(deps): update eslint/prettier to v7.18.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• chore(ui): update eslint/prettier to v7.18.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• fix(bootstrap): update non-major dependencies (@algorandfoundation/algokit-utils, @types/node, @types/yargs)
• fix(nodemgr): update node manager (github.com/prometheus/client_golang, golang, golang.org/x/crypto, golang.org/x/term)
• fix(ui): update non-major dependencies (@algorandfoundation/algokit-utils, @playwright/test, @tanstack/react-query, @tanstack/react-query-devtools, @tanstack/react-router, @tanstack/react-table, @tanstack/router-devtools, @tanstack/router-vite-plugin, @testing-library/dom, @testing-library/jest-dom, @txnlab/use-wallet-react, @types/node, @vitest/coverage-v8, autoprefixer, jsdom, lucide-react, msw, playwright, postcss, query-string, react-hook-form, tailwind-merge, tailwindcss, typescript, use-debounce, vite, vitest)
• chore(deps): update eslint/prettier to v8 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• fix(ui): update dependency react-day-picker to v9
• chore(ui): lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency eslint to v9
• chore(ui): update dependency eslint to v9

Detected dependencies

copier

ui/.copier-answers.yml

• gh:algorandfoundation/algokit-react-frontend-template 0.10.1

dockerfile

Dockerfile-nodemgr

• golang 1.22-alpine

github-actions

.github/workflows/ci-contracts.yaml

• actions/checkout v4
• actions/setup-node v4
• pnpm/action-setup v4
• actions/cache v4

.github/workflows/ci-tests.yaml

• actions/checkout v4
• actions/setup-node v4
• pnpm/action-setup v4
• actions/cache v4
• actions/setup-python v5

.github/workflows/ci-ui.yaml

• actions/checkout v4
• actions/setup-node v4
• pnpm/action-setup v4
• actions/cache v4

.github/workflows/release.yaml

• actions/checkout v4
• wangyoucao577/go-release-action v1
• actions/checkout v4
• docker/setup-qemu-action v3
• docker/setup-buildx-action v3
• docker/metadata-action v5
• docker/login-action v3
• docker/build-push-action v6
• actions/checkout v4
• SethCohen/github-releases-to-discord v1.15.0

gomod

nodemgr/go.mod

• go 1.22.2
• github.com/algorand/go-algorand-sdk/v2 v2.6.0
• github.com/antihax/optional v1.0.0
• github.com/joho/godotenv v1.5.1
• github.com/mailgun/holster/v4 v4.20.2
• github.com/manifoldco/promptui v0.9.0
• github.com/prometheus/client_golang v1.19.1
• github.com/ssgreg/repeat v1.5.1
• github.com/urfave/cli/v3 v3.0.0-alpha9
• golang.org/x/crypto v0.25.0
• golang.org/x/oauth2 v0.22.0
• golang.org/x/term v0.22.0

npm

contracts/bootstrap/package.json

• @algorandfoundation/algokit-utils ^6.1.2
• algosdk ^2.8.0
• prompts ^2.4.2
• yargs ^17.7.2
• @tsconfig/node18 ^18.2.4
• @types/node ^20.12.2
• @types/prompts ^2.4.9
• @types/yargs ^17.0.32
• typescript ^5.4.3

contracts/package.json

• @algorandfoundation/algokit-utils ^6.1.2
• algosdk 2.8.0
• @algorandfoundation/algokit-client-generator ^3.0.2
• @algorandfoundation/tealscript ^0.98.0
• @joe-p/algokit-generate-component ^0.2.1
• @typescript-eslint/eslint-plugin 7.16.1
• @typescript-eslint/parser 7.16.1
• eslint 8.57.0
• eslint-config-airbnb-base ^15.0.0
• eslint-config-airbnb-typescript ^18.0.0
• eslint-config-prettier ^9.1.0
• eslint-plugin-import ^2.29.1
• eslint-plugin-prettier ^5.1.3
• prettier ^3.2.5
• typescript ^5.4.5
• vitest 2.0.3

package.json

ui/package.json

• @algorandfoundation/algokit-utils 6.1.1
• @blockshake/defly-connect 1.1.6
• @hookform/resolvers 3.9.0
• @perawallet/connect 1.3.4
• @radix-ui/react-avatar 1.1.0
• @radix-ui/react-checkbox 1.1.1
• @radix-ui/react-collapsible 1.1.0
• @radix-ui/react-dialog 1.1.1
• @radix-ui/react-dropdown-menu 2.1.1
• @radix-ui/react-hover-card 1.1.1
• @radix-ui/react-icons 1.3.0
• @radix-ui/react-label 2.1.0
• @radix-ui/react-navigation-menu 1.2.0
• @radix-ui/react-popover 1.1.1
• @radix-ui/react-scroll-area 1.1.0
• @radix-ui/react-select 2.1.1
• @radix-ui/react-separator 1.1.0
• @radix-ui/react-slot 1.1.0
• @radix-ui/react-switch 1.1.0
• @radix-ui/react-tooltip 1.1.2
• @tanstack/react-query 5.51.11
• @tanstack/react-query-devtools 5.51.11
• @tanstack/react-router 1.45.6
• @tanstack/react-table 8.19.3
• @tanstack/router-devtools 1.45.6
• @tremor/react 3.17.4
• @txnlab/use-wallet-react 3.0.0
• @walletconnect/modal-sign-html 2.6.2
• algosdk 2.8.0
• axios 1.7.2
• axios-cache-interceptor 1.5.3
• big.js 6.2.1
• class-variance-authority 0.7.0
• clsx 2.1.1
• copy-to-clipboard 3.3.3
• date-fns 3.6.0
• dayjs 1.11.12
• lucide-react 0.412.0
• lute-connect 1.3.0
• next-themes 0.3.0
• notistack 3.0.1
• query-string 9.0.0
• react 18.3.1
• react-day-picker 8.10.1
• react-dom 18.3.1
• react-helmet-async 2.0.5
• react-hook-form 7.52.1
• sonner 1.5.0
• tailwind-merge 2.4.0
• tailwindcss-animate 1.0.7
• tslib 2.6.3
• use-debounce 10.0.1
• vite-plugin-node-polyfills 0.22.0
• zod 3.23.8
• @playwright/test 1.45.2
• @tanstack/router-vite-plugin 1.45.3
• @testing-library/dom 10.3.2
• @testing-library/jest-dom 6.4.6
• @testing-library/react 16.0.0
• @types/big.js 6.2.2
• @types/node 20.14.11
• @types/react 18.3.3
• @types/react-dom 18.3.0
• @typescript-eslint/eslint-plugin 7.16.1
• @typescript-eslint/parser 7.16.1
• @vitejs/plugin-react 4.3.1
• @vitest/coverage-v8 2.0.3
• algo-msgpack-with-bigint 2.1.1
• autoprefixer 10.4.19
• eslint 8.57.0
• eslint-config-prettier 9.1.0
• eslint-plugin-prettier 5.2.1
• jsdom 24.1.0
• msw 2.3.2
• playwright 1.45.2
• postcss 8.4.39
• tailwindcss 3.4.6
• ts-node 10.9.2
• typescript 5.5.3
• vite 5.3.4
• vitest 2.0.3

---

• Check this box to trigger a request for Renovate to run again on this repository