search

autonity / docs.autonity.org

Documentation for the Autonity Go Client (AGC)
https://docs.autonity.org
2 stars 5 forks source link

Missing parameter on the description of the function"totalSupply" #212

Open jfaiza opened 1 month ago

jfaiza commented 1 month ago

Hello,

The "Parameters" is "None" on the description of the function "totalSupply" while we need to define the token. I think you should add the parameter "tokenAddress" to the Parameters description of this function.

image

image

cmjc commented 4 weeks ago

Hi @jfaiza - this isn't a bug in the docs. The function takes no parameters. The aut token command is for interacting with ERC-20 token contracts and requires that you specify the option --ntn or --token to specify an ERC20 token contract address:

aut token total-supply --help
Usage: aut token total-supply [OPTIONS]

  Total supply (in units of whole Tokens).

Options:
  -r, --rpc-endpoint URL  RPC endpoint (defaults to WEB3_ENDPOINT env var if
                          set)
  -t, --token TOKEN-ADDR  Use the ERC20 token at the given address
  --ntn                   Use Newton (NTN) instead of Auton
  -h, --help              Show this message and exit.

What is erroneous is the description of the --ntn option:

--ntn Use Newton (NTN) instead of Auton

That should read something like 'Specify to return total supply for the Newton(NTN) contract address'

@szemate - FYSA