Permissionless staking contract - Staker

Makefile

@@ -1,13 +1,17 @@
-.PHONY: clean generate regenerate test docs redocs hardhat bindings
+.PHONY: clean generate regenerate test docs redocs hardhat bindings test-graffiti test-web3 clean-web3 deepclean
 
-build: hardhat bindings bin/game7
+build: hardhat bindings bin/game7 bin/graffiti
 
 rebuild: clean generate build
 
 bin/game7:
 	mkdir -p bin
 	go build -o bin/game7 ./cmd/game7
 
+bin/graffiti:
+	mkdir -p bin
+	go build -o bin/graffiti ./cmd/graffiti
+
 bindings/ERC20/ERC20.go: hardhat
 	mkdir -p bindings/ERC20
 	seer evm generate --package ERC20 --output bindings/ERC20/ERC20.go --hardhat web3/artifacts/contracts/token/ERC20.sol/ERC20.json --cli --struct ERC20
@@ -20,18 +24,39 @@ bindings/WrappedNativeToken/WrappedNativeToken.go: hardhat
 	mkdir -p bindings/WrappedNativeToken
 	seer evm generate --package WrappedNativeToken --output bindings/WrappedNativeToken/WrappedNativeToken.go --hardhat web3/artifacts/contracts/token/WrappedNativeToken.sol/WrappedNativeToken.json --cli --struct WrappedNativeToken
 
-bindings: bindings/ERC20/ERC20.go bindings/TokenFaucet/TokenFaucet.go bindings/WrappedNativeToken/WrappedNativeToken.go
+bindings/Staker/Staker.go: hardhat
+	mkdir -p bindings/Staker
+	seer evm generate --package Staker --output bindings/Staker/Staker.go --hardhat web3/artifacts/contracts/staking/Staker.sol/Staker.json --cli --struct Staker
+
+bindings/MockERC20/MockERC20.go: hardhat
+	mkdir -p bindings/MockERC20
+	seer evm generate --package MockERC20 --output bindings/MockERC20/MockERC20.go --hardhat web3/artifacts/contracts/mock/tokens.sol/MockERC20.json --cli --struct MockERC20
+
+bindings/MockERC721/MockERC721.go: hardhat
+	mkdir -p bindings/MockERC721
+	seer evm generate --package MockERC721 --output bindings/MockERC721/MockERC721.go --hardhat web3/artifacts/contracts/mock/tokens.sol/MockERC721.json --cli --struct MockERC721
+
+bindings/MockERC1155/MockERC1155.go: hardhat
+	mkdir -p bindings/MockERC1155
+	seer evm generate --package MockERC1155 --output bindings/MockERC1155/MockERC1155.go --hardhat web3/artifacts/contracts/mock/tokens.sol/MockERC1155.json --cli --struct MockERC1155
+
+bindings: bindings/ERC20/ERC20.go bindings/TokenFaucet/TokenFaucet.go bindings/WrappedNativeToken/WrappedNativeToken.go bindings/Staker/Staker.go bindings/MockERC20/MockERC20.go bindings/MockERC721/MockERC721.go bindings/MockERC1155/MockERC1155.go
 
-test:
-	npx hardhat test
+test-web3:
+	cd web3 && npx hardhat test
+
+test-graffiti:
+	go test ./cmd/graffiti -v
+
+test: test-web3 test-graffiti
 
 clean:
