github.com/MetalBlockchain/metalgo@v1.11.9/vms/avm/config.md (about)

     1  ---
     2  tags: [Nodes, AvalancheGo]
     3  description: Reference for all available X-chain config options and flags.
     4  pagination_label: X-Chain Configs
     5  sidebar_position: 2
     6  ---
     7  
     8  # X-Chain
     9  
    10  In order to specify a config for the X-Chain, a JSON config file should be
    11  placed at `{chain-config-dir}/X/config.json`.
    12  
    13  For example if `chain-config-dir` has the default value which is
    14  `$HOME/.avalanchego/configs/chains`, then `config.json` can be placed at
    15  `$HOME/.avalanchego/configs/chains/X/config.json`.
    16  
    17  This allows you to specify a config to be passed into the X-Chain. The default
    18  values for this config are:
    19  
    20  ```json
    21  {
    22    "index-transactions": false,
    23    "index-allow-incomplete": false,
    24    "checksums-enabled": false
    25  }
    26  ```
    27  
    28  Default values are overridden only if explicitly specified in the config.
    29  
    30  The parameters are as follows:
    31  
    32  ## Transaction Indexing
    33  
    34  ### `index-transactions`
    35  
    36  _Boolean_
    37  
    38  Enables AVM transaction indexing if set to `true`.
    39  When set to `true`, AVM transactions are indexed against the `address` and
    40  `assetID` involved. This data is available via `avm.getAddressTxs`
    41  [API](/reference/avalanchego/x-chain/api.md#avmgetaddresstxs).
    42  
    43  :::note
    44  If `index-transactions` is set to true, it must always be set to true
    45  for the node's lifetime. If set to `false` after having been set to `true`, the
    46  node will refuse to start unless `index-allow-incomplete` is also set to `true`
    47  (see below).
    48  :::
    49  
    50  ### `index-allow-incomplete`
    51  
    52  _Boolean_
    53  
    54  Allows incomplete indices. This config value is ignored if there is no X-Chain indexed data in the DB and
    55  `index-transactions` is set to `false`.
    56  
    57  ### `checksums-enabled`
    58  
    59  _Boolean_
    60  
    61  Enables checksums if set to `true`.