OverheadIGP.sol, deploy new IGPs, deploy ValidatorAnnounce #1572

tkporter · 2023-01-12T13:23:28Z

Description

Adds OverheadGasIgp (very open to better names here). This is what will serve as the "ISM-specific IGP". It lets an owner configure overhead gas amounts for destination domains, and for the IGP functions the OverheadGasIgp will just add the stored overhead gas amount to the provided _gasAmount and forward the call along to the inner IGP.
Moves the IGPs into their own dir
Deploy tooling for this will come separately with On-chain fee quoting: tooling for the default ISM-specific IGP #1299

Drive-by changes

None

Related issues

Fixes On-chain fee quoting: create ISM-specific IGP contract #1298

Backward compatibility

Are these changes backward compatible?

Yes

Are there any infrastructure implications, e.g. changes that would prohibit deploying older commits using this infra tooling?

None

Testing

What kind of testing have these changes undergone?

Unit Tests

… trevor/on-chain-fee-1-wei

…/abacus-monorepo into trevor/on-chain-fee-ism-igp

… trevor/on-chain-fee-ism-igp

yorhodes

great work! one question about the destination keys

solidity/contracts/igps/GasOverheadIgp.sol

solidity/test/igps/GasOverheadIgp.t.sol

yorhodes · 2023-01-13T00:28:34Z

see #1588 before responding to PR comments

* Instrument multisigIsm.verify gas costs * Add deployment tooling for IGP gas overhead * Include mailbox.process and max body in overhead * Restore multisig tests

… trevor/on-chain-fee-ism-igp

solidity/contracts/igps/OverheadIgp.sol

solidity/test/igps/OverheadIgp.t.sol

solidity/test/isms/multisigIsm.test.ts

solidity/test/lib/mailboxes.ts

typescript/sdk/src/core/contracts.ts

typescript/sdk/src/deploy/core/HyperlaneCoreDeployer.ts

… trevor/on-chain-fee-ism-igp

github-actions · 2023-01-24T12:54:30Z

Forge Coverage Report

Coverage after merging trevor/on-chain-fee-ism-igp into main will be

