Network Settings Free Query

[DSMatusevich]

• hip: <HIP number (this is determined by the HIP editor)>
• title: Network Settings Free Query
• author: David S Matusevich (davidmatusevich@swirlds.com), Patrick Staton (), Simi Hunjan (simi@hedera.com)
• type: Standards Track
• category: Service
• status: Draft
• created: 03/15/2022
• discussions-to:
• updated:
• requires:
• replaces:
• superseded-by:

Abstract

Proposal to add a new free query that returns the current network settings.

Motivation

When a network is deployed, several of its key attributes are kept in a properties file. These properties are set by the network operators. Different networks may have slightly different attributes.
For example, one such attribute, ledger.id is set to be 0 on Mainnet, 1 on Testnet and 2 on Previewnet. Other than performing an account info query, or some other paid query, there is no way for an user to find out what, if any is the ledger id of the network.
Another example is the ledger.autoRenewPeriod.maxDuration. In this case, no query (paid or otherwise) is available to the user to find out if an account's auto renew period is within the accepted limits.
Applications that interact with the network need access to these and other parameters, in order to properly build queries and transactions, which will have less chances of being rejected by the network as invalid.

Rationale

To solve this issue, we think that it would make sense for the services to add a new query, whose response contains those properties that the user might need in order to create valid transactions, and to properly interpret the responses. Furthermore, we believe that this query should be free to the user, since it would be describing critical parameters for his application.

User stories

As a developer, I want to know what parameters are used by the network to decide if my transactions and queries are valid. I would like to periodically query the network for these parameters in order to make sure that no changes have happened that might make my tool to fail to create valid transactions.

Specification

The list of properties that should be released as part of the response to the query:

# Static properties
hedera.realm=0
hedera.shard=0
ledger.id=0x03
ledger.numSystemAccounts=100
ledger.totalTinyBarFloat=5000000000000000000

# Dynamic properties

contracts.defaultLifetime=7890000
contracts.maxGas=5000000
contracts.maxRefundPercentOfGasLimit=20
contracts.frontendThrottleMaxGasLimit=5000000
contracts.consensusThrottleMaxGasLimit=15000000

hedera.transaction.maxMemoUtf8Bytes=100
hedera.transaction.maxValidDuration=180
hedera.transaction.minValidDuration=15

consensus.message.maxBytesAllowed=1024

ledger.autoRenewPeriod.maxDuration=8000001
ledger.autoRenewPeriod.minDuration=6999999
ledger.maxAccountNum=100000000
ledger.transfers.maxLen=10
ledger.tokenTransfers.maxLen=10
ledger.nftTransfers.maxLen=10
ledger.records.maxQueryableByAccount=180
ledger.schedule.txExpiryTimeSecs=1800

tokens.maxPerAccount=1000
tokens.maxSymbolUtf8Bytes=100
tokens.maxTokenNameUtf8Bytes=100
tokens.maxCustomFeesAllowed=10
tokens.maxCustomFeeDepth=2

tokens.nfts.maxMetadataBytes=100
tokens.nfts.maxBatchSizeBurn=10
tokens.nfts.maxBatchSizeWipe=10
tokens.nfts.maxBatchSizeMint=10
tokens.nfts.maxAllowedMints=5000000
tokens.nfts.maxQueryRange=100

Backwards Compatibility

Since this is a new query, there should be no backwards compatibility issues.

Security Implications

As with any free query, this leaves the door open for DDOS attacks. This might be mitigated in the same manner other free queries are handled.

How to Teach This

• Updated to the hedera-protobufs repository
• Hedera docs update
• Reviewed in Engineering Insights

Reference Implementation

N/A

Rejected Ideas

N/A

Open Issues

• Some parameters might be sensitive and should not be released to the public as part of the query.

References

Copyright/license

This document is licensed under the Apache License, Version 2.0 -- see LICENSE or (https://www.apache.org/licenses/LICENSE-2.0)