https://github.com/0xpolygon/staking-hub
https://github.com/0xpolygon/staking-hub
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/0xpolygon/staking-hub
- Owner: 0xPolygon
- License: apache-2.0
- Archived: true
- Created: 2023-12-11T15:30:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T12:04:49.000Z (about 2 years ago)
- Last Synced: 2025-03-12T15:52:19.552Z (over 1 year ago)
- Language: Solidity
- Size: 682 KB
- Stars: 6
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
## Template Repo (Foundry)
[](https://opensource.org/licenses/MIT)
[](../../actions)
This template repo is a quick and easy way to get started with a new Solidity project. It comes with a number of features that are useful for developing and deploying smart contracts. Such as:
- Pre-commit hooks for formatting, auto generated documentation, and more
- Various libraries with useful contracts (OpenZeppelin, Solady) and libraries (Deployment log generation, storage checks, deployer templates)
#### Table of Contents
- [Setup](#setup)
- [Deployment](#deployment)
- [Docs](#docs)
- [Contributing](#contributing)
- [License](#license)
## Setup
Follow these steps to set up your local environment:
- [Install foundry](https://book.getfoundry.sh/getting-started/installation)
- Install dependencies: `forge install`
- Build contracts: `forge build`
- Test contracts: `forge test`
If you intend to develop on this repo, follow the steps outlined in [CONTRIBUTING.md](CONTRIBUTING.md#install).
## Deployment
This repo utilizes versioned deployments. For more information on how to use forge scripts within the repo, check [here](CONTRIBUTING.md#deployment).
Smart contracts are deployed or upgraded using the following command:
```shell
forge script script/Deploy.s.sol --broadcast --rpc-url --verify
```
## Docs
The documentation and architecture diagrams for the contracts within this repo can be found [here](docs/).
Detailed documentation generated from the NatSpec documentation of the contracts can be found [here](docs/autogen/src/src/).
When exploring the contracts within this repository, it is recommended to start with the interfaces first and then move on to the implementation as outlined [here](CONTRIBUTING.md#natspec--comments)
## Contributing
If you want to contribute to this project, please check [CONTRIBUTING.md](CONTRIBUTING.md) first.
## License
Licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
---
© 2023 PT Services DMCC