document avail batcher settings #53
Conversation
and other undocumented variables
docs/home/1-setup/20-paima-bacher.md
Outdated
|
|
||
| ## Optional variables | ||
|
|
||
| - `CONTRACT_ADDRESS`: The address of your Paima L2 contract. |
There was a problem hiding this comment.
CONTRACT_ADDRESS here is duplicated with the EVM section
docs/home/1-setup/20-paima-bacher.md
Outdated
| - `MAX_BASE_GAS`: For gas estimation. Defaults to 50000. | ||
| - `MAX_GAS_PER_BYTE`: For gas estimation: 32. |
There was a problem hiding this comment.
Both of these are EVM-specific
There was a problem hiding this comment.
Well, I put all the optional variables together and only mentioned the required ones depending on the underlying network. But I guess I could organize it a bit differently and have a section of required and optional for each one. Plus a general one with shared variables also with required and optional.
docs/home/1-setup/20-paima-bacher.md
Outdated
| - `CARP_URL`: The URL of a Carp instance. This is required if | ||
| `BATCHER_CARDANO_ENABLED_POOLS` is used. | ||
| - `BATCHER_CARDANO_ENABLED_POOLS`: A comma separated list of pool credentials, | ||
| only users delegating to one of these pools will be able to post to the batcher. | ||
| The expected format is the public key hash (28 bytes) as a hexadecimal string | ||
| (56 characters). |
There was a problem hiding this comment.
Maybe a section for Cardano?
There was a problem hiding this comment.
It's not quite the same though, since you can use this feature while submitting to any other network. But maybe it should have its own section like the captcha thing.
docs/home/1-setup/20-paima-bacher.md
Outdated
| private key). For Avail the format is that of a [Substrate | ||
| uri](https://polkadot.js.org/docs/keyring/start/suri/). | ||
|
|
||
| ** Note **: For Avail this is only used for self signed inputs, otherwise it's |
There was a problem hiding this comment.
perhaps you meant this?
| ** Note **: For Avail this is only used for self signed inputs, otherwise it's | |
| **Note**: For Avail this is only used for self signed inputs, otherwise it's |
|
|
||
| #### Optional settings | ||
|
|
||
| - `BATCHED_TRANSACTION_POSTER_PERIOD`: Delay for the transaction poster loop |
There was a problem hiding this comment.
btw, I think this is what this does right now, but I'm not convinced it's doing what it's supposed to do.
| @@ -49,10 +49,93 @@ First, ensure you have a config file `.env.*` ready in the root directory of you | |||
| cat .env.mainnet >> ../.env.mainnet | |||
There was a problem hiding this comment.
note: we also modified the switchChain function in the Avail batcher PR, so we should update the docs for that too (maybe in this PR, maybe in a separate one)
There was a problem hiding this comment.
I was going to do that in this one actually. But that function is not documented anywhere right now, and I'm not really sure in which case someone would use it directly (its not in the templates afaik)
I wasn't really sure where to put this, since the documentation for environment variables that we currently have is mostly for the engine, with some batcher variables mixed in but it's not super clear. So I added new section with a full list of variables and tried to document all of them, and included the new ones there.
Mostly documents this PaimaStudios/paima-engine#391
Plus some of the changes introduced at PaimaStudios/paima-engine#385 after the previous PR was merged here.