Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update docs stargate #648

Merged
merged 3 commits into from
Jan 16, 2021
Merged

docs: update docs stargate #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f10a035
Update docs to stargate
Jan 15, 2021
6b96229
Revert the directory changes
Jan 15, 2021
079596f
Doc Fixes after review
Jan 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/1 Introduction/1 Introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following projects are using the technology:

Cosmos modules are the foundational building blocks for building a blockchain. Modules can be created and shared with anyone. Each module plugs into the Cosmos SDK. Some of the modules are core building blocks for creating blockchains, while other modules enable new features.

Many of the live blockchains use multiple Cosmos modules. The foundational modules for starport are: `auth`, `bank`, `staking`, `params` and `supply`. We also recommend adding the `wasm` or the `evm` module, this allows you to deploy Web Assembly smart contracts to your blockchain. The `evm` module enables the Ethereum EVM to be used in your blockchain. Each module comes with clear documentation and codebase. If you wanted to make changes to a specific module, you can fork the module and change what suits your use case better.
Many of the live blockchains use multiple Cosmos modules. The foundational modules for starport are: `auth`, `bank`, `staking`, `params`, `capability`, `mint`, `governance`, `crisis`, `slashing`, `ibc`, `upgrade`, `evidence` and `supply`. We also recommend adding the `wasm` or the `evm` module, this allows you to deploy - Web Assembly for wasm, Solidity for evm - smart contracts to your blockchain. The `evm` module enables the Ethereum EVM to be used in your blockchain. Each module comes with clear documentation and codebase. If you want to make changes to a specific module, you can fork the module and change what suits your use case better.

## Summary

Expand Down
330 changes: 232 additions & 98 deletions docs/1 Introduction/5 Genesis File.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ With Starport you will create a genesis file from your `config.yml`, it typicall