20.74%	▴ +6.14%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
../node_modules/@openzeppelin/contracts-upgradeable/access
OwnableUpgradeable.sol	85.71%	75%	85.71%	90%	67, 75
../node_modules/@openzeppelin/contracts-upgradeable/proxy/utils
Initializable.sol	0%	0%	0%	0%	145, 145, 145–146, 146, 146–148, 156, 163
../node_modules/@openzeppelin/contracts-upgradeable/token/ERC20
ERC20Upgradeable.sol	66%	54.55%	55%	74.14%	100, 187–189, 207–209, 209, 209, 211, 214, 236–237, 242, 265, 291, 296, 326–327, 56, 60–61, 68, 76, 93
../node_modules/@openzeppelin/contracts-upgradeable/utils
AddressUpgradeable.sol	0%	0%	0%	0%	100, 119, 134, 134, 134–136, 146, 160–161, 176, 176, 176–177, 177, 177, 180, 180, 180, 182, 184, 199, 199, 199–200, 202, 208, 208, 208, 216, 41, 61, 61, 61, 63–64, 64, 64, 86
ContextUpgradeable.sol	33.33%	100%	25%	50%	28
../node_modules/@openzeppelin/contracts/access
Ownable.sol	82.35%	75%	80%	87.50%	62, 70
../node_modules/@openzeppelin/contracts/proxy
Proxy.sol	0%	100%	0%	0%	59–60, 68
../node_modules/@openzeppelin/contracts/proxy/ERC1967
ERC1967Proxy.sol	0%	100%	0%	0%	30
ERC1967Upgrade.sol	0%	0%	0%	0%	117, 124, 124, 124–125, 134–135, 153, 160, 160, 160–161, 161, 161, 165, 179–181, 181, 181–182, 39, 46, 46, 46–47, 56–57, 70–71, 71, 71–72, 89, 89, 89–90, 92, 97
../node_modules/@openzeppelin/contracts/proxy/transparent
ProxyAdmin.sol	0%	0%	0%	0%	24–25, 25, 25–26, 39–40, 40, 40–41, 52, 63, 79
TransparentUpgradeableProxy.sol	0%	0%	0%	0%	107, 114, 121, 121, 121–122, 63, 76, 87, 96
../node_modules/@openzeppelin/contracts/utils
Address.sol	0%	0%	0%	0%	100, 119, 134, 134, 134–136, 146, 160–161, 171, 185–186, 201, 201, 201–202, 202, 202, 205, 205, 205, 207, 209, 224, 224, 224–225, 227, 233, 233, 233, 241, 41, 61, 61, 61, 63–64, 64, 64, 86
Context.sol	50%	100%	50%	50%	22
Create2.sol	0%	0%	0%	0%	35, 35, 35–36, 36, 36, 39, 41, 41, 41, 49, 80
StorageSlot.sol	0%	100%	0%	0%	55, 65, 75, 85
Strings.sol	0%	0%	0%	0%	20–22, 25, 28, 33–34, 34, 34, 36, 45, 53–58, 60, 60, 60–61, 68
../node_modules/@openzeppelin/contracts/utils/cryptography
ECDSA.sol	43.55%	28.57%	50%	47.37%	106–108, 121–123, 147–148, 153–154, 170–172, 198, 211, 24, 26, 26, 26–28, 28, 28–30, 30, 30–31, 56, 70
../node_modules/@openzeppelin/contracts/utils/math
Math.sol	0%	0%	0%	0%	102, 105, 108, 112, 117, 121–126, 132–133, 146–147, 147, 147–148, 150, 159, 159, 159–160, 173, 180–187, 196–197, 20, 206, 208, 208, 208–210, 212, 212, 212–214, 216, 216, 216–218, 220, 220, 220–222, 224, 224, 224–226, 228, 228, 228–230, 232, 232, 232–234, 236, 236, 236–237, 240, 249–250, 259, 261, 261, 261–263, 265, 265, 265–267, 269, 269, 269, 27, 270–271, 273, 273, 273–275, 277, 277, 277–279, 281, 281, 281–283, 285, 285, 285–286, 289, 298–299, 310, 312, 312, 312–314, 316, 316, 316–318, 320, 320, 320–322, 324, 324, 324–326, 328, 328, 328–329, 332, 341–342, 36, 47, 64–65, 68–69, 73, 73, 73–74, 78, 78, 78, 85, 88, 91–92, 99
../node_modules/@openzeppelin/contracts/utils/structs
EnumerableMap.sol	0%	0%	0%	0%	103, 117–118, 126–127, 127, 127–128, 130,

github-actions · 2023-01-24T12:54:33Z

Hardhat Coverage Report

Coverage after merging trevor/on-chain-fee-ism-igp into main will be

