Skip to content

Commit

Permalink
docs: move greenfield cmd/module/api docs from docs.bnbchain.org to g…
Browse files Browse the repository at this point in the history
…reenfield repo (#619)

* docs: move greenfield cmd/module/api docs from docs.bnbchain.org to greenfield repo

* docs: move unnecessary title/order syntax

---------

Co-authored-by: Clyde <clyde.m@nodereal.io>
  • Loading branch information
ruojunm and clydemeng authored May 15, 2024
1 parent 3fb0c0e commit 211b924
Show file tree
Hide file tree
Showing 169 changed files with 14,565 additions and 0 deletions.
226 changes: 226 additions & 0 deletions docs/blockchain-cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
# Blockchain Command-Line Interface

> [!NOTE]
> Since Greenfield Command Line interface is derived from Cosmos, The majority of the content in this page is copied from the [Cosmos SDK](https://docs.cosmos.network/main/core/cli).
There is no set way to create a CLI, but Greenfield typically use the [Cobra Library](https://github.com/spf13/cobra).
Building a CLI with Cobra entails defining commands, arguments, and flags. Commands understand the
actions users wish to take, such as `tx` for creating a transaction and `query` for querying the application.
Each command can also have nested subcommands, necessary for naming the specific transaction type.
Users also supply **Arguments**, such as account numbers to send coins to, and flags to modify various
aspects of the commands, such as gas prices or which node to broadcast to.

### Transaction Command
Here is an example of a command a user might enter to interact with `gnfd` in order to send some tokens:

```bash
gnfd tx bank send $MY_ADDRESS $RECIPIENT 1000BNB --gas auto
```

The first four strings specify the command:

* The subcommand `tx`, which contains all commands that let users create transactions.
* The subcommand `bank` to indicate which module to route the command to `x/bank` module in this case.
* The type of transaction `send`.

The next two strings are arguments: the `from_address` the user wishes to send from, the `to_address` of the recipient,
and the `amount` they want to send. Finally, the last few strings of the command are optional flags to indicate
how much the user is willing to pay in fees.

### Transaction Data
Greenfield utilizes the EIP712 transaction format. To view the transaction data, you can use the `print-eip712-msg-type` flag.
Below is an example of how to display the transaction data of sending tokens.

```shell
gnfd tx bank send $MY_ADDRESS $RECIPIENT 1000BNB --print-eip712-msg-type
```

From the output, we can obtain the following three fields:

1. **EIP712MessageType**: This field represents the EIP712 messages format of the transaction.
```json
{
"Coin": [
{
"name": "amount",
"type": "uint256"
},
{
"name": "denom",
"type": "string"
}
],
"EIP712Domain": [
{
"name": "chainId",
"type": "uint256"
},
{
"name": "name",
"type": "string"
},
{
"name": "salt",
"type": "string"
},
{
"name": "verifyingContract",
"type": "string"
},
{
"name": "version",
"type": "string"
}
],
"Fee": [
{
"name": "amount",
"type": "Coin[]"
},
{
"name": "gas_limit",
"type": "uint256"
},
{
"name": "granter",
"type": "string"
},
{
"name": "payer",
"type": "string"
}
],
"Msg1": [
{
"name": "amount",
"type": "TypeMsg1Amount[]"
},
{
"name": "from_address",
"type": "string"
},
{
"name": "to_address",
"type": "string"
},
{
"name": "type",
"type": "string"
}
],
"Tx": [
{
"name": "account_number",
"type": "uint256"
},
{
"name": "chain_id",
"type": "uint256"
},
{
"name": "fee",
"type": "Fee"
},
{
"name": "memo",
"type": "string"
},
{
"name": "msg1",
"type": "Msg1"
},
{
"name": "sequence",
"type": "uint256"
},
{
"name": "timeout_height",
"type": "uint256"
}
],
"TypeMsg1Amount": [
{
"name": "amount",
"type": "string"
},
{
"name": "denom",
"type": "string"
}
]
}
```

2. **MessageData**: This field represents the messages data of the transaction, displayed in a readable format.
```json
{
"msg1": {
"amount": [
{
"amount": "1000",
"denom": "BNB"
}
],
"from_address": "0x0aA5170C854AA093e1c32F15285dE4Bf7f6802Ce",
"to_address": "0x2123B607e1b9E8Ae65FbE12585C1bE6838Bb32C7",
"type": "/cosmos.bank.v1beta1.MsgSend"
}
}
```

3. **TxRawBytes**: This field represents the encoded byte array of the transaction.
```json
0a88010a85010a1c2f636f736d6f732e62616e6b2e763162657461312e4d736753656e6412650a2a307830614135313730433835344141303933653163333246313532383564453442663766363830324365122a3078323132334236303765316239453841653635466245313235383543316245363833384262333243371a0b0a03424e4212043130303012021200
```

Once you have obtained these three fields of the transaction, you can use `gnfd-tx-sender` to send the transaction
instead of using a command. Here are the steps:

1. Visit the [gnfd-tx-sender](https://gnfd-tx-sender.nodereal.io/) website.
2. Connect your wallet and switch to the correct network.
3. Navigate to the `Custom Tx` page and fill in the aforementioned three fields accordingly.
4. Click the `Submit` button and sign in the wallet when prompted.
5. Wait for confirmation.

### Query Commands

Queries are objects that allow users to retrieve information about the application's state.

This `queryCommand` function adds all the queries available to end-users for the application. This typically includes:

* **QueryTx** and/or other transaction query commands from the `auth` module which allow the user to search for a transaction by inputting its hash, a list of tags, or a block height. These queries allow users to see if transactions have been included in a block.
* **Account command** from the `auth` module, which displays the state (e.g. account balance) of an account given an address.
* **Validator command** from the Cosmos SDK rpc client tools, which displays the validator set of a given height.
* **Block command** from the Cosmos SDK rpc client tools, which displays the block data for a given height.
* **All module query commands the application is dependent on,

Here is an example of a `queryCommand`:

```shell
## query the metadata of BNB
gnfd q bank denom-metadata --node https://greenfield-chain.bnbchain.org:443
```

## Environment variables

Each flag is bound to its respective named environment variable. Then name of the environment variable consist of two parts
- capital case `basename` followed by flag name of the flag. `-` must be substituted with `_`.
- For example flag `--home` for application with basename `GNFD` is bound to `GNFD_HOME`. It allows reducing
the amount of flags typed for routine operations. For example instead of:

```sh
gnfd --home=./ --node=<node address> --chain-id="greenfield_1017-1" tx ... --from=<key name>
```

this will be more convenient:

```sh
# define env variables in .env, .envrc etc
GNFD_HOME=<path to home>
GNFD_NODE=<node address>
GNFD_CHAIN_ID="greenfield_1017-1"
GNFD_KEYRING_BACKEND="file"

# and later just use
gnfd tx ... --from=<key name>
```
167 changes: 167 additions & 0 deletions docs/blockchain-cli/bank.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
# Account Balance

## Abstract
The bank module is responsible for handling BNB transfers between
accounts and module accounts.

In addition, the bank module tracks and provides query support for the total
supply of BNB in the application.

## Quick Start

### Query Balances

To query the balances of an account, you can use the following command.

```shell
gnfd q bank balances ${receiver} --node ${node}
```

You can specify any valid address you want to query via ${receiver}.


${node} is the rpc address of a Greenfield node.

- Mainnet

```js
node = "https://greenfield-chain.bnbchain.org:443"
```

- Testnet

```js
node = "https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org:443"
```


### Send

To transfer some coins you can use `send` command.
```shell
gnfd tx bank send ${key} ${receiver} ${coins} --home ~/.gnfd --node ${node} -y
```

${key} is the name of local key.

${coins} defines the coins you want to transfer, for example, `500000000000000000000BNB`.

### Multi-send

Sometimes, you may want to transfer tokens to multiple people. `multi-send` command can be used for the purpose.

```shell
gnfd tx bank multi-send ${key} ${receiver1} ${receiver2} ${coins} --home ~/.gnfd --node ${node} -y
```

## Detailed CLI

A user can query and interact with the `bank` module using the CLI.

### Query

The `query` commands allow users to query `bank` state.

```sh
gnfd query bank --help
```

#### balances

The `balances` command allows users to query account balances by address.

```sh
gnfd query bank balances [address] [flags]
```

Example:

```sh
gnfd query bank balances 0x73a4Cf67b46D7E4efbb95Fc6F59D64129299c2E3
```

Example Output:

```yml
balances:
- amount: "10000000000000000000000"
denom: BNB
pagination:
next_key: null
total: "0"
```

#### denom-metadata

The `denom-metadata` command allows users to query metadata for coin denominations. A user can query metadata for a single denomination using the `--denom` flag or all denominations without it.

```sh
gnfd query bank denom-metadata [flags]
```

Example:

```sh
gnfd query bank denom-metadata --denom BNB
```

Example Output:

```yml
metadata:
base: BNB
denom_units:
- aliases:
- wei
denom: BNB
exponent: 0
description: The native staking token of the Greenfield.
display: BNB
name: ""
symbol: ""
uri: ""
uri_hash: ""
```

#### total

The `total` command allows users to query the total supply of coins. A user can query the total supply for a single coin using the `--denom` flag or all coins without it.

```sh
gnfd query bank total [flags]
```

Example:

```sh
gnfd query bank total --denom BNB
```

Example Output:

```yml
amount: "1000000000000000800000000000"
denom: BNB
```

### Transactions

The `tx` commands allow users to interact with the `bank` module.

```sh
gnfd tx bank --help
```

#### send

The `send` command allows users to send funds from one account to another.

```sh
gnfd tx bank send [from_key_or_address] [to_address] [amount] [flags]
```

Example:

```sh
gnfd tx bank send addr1.. addr2.. 100000000000000000000BNB
```
Loading

0 comments on commit 211b924

Please sign in to comment.