-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test: add additional hbar limiter tests (#2697)
* test: add additional hbar limiter tests Signed-off-by: georgi-l95 <[email protected]> * chore: remove duplicate variable Signed-off-by: georgi-l95 <[email protected]> * chore: update tests after merge from main Signed-off-by: Victor Yanev <[email protected]> * chore: move hbar limiter tests to separate job Signed-off-by: Victor Yanev <[email protected]> * chore: small fix Signed-off-by: Victor Yanev <[email protected]> * chore: small fix Signed-off-by: Victor Yanev <[email protected]> * chore: do not restart relay and create accounts if `!global.relayIsLocal` Signed-off-by: Victor Yanev <[email protected]> * chore: fix tests Signed-off-by: Victor Yanev <[email protected]> * chore: fix tests Signed-off-by: Victor Yanev <[email protected]> * chore: restore rateLimiter tests to be the same as before Signed-off-by: Victor Yanev <[email protected]> * test: improved assertions to compare the cost of the transaction and the remaining hbar limiter balanace Signed-off-by: Victor Yanev <[email protected]> * test: adjust expected costs Signed-off-by: Victor Yanev <[email protected]> * test: add `needs: hbarlimiter` to `publish_results` Signed-off-by: Victor Yanev <[email protected]> * test: change delta to 0.1% tolerance Signed-off-by: Victor Yanev <[email protected]> * test: extract common logic for checking remaining hbar limit Signed-off-by: Victor Yanev <[email protected]> --------- Signed-off-by: georgi-l95 <[email protected]> Signed-off-by: Victor Yanev <[email protected]> Co-authored-by: Victor Yanev <[email protected]>
- Loading branch information
1 parent
f0d94f5
commit 33aecca
Showing
10 changed files
with
1,193 additions
and
162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| /*- | ||
| * | ||
| * Hedera JSON RPC Relay | ||
| * | ||
| * Copyright (C) 2024 Hedera Hashgraph, LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| import { predefined } from '@hashgraph/json-rpc-relay'; | ||
| import { BaseContract, ethers } from 'ethers'; | ||
| import { expect } from 'chai'; | ||
|
|
||
| // Local resources | ||
| import { Utils } from '../helpers/utils'; | ||
| import { AliasAccount } from '../types/AliasAccount'; | ||
| import Assertions from '../helpers/assertions'; | ||
| import testConstants from '../helpers/constants'; | ||
|
|
||
| // Contracts used in tests | ||
| import parentContractJson from '../contracts/Parent.json'; | ||
| import EstimateGasContract from '../contracts/EstimateGasContract.json'; | ||
| import largeContractJson from '../contracts/hbarLimiterContracts/largeSizeContract.json'; | ||
| import mediumSizeContract from '../contracts/hbarLimiterContracts/mediumSizeContract.json'; | ||
|
|
||
| describe('@hbarlimiter HBAR Limiter Acceptance Tests', function () { | ||
| // @ts-ignore | ||
| const { mirrorNode, relay, logger, initialBalance, metrics, relayIsLocal } = global; | ||
|
|
||
| // The following tests exhaust the hbar limit, so they should only be run against a local relay | ||
| if (relayIsLocal) { | ||
| const deployContract = async (contractJson: any, wallet: ethers.Wallet): Promise<ethers.Contract> => { | ||
| const contract = await Utils.deployContract(contractJson.abi, contractJson.bytecode, wallet); | ||
| expect(contract).to.be.instanceOf(BaseContract); | ||
| await contract.waitForDeployment(); | ||
| expect(contract.target).to.not.be.null; | ||
| return contract; | ||
| }; | ||
|
|
||
| const verifyRemainingLimit = (expectedCost: number, remainingHbarsBefore: number, remainingHbarsAfter: number) => { | ||
| const delta = 0.001 * expectedCost; // 0.1% tolerance | ||
| global.logger.trace(`Expected cost: ${expectedCost} ±${delta}`); | ||
| global.logger.trace(`Actual cost: ${remainingHbarsBefore - remainingHbarsAfter}`); | ||
| expect(remainingHbarsAfter).to.be.approximately(remainingHbarsBefore - expectedCost, delta); | ||
| }; | ||
|
|
||
| describe('HBAR Rate Limit Tests', function () { | ||
| this.timeout(480 * 1000); // 480 seconds | ||
|
|
||
| const accounts: AliasAccount[] = []; | ||
| const defaultLondonTransactionData = { | ||
| value: Utils.add0xPrefix(Utils.toHex(ethers.parseUnits('1', 10))), // 1 tinybar | ||
| chainId: Number(process.env.CHAIN_ID || 0), | ||
| maxPriorityFeePerGas: Assertions.defaultGasPrice, | ||
| maxFeePerGas: Assertions.defaultGasPrice, | ||
| gasLimit: 3_000_000, | ||
| type: 2, | ||
| }; | ||
|
|
||
| // cached entities | ||
| let requestId: string; | ||
| let requestIdPrefix: string; | ||
|
|
||
| before(async function () { | ||
| // Restart the relay to reset the limits | ||
| await global.restartLocalRelay(); | ||
|
|
||
| requestId = Utils.generateRequestId(); | ||
| requestIdPrefix = Utils.formatRequestIdMessage(requestId); | ||
|
|
||
| logger.info(`${requestIdPrefix} Creating accounts`); | ||
| logger.info(`${requestIdPrefix} HBAR_RATE_LIMIT_TINYBAR: ${process.env.HBAR_RATE_LIMIT_TINYBAR}`); | ||
|
|
||
| const initialAccount: AliasAccount = global.accounts[0]; | ||
|
|
||
| const neededAccounts: number = 2; | ||
| accounts.push( | ||
| ...(await Utils.createMultipleAliasAccounts( | ||
| mirrorNode, | ||
| initialAccount, | ||
| neededAccounts, | ||
| initialBalance, | ||
| requestId, | ||
| )), | ||
| ); | ||
| global.accounts.push(...accounts); | ||
| }); | ||
|
|
||
| beforeEach(async function () { | ||
| requestId = Utils.generateRequestId(); | ||
| requestIdPrefix = Utils.formatRequestIdMessage(requestId); | ||
| }); | ||
|
|
||
| it('should execute "eth_sendRawTransaction" without triggering HBAR rate limit exceeded', async function () { | ||
| const parentContract = await deployContract(parentContractJson, accounts[0].wallet); | ||
| const parentContractAddress = parentContract.target as string; | ||
| global.logger.trace(`${requestIdPrefix} Deploy parent contract on address ${parentContractAddress}`); | ||
|
|
||
| const gasPrice = await relay.gasPrice(requestId); | ||
| const remainingHbarsBefore = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
|
|
||
| const transaction = { | ||
| ...defaultLondonTransactionData, | ||
| to: parentContractAddress, | ||
| nonce: await relay.getAccountNonce(accounts[1].address, requestId), | ||
| maxPriorityFeePerGas: gasPrice, | ||
| maxFeePerGas: gasPrice, | ||
| }; | ||
| const signedTx = await accounts[1].wallet.signTransaction(transaction); | ||
|
|
||
| await expect(relay.call(testConstants.ETH_ENDPOINTS.ETH_SEND_RAW_TRANSACTION, [signedTx], requestId)).to.be | ||
| .fulfilled; | ||
|
|
||
| const remainingHbarsAfter = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
| const expectedCost = 215132838; | ||
| verifyRemainingLimit(expectedCost, remainingHbarsBefore, remainingHbarsAfter); | ||
| }); | ||
|
|
||
| it('should deploy a large contract and decrease remaining HBAR in limiter when transaction data is large', async function () { | ||
| const remainingHbarsBefore = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
| expect(remainingHbarsBefore).to.be.gt(0); | ||
|
|
||
| await deployContract(largeContractJson, accounts[0].wallet); | ||
|
|
||
| const remainingHbarsAfter = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
| const expectedCost = 601829911; | ||
| verifyRemainingLimit(expectedCost, remainingHbarsBefore, remainingHbarsAfter); | ||
| }); | ||
|
|
||
| it('should be able to deploy a contract without creating file', async function () { | ||
| const remainingHbarsBefore = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
| expect(remainingHbarsBefore).to.be.gt(0); | ||
|
|
||
| // This flow should not spend any hbars from the operator, as it's fully paid by the signer | ||
| await deployContract(EstimateGasContract, accounts[0].wallet); | ||
|
|
||
| const remainingHbarsAfter = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
| const expectedCost = 97143770; | ||
| verifyRemainingLimit(expectedCost, remainingHbarsBefore, remainingHbarsAfter); | ||
| }); | ||
|
|
||
| it('should be able to deploy a medium size contract with fileCreate', async function () { | ||
| const remainingHbarsBefore = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
| expect(remainingHbarsBefore).to.be.gt(0); | ||
|
|
||
| // This flow should spend hbars from the operator, for fileCreate | ||
| await deployContract(mediumSizeContract, accounts[0].wallet); | ||
|
|
||
| const remainingHbarsAfter = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
| const expectedCost = 354819247; | ||
| verifyRemainingLimit(expectedCost, remainingHbarsBefore, remainingHbarsAfter); | ||
| }); | ||
|
|
||
| it('multiple deployments of large contracts should eventually exhaust the remaining hbar limit', async function () { | ||
| const remainingHbarsBefore = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
| expect(remainingHbarsBefore).to.be.gt(0); | ||
| try { | ||
| for (let i = 0; i < 50; i++) { | ||
| await deployContract(largeContractJson, accounts[0].wallet); | ||
| } | ||
| expect.fail(`Expected an error but nothing was thrown`); | ||
| } catch (e: any) { | ||
| expect(e.message).to.contain(predefined.HBAR_RATE_LIMIT_EXCEEDED.message); | ||
| } | ||
|
|
||
| const remainingHbarsAfter = Number(await metrics.get(testConstants.METRICS.REMAINING_HBAR_LIMIT)); | ||
| expect(remainingHbarsAfter).to.be.lte(0); | ||
| }); | ||
| }); | ||
| } | ||
| }); |
Oops, something went wrong.