-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add the readme of gnfd-cosmso-sdk (#111)
- Loading branch information
Showing
1 changed file
with
40 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,56 @@ | ||
| <!-- | ||
| parent: | ||
| order: false | ||
| --> | ||
| # Greenfield Cosmos-SDK | ||
|
|
||
| <div align="center"> | ||
| <h1> Cosmos SDK </h1> | ||
| </div> | ||
| This repo is forked from [cosmos-sdk](https://github.com/cosmos/cosmos-sdk). | ||
|
|
||
|  | ||
| The Greenfield Block Chain leverages cosmos-sdk to fast build a dApp running with tendermint. Due to the many | ||
| requirements of Greenfield blockchain that cannot be fully satisfied by cosmos-sdk at present, we have decided to fork | ||
| the cosmos-sdk repo and add modules and features based on it. | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/cosmos/cosmos-sdk/blob/main/LICENSE"> | ||
| <img alt="License: Apache-2.0" src="https://img.shields.io/github/license/cosmos/cosmos-sdk.svg" /> | ||
| </a> | ||
| <a href="https://pkg.go.dev/github.com/cosmos/cosmos-sdk?tab=doc"> | ||
| <img alt="GoDoc" src="https://pkg.go.dev/github.com/cosmos/cosmos-sdk?status.svg" /> | ||
| </a> | ||
| <a href="https://goreportcard.com/report/github.com/cosmos/cosmos-sdk"> | ||
| <img alt="Go report card" src="https://goreportcard.com/badge/github.com/cosmos/cosmos-sdk" /> | ||
| </a> | ||
| <a href="https://codecov.io/gh/cosmos/cosmos-sdk"> | ||
| <img alt="Code Coverage" src="https://codecov.io/gh/cosmos/cosmos-sdk/branch/main/graph/badge.svg" /> | ||
| </a> | ||
| </div> | ||
| <div align="center"> | ||
| <a href="https://github.com/cosmos/cosmos-sdk"> | ||
| <img alt="Lines Of Code" src="https://tokei.rs/b1/github/cosmos/cosmos-sdk" /> | ||
| </a> | ||
| <a href="https://discord.gg/AzefAFd"> | ||
| <img alt="Discord" src="https://img.shields.io/discord/669268347736686612.svg" /> | ||
| </a> | ||
| <a href="https://sourcegraph.com/github.com/cosmos/cosmos-sdk?badge"> | ||
| <img alt="Imported by" src="https://sourcegraph.com/github.com/cosmos/cosmos-sdk/-/badge.svg" /> | ||
| </a> | ||
| <img alt="Sims" src="https://github.com/cosmos/cosmos-sdk/workflows/Sims/badge.svg" /> | ||
| <img alt="Lint Satus" src="https://github.com/cosmos/cosmos-sdk/workflows/Lint/badge.svg" /> | ||
| </div> | ||
| ## Key Features | ||
|
|
||
| The Cosmos SDK is a framework for building blockchain applications. [Tendermint Core (BFT Consensus)](https://github.com/tendermint/tendermint) and the Cosmos SDK are written in the Golang programming language. Cosmos SDK is used to build [Gaia](https://github.com/cosmos/gaia), the first implementation of the Cosmos Hub. | ||
|
|
||
| **WARNING**: The Cosmos SDK has mostly stabilized, but we are still making some | ||
| breaking changes. | ||
|
|
||
| **Note**: Requires [Go 1.18+](https://go.dev/dl) | ||
| 1. **auth**. The address format of the Greenfield blockchain is fully compatible with BSC (and Ethereum). It accepts EIP712 transaction signing and verification. These enable the existing wallet infrastructure to interact with Greenfield at the beginning naturally. | ||
| 2. **crosschain**. Cross-chain communication is the key foundation to allow the community to take advantage of the Greenfield and BNB Smart Chain dual chain structure.. | ||
| 3. **gashub**. As an application specific chain, Greenfield defines the gas fee of each transaction type instead of calculating gas according to the CPU and storage consumption. | ||
| 4. **gov**. There are many system parameters to control the behavior of the Greenfield and its smart contract on BSC, e.g. gas price, cross-chain transfer fees. All these parameters will be determined by Greenfield Validator Set together through a proposal-vote process based on their staking. Such the process will be carried on cosmos sdk. | ||
| 5. **oracle**. The bottom layer of cross-chain mechanism, which focuses on primitive communication package handling and verification. | ||
| 6. **upgrade**. Seamless upgrade on Greenfield enable a client to sync blocks from genesis to the latest state. | ||
|
|
||
| ## Quick Start | ||
| *Note*: Requires [Go 1.18+](https://go.dev/dl/) | ||
|
|
||
| To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK [High-Level Intro](./docs/intro/overview.md). | ||
|
|
||
| If you want to get started quickly and learn how to build on top of Cosmos SDK, visit [Cosmos SDK Tutorials](https://tutorials.cosmos.network). You can also fork the tutorial's repository to get started building your own Cosmos SDK application. | ||
|
|
||
| For more information, see the [Cosmos SDK Documentation](./docs/). | ||
|
|
||
| ## Contributing | ||
|
|
||
| See [CONTRIBUTING.md](./CONTRIBUTING.md) for details how to contribute and participate in our [dev calls](./CONTRIBUTING.md#teams-dev-calls). | ||
| If you want to follow the updates or learn more about the latest design then join our [Discord](https://discord.com/invite/cosmosnetwork). | ||
|
|
||
| ## Tools and Frameworks | ||
|
|
||
| The Cosmos ecosystem is vast. We will only make a few notable mentions here. | ||
| ```shell | ||
| ## proto-all | ||
| make proto-all | ||
|
|
||
| + [Tools](https://v1.cosmos.network/tools): notable frameworks and modules. | ||
| + [CosmJS](https://github.com/cosmos/cosmjs): the Swiss Army knife to power JavaScript based client solutions. | ||
| ## build from source | ||
| make build | ||
|
|
||
| ### Cosmos Hub Mainnet | ||
| ## test | ||
| make test | ||
|
|
||
| The Cosmos Hub application, `gaia`, has moved to its own [cosmos/gaia repository](https://github.com/cosmos/gaia). Go there to join the Cosmos Hub mainnet and more. | ||
| ## lint check | ||
| make lint | ||
| ``` | ||
|
|
||
| ### Inter-Blockchain Communication (IBC) | ||
| See the [Cosmos Docs](https://cosmos.network/docs/) and [Getting started with the SDK](https://tutorials.cosmos.network/academy/1-what-is-cosmos/). | ||
|
|
||
| The IBC module for the Cosmos SDK has moved to its own [cosmos/ibc-go repository](https://github.com/cosmos/ibc-go). Go there to build and integrate with the IBC module. | ||
| ## Related Projects | ||
| - [Greenfield](https://github.com/bnb-chain/greenfield): the official greenfield blockchain client. | ||
| - [Greenfield-Tendermint](https://github.com/bnb-chain/greenfield-tendermint): the consensus layer of Greenfield blockchain. | ||
| - [Greenfield-Storage-Provider](https://github.com/bnb-chain/greenfield-storage-provider): the storage service infrastructures provided by either organizations or individuals. | ||
| - [Greenfield-Relayer](https://github.com/bnb-chain/greenfield-relayer): the service that relay cross chain package to both chains. | ||
| - [Greenfield-Cmd](https://github.com/bnb-chain/greenfield-cmd): the most powerful command line to interact with Greenfield system. | ||
| - [Awesome Cosmos](https://github.com/cosmos/awesome-cosmos): Collection of Cosmos related resources which also fits Greenfield. | ||
|
|
||
| ### Ignite CLI | ||
|
|
||
| Ignite CLI is the all-in-one platform to build, launch, and maintain any crypto application on a sovereign and secured blockchain. If you are building a new app or a new module, use [Ignite CLI](https://github.com/ignite-hq/cli) to get started and speed up development. | ||
| ## Contribution | ||
| Thank you for considering helping with the source code! We appreciate contributions from anyone on the internet, no | ||
| matter how small the fix may be. | ||
|
|
||
| ## Disambiguation | ||
| If you would like to contribute to Greenfield, please follow these steps: fork the project, make your changes, commit them, | ||
| and send a pull request to the maintainers for review and merge into the main codebase. However, if you plan on submitting | ||
| more complex changes, we recommend checking with the core developers first via GitHub issues (we will soon have a Discord channel) | ||
| to ensure that your changes align with the project's general philosophy. This can also help reduce the workload of both | ||
| parties and streamline the review and merge process. | ||
|
|
||
| This Cosmos SDK project is not related to the [React-Cosmos](https://github.com/react-cosmos/react-cosmos) project (yet). Many thanks to Evan Coury and Ovidiu (@skidding) for this Github organization name. As per our agreement, this disambiguation notice will stay here. | ||
| ## Licence (pending) |