CipherLabs
/
hyperlane-monorepo
mirror of https://github.com/hyperlane-xyz/hyperlane-monorepo
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

v2 IGP interface change (#1308)

Browse Source 
* Solidity / ts changes

* Update ABIs

* Agent changes

* cargo fmt

* TestSendReceiver changes

* Change param order

* Rm gas payment > 0 check, add handleGasAmounts mapping to HelloWorld

* Some renames

* Update abi

* Fix router test

* Note on why we call the IGP always in _dispatchWithGas
pull/1378/head
Trevor Porter 2 years ago committed by GitHub
parent 0f49c66c1c
commit 6046ce68ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 528 additions and 392 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 20
      rust/chains/hyperlane-ethereum/abis/InterchainGasPaymaster.abi.json
  2. 4
      rust/chains/hyperlane-ethereum/abis/Mailbox.abi.json
  3. 646
      rust/chains/hyperlane-ethereum/abis/MultisigIsm.abi.json
  4. 2
      rust/chains/hyperlane-ethereum/src/interchain_gas.rs
  5. 9
      rust/hyperlane-core/src/db/hyperlane_db.rs
  6. 2
      rust/hyperlane-core/src/types/mod.rs
  7. 29
      solidity/contracts/InterchainGasPaymaster.sol
  8. 20
      solidity/contracts/Router.sol
  9. 8
      solidity/contracts/middleware/liquidity-layer/LiquidityLayerRouter.sol
  10. 16
      solidity/contracts/test/TestRouter.sol
  11. 25
      solidity/contracts/test/TestSendReceiver.sol
  12. 9
      solidity/interfaces/IInterchainGasPaymaster.sol
  13. 50
      solidity/test/interchainGasPaymaster.test.ts
  14. 44
      solidity/test/router.test.ts
  15. 4
      solidity/update_abis.sh
  16. 32
      typescript/helloworld/contracts/HelloWorld.sol

20
rust/chains/hyperlane-ethereum/abis/InterchainGasPaymaster.abi.json
Unescape View File

@ -16,7 +16,13 @@
{ {
"indexed": false, "indexed": false,
"internalType": "uint256", "internalType": "uint256",
"name": "amount", "name": "gasAmount",
"type": "uint256"
},
{
"indexed": false,
"internalType": "uint256",
"name": "payment",
"type": "uint256" "type": "uint256"
} }
], ],
@ -93,9 +99,19 @@
"internalType": "uint32", "internalType": "uint32",
"name": "_destinationDomain", "name": "_destinationDomain",
"type": "uint32" "type": "uint32"
},
{
"internalType": "uint256",
"name": "_gasAmount",
"type": "uint256"
},
{
"internalType": "address",
"name": "_refundAddress",
"type": "address"
} }
], ],
"name": "payGasFor", "name": "payForGas",
"outputs": [], "outputs": [],
"stateMutability": "payable", "stateMutability": "payable",
"type": "function" "type": "function"

4
rust/chains/hyperlane-ethereum/abis/Mailbox.abi.json
Unescape View File

@ -105,9 +105,9 @@
"name": "VERSION", "name": "VERSION",
"outputs": [ "outputs": [
{ {
"internalType": "uint32", "internalType": "uint8",
"name": "", "name": "",
"type": "uint32" "type": "uint8"
} }
], ],
"stateMutability": "view", "stateMutability": "view",

646
rust/chains/hyperlane-ethereum/abis/MultisigIsm.abi.json
Unescape View File

