From f951fcee4035f40abf74518202554690811ec139 Mon Sep 17 00:00:00 2001 From: "jaeseung.bae" Date: Tue, 2 Jul 2024 16:02:04 +0900 Subject: [PATCH] docs: finschia mainnet/testnet information --- README.md | 1 + docs/FINSCHIA_README.md | 103 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 104 insertions(+) create mode 100644 docs/FINSCHIA_README.md diff --git a/README.md b/README.md index bdb09ba2..81a9a163 100644 --- a/README.md +++ b/README.md @@ -87,3 +87,4 @@ make localnet-stop # How to contribute check out [CONTRIBUTING.md](CONTRIBUTING.md) for our guidelines & policies for how we develop Finschia. Thank you to all those who have contributed! +# [Finschia Mainnet/Testnet](./docs/FINSCHIA_README.md) diff --git a/docs/FINSCHIA_README.md b/docs/FINSCHIA_README.md new file mode 100644 index 00000000..716554e1 --- /dev/null +++ b/docs/FINSCHIA_README.md @@ -0,0 +1,103 @@ +# Finschia Mainnet/Testnet + +## Public endpoints + +| Chain | Chain ID | Endpoint | +| ---------------- | ---------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Finschia mainnet | finschia-2 | https://finschia-api.finschia.io (REST)
https://finschia-rpc.finschia.io/ (RPC)
finschia-grpc.finschia.io:443 (gRPC)
https://finschia-api.finschia.io/swagger/ (Swagger) | +| Ebony testnet | ebony-2 | https://ebony-api.finschia.io (REST)
https://ebony-rpc.finschia.io (RPC)
ebony-grpc.finschia.io:443 (gRPC)
https://ebony-api.finschia.io/swagger/ (Swagger) | + +## Genesis/Snapshot files for Finschia mainnet/testnet + +* Genesis file + * Finschia mainnet + * TBD(link) + * Ebony testnet + * TBD(link) +* Snapshot file + * Finschia mainnet (pruned) + * TBD(link) + * Ebony testnet (pruned) + * TBD(link) + +## Current Finschia mainnet/testent environment + +* Required software + * Go v1.22+ + * Docker (Required only when using Docker) +* Required binary versions + * Finschia mainnet (finschia-2) + * TBD(finschia v4.0.x) + * Ebony testnet (ebony-2) + * TBD(finschia v4.0.x) + +## Testnet Faucet + +* Check faucet status + +```shell +curl -X GET https://faucet-ebonynw.line-apps.com/status +``` +* How to get coins for Ebony testnet + +```shell +curl --header "Content-Type: application/json" \ + --request POST \ + --data '{"denom":"tcony","address":"REPLACE WITH YOUR ADDRESS tlink1..."}' \ + https://faucet-ebonynw.line-apps.com/credit +``` + +## CLI Examples + +### Account + +* Create an account + * `fnsad keys add ` +* Manage an account key + * Key information + * `fnsad keys show ` + * Address of validator node operator + * `fnsad keys show --bech=val` + * Available keys + * `fnsad keys list` + +### Transaction + +* Send coins Tx + * `fnsad tx bank send --chain-id=` + * example + * `fnsad tx bank send 1000000cony --chain-id finschia-2 --gas-prices=0.015cony --gas auto --gas-adjustment 1.3` +* Query Tx + * Search a transaction matching a hash + * `fnsad query tx ` + +### Query + +* Query an account + * `fnsad query account ` +* Check balance + * `fnsad query bank balances ` +* Check module parameters + * `fnsad query gov params` + +## REST API Examples + +* Query the current state + +```shell +curl \ + -X GET \ + -H "Content-Type: application/json" \ + http://localhost:1317/cosmos/bank/v1beta1/balances/
+``` + +* Query the past state + * Use the HTTP header x-cosmos-block-height to make a query for the past state. + +```shell +curl \ + -X GET \ + -H "Content-Type: application/json" \ + -H "x-cosmos-block-height: 279256" + http://localhost:1317/cosmos/bank/v1beta1/balances/
+```