Documentation

Configuration

Basics

The paymaster supports 3 types of configurations, command-line arguments, environment variables and JSON profile. You can configure everything using a single method, or combine them.

👍

Tip

We suggest to combine these methods using the following guidelines

  • Define all non-sensitive values in a JSON profile file
  • Use environment variables for sensitive values (ex. relayer private key)
  • Use command-line arguments primarily for testing and overrides

The final configuration is built by merging the outputs of all methods, using the following precedence order:

TypePriority
Command-Line Arguments1
Environment Variables2
JSON Profile3

A good approach to configure the Paymaster is to start from the Quick setup or Setup configuration and change the parameters according to your need.

📘

Note

The rule for naming environment variables and argument is the following. Consider a JSON value store under the path foo_1.foo_2.foo_3 then we get the following (using underscore as separator)

  • Environment: PAYMASTER_FOO_1_FOO_2_FOO_3
  • Command Line Argument: --foo_1_foo_2_foo_3