-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update flow rate parameter documentation #105
Conversation
📃CI ReportCompiling 157 files with Solc 0.8.19 Warning (9302): Return value of low-level calls not used. Analysing contracts... [PASS] test_RevertsIf_WithdrawWIMXCalledWithInsufficientAllowance() (gas: 61325) [PASS] test_grantRoles() (gas: 115752) [PASS] test_WithdrawWIMX_CallsAxelarGateway() (gas: 132226) [PASS] test_RevertsIf_WithdrawWIMXToCalledWithInsufficientAllowance() (gas: 61742) [PASS] testActivateWithdrawalQueue() (gas: 30078) [PASS] test_grantRoles() (gas: 116081) [PASS] test_WithdrawWIMXToWithDifferentAccount_CallsAxelarGateway() (gas: 132535) [PASS] test_ChildTokenMap() (gas: 401572) [PASS] testFuzz_Burn(address,uint256,uint256) (runs: 256, μ: 77295, ~: 77295) [PASS] testFuzz_RateLimit(address,uint256,uint256) (runs: 256, μ: 118944, ~: 118944) [PASS] testUpdateFlowRateBucketAfterEmpty() (gas: 81196) [PASS] testUnWithdrawalQueueActivated() (gas: 7925) [PASS] testInitWithdrawalQueue() (gas: 36361) [PASS] testAlreadyProcessed() (gas: 109910) [PASS] testEmptyFindPendingWithdrawals() (gas: 26476) [FAIL. Reason: setup failed: vm.createFork: Could not instantiate forked environment with fork url: http://127.0.0.1:8500] setUp() (gas: 0) [PASS] testFuzz_Execute(bytes32,bytes) (runs: 256, μ: 53049, ~: 52632) [PASS] testFuzz_sendMessage_PaysGasToGasService(uint256) (runs: 256, μ: 63853, ~: 63853) [PASS] test_RevertIf_WithdrawWithNoGas() (gas: 22956) [PASS] test_WithdrawETH_CallsAxelarGateway() (gas: 114075) [PASS] test_WithdrawETHToWithDifferentAccount_CallsAxelarGateway() (gas: 114550) [PASS] test_WithdrawIMX_CallsAxelarGateway() (gas: 90568) [PASS] test_RevertIf_WithdrawToCalledWithNoGas() (gas: 25486) [PASS] test_withdrawIMXToWithDifferentAccount_CallsAxelarGateway() (gas: 91020) [PASS] test_RevertsIf_WithdrawCalledWithAChildTokenThatHasWrongBridge() (gas: 40679) [PASS] test_RevertsIf_WithdrawETHCalledWithZeroFee() (gas: 18397) [PASS] testFuzz_Execute(bytes32,bytes) (runs: 256, μ: 53093, ~: 52676) [PASS] test_RevertsIf_WithdrawETHToCalledWithZeroFee() (gas: 18859) [PASS] test_RevertIf_WithdrawIMXCalledWithZeroFee() (gas: 16262) [PASS] test_RevertIf_withdrawIMXToZeroAmountIsProvided() (gas: 23557) [PASS] test_RevertsIf_MessageWithEmptyData() (gas: 45591) [PASS] test_RevertsIf_WithdrawToCalledWithAChildTokenThatHasWrongBridge() (gas: 41136) [PASS] test_BurnSuccess() (gas: 65365) [PASS] test_InitialState() (gas: 17612) [PASS] test_RevertsIf_OnMessageReceiveWithInvalidSignature() (gas: 21321) [PASS] testFuzz_sendMessage_PaysGasToGasService(uint256) (runs: 256, μ: 77852, ~: 77852) [PASS] test_Initialize() (gas: 52462) [FAIL. Reason: vm.envString: environment variable "DEPLOYMENTS" not found] setUp() (gas: 0) [PASS] test_depositETHCallsAxelarServices() (gas: 119662) [PASS] testActivateWithdrawalQueue() (gas: 37812) [PASS] testFuzz_mapToken_UpdatesEthBalance(uint256) (runs: 256, μ: 86923, ~: 86923) [PASS] testFuzz_Approve(address,address,uint256) (runs: 256, μ: 39340, ~: 39807) [PASS] testFuzz_DepositERC20(address,address,address,uint256) (runs: 256, μ: 464454, ~: 464454) [PASS] testFuzz_DepositERC20(address,address,uint256,uint256,uint256) (runs: 256, μ: 3275452, ~: 3275490) Ran 44 test suites in 9.11s (24.78s CPU time): 551 tests passed, 2 failed, 0 skipped (553 total tests) Failing tests: [FAIL. Reason: setup failed: vm.createFork: Could not instantiate forked environment with fork url: http://127.0.0.1:8500] setUp() (gas: 0) Encountered a total of 2 failing tests, 551 tests succeeded For a full HTML report run: |
The source of truth for the bridge's flow rate parameters is the L1 bridge contract. This PR replaces the outdated flow rate parameters documented in the README with a brief guide on how to query these parameters from the contracts.