Skip to main content

Postman configuration reference

Advanced options

These are environment variables for Postman deployments. Their presence does not indicate that changing them is recommended or supported for every deployment. Verify their applicability against the relevant release and deployment guidance. Secret and endpoint variables (RPC URLs, private keys, contract addresses, database passwords, signer endpoints) are listed by name only, never with live values.

Defaults

Defaults are literal fallbacks defined in the Postman source (envLoader.ts). Placeholders such as empty strings or 0x are omitted from the Default column. These are not recommended production settings and may be overridden by deployment configuration. .env / .env.sample files are never used as the source of defaults.

This reference lists Postman environment variables, grouped by section. Variable names and defaults come from envLoader.ts; descriptions and types come from Zod .describe() on schema.ts.

Generated from LFDT-Lineth/lineth-monorepo@c9e78f3.

Env vars may differ in other Postman releases.

General​

Env varDescriptionDefaultTypeRequired
L1_L2_AUTO_CLAIM_ENABLEDWhen true, automatically claim L1→L2 messagesfalsebooleanrequired
L2_L1_AUTO_CLAIM_ENABLEDWhen true, automatically claim L2→L1 messagesfalsebooleanrequired
LOG_LEVELLog level for the Winston loggerinfostringoptional

L1 network​

Env varDescriptionDefaultTypeRequired
L1_CONTRACT_ADDRESSAddress of the message service contract on this network—addressrequired
L1_L2_CALLDATA_ENABLEDWhen true, process and claim messages that carry calldatafalsebooleanoptional
L1_L2_EOA_ENABLEDWhen true, process and claim EOA (empty calldata) messagesfalsebooleanoptional
L1_RPC_URLJSON-RPC endpoint URL for the network node—string (url)required

L2 network​

Env varDescriptionDefaultTypeRequired
ENABLE_LINEA_ESTIMATE_GASWhen true, use Linea's linea_estimateGas endpoint for L2 gas fee estimationfalsebooleanoptional
L2_CONTRACT_ADDRESSAddress of the message service contract on this network—addressrequired
L2_L1_CALLDATA_ENABLEDWhen true, process and claim messages that carry calldatafalsebooleanoptional
L2_L1_EOA_ENABLEDWhen true, process and claim EOA (empty calldata) messagesfalsebooleanoptional
L2_MESSAGE_TREE_DEPTHDepth of the L2 message Merkle tree—number (positive)optional
L2_RPC_URLJSON-RPC endpoint URL for the network node—string (url)required

Listener​

Env varDescriptionDefaultTypeRequired
L1_EVENT_FILTER_CALLDATAFiltrex expression used to filter MessageSent events by decoded calldata—stringoptional; requires both CALLDATA and CALLDATA_FUNCTION_INTERFACE
L1_EVENT_FILTER_CALLDATA_FUNCTION_INTERFACESolidity function interface used to decode calldata (e.g. "function transfer(address to, uint256 amount)")—stringoptional; requires both CALLDATA and CALLDATA_FUNCTION_INTERFACE
L1_EVENT_FILTER_FROM_ADDRESSOnly process MessageSent events with this from address—addressoptional; eventFilters object included only when any filter is set
L1_EVENT_FILTER_TO_ADDRESSOnly process MessageSent events with this to address—addressoptional; eventFilters object included only when any filter is set
L1_LISTENER_BLOCK_CONFIRMATIONNumber of block confirmations required before processing an event—number (nonnegative)optional; included only when parseInt(value) >= 0
L1_LISTENER_INITIAL_FROM_BLOCKStarting block for event listening (-1 = latest/resume from DB, 0 = genesis, or a specific block number)—numberoptional; included only when parseInt(value) >= 0
L1_LISTENER_INTERVALInterval in ms between block/event polling cycles—number (positive)optional
L1_LISTENER_RECEIPT_POLLING_INTERVALInterval in ms between transaction receipt polling attempts—number (positive)optional
L1_MAX_BLOCKS_TO_FETCH_LOGSMaximum number of blocks to request logs for in a single eth_getLogs call—number (positive)optional
L2_EVENT_FILTER_CALLDATAFiltrex expression used to filter MessageSent events by decoded calldata—stringoptional; requires both CALLDATA and CALLDATA_FUNCTION_INTERFACE
L2_EVENT_FILTER_CALLDATA_FUNCTION_INTERFACESolidity function interface used to decode calldata (e.g. "function transfer(address to, uint256 amount)")—stringoptional; requires both CALLDATA and CALLDATA_FUNCTION_INTERFACE
L2_EVENT_FILTER_FROM_ADDRESSOnly process MessageSent events with this from address—addressoptional; eventFilters object included only when any filter is set
L2_EVENT_FILTER_TO_ADDRESSOnly process MessageSent events with this to address—addressoptional; eventFilters object included only when any filter is set
L2_LISTENER_BLOCK_CONFIRMATIONNumber of block confirmations required before processing an event—number (nonnegative)optional; included only when parseInt(value) >= 0
L2_LISTENER_INITIAL_FROM_BLOCKStarting block for event listening (-1 = latest/resume from DB, 0 = genesis, or a specific block number)—numberoptional; included only when parseInt(value) >= 0
L2_LISTENER_INTERVALInterval in ms between block/event polling cycles—number (positive)optional
L2_LISTENER_RECEIPT_POLLING_INTERVALInterval in ms between transaction receipt polling attempts—number (positive)optional
L2_MAX_BLOCKS_TO_FETCH_LOGSMaximum number of blocks to request logs for in a single eth_getLogs call—number (positive)optional
MAX_FETCH_MESSAGES_FROM_DBMaximum number of messages to fetch from the database per batch—number (positive)optional

