Skip to content

Commit

Permalink
fix config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dhaidashenko committed Nov 10, 2023
1 parent c6142c3 commit 565c9c3
Show file tree
Hide file tree
Showing 13 changed files with 65 additions and 0 deletions.
5 changes: 5 additions & 0 deletions core/config/docs/core.toml
Original file line number Diff line number Diff line change
Expand Up @@ -597,3 +597,8 @@ SamplingRatio = 1.0 # Example
[Tracing.Attributes]
# env is an example user specified key-value pair
env = "test" # Example

[TxmAsService]
# Enabled turns Transaction Manager as a service feature on or off. When enabled exposes endpoint to submit arbitrary EVM transaction
# using one of the keys enabled for the specified chain.
Enabled = false # Default
16 changes: 16 additions & 0 deletions core/services/chainlink/mocks/general_config.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions core/web/resolver/testdata/config-empty-effective.toml
Original file line number Diff line number Diff line change
Expand Up @@ -232,3 +232,6 @@ Enabled = false
CollectorTarget = ''
NodeID = ''
SamplingRatio = 0.0

[TxmAsService]
Enabled = false
3 changes: 3 additions & 0 deletions core/web/resolver/testdata/config-full.toml
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,9 @@ SamplingRatio = 1.0
env = 'dev'
test = 'load'

[TxmAsService]
Enabled = false

[[EVM]]
ChainID = '1'
Enabled = false
Expand Down
3 changes: 3 additions & 0 deletions core/web/resolver/testdata/config-multi-chain-effective.toml
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,9 @@ CollectorTarget = ''
NodeID = ''
SamplingRatio = 0.0

[TxmAsService]
Enabled = false

[[EVM]]
ChainID = '1'
AutoCreateKey = true
Expand Down
14 changes: 14 additions & 0 deletions docs/CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -1638,6 +1638,20 @@ env = "test" # Example
```
env is an example user specified key-value pair

## TxmAsService
```toml
[TxmAsService]
Enabled = false # Default
```


### Enabled
```toml
Enabled = false # Default
```
Enabled turns Transaction Manager as a service feature on or off. When enabled exposes endpoint to submit arbitrary EVM transaction
using one of the keys enabled for the specified chain.

## EVM
EVM defaults depend on ChainID:

Expand Down
3 changes: 3 additions & 0 deletions testdata/scripts/node/validate/default.txtar
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,9 @@ CollectorTarget = ''
NodeID = ''
SamplingRatio = 0.0

[TxmAsService]
Enabled = false

Invalid configuration: invalid secrets: 2 errors:
- Database.URL: empty: must be provided and non-empty
- Password.Keystore: empty: must be provided and non-empty
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,9 @@ CollectorTarget = ''
NodeID = ''
SamplingRatio = 0.0

[TxmAsService]
Enabled = false

[[EVM]]
ChainID = '1'
AutoCreateKey = true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,9 @@ CollectorTarget = ''
NodeID = ''
SamplingRatio = 0.0

[TxmAsService]
Enabled = false

[[EVM]]
ChainID = '1'
AutoCreateKey = true
Expand Down
3 changes: 3 additions & 0 deletions testdata/scripts/node/validate/disk-based-logging.txtar
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,9 @@ CollectorTarget = ''
NodeID = ''
SamplingRatio = 0.0

[TxmAsService]
Enabled = false

[[EVM]]
ChainID = '1'
AutoCreateKey = true
Expand Down
3 changes: 3 additions & 0 deletions testdata/scripts/node/validate/invalid.txtar
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,9 @@ CollectorTarget = ''
NodeID = ''
SamplingRatio = 0.0

[TxmAsService]
Enabled = false

[[EVM]]
ChainID = '1'
AutoCreateKey = true
Expand Down
3 changes: 3 additions & 0 deletions testdata/scripts/node/validate/valid.txtar
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,9 @@ CollectorTarget = ''
NodeID = ''
SamplingRatio = 0.0

[TxmAsService]
Enabled = false

[[EVM]]
ChainID = '1'
AutoCreateKey = true
Expand Down
3 changes: 3 additions & 0 deletions testdata/scripts/node/validate/warnings.txtar
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,9 @@ CollectorTarget = ''
NodeID = ''
SamplingRatio = 0.0

[TxmAsService]
Enabled = false

# Configuration warning:
2 errors:
- P2P.V1: is deprecated and will be removed in a future version
Expand Down

0 comments on commit 565c9c3

Please sign in to comment.