@ -1,324 +1,324 @@
[ [
{ {
"inputs": [], "inputs": [],
"stateMutability": "nonpayable", "stateMutability": "nonpayable",
"type": "constructor" "type": "constructor"
}, },
{ {
"anonymous": false, "anonymous": false,
"inputs": [ "inputs": [
{ {
"indexed": true, "indexed": true,
"internalType": "address", "internalType": "address",
"name": "previousOwner", "name": "previousOwner",
"type": "address" "type": "address"
}, },
{ {
"indexed": true, "indexed": true,
"internalType": "address", "internalType": "address",
"name": "newOwner", "name": "newOwner",
"type": "address" "type": "address"
} }
], ],
"name": "OwnershipTransferred", "name": "OwnershipTransferred",
"type": "event" "type": "event"
}, },
{ {
"anonymous": false, "anonymous": false,
"inputs": [ "inputs": [
{ {
"indexed": true, "indexed": true,
"internalType": "uint32", "internalType": "uint32",
"name": "domain", "name": "domain",
"type": "uint32" "type": "uint32"
}, },
{ {
"indexed": false, "indexed": false,
"internalType": "uint256", "internalType": "uint256",
"name": "threshold", "name": "threshold",
"type": "uint256" "type": "uint256"
}, },
{ {
"indexed": false, "indexed": false,
"internalType": "bytes32", "internalType": "bytes32",
"name": "commitment", "name": "commitment",
"type": "bytes32" "type": "bytes32"
} }
], ],
"name": "ThresholdSet", "name": "ThresholdSet",
"type": "event" "type": "event"
}, },
{ {
"anonymous": false, "anonymous": false,
"inputs": [ "inputs": [
{ {
"indexed": true, "indexed": true,
"internalType": "uint32", "internalType": "uint32",
"name": "domain", "name": "domain",
"type": "uint32" "type": "uint32"
}, },
{ {
"indexed": true, "indexed": true,
"internalType": "address", "internalType": "address",
"name": "validator", "name": "validator",
"type": "address" "type": "address"
}, },
{ {
"indexed": false, "indexed": false,
"internalType": "uint256", "internalType": "uint256",
"name": "validatorCount", "name": "validatorCount",
"type": "uint256" "type": "uint256"
}, },
{ {
"indexed": false, "indexed": false,
"internalType": "bytes32", "internalType": "bytes32",
"name": "commitment", "name": "commitment",
"type": "bytes32" "type": "bytes32"
} }
], ],
"name": "ValidatorEnrolled", "name": "ValidatorEnrolled",
"type": "event" "type": "event"
}, },
{ {
"anonymous": false, "anonymous": false,
"inputs": [ "inputs": [
{ {
"indexed": true, "indexed": true,
"internalType": "uint32", "internalType": "uint32",
"name": "domain", "name": "domain",
"type": "uint32" "type": "uint32"
}, },
{ {
"indexed": true, "indexed": true,
"internalType": "address", "internalType": "address",
"name": "validator", "name": "validator",
"type": "address" "type": "address"
}, },
{ {
"indexed": false, "indexed": false,
"internalType": "uint256", "internalType": "uint256",
"name": "validatorCount", "name": "validatorCount",
"type": "uint256" "type": "uint256"
}, },
{ {
"indexed": false, "indexed": false,
"internalType": "bytes32", "internalType": "bytes32",
"name": "commitment", "name": "commitment",
"type": "bytes32" "type": "bytes32"
} }
], ],
"name": "ValidatorUnenrolled", "name": "ValidatorUnenrolled",
"type": "event" "type": "event"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "uint32", "internalType": "uint32",
"name": "", "name": "",
"type": "uint32" "type": "uint32"
} }
], ],
"name": "commitment", "name": "commitment",
"outputs": [ "outputs": [
{ {
"internalType": "bytes32", "internalType": "bytes32",
"name": "", "name": "",
"type": "bytes32" "type": "bytes32"
} }
], ],
"stateMutability": "view", "stateMutability": "view",
"type": "function" "type": "function"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "uint32", "internalType": "uint32",
"name": "_domain", "name": "_domain",
"type": "uint32" "type": "uint32"
}, },
{ {
"internalType": "address", "internalType": "address",
"name": "_validator", "name": "_validator",
"type": "address" "type": "address"
} }
], ],
"name": "enrollValidator", "name": "enrollValidator",
"outputs": [], "outputs": [],
"stateMutability": "nonpayable", "stateMutability": "nonpayable",
"type": "function" "type": "function"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "uint32", "internalType": "uint32",
"name": "_domain", "name": "_domain",
"type": "uint32" "type": "uint32"
}, },
{ {
"internalType": "address", "internalType": "address",
"name": "_address", "name": "_address",
"type": "address" "type": "address"
} }
], ],
"name": "isEnrolled", "name": "isEnrolled",
"outputs": [ "outputs": [
{ {
"internalType": "bool", "internalType": "bool",
"name": "", "name": "",
"type": "bool" "type": "bool"
} }
], ],
"stateMutability": "view", "stateMutability": "view",
"type": "function" "type": "function"
}, },
{ {
"inputs": [], "inputs": [],
"name": "owner", "name": "owner",
"outputs": [ "outputs": [
{ {
"internalType": "address", "internalType": "address",
"name": "", "name": "",
"type": "address" "type": "address"
} }
], ],
"stateMutability": "view", "stateMutability": "view",
"type": "function" "type": "function"
}, },
{ {
"inputs": [], "inputs": [],
"name": "renounceOwnership", "name": "renounceOwnership",
"outputs": [], "outputs": [],
"stateMutability": "nonpayable", "stateMutability": "nonpayable",
"type": "function" "type": "function"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "uint32", "internalType": "uint32",
"name": "_domain", "name": "_domain",
"type": "uint32" "type": "uint32"
}, },
{ {
"internalType": "uint256", "internalType": "uint256",
"name": "_threshold", "name": "_threshold",
"type": "uint256" "type": "uint256"
} }
], ],
"name": "setThreshold", "name": "setThreshold",
"outputs": [], "outputs": [],
"stateMutability": "nonpayable", "stateMutability": "nonpayable",
"type": "function" "type": "function"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "uint32", "internalType": "uint32",
"name": "", "name": "",
"type": "uint32" "type": "uint32"
} }
], ],
"name": "threshold", "name": "threshold",
"outputs": [ "outputs": [
{ {
"internalType": "uint256", "internalType": "uint256",
"name": "", "name": "",
"type": "uint256" "type": "uint256"
} }
], ],
"stateMutability": "view", "stateMutability": "view",
"type": "function" "type": "function"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "address", "internalType": "address",
"name": "newOwner", "name": "newOwner",
"type": "address" "type": "address"
} }
], ],
"name": "transferOwnership", "name": "transferOwnership",
"outputs": [], "outputs": [],
"stateMutability": "nonpayable", "stateMutability": "nonpayable",
"type": "function" "type": "function"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "uint32", "internalType": "uint32",
"name": "_domain", "name": "_domain",
"type": "uint32" "type": "uint32"
}, },
{ {
"internalType": "address", "internalType": "address",
"name": "_validator", "name": "_validator",
"type": "address" "type": "address"
} }
], ],
"name": "unenrollValidator", "name": "unenrollValidator",
"outputs": [], "outputs": [],
"stateMutability": "nonpayable", "stateMutability": "nonpayable",
"type": "function" "type": "function"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "uint32", "internalType": "uint32",
"name": "_domain", "name": "_domain",
"type": "uint32" "type": "uint32"
} }
], ],
"name": "validatorCount", "name": "validatorCount",
"outputs": [ "outputs": [
{ {
"internalType": "uint256", "internalType": "uint256",
"name": "", "name": "",
"type": "uint256" "type": "uint256"
} }
], ],
"stateMutability": "view", "stateMutability": "view",
"type": "function" "type": "function"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "uint32", "internalType": "uint32",
"name": "_domain", "name": "_domain",
"type": "uint32" "type": "uint32"
} }
], ],
"name": "validators", "name": "validators",
"outputs": [ "outputs": [
{ {
"internalType": "address[]", "internalType": "address[]",
"name": "", "name": "",
"type": "address[]" "type": "address[]"
} }
], ],
"stateMutability": "view", "stateMutability": "view",
"type": "function" "type": "function"
}, },
{ {
"inputs": [ "inputs": [
{ {
"internalType": "bytes", "internalType": "bytes",
"name": "_metadata", "name": "_metadata",
"type": "bytes" "type": "bytes"
}, },
{ {
"internalType": "bytes", "internalType": "bytes",
"name": "_message", "name": "_message",
"type": "bytes" "type": "bytes"
} }
], ],
"name": "verify", "name": "verify",
"outputs": [ "outputs": [
{ {
"internalType": "bool", "internalType": "bool",
"name": "", "name": "",
"type": "bool" "type": "bool"
} }
], ],
"stateMutability": "view", "stateMutability": "view",
"type": "function" "type": "function"
} }
] ]

