search

ava-labs / avalanchego

Go implementation of an Avalanche node.
https://avax.network
BSD 3-Clause "New" or "Revised" License
2.12k stars 669 forks source link

Please document how to use chain-config-content #1069

Open diwu1989 opened 2 years ago

diwu1989 commented 2 years ago

flag --chain-config-content is VERY difficult to use. There's no good documentation for it, and I had to read the source code to really figure out how it works.

The structure expected is a base64 encoding of a JSON map from chain-id to a {Config: <base64 encoded chain config>} There's 2 level of base64 encoding because each chain-config itself has to be b64 encoded first, and then stuffed into a {chainId: {Config: string}} JSON, and b64 encoded yet again...

Please document this more clearly and add examples for this.

StephenButtolph commented 2 years ago

I don't think any of the -content flags are currently really intended to be heavily used. Unless you have a specialized setup, the expected way to specify chain configs is documented here. Does that not work for your use-case?

yulin-dong commented 2 years ago

Also we always welcome PR on https://github.com/ava-labs/avalanche-docs

diwu1989 commented 2 years ago

Passing in the config via environment variable is way easier for me in K8s.

github-actions[bot] commented 1 year ago

This issue has become stale because it has been open 60 days with no activity. Adding the lifecycle/frozen label will cause this issue to ignore lifecycle events.