49.35%	▾ -8.50%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
solidity/contracts
Create2Factory.sol	0%	0%	0%	0%	101, 110, 110, 110, 112, 33, 58, 64–65, 65, 65, 77–78, 98, 98, 98
HyperlaneConnectionClient.sol	52.38%	50%	58.33%	50%	100–101, 131, 160, 160, 160, 164–165, 58, 76–77, 85–86, 98–99
Mailbox.sol	97.06%	100%	92.31%	97.56%	231
OwnableMulticall.sol	0%	100%	0%	0%	18, 22, 26
PausableReentrancyGuard.sol	95.65%	83.33%	100%	100%	30
Router.sol	85.71%	87.50%	78.57%	88.89%	111, 46, 53, 64
ValidatorAnnounce.sol	0%	0%	0%	0%	106–108, 110, 115, 55–56, 75, 78, 78, 78–79, 82, 84–85, 85, 85, 88, 88, 88–89, 91–93
solidity/contracts/igps
InterchainGasPaymaster.sol	85.19%	50%	100%	100%	101, 61, 66, 68
OverheadIgp.sol	0%	100%	0%	0%	102, 122, 130–131, 45, 65, 82–83
solidity/contracts/isms
MultisigIsm.sol	97.12%	86.36%	100%	100%	102, 155, 263
solidity/contracts/libs
Call.sol	0%	100%	0%	0%	13–18, 24–29, 39, 41–44, 48–50
EnumerableMapExtended.sol	53.33%	100%	57.14%	50%	45, 61, 69–70
Merkle.sol	97.14%	87.50%	100%	98.25%	30, 44
Message.sol	90.91%	100%	90.91%	90.91%	109
MinimalProxy.sol	0%	100%	0%	0%	14
MultisigIsmMetadata.sol	100%	100%	100%	100%
TypeCasts.sol	44.44%	100%	66.67%	33.33%	11–13, 17
ValidatorAnnouncements.sol	0%	100%	0%	0%	23, 30
solidity/contracts/middleware
InterchainAccountRouter.sol	0%	0%	0%	0%	107, 120–122, 122, 122–126, 128, 142, 155, 168, 172, 40, 42–43, 59, 76, 91–93
InterchainQueryRouter.sol	0%	0%	0%	0%	105–109, 122, 122, 122, 126, 130, 143–144, 144, 144–145, 154–157, 157–158, 162–163, 65, 87–91
solidity/contracts/middleware/liquidity-layer
LiquidityLayerRouter.sol	0%	0%	0%	0%	103, 108, 116, 116, 116–117, 131–132, 140, 142, 142, 142, 34, 50, 55, 55, 55, 63, 71, 81, 91
solidity/contracts/middleware/liquidity-layer/adapters
CircleBridgeAdapter.sol	0%	0%	0%	0%	100, 100, 100, 107, 107, 107, 112, 119–120, 131, 135, 141–142, 142, 142, 147–148, 148, 148, 157, 157, 157, 159, 169, 176, 178, 185, 185, 185, 191–192, 192, 192, 194–195, 195, 195, 200–201, 203, 211–212, 212, 212, 214–215, 215, 215, 221–222, 224, 239, 58, 58, 58–59, 75, 77–78, 81, 90–91, 91, 91, 96, 99
PortalAdapter.sol	0%	0%	0%	0%	102, 114–115, 132, 134, 138, 138, 138, 143, 149, 149, 149–150, 159, 161, 166, 172, 180, 192, 199, 201, 214, 52, 52, 52–53, 69, 71–73, 88–89, 93, 97, 97, 97
solidity/contracts/middleware/liquidity-layer/interfaces
ILiquidityLayerAdapter.sol	100%	100%	100%	100%
solidity/contracts/middleware/liquidity-layer/interfaces/circle
ICircleMessageTransmitter.sol	100%	100%	100%	100%
ITokenMessenger.sol	100%	100%	100%	100%
solidity/contracts/middleware/liquidity-layer/interfaces/portal
IPortalTokenBridge.sol	100%	100%	100%	100%
solidity/contracts/mock
MockCircleMessageTransmitter.sol	0%	100%	0%	0%	12, 20, 28, 36–37, 41
MockCircleTokenMessenger.sol	0%	0%	0%	0%	12, 21–23, 23, 23–25, 35–36
MockHyperlaneEnvironment.sol	0%	100%	0%	0%	21–22, 24–25, 27–28, 30–31, 33–34, 36–37, 39–40, 42–43, 49, 56, 60, 65–66, 70, 74
MockMailbox.sol	94.74%	50%	100%	100%	41
MockPortalBridge.sol	0%	100%	0%	0%	13, 24–27, 31, 35, 42, 47, 49, 61, 65–66, 74, 87
MockToken.sol	0%	100%	0%	0%	12, 8
solidity/contracts/upgrade
ProxyAdmin.sol	100%	100%	100%	100%
TransparentUpgradeableProxy.sol	100%	100%	100%	100%
Versioned.sol	100%	100%	100%	100%

tkporter added 15 commits January 9, 2023 13:41

IGP charges 1 wei

805580f

Don't pay for gas in LiquidityLayerRouter

9a93683

yarn gas

a92a5bf

Merge branch 'main' of github.com:abacus-network/abacus-monorepo into…

60c489b

… trevor/on-chain-fee-1-wei

Merge branch 'main' of github.com:abacus-network/abacus-monorepo into…

9326b37

… trevor/on-chain-fee-1-wei

Merge branch 'main' of github.com:abacus-network/abacus-monorepo into…

a0d55de

… trevor/on-chain-fee-1-wei

Add GasOverheadIgp

74f7d79

Merge branch 'main' of github.com:abacus-network/abacus-monorepo into…

e4fcd1a

… trevor/on-chain-fee-1-wei

Remove compiler silencing

8fe08f8

yarn gas

9e704e7

Merge branch 'trevor/on-chain-fee-1-wei' of github.com:abacus-network…

7d0e39d

…/abacus-monorepo into trevor/on-chain-fee-ism-igp

Shift around some fns