-	rm -rf bindings/ERC20/* bin/* bindings/TokenFaucet/* bindings/WrappedNativeToken/*
+	rm -rf bindings/ERC20/* bin/* bindings/TokenFaucet/* bindings/WrappedNativeToken/* bindings/Staker/* bindings/MockERC20/* bindings/MockERC721/* bindings/MockERC1155/*
 
-hardhat:
-	cd web3 && npm install && npx hardhat compile
+clean-web3:
+	rm -rf web3/node_modules web3/artifacts
 
-docs:
-	forge doc
+deepclean: clean clean-web3
 
-redocs: clean docs
+hardhat:
+	cd web3 && npm install && npx hardhat compile

README.md

@@ -8,12 +8,77 @@
 
 The Game 7 Protocol is a comprehensive mono repository that includes all the essential components for the Game 7 ecosystem. This repository consolidates the frontend, backend, and web3 components required to run and interact with the Game 7 Protocol.
 
-## Repository Structure
+## What this repository contains
 
-- **frontend**: This directory contains the codebase for the user interface of the Game 7 Protocol. Built with modern web technologies, it offers a seamless and intuitive user experience.
-
-- **backend**: This directory houses the server-side logic, including APIs, database management, and other essential backend services. It ensures robust and secure data handling for the protocol.
-
-- **web3**: This directory includes all the web3 components, such as smart contracts, that power the Game 7 Protocol. These contracts are written in Solidity and are responsible for the decentralized logic of the game, ensuring transparency and security.
+The [`G7DAO/protocol`](https://github.com/G7DAO/protocol) repository contains the smart contracts that make up
+the Game7 protocol.
 
-- **cmd**: This directory contains the command-line interface (CLI) for the Game 7 Protocol. It provides a convenient way to interact with the protocol from the command line.
+It also contains:
+
+1. Go bindings to these contracts
+2. The `game7` command line tool which can be used to deploy and interact with these contracts
+3. Some tools, like `graffiti`, which are used in the process of developing and testing the Game7 protocol
+
+## The Game7 protocol
+
+### The G7 token
+
+[Implementation of the Game7 ERC20 token](./web3/contracts/token/ERC20.sol)
+
+This token will be deployed on Ethereum mainnet. The implementation consists of slight modifications to
+the wrapped Ether contract, [`WETH9`](https://github.com/gnosis/canonical-weth/blob/master/contracts/WETH9.sol).
+
+### Staker
+
+- [Implementation of the Game7 `Staker`](./web3/contracts/staking/Staker.sol)
+- [Execution flows used to test the `Staker`](./web3/flows/staker.md)
+- Staker test files: [1](./web3/test/Staker.test.1.ts), [2](./web3/test/Staker.test.1.ts), [3](./web3/test/Staker.test.1.ts)
+
+The `Staker` is a permissionless staking contract that can be used by anybody.
+
+Anyone can create staking pools which accept either one of:
+1. The native token of the chain the `Staker` is deployed to
+2. Tokens from an ERC20 contract
+3. Tokens from an ERC721 contract
+4. Tokens with a fixed token ID from an ERC1155 contract
+
+Once a pool has been created, anyone can open positions under that staking pool by transferring tokens to the `Staker`.
+Positions are represented by ERC721 tokens on the `Staker` contract.
+
+Each pool has the following parameters:
+1. Whether positions opened under that staking pool (represented by ERC721 tokens) are transferable.
+2. The lockup period for positions opened under that pool - i.e. the number of seconds before the tokens
+can be unstaked.
+3. The cooldown period for positions opened under that pool - i.e. the number of seconds after a user
+initiates an unstake that they have to wait before they can complete the unstake operation and receive
+their staked tokens.
+
+Pool administrators can change any of these parameters at any time. To make a pool immutable, we recommend
+transferring administration of that pool to the zero address.
+
+
+## Development
+
+### Requirements
+
+- [Node.js](https://nodejs.org/en) (version >= 20)
+- [`hardhat`](https://github.com/NomicFoundation/hardhat), which we used to build and test our smart contracts
+- [Go](https://go.dev/) (version >= 1.21), for the `game7` CLI, and other developmental and operational tools
+- [`seer`](https://github.com/moonstream-to/seer), which we use to generate Go bindings and command-line interfaces
+
+
+### Building and testing this code
+
+The [`Makefile`](./Makefile) for this project can be used to build all the code in the repository.
+
+Build everything using:
+
+```bash
+make
+```
+
+To run all tests for all the code in this repository:
+
+```bash
+make test
+```