From 5e7ca1da78a876374d374806e38ed6e63be3a603 Mon Sep 17 00:00:00 2001 From: haryunio Date: Tue, 5 Nov 2024 17:24:25 +0900 Subject: [PATCH 1/2] docs: update readme including v0.4.0 requirements --- Dockerfile | 2 +- readme.md | 36 +++++++++++++++++++++++------------- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/Dockerfile b/Dockerfile index 8c28938..eb8f295 100755 --- a/Dockerfile +++ b/Dockerfile @@ -34,4 +34,4 @@ EXPOSE 1317 9090 26656 26657 # Run firmachind by default # ex) docker run firmachain -CMD ["/usr/local/bin/firmachaind"] \ No newline at end of file +CMD ["/usr/local/bin/firmachaind"] diff --git a/readme.md b/readme.md index 7f52bb9..762c7ce 100644 --- a/readme.md +++ b/readme.md @@ -12,45 +12,52 @@ -### A BLOCKCHAIN BASED E-CONTRACT PLATFORM +## A BLOCKCHAIN BASED E-CONTRACT PLATFORM -FirmaChain adds a signing and verifying e-contract function to the blockchain. +FirmaChain adds a signing and verifying e-contract function to the blockchain. Unlocking new limits of electronic contracts with blockchain technology, FirmaChain seeks to resolve all the social and legal issues (contracts, notarial, etc.) with written contracts through the use of electronic contracts based on FirmaChain’s data blockchain. FirmaChain now builds on [Tendermint](https://github.com/tendermint/tendermint) consensus and the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) toolkits and [Ignite](https://github.com/ignite/cli/) ---- ## Installation -## - Install Go ## +### Install Go ### -Go v1.18+ or higher is required for FirmaChain. +**Go v1.21 or higher** is required for building and running FirmaChain. + +NOTE : we updated Go requirements from `v1.18` to `v1.21` in `Firmachain v0.4.0`
-## - Official Build ## +### Official Build ### +We are not providing official prebuilt binaries from v0.3.5. Please check the guide to build your own binary. -v0.3.3 : https://docs.firmachain.org/master/getting-started/install-firmachain/install +https://docs.firmachain.org/master/node-and-validators-guide/run-a-full-node/installation-firmachaind -v0.3.5 : https://docs.firmachain.org/master/validator-guide/upgrade/v0.3.5 +Currently available tags: +| Version | Tag +| - | - | +| v0.4.0 | `v0.4.0` | +| v0.3.5 | `v0.3.5-patch` | +| v0.3.3 (Deprecated) | `v0.3.3-patch` |
- -## - Development Build : using make ## +### Development Build : using make ### ```bash git clone https://github.com/firmachain/firmachain cd firmachain +git checkout (desired tags) make install ```
-## - Development Build : using ignite ## +### Development Build : using ignite ### **Step 1: Install ignite v0.23.0** ``` @@ -78,8 +85,6 @@ ignite chain serve ```
- ----
## Validator & Node @@ -88,6 +93,7 @@ We are currently looking for validators to contribute to our network. If you are interested, please contact us through contact@firmachain.org +
## Network @@ -96,11 +102,15 @@ If you are interested, please contact us through contact@firmachain.org - All contracts and tokens will be migrated to our main network once it is complete network stabilization. - Testnet **Imperium-4** is ready for online. (private testnet for only chain developer) +
+ ## EcoSystem - [FirmaChain-BlockExplorer](https://github.com/FirmaChain/firmachain-explorer) - [FirmaChain-Station](https://github.com/FirmaChain/firma-station) - [FirmaChain-Faucet (testnet only)](https://github.com/FirmaChain/firmachain-faucet) +
+ ## Community - [Website](https://firmachain.org/#/) - [Medium](https://medium.com/firmachain) From 4d1967ed1359d51f0ecaeaf156f94f5613a883ff Mon Sep 17 00:00:00 2001 From: haryunio Date: Tue, 19 Nov 2024 14:04:17 +0900 Subject: [PATCH 2/2] docs: update readme --- readme.md | 53 +++++++++++++---------------------------------------- 1 file changed, 13 insertions(+), 40 deletions(-) diff --git a/readme.md b/readme.md index 762c7ce..9252738 100644 --- a/readme.md +++ b/readme.md @@ -18,8 +18,7 @@ FirmaChain adds a signing and verifying e-contract function to the blockchain. Unlocking new limits of electronic contracts with blockchain technology, FirmaChain seeks to resolve all the social and legal issues (contracts, notarial, etc.) with written contracts through the use of electronic contracts based on FirmaChain’s data blockchain. -FirmaChain now builds on [Tendermint](https://github.com/tendermint/tendermint) consensus and the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) toolkits and [Ignite](https://github.com/ignite/cli/) - +FirmaChain now builds on [CometBFT](https://github.com/cometbft/cometbft) consensus and the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) toolkits. ## Installation @@ -27,13 +26,13 @@ FirmaChain now builds on [Tendermint](https://github.com/tendermint/tendermint) **Go v1.21 or higher** is required for building and running FirmaChain. -NOTE : we updated Go requirements from `v1.18` to `v1.21` in `Firmachain v0.4.0` +**NOTE** : we updated Go requirements from `v1.18` to `v1.21` in `Firmachain v0.4.0`
### Official Build ### -We are not providing official prebuilt binaries from v0.3.5. Please check the guide to build your own binary. +We are not providing official prebuilt binaries from `v0.3.5`. Please check the guide to build your own binary. https://docs.firmachain.org/master/node-and-validators-guide/run-a-full-node/installation-firmachaind @@ -46,45 +45,19 @@ Currently available tags:
-### Development Build : using make ### +### Build Guide : using make ### ```bash git clone https://github.com/firmachain/firmachain cd firmachain git checkout (desired tags) -make install -``` - -
- -### Development Build : using ignite ### - -**Step 1: Install ignite v0.23.0** -``` -// 1. download and unarchive the file below. -https://github.com/ignite/cli/releases/tag/v0.23.0 - -// Then run this command to move the ignite executable to /usr/local/bin/: -sudo mv ignite /usr/local/bin/ -``` -**Step 2: Install FirmaChain** - -```bash -git clone https://github.com/firmachain/firmachain -cd firmachain -ignite chain build +make install +... ``` -After build, you can find the firmachaind file on "~/go/bin/firmachaind". +After the successful build, you will find `firmachaind` binary on the `~/go/bin` build path. -If you want to run FirmaChain on dev env, just run this command. - -```bash -ignite chain serve -``` - -

## Validator & Node @@ -97,17 +70,17 @@ If you are interested, please contact us through contact@firmachain.org ## Network -- Maintnet **Colosseum-1** launced at 2022.01.26 +- Firmachain Mainnet **Colosseum-1** launched on 2022.01.26 - FirmaChain is currently operating on Ethereum as an ERC-20 Token FCT. - All contracts and tokens will be migrated to our main network once it is complete network stabilization. -- Testnet **Imperium-4** is ready for online. (private testnet for only chain developer) +- Firmachain Pubilc Testnet **Imperium-4** is also available.
-## EcoSystem -- [FirmaChain-BlockExplorer](https://github.com/FirmaChain/firmachain-explorer) -- [FirmaChain-Station](https://github.com/FirmaChain/firma-station) -- [FirmaChain-Faucet (testnet only)](https://github.com/FirmaChain/firmachain-faucet) +## Ecosystem +- [Firmachain Block Explorer](https://github.com/FirmaChain/firmachain-explorer) +- [Firma Station](https://github.com/FirmaChain/firma-station) +- [Firmachain Faucet (Testnet, Imperium-4)](https://github.com/FirmaChain/firmachain-faucet)