txnlab / reti Goto Github PK

View Code? Open in Web Editor NEW

16.0 3.0 4.0 12.16 MB

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

Home Page: https://reti.vercel.app/

License: MIT License

JavaScript 0.31% TypeScript 79.88% Shell 0.02% Go 19.59% HTML 0.08% CSS 0.13%

algorand pooling staking

reti's Introduction

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 People

Contributors

Stargazers

Watchers

Forkers

acfunk proegor mrunderstood d3ath5t4r

reti's Issues

Dependency Dashboard

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

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

fix(ui): update non-major dependencies (@tanstack/react-router, @tanstack/router-devtools, @types/react)
chore(ui): lock file maintenance

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

chore(bootstrap): update dependency @types/node to v20.12.12
chore(deps): update eslint/prettier to v7.9.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
chore(ui): update eslint/prettier to v7.9.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)

Ignored or Blocked

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

Detected dependencies

dockerfile

Dockerfile-nodemgr

golang 1.22-alpine

github-actions

.github/workflows/ci-contracts.yaml

actions/checkout v4

actions/setup-node v4

pnpm/action-setup v2

actions/cache v4

.github/workflows/ci-ui.yaml

actions/checkout v4

actions/setup-node v4

pnpm/action-setup v2

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 v5

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

github.com/antihax/optional v1.0.0

github.com/joho/godotenv v1.5.1

github.com/mailgun/holster/v4 v4.19.0

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

golang.org/x/oauth2 v0.20.0

golang.org/x/term v0.20.0

npm

contracts/bootstrap/package.json

@algorandfoundation/algokit-utils ^6.0.0

algosdk ^2.7.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.0.0

algosdk ^2.7.0

@algorandfoundation/algokit-client-generator ^3.0.2

@algorandfoundation/tealscript =0.92.0

@jest/globals ^29.7.0

@joe-p/algokit-generate-component ^0.2.1

@typescript-eslint/eslint-plugin 7.8.0

@typescript-eslint/parser 7.8.0

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

jest ^29.7.0

prettier ^3.2.5

ts-jest ^29.1.2

typescript ^5.4.5

package.json

ui/package.json

@algorandfoundation/algokit-utils 6.0.2

@blockshake/defly-connect 1.1.6

@hookform/resolvers 3.3.4

@perawallet/connect 1.3.4

@radix-ui/react-avatar 1.0.4

@radix-ui/react-checkbox 1.0.4

@radix-ui/react-collapsible 1.0.3

@radix-ui/react-dialog 1.0.5

@radix-ui/react-dropdown-menu 2.0.6

@radix-ui/react-hover-card 1.0.7

@radix-ui/react-icons 1.3.0

@radix-ui/react-label 2.0.2

@radix-ui/react-navigation-menu 1.1.4

@radix-ui/react-popover 1.0.7

@radix-ui/react-scroll-area 1.0.5

@radix-ui/react-select 2.0.0

@radix-ui/react-separator 1.0.3

@radix-ui/react-slot 1.0.2

@radix-ui/react-switch 1.0.3

@radix-ui/react-tooltip 1.0.7

@tanstack/react-query 5.35.5

@tanstack/react-query-devtools 5.35.5

@tanstack/react-router 1.31.27

@tanstack/react-table 8.16.0

@tanstack/router-devtools 1.31.27

@tremor/react 3.16.2

@txnlab/use-wallet-react 3.0.0-beta.5

@walletconnect/modal-sign-html 2.6.2

algosdk 2.7.0

axios 1.6.8

axios-cache-interceptor 1.5.2

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

lucide-react 0.378.0

lute-connect 1.2.0

next-themes 0.3.0

notistack 3.0.1

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

sonner 1.4.41

tailwind-merge 2.3.0

tailwindcss-animate 1.0.7

tslib 2.6.2

use-debounce 10.0.0

vite-plugin-node-polyfills 0.21.0

zod 3.23.8

@playwright/test 1.44.0

@tanstack/router-vite-plugin 1.31.18

@testing-library/jest-dom 6.4.5

@testing-library/react 15.0.7

@types/big.js 6.2.2

@types/node 20.12.11

@types/react 18.3.1

@types/react-dom 18.3.0

@typescript-eslint/eslint-plugin 7.8.0

@typescript-eslint/parser 7.8.0

@vitejs/plugin-react 4.2.1

@vitest/coverage-v8 1.6.0

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

jsdom 24.0.0

msw 2.3.0

playwright 1.44.0

postcss 8.4.38

tailwindcss 3.4.3

ts-node 10.9.2

typescript 5.4.5

vite 5.2.11

vitest 1.6.0

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

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}

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.