module documentation + genesis and scripts (#14)

* docs

* add manifest_testing script

* comments, extra test case

* add a base genesis

* added post genesis validator guide

* fmt

* from scratch genesis

go.mod

@@ -46,9 +46,7 @@ require (
 	github.com/golang/protobuf v1.5.3
 	github.com/gorilla/mux v1.8.1
 	github.com/grpc-ecosystem/grpc-gateway v1.16.0
-	github.com/prometheus/client_golang v1.18.0 // indirect
 	github.com/reecepbcups/tokenfactory v0.50.0-alpha.3
-	github.com/rs/zerolog v1.32.0 // indirect
 	github.com/spf13/cast v1.6.0
 	github.com/spf13/cobra v1.8.0
 	github.com/spf13/pflag v1.0.5
@@ -170,12 +168,14 @@ require (
 	github.com/petermattis/goid v0.0.0-20230904192822-1876fd5063bc // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
+	github.com/prometheus/client_golang v1.18.0 // indirect
 	github.com/prometheus/client_model v0.6.0 // indirect
 	github.com/prometheus/common v0.47.0 // indirect
 	github.com/prometheus/procfs v0.12.0 // indirect
 	github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect
 	github.com/rogpeppe/go-internal v1.12.0 // indirect
 	github.com/rs/cors v1.8.3 // indirect
+	github.com/rs/zerolog v1.32.0 // indirect
 	github.com/sagikazarmark/locafero v0.4.0 // indirect
 	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
 	github.com/sasha-s/go-deadlock v0.3.1 // indirect

network/manifest-1/POST_GENESIS.md

@@ -0,0 +1,28 @@
+# Post-Genesis
+
+### Become a validator
+* Install the manifest binary
+* manifestd init <moniker> --chain-id manifest-1 --default-denom poastake
+* Replace your genesis with the public one found in this repo
+* Find peers and seeds here.
+* Update your minimum-gas-prices in the app.toml
+* Start the node and sync up
+* Once completed, `manifestd tx poa create-validator path/to/validator.json --from keyname`. This command shows the JSON needed.
+```json
+{
+        "pubkey": {"@type":"/cosmos.crypto.ed25519.PubKey","key":"oWg2ISpLF405Jcm2vXV+2v4fnjodh6aafuIdeoW+rUw="},
+        "amount": "1poastake", # ignored
+        "moniker": "myvalidator",
+        "identity": "keybase-identity",
+        "website": "validator's (optional) website",
+        "security": "validator's (optional) security contact email",
+        "details": "validator's (optional) details",
+        "commission-rate": "0.1",
+        "commission-max-rate": "0.2",
+        "commission-max-change-rate": "0.01",
+        "min-self-delegation": "1" # ignored
+}
+```
+
+Following these instructions, your validator will be put into a queue for the chain admins to accept or reject. Once accepted, you will be a validator on the network.
+The chain admin's will set your amount if they accept.

network/manifest-1/README.md

@@ -0,0 +1,104 @@
+# Mainnet Genesis
+
+TODO:
+- Update PoA Admin(s) from manifest10d07y265gmmuvt4z0w9aw880jnsr700jmq3jzm
+- Remove manifest1hj5fveer5cjtn4wd6wstzugjfdxzl0xp8ws9ct once others are given genesis allocations
+
+# Post Genesis Validators
+If you are a validator joining the network after the initial genesis launch, follow the [post genesis document here](./POST_GENESIS.md).
+
+## Hardware Requirements
+**Minimal**
+* 4 GB RAM
+* 100 GB SSD
+* 3.2 x4 GHz CPU
+
+**Recommended**
+* 8 GB RAM
+* 100 GB NVME SSD
+* 4.2 GHz x6 CPU
+
+**Operating System**
+* Linux (x86_64) or Linux (amd64) Recommended Arch Linux
+
+### Dependencies
+>Prerequisite: go1.21+, git, gcc, make, jq
+
+**Arch Linux:**
+```
+pacman -S go git gcc make
+```
+
+**Ubuntu Linux:**
+```
+sudo snap install go --classic
+sudo apt-get install git gcc make jq
+```
+
+## manifestd Installation Steps
+
+```bash
+# Clone git repository
+git clone https://github.com/liftedinit/manifest-ledger.git
+cd manifest-ledger
+git checkout VERSION
+
+make install # go install ./...
+# For ledger support `go install -tags ledger ./...`
+
+manifestd config set client chain-id manifest-1
+```
+
+### Generate keys
+* `manifestd keys add [key_name]`
+* `manifestd keys add [key_name] --recover` to regenerate keys with your BIP39 mnemonic to add ledger key
+* `manifestd keys add [key_name] --ledger` to add a ledger key
+
+# Validator setup instructions
+## Genesis Tx:
+```bash
+# Validator variables
+KEYNAME='validator' # your keyname
+MONIKER='pbcups'
+SECURITY_CONTACT="[email protected]"
+WEBSITE="https://domain.com"
+MAX_RATE='0.20'        # 20%
+COMMISSION_RATE='0.00' # 0%
+MAX_CHANGE='0.01'      # 1%
+CHAIN_ID='manifest-1'
+PROJECT_HOME="${HOME}/.manifest"
+KEYNAME_ADDR=$(manifestd keys show $KEYNAME -a)
+
+# Remove old files if they exist
+manifestd tendermint unsafe-reset-all
+rm $HOME/.manifest/config/genesis.json
+rm $HOME/.manifest/config/gentx/*.json
+
+# Give yourself 1POASTAKE for the genesis Tx signed
+manifestd init "$MONIKER" --chain-id $CHAIN_ID --staking-bond-denom poastake
+manifestd add-genesis-account $KEYNAME_ADDR 1000000poastake
+
+# genesis transaction using all above variables
+manifestd gentx $KEYNAME 1000000poastake \
+    --home=$PROJECT_HOME \
+    --chain-id=$CHAIN_ID \
+    --moniker="$MONIKER" \
+     --commission-max-change-rate=$MAX_CHANGE \
+    --commission-max-rate=$MAX_RATE \
+    --commission-rate=$COMMISSION_RATE \
+    --security-contact=$SECURITY_CONTACT \
+    --website=$WEBSITE \
+    --details=""
+
+# Get that gentx data easily -> your home directory
+cat ${PROJECT_HOME}/config/gentx/gentx-*.json
+
+# get your peer
+echo $(manifestd tendermint show-node-id)@$(curl -s ifconfig.me):26656`
+```
+
+> Update minimum gas prices
+```bash
+# nano ${HOME}/.manifest/config/app.toml # minimum-gas-prices -> "0umfx"
+sed -i 's/minimum-gas-prices = "0stake"/minimum-gas-prices = "0umfx"/g' ${HOME}/.manifest/config/app.toml
+```

network/manifest-1/from_scratch.sh

@@ -0,0 +1,82 @@
+# Takes a default genesis from manifestd and creates a new genesis file.
+
+make install
+
+export HOME_DIR=$(eval echo "${HOME_DIR:-"~/.manifest"}")
+
+rm -rf $HOME_DIR && echo "Removed $HOME_DIR"
+
+manifestd init moniker --chain-id=manifest-1 --default-denom=umfx
+
+update_genesis () {
+    cat $HOME_DIR/config/genesis.json | jq "$1" > $HOME_DIR/config/tmp_genesis.json && mv $HOME_DIR/config/tmp_genesis.json $HOME_DIR/config/genesis.json
+}
+
+update_genesis '.consensus["params"]["block"]["max_gas"]="-1"'
+update_genesis '.consensus["params"]["abci"]["vote_extensions_enable_height"]="1"'
+
+# auth
+update_genesis '.app_state["auth"]["params"]["max_memo_characters"]="512"'
+
+update_genesis '.app_state["bank"]["denom_metadata"]=[
+        {
+            "base": "umfx",
+            "denom_units": [
+            {
+                "aliases": [],
+                "denom": "umfx",
+                "exponent": 0
+            },
+            {
+                "aliases": [],
+                "denom": "MFX",
+                "exponent": 6
+            }
+            ],
+            "description": "Denom metadata for MFX (umfx)",
+            "display": "MFX",
+            "name": "MFX",
+            "symbol": "MFX"
+        }
+]'
+
+update_genesis '.app_state["crisis"]["constant_fee"]={"denom": "umfx","amount": "100000000"}'
+
+update_genesis '.app_state["distribution"]["params"]["community_tax"]="0.000000000000000000"'
+
+update_genesis '.app_state["gov"]["params"]["min_deposit"]=[{"denom":"umfx","amount":"100000000"}]'
+update_genesis '.app_state["gov"]["params"]["max_deposit_period"]="259200s"'
+update_genesis '.app_state["gov"]["params"]["voting_period"]="259200s"'
+update_genesis '.app_state["gov"]["params"]["expedited_min_deposit"]=[{"denom":"umfx","amount":"250000000"}]'
+update_genesis '.app_state["gov"]["params"]["min_deposit_ratio"]="0.100000000000000000"' # 10%
+# update_genesis '.app_state["gov"]["params"]["constitution"]=""' # ?
+
+# TODO:
+# update_genesis '.app_state["manifest"]["params"]["stake_holders"]=[{"address":"manifest1hj5fveer5cjtn4wd6wstzugjfdxzl0xp8ws9ct","percentage":100000000}]' # TODO:
+update_genesis '.app_state["manifest"]["params"]["inflation"]["automatic_enabled"]=false'
+update_genesis '.app_state["manifest"]["params"]["inflation"]["yearly_amount"]="365000000"' # in micro format (1MFX = 10**6)
+update_genesis '.app_state["manifest"]["params"]["inflation"]["mint_denom"]="umfx"'
+
+# not used
+update_genesis '.app_state["mint"]["minter"]["inflation"]="0.000000000000000000"'
+update_genesis '.app_state["mint"]["minter"]["annual_provisions"]="0.000000000000000000"'
+update_genesis '.app_state["mint"]["params"]["mint_denom"]="notused"'
+update_genesis '.app_state["mint"]["params"]["inflation_rate_change"]="0.000000000000000000"'
+update_genesis '.app_state["mint"]["params"]["inflation_max"]="0.000000000000000000"'
+update_genesis '.app_state["mint"]["params"]["inflation_min"]="0.000000000000000000"'
+update_genesis '.app_state["mint"]["params"]["blocks_per_year"]="6311520"' # default 6s blocks
+
+update_genesis '.app_state["slashing"]["params"]["signed_blocks_window"]="10000"'
+update_genesis '.app_state["slashing"]["params"]["min_signed_per_window"]="0.050000000000000000"'
+update_genesis '.app_state["slashing"]["params"]["downtime_jail_duration"]="60s"'
+update_genesis '.app_state["slashing"]["params"]["slash_fraction_double_sign"]="1.000000000000000000"'
+update_genesis '.app_state["slashing"]["params"]["slash_fraction_downtime"]="0.000000000000000000"'
+
+update_genesis '.app_state["staking"]["params"]["bond_denom"]="poastake"'
+
+update_genesis '.app_state["tokenfactory"]["params"]["denom_creation_fee"]=[]'
+update_genesis '.app_state["tokenfactory"]["params"]["denom_creation_gas_consume"]="250000"'
+
+# add genesis accounts
+# TODO:
+manifestd genesis add-genesis-account manifest1hj5fveer5cjtn4wd6wstzugjfdxzl0xp8ws9ct 1umfx --append