From b2db208e6e25432506dcd9c53fc634f78be64d2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bogdan-=C8=98tefan=20Neac=C5=9Fu?= Date: Mon, 27 Mar 2023 13:33:00 +0300 Subject: [PATCH] Add README for credential binary (#3221) --- clients/credential/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 clients/credential/README.md diff --git a/clients/credential/README.md b/clients/credential/README.md new file mode 100644 index 0000000000..b806f60fb8 --- /dev/null +++ b/clients/credential/README.md @@ -0,0 +1,32 @@ + + +## Credential binary + +The credential binary is used to acquire coconut bandwidth credentials in exchange for nym tokens. Those credentials are stored in the client's `data` directory, so that they can be used as the client sees fit. + +### Warning + +The credential binary is still experimental software. The infrastructure for using it is not yet deployed to mainnet and it's still in the process of being deployed to sandbox. + +### Building + +From the project's root directory, run: +``` +cargo build -p credential +``` +which generates the `credential` binary in `target/debug/credential`. + + +### Running + +For example, you can get a credential worth 3 nym (3000000 unym) in a socks5 client that was already initialized like so: + +``` +./target/debug/credential --config-env-file envs/sandbox.env --client-home-directory ~/.nym/socks5-clients/cred_client --nyxd-url $SANDBOX_NYXD_VALIDATOR --mnemonic $MNEMONIC --recovery-dir /tmp/recovery --amount 3000000 +``` + +More information regarding how to run the binary can be found by running it with the `--help` argument. +