Claiming​

Env varDescriptionDefaultTypeRequired
GAS_ESTIMATION_PERCENTILEPercentile (0–100) used when estimating gas fees from recent blocks—number (min 0, max 100)optional
L1_CLAIM_VIA_ADDRESSOptional proxy/router address to call when submitting claim transactions—addressoptional
L1_L2_ENABLE_POSTMAN_SPONSORINGWhen true, the Postman sponsors gas for eligible zero-fee claim transactionsfalsebooleanoptional
L1_MAX_GAS_FEE_ENFORCEDWhen true, reject claims whose estimated fee exceeds maxFeePerGasCapfalsebooleanoptional
L2_CLAIM_VIA_ADDRESSOptional proxy/router address to call when submitting claim transactions—addressoptional
L2_L1_ENABLE_POSTMAN_SPONSORINGWhen true, the Postman sponsors gas for eligible zero-fee claim transactionsfalsebooleanoptional
L2_MAX_GAS_FEE_ENFORCEDWhen true, reject claims whose estimated fee exceeds maxFeePerGasCapfalsebooleanoptional
MAX_BUMPS_PER_CYCLEMaximum number of gas-fee bumps allowed within a single retry cycle—number (nonnegative)optional
MAX_CLAIM_GAS_LIMITMaximum gas limit allowed for a claim transaction—bigint (positive)optional
MAX_FEE_PER_GAS_CAPMaximum maxFeePerGas (wei) allowed for claim transactions—bigint (positive)optional
MAX_NONCE_DIFFMaximum allowed difference between the database nonce and the on-chain nonce—number (positive)optional
MAX_NUMBER_OF_RETRIESMaximum number of claim submission retries before giving up a cycle—number (nonnegative)optional
MAX_POSTMAN_SPONSOR_GAS_LIMITMaximum gas limit for Postman-sponsored claim transactions—bigint (positive)optional
MAX_RETRY_CYCLESMaximum number of full claim retry cycles before marking the message as failed—number (nonnegative)optional
MESSAGE_SUBMISSION_TIMEOUTTimeout in ms waiting for a submitted claim transaction to be mined—number (positive)optional
PROFIT_MARGINMinimum profit margin required before claiming a fee-paying message—number (nonnegative)optional
RETRY_DELAY_IN_SECONDSDelay in seconds between claim retry attempts—number (positive)optional

Signer​