```json
{
"genesis_time": "2020-09-03T20:39:19.245733Z",
"genesis_time": "2021-01-15T12:43:55.453718Z",
"chain_id": "blog",
"initial_height": "1",
"consensus_params": {
"block": {
"max_bytes": "22020096",
Expand All @@ -22,70 +23,18 @@ With Starport you will create a genesis file from your `config.yml`, it typicall
},
"evidence": {
"max_age_num_blocks": "100000",
"max_age_duration": "172800000000000"
"max_age_duration": "172800000000000",
"max_bytes": "1048576"
},
"validator": {
"pub_key_types": [
"ed25519"
]
}
},
"version": {}
},
"app_hash": "",
"app_state": {
"supply": {
"supply": []
},
"blog": {},
"genutil": {
"gentxs": [
{
"type": "cosmos-sdk/StdTx",
"value": {
"msg": [
{
"type": "cosmos-sdk/MsgCreateValidator",
"value": {
"description": {
"moniker": "mynode",
"identity": "",
"website": "",
"security_contact": "",
"details": ""
},
"commission": {
"rate": "0.100000000000000000",
"max_rate": "0.200000000000000000",
"max_change_rate": "0.010000000000000000"
},
"min_self_delegation": "1",
"delegator_address": "cosmos1al6ytsuyhq3e0v0mcrq88sqwguqe02n2yjxuwj",
"validator_address": "cosmosvaloper1al6ytsuyhq3e0v0mcrq88sqwguqe02n2pxjfzp",
"pubkey": "cosmosvalconspub1zcjduepqg7sqkpgeqd0hnd025fztrlmzk0f3lrc8ea90cpfhz4cjq5m0h2rqkaxgd2",
"value": {
"denom": "stake",
"amount": "100000000"
}
}
}
],
"fee": {
"amount": [],
"gas": "200000"
},
"signatures": [
{
"pub_key": {
"type": "tendermint/PubKeySecp256k1",
"value": "A4hHCwk6n8Dq0TAg+BA2vz8wbFsB0gg8WEtkbVnsi3P9"
},
"signature": "tRvI8ypTM2z45jXJgFVQ2aJ0Q4Dz3KZW92MtYDl6OlgMXA4EA99eQPl6gzVskcOM3OB+OsKzmkX4AyyVrm4qOQ=="
}
],
"memo": "3bea7947b66f99b1a6585c67456191859838b709@192.168.2.191:26656"
}
}
]
},
"auth": {
"params": {
"max_memo_characters": "256",
Expand All @@ -96,61 +45,246 @@ With Starport you will create a genesis file from your `config.yml`, it typicall
},
"accounts": [
{
"type": "cosmos-sdk/Account",
"value": {
"address": "cosmos1al6ytsuyhq3e0v0mcrq88sqwguqe02n2yjxuwj",
"coins": [
{
"denom": "stake",
"amount": "100000000"
},
"@type": "/cosmos.auth.v1beta1.BaseAccount",
"address": "cosmos1ml7mett44vnvmxzku24ncujjl5gpztp4p3kag6",
"pub_key": null,
"account_number": "0",
"sequence": "0"
},
{
"@type": "/cosmos.auth.v1beta1.BaseAccount",
"address": "cosmos17ahmvzxgvkl0ccacnpj0nwstalww68z0jrz89q",
"pub_key": null,
"account_number": "0",
"sequence": "0"
}
]
},
"bank": {
"params": {
"send_enabled": [],
"default_send_enabled": true
},
"balances": [
{
"address": "cosmos1ml7mett44vnvmxzku24ncujjl5gpztp4p3kag6",
"coins": [
{
"denom": "stake",
"amount": "100000000"
},
{
"denom": "token",
"amount": "1000"
}
]
},
{
"address": "cosmos17ahmvzxgvkl0ccacnpj0nwstalww68z0jrz89q",
"coins": [
{
"denom": "token",
"amount": "500"
}
]
}
],
"supply": [],
"denom_metadata": []
},
"capability": {
"index": "1",
"owners": []
},
"coinz": {},
"crisis": {
"constant_fee": {
"amount": "1000",
"denom": "stake"
}
},
"distribution": {
"delegator_starting_infos": [],
"delegator_withdraw_infos": [],
"fee_pool": {
"community_pool": []
},
"outstanding_rewards": [],
"params": {
"base_proposer_reward": "0.010000000000000000",
"bonus_proposer_reward": "0.040000000000000000",
"community_tax": "0.020000000000000000",
"withdraw_addr_enabled": true
},
"previous_proposer": "",
"validator_accumulated_commissions": [],
"validator_current_rewards": [],
"validator_historical_rewards": [],
"validator_slash_events": []
},
"evidence": {
"evidence": []
},
"genutil": {
"gen_txs": [
{
"body": {
"messages": [
{
"denom": "token",
"amount": "1000"
"@type": "/cosmos.staking.v1beta1.MsgCreateValidator",
"description": {
"moniker": "mynode",
"identity": "",
"website": "",
"security_contact": "",
"details": ""
},
"commission": {
"rate": "0.100000000000000000",
"max_rate": "0.200000000000000000",
"max_change_rate": "0.010000000000000000"
},
"min_self_delegation": "1",
"delegator_address": "cosmos1ml7mett44vnvmxzku24ncujjl5gpztp4p3kag6",
"validator_address": "cosmosvaloper1ml7mett44vnvmxzku24ncujjl5gpztp4y9zgyf",
"pubkey": {
"@type": "/cosmos.crypto.ed25519.PubKey",
"key": "oHynTiWsRxbdwWAkJLFBk/T8TWiFATFrKWfxemP2AWw="
},
"value": {
"denom": "stake",
"amount": "100000000"
}
}
],
"public_key": null,
"account_number": "0",
"sequence": "0"
}
},
{
"type": "cosmos-sdk/Account",
"value": {
"address": "cosmos1s25rfpwsm23ene6krurgghre6u8dnyguku52nk",
"coins": [
"memo": "9e5f3e69aab836337554f3f8699aec8ee7978360@192.168.178.23:26656",
"timeout_height": "0",
"extension_options": [],
"non_critical_extension_options": []
},
"auth_info": {
"signer_infos": [
{
"denom": "token",
"amount": "500"
"public_key": {
"@type": "/cosmos.crypto.secp256k1.PubKey",
"key": "Aidt5eKiDmfXiXy7el+zI+i0VyD34e3pOoOzI3ljWXKt"
},
"mode_info": {
"single": {
"mode": "SIGN_MODE_DIRECT"
}
},
"sequence": "0"
}
],
"public_key": null,
"account_number": "0",
"sequence": "0"
}
"fee": {
"amount": [],
"gas_limit": "200000",
"payer": "",
"granter": ""
}
},
"signatures": [
"/bELv1NNgp7941Ux8Zz6T0x5yKqKMjbX2Q+TzPB7IAMdr680fkZGMGOm2F0bX9hK2lapCp+3RnGgmxhMG/bHUw=="
]
}
]
},
"bank": {
"send_enabled": true
"gov": {
"deposit_params": {
"max_deposit_period": "172800s",
"min_deposit": [
{
"amount": "10000000",
"denom": "stake"
}
]
},
"deposits": [],
"proposals": [],
"starting_proposal_id": "1",
"tally_params": {
"quorum": "0.334000000000000000",
"threshold": "0.500000000000000000",
"veto_threshold": "0.334000000000000000"
},
"votes": [],
"voting_params": {
"voting_period": "172800s"
}
},
"ibc": {
"channel_genesis": {
"ack_sequences": [],
"acknowledgements": [],
"channels": [],
"commitments": [],
"receipts": [],
"recv_sequences": [],
"send_sequences": []
},
"client_genesis": {
"clients": [],
"clients_consensus": [],
"create_localhost": false
},
"connection_genesis": {
"client_connection_paths": [],
"connections": []
}
},
"mint": {
"minter": {
"annual_provisions": "0.000000000000000000",
"inflation": "0.130000000000000000"
},
"params": {
"blocks_per_year": "6311520",
"goal_bonded": "0.670000000000000000",
"inflation_max": "0.200000000000000000",
"inflation_min": "0.070000000000000000",
"inflation_rate_change": "0.130000000000000000",
"mint_denom": "stake"
}
},
"params": null,
"slashing": {
"missed_blocks": [],
"params": {
"downtime_jail_duration": "600s",
"min_signed_per_window": "0.500000000000000000",
"signed_blocks_window": "100",
"slash_fraction_double_sign": "0.050000000000000000",
"slash_fraction_downtime": "0.010000000000000000"
},
"signing_infos": []
},
"staking": {
"delegations": [],
"exported": false,
"last_total_power": "0",
"last_validator_powers": [],
"params": {
"unbonding_time": "1814400000000000",
"max_validators": 100,
"bond_denom": "stake",
"historical_entries": 100,
"max_entries": 7,
"historical_entries": 0,
"bond_denom": "stake"
"max_validators": 100,
"unbonding_time": "1814400s"
},
"last_total_power": "0",
"last_validator_powers": null,
"validators": null,
"delegations": null,
"unbonding_delegations": null,
"redelegations": null,
"exported": false
},
"params": null
"redelegations": [],
"unbonding_delegations": [],
"validators": []
},
"transfer": {
"denom_traces": [],
"params": {
"receive_enabled": true,
"send_enabled": true
},
"port_id": "transfer"
},
"upgrade": {},
"vesting": {}
}
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/1 Introduction/6 Starport IBC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In order to communicate between chains, bootstrapping two blockchains with starp
To start using IBC with Starport open up a [web-based development environment](https://gitpod.io/#https://github.com/tendermint/starport/), then scaffold and launch a Stargate chain:

```
starport app github.com/foo/foo --sdk-version stargate
starport app github.com/foo/foo

cd foo

Expand Down
Loading