2
rust/chains/hyperlane-ethereum/src/interchain_gas.rs
Unescape View File

@ -119,7 +119,7 @@ where
.map(|(log, log_meta)| InterchainGasPaymentWithMeta { .map(|(log, log_meta)| InterchainGasPaymentWithMeta {
payment: InterchainGasPayment { payment: InterchainGasPayment {
message_id: H256::from(log.message_id), message_id: H256::from(log.message_id),
amount: log.amount, payment: log.payment,
}, },
meta: InterchainGasPaymentMeta { meta: InterchainGasPaymentMeta {
transaction_hash: log_meta.transaction_hash, transaction_hash: log_meta.transaction_hash,

9
rust/hyperlane-core/src/db/hyperlane_db.rs
Unescape View File

@ -259,11 +259,14 @@ impl HyperlaneDB {
&self, &self,
gas_payment: &InterchainGasPayment, gas_payment: &InterchainGasPayment,
) -> Result<(), DbError> { ) -> Result<(), DbError> {
let InterchainGasPayment { message_id, amount } = gas_payment; let InterchainGasPayment {
message_id,
payment,
} = gas_payment;
let existing_payment = self.retrieve_gas_payment_for_message_id(*message_id)?; let existing_payment = self.retrieve_gas_payment_for_message_id(*message_id)?;
let total = existing_payment + amount; let total = existing_payment + payment;
info!(message_id=?message_id, gas_payment_amount=?amount, new_total_gas_payment=?total, "Storing gas payment"); info!(message_id=?message_id, gas_payment_amount=?payment, new_total_gas_payment=?total, "Storing gas payment");
self.store_keyed_encodable(GAS_PAYMENT_FOR_MESSAGE_ID, &gas_payment.message_id, &total)?; self.store_keyed_encodable(GAS_PAYMENT_FOR_MESSAGE_ID, &gas_payment.message_id, &total)?;
Ok(()) Ok(())

2
rust/hyperlane-core/src/types/mod.rs
Unescape View File

@ -22,7 +22,7 @@ pub struct InterchainGasPayment {
/// The id of the message /// The id of the message
pub message_id: H256, pub message_id: H256,
/// The payment amount, in origin chain native token wei /// The payment amount, in origin chain native token wei
pub amount: U256, pub payment: U256,
} }
/// Uniquely identifying metadata for an InterchainGasPayment /// Uniquely identifying metadata for an InterchainGasPayment

29
solidity/contracts/InterchainGasPaymaster.sol
Unescape View File

@ -17,9 +17,14 @@ contract InterchainGasPaymaster is IInterchainGasPaymaster, OwnableUpgradeable {
/** /**
* @notice Emitted when a payment is made for a message's gas costs. * @notice Emitted when a payment is made for a message's gas costs.
* @param messageId The ID of the message to pay for. * @param messageId The ID of the message to pay for.
* @param amount The amount of native tokens paid. * @param gasAmount The amount of destination gas paid for.
* @param payment The amount of native tokens paid.
*/ */
event GasPayment(bytes32 indexed messageId, uint256 amount); event GasPayment(
bytes32 indexed messageId,
uint256 gasAmount,
uint256 payment
);
// ============ Constructor ============ // ============ Constructor ============
@ -39,18 +44,22 @@ contract InterchainGasPaymaster is IInterchainGasPaymaster, OwnableUpgradeable {
* to its destination chain. * to its destination chain.
* @param _messageId The ID of the message to pay for. * @param _messageId The ID of the message to pay for.
* @param _destinationDomain The domain of the message's destination chain. * @param _destinationDomain The domain of the message's destination chain.
* @param _gasAmount The amount of destination gas to pay for. Currently unused.
* @param _refundAddress The address to refund any overpayment to. Currently unused.
*/ */
function payGasFor(bytes32 _messageId, uint32 _destinationDomain) function payForGas(
external bytes32 _messageId,
payable uint32 _destinationDomain,
override uint256 _gasAmount,
{ address _refundAddress
) external payable override {
// Silence compiler warning. The NatSpec @param requires the parameter to be named. // Silence compiler warning. The NatSpec @param requires the parameter to be named.
// While not used at the moment, future versions of the paymaster may conditionally // While not used at the moment, future versions of the paymaster have behavior specific
// forward payments depending on the destination domain. // to the destination domain and refund overpayments to the _refundAddress.
_destinationDomain; _destinationDomain;
_refundAddress;
emit GasPayment(_messageId, msg.value); emit GasPayment(_messageId, _gasAmount, msg.value);
} }
/** /**

20
solidity/contracts/Router.sol
Unescape View File

@ -151,20 +151,26 @@ abstract contract Router is HyperlaneConnectionClient, IMessageRecipient {
* @dev Reverts if there is no enrolled router for _destinationDomain. * @dev Reverts if there is no enrolled router for _destinationDomain.
* @param _destinationDomain The domain of the chain to which to send the message. * @param _destinationDomain The domain of the chain to which to send the message.
* @param _messageBody Raw bytes content of message. * @param _messageBody Raw bytes content of message.
* @param _gasAmount The amount of destination gas for the message that is requested via the InterchainGasPaymaster.
* @param _gasPayment The amount of native tokens to pay for the message to be relayed. * @param _gasPayment The amount of native tokens to pay for the message to be relayed.
* @param _gasPaymentRefundAddress The address to refund any gas overpayment to.
*/ */
function _dispatchWithGas( function _dispatchWithGas(
uint32 _destinationDomain, uint32 _destinationDomain,
bytes memory _messageBody, bytes memory _messageBody,
uint256 _gasPayment uint256 _gasAmount,
uint256 _gasPayment,
address _gasPaymentRefundAddress
) internal { ) internal {
bytes32 _messageId = _dispatch(_destinationDomain, _messageBody); bytes32 _messageId = _dispatch(_destinationDomain, _messageBody);
if (_gasPayment > 0) { // Call the IGP even if the gas payment is zero. This is to support on-chain
interchainGasPaymaster.payGasFor{value: _gasPayment}( // fee quoting in IGPs, which should always revert if gas payment is insufficient.
_messageId, interchainGasPaymaster.payForGas{value: _gasPayment}(
_destinationDomain _messageId,
); _destinationDomain,
} _gasAmount,
_gasPaymentRefundAddress
);
} }
/** /**

8
solidity/contracts/middleware/liquidity-layer/LiquidityLayerRouter.sol
Unescape View File

@ -70,7 +70,13 @@ contract LiquidityLayerRouter is Router {
); );
// Dispatch the _messageWithMetadata to the destination's LiquidityLayerRouter. // Dispatch the _messageWithMetadata to the destination's LiquidityLayerRouter.
_dispatchWithGas(_destinationDomain, _messageWithMetadata, msg.value); _dispatchWithGas(
_destinationDomain,
_messageWithMetadata,
0, // TODO eventually accommodate gas amounts
msg.value,
msg.sender
);
} }
// Handles a message from an enrolled remote LiquidityLayerRouter // Handles a message from an enrolled remote LiquidityLayerRouter

16
solidity/contracts/test/TestRouter.sol
Unescape View File

@ -38,10 +38,18 @@ contract TestRouter is Router {
} }
function dispatchWithGas( function dispatchWithGas(
uint32 _destination, uint32 _destinationDomain,
bytes memory _msg, bytes memory _messageBody,
uint256 _gasPayment uint256 _gasAmount,
uint256 _gasPayment,
address _gasPaymentRefundAddress
) external payable { ) external payable {
_dispatchWithGas(_destination, _msg, _gasPayment); _dispatchWithGas(
_destinationDomain,
_messageBody,
_gasAmount,
_gasPayment,
_gasPaymentRefundAddress
);
} }
} }

25
solidity/contracts/test/TestSendReceiver.sol
Unescape View File

@ -10,6 +10,8 @@ import {IMailbox} from "../../interfaces/IMailbox.sol";
contract TestSendReceiver is IMessageRecipient { contract TestSendReceiver is IMessageRecipient {
using TypeCasts for address; using TypeCasts for address;
uint256 public constant HANDLE_GAS_AMOUNT = 50_000;
event Handled(bytes32 blockHash); event Handled(bytes32 blockHash);
function dispatchToSelf( function dispatchToSelf(
@ -27,15 +29,28 @@ contract TestSendReceiver is IMessageRecipient {
uint256 _value = msg.value; uint256 _value = msg.value;
if (_blockHashNum % 5 == 0) { if (_blockHashNum % 5 == 0) {
// Pay in two separate calls, resulting in 2 distinct events // Pay in two separate calls, resulting in 2 distinct events
uint256 _half = _value / 2; uint256 _halfPayment = _value / 2;
_paymaster.payGasFor{value: _half}(_messageId, _destinationDomain); uint256 _halfGasAmount = HANDLE_GAS_AMOUNT / 2;
_paymaster.payGasFor{value: _value - _half}( _paymaster.payForGas{value: _halfPayment}(
_messageId,
_destinationDomain,
_halfGasAmount,
msg.sender
);
_paymaster.payForGas{value: _value - _halfPayment}(
_messageId, _messageId,
_destinationDomain _destinationDomain,
HANDLE_GAS_AMOUNT - _halfGasAmount,
msg.sender
); );
} else { } else {
// Pay the entire msg.value in one call // Pay the entire msg.value in one call
_paymaster.payGasFor{value: _value}(_messageId, _destinationDomain); _paymaster.payForGas{value: _value}(
_messageId,
_destinationDomain,
HANDLE_GAS_AMOUNT,
msg.sender
);
} }
} }

9
solidity/interfaces/IInterchainGasPaymaster.sol
Unescape View File

@ -7,7 +7,10 @@ pragma solidity >=0.6.11;
* messages to destination chains. * messages to destination chains.
*/ */
interface IInterchainGasPaymaster { interface IInterchainGasPaymaster {
function payGasFor(bytes32 _messageId, uint32 _destinationDomain) function payForGas(
external bytes32 _messageId,
payable; uint32 _destinationDomain,
uint256 _gas,
address _refundAddress
) external payable;
} }

50
solidity/test/interchainGasPaymaster.test.ts
Unescape View File

@ -10,7 +10,9 @@ import {
const MESSAGE_ID = const MESSAGE_ID =
'0x6ae9a99190641b9ed0c07143340612dde0e9cb7deaa5fe07597858ae9ba5fd7f'; '0x6ae9a99190641b9ed0c07143340612dde0e9cb7deaa5fe07597858ae9ba5fd7f';
const DESTINATION_DOMAIN = 1234; const DESTINATION_DOMAIN = 1234;
const PAYMENT_AMOUNT = 123456789; const GAS_PAYMENT_AMOUNT = 123456789;
const GAS_AMOUNT = 4444;
const REFUND_ADDRESS = '0xc0ffee0000000000000000000000000000000000';
const OWNER = '0xdeadbeef00000000000000000000000000000000'; const OWNER = '0xdeadbeef00000000000000000000000000000000';
describe('InterchainGasPaymaster', async () => { describe('InterchainGasPaymaster', async () => {
@ -31,42 +33,60 @@ describe('InterchainGasPaymaster', async () => {
}); });
}); });
describe('#payGasFor', async () => { describe('#payForGas', async () => {
it('deposits the value into the contract', async () => { it('deposits the value into the contract', async () => {
const paymasterBalanceBefore = await signer.provider!.getBalance( const paymasterBalanceBefore = await signer.provider!.getBalance(
paymaster.address, paymaster.address,
); );
await paymaster.payGasFor(MESSAGE_ID, DESTINATION_DOMAIN, { await paymaster.payForGas(
value: PAYMENT_AMOUNT, MESSAGE_ID,
}); DESTINATION_DOMAIN,
GAS_AMOUNT,
REFUND_ADDRESS,
{
value: GAS_PAYMENT_AMOUNT,
},
);
const paymasterBalanceAfter = await signer.provider!.getBalance( const paymasterBalanceAfter = await signer.provider!.getBalance(
paymaster.address, paymaster.address,
); );
expect(paymasterBalanceAfter.sub(paymasterBalanceBefore)).equals( expect(paymasterBalanceAfter.sub(paymasterBalanceBefore)).equals(
PAYMENT_AMOUNT, GAS_PAYMENT_AMOUNT,
); );
}); });
it('emits the GasPayment event', async () => { it('emits the GasPayment event', async () => {
await expect( await expect(
paymaster.payGasFor(MESSAGE_ID, DESTINATION_DOMAIN, { paymaster.payForGas(
value: PAYMENT_AMOUNT, MESSAGE_ID,
}), DESTINATION_DOMAIN,
GAS_AMOUNT,
REFUND_ADDRESS,
{
value: GAS_PAYMENT_AMOUNT,
},
),
) )
.to.emit(paymaster, 'GasPayment') .to.emit(paymaster, 'GasPayment')
.withArgs(MESSAGE_ID, PAYMENT_AMOUNT); .withArgs(MESSAGE_ID, GAS_AMOUNT, GAS_PAYMENT_AMOUNT);
}); });
}); });
describe('#claim', async () => { describe('#claim', async () => {
it('sends the entire balance of the contract to the owner', async () => { it('sends the entire balance of the contract to the owner', async () => {
// First pay some ether into the contract // First pay some ether into the contract
await paymaster.payGasFor(MESSAGE_ID, DESTINATION_DOMAIN, { await paymaster.payForGas(
value: PAYMENT_AMOUNT, MESSAGE_ID,
}); DESTINATION_DOMAIN,
GAS_AMOUNT,
REFUND_ADDRESS,
{
value: GAS_PAYMENT_AMOUNT,
},
);
// Set the owner to a different address so we aren't paying gas with the same // Set the owner to a different address so we aren't paying gas with the same
// address we want to observe the balance of // address we want to observe the balance of
@ -77,12 +97,12 @@ describe('InterchainGasPaymaster', async () => {
const paymasterBalanceBefore = await signer.provider!.getBalance( const paymasterBalanceBefore = await signer.provider!.getBalance(
paymaster.address, paymaster.address,
); );
expect(paymasterBalanceBefore).equals(PAYMENT_AMOUNT); expect(paymasterBalanceBefore).equals(GAS_PAYMENT_AMOUNT);
await paymaster.claim(); await paymaster.claim();
const ownerBalanceAfter = await signer.provider!.getBalance(OWNER); const ownerBalanceAfter = await signer.provider!.getBalance(OWNER);
expect(ownerBalanceAfter).equals(PAYMENT_AMOUNT); expect(ownerBalanceAfter).equals(GAS_PAYMENT_AMOUNT);
const paymasterBalanceAfter = await signer.provider!.getBalance( const paymasterBalanceAfter = await signer.provider!.getBalance(
paymaster.address, paymaster.address,
); );

44
solidity/test/router.test.ts
Unescape View File

@ -1,7 +1,7 @@
/* eslint-disable @typescript-eslint/no-floating-promises */ /* eslint-disable @typescript-eslint/no-floating-promises */
import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers'; import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers';
import { expect } from 'chai'; import { expect } from 'chai';
import { ContractTransaction } from 'ethers'; import { BigNumberish, ContractTransaction } from 'ethers';
import { ethers } from 'hardhat'; import { ethers } from 'hardhat';
import { utils } from '@hyperlane-xyz/utils'; import { utils } from '@hyperlane-xyz/utils';
@ -24,6 +24,14 @@ const destination = 2;
const destinationWithoutRouter = 3; const destinationWithoutRouter = 3;
const body = '0xdeadbeef'; const body = '0xdeadbeef';
interface GasPaymentParams {
// The amount of destination gas being paid for
gasAmount: BigNumberish;
// The amount of native tokens paid
payment: BigNumberish;
refundAddress: string;
}
describe('Router', async () => { describe('Router', async () => {
let router: TestRouter, let router: TestRouter,
mailbox: TestMailbox, mailbox: TestMailbox,
@ -153,7 +161,7 @@ describe('Router', async () => {
const runDispatchFunctionTests = async ( const runDispatchFunctionTests = async (
dispatchFunction: ( dispatchFunction: (
destinationDomain: number, destinationDomain: number,
interchainGasPayment?: number, gasPaymentParams: GasPaymentParams,
) => Promise<ContractTransaction>, ) => Promise<ContractTransaction>,
expectGasPayment: boolean, expectGasPayment: boolean,
) => { ) => {
@ -165,17 +173,21 @@ describe('Router', async () => {
return expected ? assertion : assertion.not; return expected ? assertion : assertion.not;
}; };
const testGasPaymentParams: GasPaymentParams = {
gasAmount: 4321,
payment: 1234,
refundAddress: '0xc0ffee0000000000000000000000000000000000',
};
it('dispatches a message', async () => { it('dispatches a message', async () => {
await expect(dispatchFunction(destination)).to.emit( await expect(
mailbox, dispatchFunction(destination, testGasPaymentParams),
'Dispatch', ).to.emit(mailbox, 'Dispatch');
);
}); });
it(`${ it(`${
expectGasPayment ? 'pays' : 'does not pay' expectGasPayment ? 'pays' : 'does not pay'
} interchain gas`, async () => { } interchain gas`, async () => {
const testInterchainGasPayment = 1234;
const { id } = await inferMessageValues( const { id } = await inferMessageValues(
mailbox, mailbox,
router.address, router.address,
@ -184,17 +196,21 @@ describe('Router', async () => {
'', '',
); );
const assertion = expectAssertion( const assertion = expectAssertion(
expect(dispatchFunction(destination, testInterchainGasPayment)).to, expect(dispatchFunction(destination, testGasPaymentParams)).to,
expectGasPayment, expectGasPayment,
); );
await assertion await assertion
.emit(interchainGasPaymaster, 'GasPayment') .emit(interchainGasPaymaster, 'GasPayment')
.withArgs(id, testInterchainGasPayment); .withArgs(
id,
testGasPaymentParams.gasAmount,
testGasPaymentParams.payment,
);
}); });
it('reverts when dispatching a message to an unenrolled remote router', async () => { it('reverts when dispatching a message to an unenrolled remote router', async () => {
await expect( await expect(
dispatchFunction(destinationWithoutRouter), dispatchFunction(destinationWithoutRouter, testGasPaymentParams),
).to.be.revertedWith( ).to.be.revertedWith(
`No router enrolled for domain. Did you specify the right domain ID?`, `No router enrolled for domain. Did you specify the right domain ID?`,
); );
@ -210,13 +226,15 @@ describe('Router', async () => {
describe('#dispatchWithGas', () => { describe('#dispatchWithGas', () => {
runDispatchFunctionTests( runDispatchFunctionTests(
(destinationDomain, interchainGasPayment = 0) => (destinationDomain, gasPaymentParams) =>
router.dispatchWithGas( router.dispatchWithGas(
destinationDomain, destinationDomain,
'0x', '0x',
interchainGasPayment, gasPaymentParams.gasAmount,
gasPaymentParams.payment,
gasPaymentParams.refundAddress,
{ {
value: interchainGasPayment, value: gasPaymentParams.payment,
}, },
), ),
true, true,

4
solidity/update_abis.sh
Unescape View File

@ -1,5 +1,7 @@
#!/bin/sh #!/bin/sh
# Must be ran from the `solidity` directory
copy() { copy() {
# Optionally allow path to be passed in, and extract the contract name # Optionally allow path to be passed in, and extract the contract name
# as the string following the last instance of `/` # as the string following the last instance of `/`
@ -7,4 +9,4 @@ copy() {
jq .abi < artifacts/contracts/"$1".sol/"$CONTRACT_NAME".json > ../rust/chains/hyperlane-ethereum/abis/"$CONTRACT_NAME".abi.json jq .abi < artifacts/contracts/"$1".sol/"$CONTRACT_NAME".json > ../rust/chains/hyperlane-ethereum/abis/"$CONTRACT_NAME".abi.json
} }
copy Inbox && copy Outbox && copy validator-manager/InboxValidatorManager && copy InterchainGasPaymaster copy Mailbox && copy isms/MultisigIsm && copy InterchainGasPaymaster

32
typescript/helloworld/contracts/HelloWorld.sol
Unescape View File

@ -21,6 +21,10 @@ contract HelloWorld is Router {
// by this contract from the domain. // by this contract from the domain.
mapping(uint32 => uint256) public receivedFrom; mapping(uint32 => uint256) public receivedFrom;
// Keyed by domain, a generous upper bound on the amount of gas to use in the
// handle function when a message is processed. Used for paying for gas.
mapping(uint32 => uint256) public handleGasAmounts;
// ============ Events ============ // ============ Events ============
event SentHelloWorld( event SentHelloWorld(
uint32 indexed origin, uint32 indexed origin,
@ -33,6 +37,10 @@ contract HelloWorld is Router {
bytes32 sender, bytes32 sender,
string message string message
); );
event HandleGasAmountSet(
uint32 indexed destination,
uint256 handleGasAmount
);
constructor(address _mailbox, address _interchainGasPaymaster) { constructor(address _mailbox, address _interchainGasPaymaster) {
// Transfer ownership of the contract to deployer // Transfer ownership of the contract to deployer
@ -49,6 +57,7 @@ contract HelloWorld is Router {
* @notice Sends a message to the _destinationDomain. Any msg.value is * @notice Sends a message to the _destinationDomain. Any msg.value is
* used as interchain gas payment. * used as interchain gas payment.
* @param _destinationDomain The destination domain to send the message to. * @param _destinationDomain The destination domain to send the message to.
* @param _message The message to send.
*/ */
function sendHelloWorld(uint32 _destinationDomain, string calldata _message) function sendHelloWorld(uint32 _destinationDomain, string calldata _message)
external external
@ -56,7 +65,13 @@ contract HelloWorld is Router {
{ {
sent += 1; sent += 1;
sentTo[_destinationDomain] += 1; sentTo[_destinationDomain] += 1;
_dispatchWithGas(_destinationDomain, bytes(_message), msg.value); _dispatchWithGas(
_destinationDomain,
bytes(_message),
handleGasAmounts[_destinationDomain],
msg.value,
msg.sender
);
emit SentHelloWorld( emit SentHelloWorld(
mailbox.localDomain(), mailbox.localDomain(),
_destinationDomain, _destinationDomain,
@ -64,6 +79,21 @@ contract HelloWorld is Router {
); );
} }
/**
* @notice Sets the amount of gas the recipient's handle function uses on
* the destination domain, which is used when paying for gas.
* @dev Reverts if called by a non-owner.
* @param _destinationDomain The destination domain,
* @param _handleGasAmount The handle gas amount.
*/
function setHandleGasAmount(
uint32 _destinationDomain,
uint256 _handleGasAmount
) external onlyOwner {
handleGasAmounts[_destinationDomain] = _handleGasAmount;
emit HandleGasAmountSet(_destinationDomain, _handleGasAmount);
}
// ============ Internal functions ============ // ============ Internal functions ============
/** /**

Write Preview
Loading…
Cancel
Save