Env varDescriptionDefaultTypeRequired
L1_AWS_KMS_KEY_IDAWS KMS key ID or ARN used for signing—stringoptional; used when L1_SIGNER_TYPE is "aws-kms"
L1_AWS_KMS_REGIONAWS region of the KMS key (falls back to default SDK region)—stringoptional; included only when set (aws-kms)
L1_SIGNER_PRIVATE_KEYHex-encoded 32-byte private key used to sign transactions—hex private key (32 bytes)optional; used when L1_SIGNER_TYPE is "private-key"
L1_SIGNER_TYPESigner backend type: "private-key" (local key), "web3signer" (remote), or "aws-kms"private-keystring (private-key|web3signer|aws-kms)required; allowed: private-key|web3signer|aws-kms
L1_WEB3_SIGNER_ENDPOINTWeb3Signer HTTP(S) endpoint URL—stringoptional; used when L1_SIGNER_TYPE is "web3signer"
L1_WEB3_SIGNER_PUBLIC_KEYPublic key of the Web3Signer signing account—hex stringoptional; used when L1_SIGNER_TYPE is "web3signer"
L1_WEB3_SIGNER_TLS_KEYSTORE_PASSWORDPassword for the Web3Signer client keystore—stringoptional; included with TLS object
L1_WEB3_SIGNER_TLS_KEYSTORE_PATHPath to the PKCS12 client keystore used for mTLS with Web3Signer—stringoptional; TLS object included only when this path is set
L1_WEB3_SIGNER_TLS_TRUSTSTORE_PASSWORDPassword for the Web3Signer truststore—stringoptional; included with TLS object
L1_WEB3_SIGNER_TLS_TRUSTSTORE_PATHPath to the PKCS12 truststore used to verify the Web3Signer server—stringoptional; included with TLS object
L2_AWS_KMS_KEY_IDAWS KMS key ID or ARN used for signing—stringoptional; used when L2_SIGNER_TYPE is "aws-kms"
L2_AWS_KMS_REGIONAWS region of the KMS key (falls back to default SDK region)—stringoptional; included only when set (aws-kms)
L2_SIGNER_PRIVATE_KEYHex-encoded 32-byte private key used to sign transactions—hex private key (32 bytes)optional; used when L2_SIGNER_TYPE is "private-key"
L2_SIGNER_TYPESigner backend type: "private-key" (local key), "web3signer" (remote), or "aws-kms"private-keystring (private-key|web3signer|aws-kms)required; allowed: private-key|web3signer|aws-kms
L2_WEB3_SIGNER_ENDPOINTWeb3Signer HTTP(S) endpoint URL—stringoptional; used when L2_SIGNER_TYPE is "web3signer"
L2_WEB3_SIGNER_PUBLIC_KEYPublic key of the Web3Signer signing account—hex stringoptional; used when L2_SIGNER_TYPE is "web3signer"
L2_WEB3_SIGNER_TLS_KEYSTORE_PASSWORDPassword for the Web3Signer client keystore—stringoptional; included with TLS object
L2_WEB3_SIGNER_TLS_KEYSTORE_PATHPath to the PKCS12 client keystore used for mTLS with Web3Signer—stringoptional; TLS object included only when this path is set
L2_WEB3_SIGNER_TLS_TRUSTSTORE_PASSWORDPassword for the Web3Signer truststore—stringoptional; included with TLS object
L2_WEB3_SIGNER_TLS_TRUSTSTORE_PATHPath to the PKCS12 truststore used to verify the Web3Signer server—stringoptional; included with TLS object

Database​

Env varDescriptionDefaultTypeRequired
POSTGRES_DBpostman_dboptional
POSTGRES_HOST—optional
POSTGRES_PASSWORD—optional
POSTGRES_PORT5432numberoptional
POSTGRES_SSLfalsebooleanoptional; when "true", ssl object is included
POSTGRES_SSL_CA_PATH—optional; only when POSTGRES_SSL=true
POSTGRES_SSL_REJECT_UNAUTHORIZEDfalsebooleanoptional; only when POSTGRES_SSL=true
POSTGRES_USER—optional

Database cleaner​

Env varDescriptionDefaultTypeRequired
DB_CLEANER_ENABLEDWhen true, periodically delete old claimed/finalized messages from the databasefalsebooleanrequired
DB_CLEANING_INTERVALInterval in ms between database cleaning runs—number (positive)optional
DB_DAYS_BEFORE_NOW_TO_DELETERetain finalized messages for this many days before deleting them—number (positive)optional

API​

Env varDescriptionDefaultTypeRequired
API_PORTTCP port for the Express API exposing metrics and health endpoints—number (int, positive, max 65535)optional

Was this page helpful?