https://github.com/regen-network/regen-ledger
:seedling: Blockchain for planetary regeneration
https://github.com/regen-network/regen-ledger
biodiversity blockchain carbon climate-tech cosmos-sdk credit marketplace origination tendermint
Last synced: 11 days ago
JSON representation
:seedling: Blockchain for planetary regeneration
- Host: GitHub
- URL: https://github.com/regen-network/regen-ledger
- Owner: regen-network
- License: other
- Created: 2018-05-16T21:10:11.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T02:49:23.000Z (6 months ago)
- Last Synced: 2024-10-29T20:40:02.906Z (6 months ago)
- Topics: biodiversity, blockchain, carbon, climate-tech, cosmos-sdk, credit, marketplace, origination, tendermint
- Language: Go
- Homepage: https://docs.regen.network
- Size: 54.9 MB
- Stars: 214
- Watchers: 28
- Forks: 103
- Open Issues: 132
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ccamel - regen-network/regen-ledger - :seedling: Blockchain for planetary regeneration (Go)
- best-of-crypto - GitHub - 18% open · ⏱️ 03.04.2024): (Others)
README
A distributed ledger for ecological assets and data claims
## Introduction
Regen Ledger is a blockchain application for ecological assets and data claims built on top of [Cosmos SDK](http://github.com/cosmos/cosmos-sdk) and [Tendermint Core](http://github.com/tendermint/tendermint). Leveraging these tools, Regen Ledger provides the infrastructure for a Proof-of-Stake blockchain network governed by a community dedicated to planetary regeneration.
Features specific to Regen Ledger are developed within this repository as custom modules that are then wired up to the main application. The custom modules developed within Regen Ledger follow the same architecture and pattern as modules developed within Cosmos SDK and other Cosmos SDK applications.
The core features that Regen Ledger aims to provide include the following:
- infrastructure for managing the issuance and retirement of ecosystem service credits
- a database of ecological state and change of state claims that spans both on and off-chain data sources
- mechanisms for automating the assessment of ecological state, making payments, and issuing assets
Regen Ledger is under heavy development and as result the above features are implemented to varying degrees of completeness. For more information about our approach and vision, see [Regen Ledger Specification](specs/regen-ledger.md).
## Documentation
Documentation for Regen Ledger is hosted at [docs.regen.network](https://docs.regen.network). This includes installation instructions for users and developers, information about live networks running Regen Ledger, instructions on how to interact with local and live networks, infrastructure and module-specific documentation, tutorials for users and developers, migration guides for developers, upgrade guides for validators, a complete list of available commands, and more.
## Contributing
Contributions are more than welcome and greatly appreciated. All the information you need to get started should be available in [Contributing Guidelines](./CONTRIBUTING.md). Please take the time to read through the contributing guidelines before opening an issue or pull request. The following prerequisites and commands cover the basics.
### Prerequisites
- [Git](https://git-scm.com) `>=2`
- [Make](https://www.gnu.org/software/make/) `>=4`
- [Go](https://golang.org/) `>=1.19`
### Go Tools
Install go tools:
```
make tools
```
### Git Hooks
Configure git hooks:
```
git config core.hooksPath scripts/githooks
```
### Lint and Format
Run linter in all go modules:
```
make lint
```
Run linter and attempt to fix errors in all go modules:
```
make lint-fix
```
Run formatting in all go modules:
```
make format
```
Run linter for all proto files:
```
make proto-lint
```
Run linter and attempt to fix errors for all proto files:
```
make proto-lint-fix
```
Run formatting for all proto files:
```
make proto-format
```
### Running Tests
Run all unit and integrations tests:
```
make test
```
### Manual Testing
Build the regen binary:
```
make build
```
View the available commands:
```
./build/regen help
```
## Related Repositories
- [regen-network/governance](https://github.com/regen-network/governance) - guidelines and long-form proposals for Regen Mainnet
- [regen-network/mainnet](https://github.com/regen-network/mainnet) - additional information and historical record for Regen Mainnet
- [regen-network/testnets](https://github.com/regen-network/testnets) - additional information and historical record for Regen Testnets
- [regen-network/regen-js](https://github.com/regen-network/regen-js) - a JavaScript client library for interacting with Regen Ledger
- [regen-network/regen-web](https://github.com/regen-network/regen-web) - user interfaces for Regen Network and Regen Registry
## Sleeping in the Forest
> I thought the earth remembered me,
> she took me back so tenderly,
> arranging her dark skirts, her pockets
> full of lichens and seeds.
>
> I slept as never before, a stone on the river bed,
> nothing between me and the white fire of the stars
> but my thoughts, and they floated light as moths
> among the branches of the perfect trees.
>
> All night I heard the small kingdoms
> breathing around me, the insects,
> and the birds who do their work in the darkness.
>
> All night I rose and fell, as if in water,
> grappling with a luminous doom. By morning
> I had vanished at least a dozen times
> into something better.
>
> ― Mary Oliver