2345d9e

Merge branch 'main' of github.com:abacus-network/abacus-monorepo into…

14b3b90

… trevor/on-chain-fee-ism-igp

nit var name

fc3787c

nit

3863d9f

tkporter requested a review from yorhodes January 12, 2023 13:23

tkporter mentioned this pull request Jan 12, 2023

On-chain fee quoting: tooling for the default ISM-specific IGP #1299

Closed

yorhodes reviewed Jan 12, 2023

View reviewed changes

yorhodes and others added 10 commits January 18, 2023 11:38

Configure gas overhead IGP (#1588)

5546465

* Instrument multisigIsm.verify gas costs * Add deployment tooling for IGP gas overhead * Include mailbox.process and max body in overhead * Restore multisig tests

GasOverheadIgp -> OverheadIgp, fix infra build

cbd8949

Prettier, change some infra / deploy tooling

51d47e6

run yarn hyperlane

60eea80

yarn gas

adb0911

Merge branch 'main' of github.com:abacus-network/abacus-monorepo into…

b21a619

… trevor/on-chain-fee-ism-igp

yarn gas, update test contracts

d2ae1c1

rm OwnableUpgradeable for Overhead ISM

061fc5c

Move gas instrumentation into its own describe

1988879

back to TestRecipient__factory for normal verify tests

c9c1732

yorhodes reviewed Jan 20, 2023

View reviewed changes

tkporter added 10 commits January 20, 2023 16:43

New submodule commits

9bf3303

deploy test

bf5dee4

BaseInterchainGasPaymaster -> InterchainGasPaymaster

c41247a

trying to deploy

4ffde11

Deploying with deployerOwnedProxyAdmin

5ff7c32

Deployed to testnet3

0a5dc85

Cleaning up

8ae69ab

cleaning up

71ecfd8

clean

a0bfb6d

Fix tests

9adcdcc

tkporter mentioned this pull request Jan 23, 2023

Update InterchainGasCalculator with on chain fee quoting #1645

Merged

tkporter added 4 commits January 23, 2023 13:56

revert infra/package.json

0fc9105

clean up verification.json

c335873

Update yarn.lock

d67e410

Fix lint

278fadc

yorhodes approved these changes Jan 23, 2023

View reviewed changes

tkporter added 5 commits January 24, 2023 11:11

Changing logic around deployerOwnedProxyAdmin

775e990

Deploy mainnet

8597a9d

Redeploy testnet with new salt versions

ed7ce09

Merge branch 'main' of github.com:abacus-network/abacus-monorepo into…

3fef80f

… trevor/on-chain-fee-ism-igp

nit

a835f8f

tkporter changed the title ~~IGP "proxy" that adds configured overhead gas amounts~~ OverheadIGP.sol, deploy new IGPs, deploy ValidatorAnnounce Jan 24, 2023

tkporter enabled auto-merge (squash) January 24, 2023 12:47

tkporter merged commit bf9d0ae into main Jan 24, 2023

tkporter deleted the trevor/on-chain-fee-ism-igp branch January 24, 2023 14:40

tkporter mentioned this pull request Jan 24, 2023

Deploy OverheadIGP for the default MultisigIsm and new base IGP #1600

Closed

yorhodes mentioned this pull request Feb 8, 2023

main auditv2 merge #1782

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OverheadIGP.sol, deploy new IGPs, deploy ValidatorAnnounce #1572

OverheadIGP.sol, deploy new IGPs, deploy ValidatorAnnounce #1572

tkporter commented Jan 12, 2023

yorhodes left a comment •

edited

Loading

yorhodes commented Jan 13, 2023

github-actions bot commented Jan 24, 2023

github-actions bot commented Jan 24, 2023

OverheadIGP.sol, deploy new IGPs, deploy ValidatorAnnounce #1572

OverheadIGP.sol, deploy new IGPs, deploy ValidatorAnnounce #1572

Conversation

tkporter commented Jan 12, 2023

Description

Drive-by changes

Related issues

Backward compatibility

Testing

yorhodes left a comment • edited Loading

Choose a reason for hiding this comment

yorhodes commented Jan 13, 2023

github-actions bot commented Jan 24, 2023

Forge Coverage Report

github-actions bot commented Jan 24, 2023

Hardhat Coverage Report

yorhodes left a comment •

edited

Loading