IntersectMBO / cardaminal

A CLI-based Cardano Wallet
Apache License 2.0
9 stars 1 forks source link

Docs are out of sync #166

Open abailly opened 2 months ago

abailly commented 2 months ago

In my spare time I am having a fresh look at cardaminal and try to play with it, but documentation is outdated and I am not even able to create a chain! I am trying to do the following:

% cardaminal chain create mainnet 764824073 relays-new.cardano-mainnet.iohk.io:3001 1
2024-09-11T06:28:12.682533Z  INFO create{name="mainnet"}: cardaminal::chain::create: chain created chain="mainnet"

then

% cardaminal chain sync mainnet
2024-09-11T06:28:24.067792Z  INFO sync{name="mainnet"}: cardaminal::chain::sync: updating chain="mainnet"
2024-09-11T06:28:24.080399Z  INFO sync{name="mainnet"}: cardaminal::chain::upstream: intersecting chain points=[]
Error:   × invalid digit found in string

The documentation does not have this ADDRESS_NETWORK_ID parameter, what does this represent?

Screenshot 2024-09-11 at 08 28 53
abailly commented 2 months ago

@scarmuega In case you can provide some insights on this :)

scarmuega commented 2 months ago

@abailly the network_id arg represents the id for the network to disambiguate between mainnet and testnets (as it appears in the genesis config file for the node).

The chain create command should be something like this:

cardaminal chain create mainnet backbone.mainnet.cardanofoundation.org:3001 764824073 1

(using new relay since the iohk one is no longer available AFAIK)

I have a small fix for the docs to reflect this missing arg but sadly we no longer have write permissions to this repository. I'll see if we can find time to fork the repo and send a PR.

When in doubt, you can also run cardaminal <command> --help to see the auto-generated docs for each command.