diff --git a/getTez/README.md b/getTez/README.md index a2ad3d6..ad06389 100644 --- a/getTez/README.md +++ b/getTez/README.md @@ -30,7 +30,7 @@ You can then use the `getTez` function to interact with the Tezos faucet. The fu - `amount`: The amount of Tez to request. - `network`: The faucet's network name. Must match a network name with a faucet listed at https://teztnets.xyz. Ignored if `faucetUrl` is set. - `faucetUrl`: The custom faucet URL. Ignores `network`. -- `clientDir`: (Optional) Specifies a custom client directory path to look up address aliases. If not set, it will default to `$HOME/.tezos-client/` or `$TEZOS_CLIENT_DIR/public_key_hashs` if the `TEZOS_CLIENT_DIR` environment variable is specified. +- `clientDir`: (Optional) Specifies a custom client directory path to look up an address alias. If not set, it will default to `$HOME/.tezos-client/` or `$TEZOS_CLIENT_DIR` if the `TEZOS_CLIENT_DIR` environment variable is set. Here is an example of how to use the `getTez` function: diff --git a/getTez/getTez.ts b/getTez/getTez.ts index e8103f2..310e9d1 100755 --- a/getTez/getTez.ts +++ b/getTez/getTez.ts @@ -7,9 +7,9 @@ import * as pkgJson from "./package.json" const isMainModule = require.main === module /* -We use instantiate a "Console" to stderr for logging so that logs are not -written to stdout when the script is run from the CLI. We want the transaction -hash to be the only stdout once the Tez is sent to the user. +We instantiate a "Console" to stderr for logging so that logs are not written to +stdout when the script is run from the CLI. We want the transaction hash to be +the only stdout once the Tez is sent to the user. */ import { Console } from "console" const console = new Console(isMainModule ? process.stderr : process.stdout) @@ -35,8 +35,8 @@ const displayHelp = () => {
: The address where Tez should be sent. This can be either a standard Tezos public key hash (e.g. tz1234abc...) or a local alias. If an alias is provided (e.g., 'alice'), the program will attempt to resolve it to a public - key hash by looking it up in the specified client directory (set by --client-dir or by the TEZOS_CLIENT_DIR - environment variable). If neither is set, the default lookup location is $HOME/.tezos-client/public_key_hashes. + key hash by looking it up in the specified client directory, set by --client-dir or by the TEZOS_CLIENT_DIR + environment variable. If neither is set, the default lookup location is $HOME/.tezos-client. Options: -h, --help Display help information.