@hyperbridge/core 1.3.0 → 1.5.0

package/contracts/apps/IntentGatewayV2.sol

@@ -37,6 +37,10 @@ struct TokenInfo {
     uint256 amount;
 }
 
+/**
+ * @notice Information for executing calls before an order is placed on the destination chain
+ * @dev Used to specify pre-dispatch operations with associated assets
+ */
 struct DispatchInfo {
     /// @dev Assets to execute a predispatch call with
     TokenInfo[] assets;
@@ -98,6 +102,30 @@ struct Params {
     /// @dev The protocol fee in basis points charged on order inputs.
     /// 10000 = 100%, 100 = 1%, etc.
     uint256 protocolFeeBps;
+    /// @dev The address of the price oracle contract.
+    address priceOracle;
+}
+
+/**
+ * @dev Struct to define the destination fee parameters.
+ */
+struct DestinationFee {
+    /// @dev The percentage of fee (in basis points) charged for the destination chain.
+    /// 10000 = 100%, 5000 = 50%, etc.
+    uint256 destinationFeeBps;
+    /// @dev The state machine ID associated with the destination fee.
+    bytes32 stateMachineId;
+}
+
+/**
+ * @dev Struct to define a parameter update request from Hyperbridge
+ * @notice Contains both general parameters and destination-specific fee configurations
+ */
+struct ParamsUpdate {
+    /// @dev The general parameters for the IntentGateway module
+    Params params;
+    /// @dev The destination fee parameters for specific chains
+    DestinationFee[] destinationFees;
 }
 
 /**

package/contracts/apps/IntentPriceOracle.sol

@@ -0,0 +1,85 @@
+// Copyright (C) Polytope Labs Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// 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.
+pragma solidity ^0.8.24;
+
+import {TokenInfo} from "./IntentGatewayV2.sol";
+
+/**
+ * @title IIntentPriceOracle
+ * @author Polytope Labs (hello@polytope.technology)
+ * @notice Interface for tracking cumulative weighted average spreads for same-token swaps
+ * @dev Only supports same-token swaps across chains
+ */
+interface IIntentPriceOracle {
+    /**
+     * @notice Struct to track cumulative spread data for weighted average calculation
+     */
+    struct CumulativeSpreadData {
+        /// @dev Sum of (spread * volume) for all fills
+        int256 weightedSpreadSum;
+        /// @dev Total volume in normalized token units (18 decimals)
+        uint256 totalVolume;
+        /// @dev Number of fills
+        uint256 fillCount;
+        /// @dev Last update timestamp
+        uint256 lastUpdate;
+    }
+
+    /**
+     * @notice Event emitted when spread is recorded for a filled order
+     * @param commitment The order commitment hash
+     * @param destinationToken The destination token address
+     * @param spreadBps The spread in basis points
+     */
+    event SpreadRecorded(bytes32 indexed commitment, address indexed destinationToken, int256 spreadBps);
+
+    /**
+     * @notice Event emitted when token decimals are updated
+     * @param sourceChain The source chain state machine ID
+     * @param token The token address
+     * @param decimals The number of decimals
+     */
+    event TokenDecimalsUpdated(bytes sourceChain, address indexed token, uint8 decimals);
+
+    /**
+     * @notice Records the spread for a filled order and computes weighted average
+     * @param commitment The order commitment hash
+     * @param sourceChain The source chain identifier (bytes format)
+     * @param inputs The input tokens that were escrowed
+     * @param outputs The output tokens provided by the filler (actual amounts)
+     */
+    function recordSpread(
+        bytes32 commitment,
+        bytes memory sourceChain,
+        TokenInfo[] calldata inputs,
+        TokenInfo[] calldata outputs
+    ) external;
+
+    /**
+     * @notice Gets the decimals for a token on a specific source chain
+     * @param sourceChain The source chain identifier
+     * @param token The token address
+     * @return decimals The number of decimals (defaults to 18 if not set)
+     */
+    function decimals(bytes memory sourceChain, address token) external view returns (uint8 decimals);
+
+    /**
+     * @notice Gets the cumulative weighted average spread data for a token on a source chain
+     * @param sourceChain The source chain identifier
+     * @param token The token address
+     * @return data The cumulative spread data
+     */
+    function spread(bytes memory sourceChain, address token) external view returns (CumulativeSpreadData memory data);
+}

package/contracts/apps/TokenGateway.sol

@@ -15,33 +15,33 @@
 pragma solidity ^0.8.17;
 
 struct TeleportParams {
-	// amount to be sent
-	uint256 amount;
-	// Relayer fee
-	uint256 relayerFee;
-	// The token identifier to send
-	bytes32 assetId;
-	// Redeem ERC20 on the destination?
-	bool redeem;
-	// recipient address
-	bytes32 to;
-	// recipient state machine
-	bytes dest;
-	// request timeout in seconds
-	uint64 timeout;
-	// Amount of native token to pay for dispatching the request
-	// if 0 will use the `IIsmpHost.feeToken`
-	uint256 nativeCost;
-	// destination contract call data
-	bytes data;
+    // amount to be sent
+    uint256 amount;
+    // Relayer fee
+    uint256 relayerFee;
+    // The token identifier to send
+    bytes32 assetId;
+    // Redeem ERC20 on the destination?
+    bool redeem;
+    // recipient address
+    bytes32 to;
+    // recipient state machine
+    bytes dest;
+    // request timeout in seconds
+    uint64 timeout;
+    // Amount of native token to pay for dispatching the request
+    // if 0 will use the `IIsmpHost.feeToken`
+    uint256 nativeCost;
+    // destination contract call data
+    bytes data;
 }
 
 // Params for the TokenGateway contract
 struct TokenGatewayParams {
-	// address of the IsmpHost contract on this chain
-	address host;
-	// dispatcher for delegating external calls
-	address dispatcher;
+    // address of the IsmpHost contract on this chain
+    address host;
+    // dispatcher for delegating external calls
+    address dispatcher;
 }
 
 /**
@@ -55,88 +55,88 @@ struct TokenGatewayParams {
  * Otherwise if hyper-fungible tokens are sent, then it simply performs a burn-and-mint.
  */
 interface ITokenGateway {
-	// User has received some assets
-	event AssetReceived(
-		// The amount that was provided to the user
-		uint256 amount,
-		// The associated request commitment
-		bytes32 commitment,
-		// The source of the funds
-		bytes32 indexed from,
-		// The beneficiary of the funds
-		address indexed beneficiary,
-		// The provided assetId
-		bytes32 indexed assetId
-	);
+    // User has received some assets
+    event AssetReceived(
+        // The amount that was provided to the user
+        uint256 amount,
+        // The associated request commitment
+        bytes32 commitment,
+        // The source of the funds
+        bytes32 indexed from,
+        // The beneficiary of the funds
+        address indexed beneficiary,
+        // The provided assetId
+        bytes32 indexed assetId
+    );
 
-	// User has sent some assets
-	event AssetTeleported(
-		// The beneficiary of the funds
-		bytes32 to,
-		// The destination chain
-		string dest,
-		// The amount that was requested to be sent
-		uint256 amount,
-		// The associated request commitment
-		bytes32 commitment,
-		// The source of the funds
-		address indexed from,
-		// The provided assetId
-		bytes32 indexed assetId,
-		// Flag to redeem funds from the TokenGateway
-		bool redeem
-	);
+    // User has sent some assets
+    event AssetTeleported(
+        // The beneficiary of the funds
+        bytes32 to,
+        // The destination chain
+        string dest,
+        // The amount that was requested to be sent
+        uint256 amount,
+        // The associated request commitment
+        bytes32 commitment,
+        // The source of the funds
+        address indexed from,
+        // The provided assetId
+        bytes32 indexed assetId,
+        // Flag to redeem funds from the TokenGateway
+        bool redeem
+    );
 
-	// User assets could not be delivered and have been refunded.
-	event AssetRefunded(
-		// The amount that was requested to be sent
-		uint256 amount,
-		// The associated request commitment
-		bytes32 commitment,
-		// The beneficiary of the funds
-		address indexed beneficiary,
-		// The provided assetId
-		bytes32 indexed assetId
-	);
+    // User assets could not be delivered and have been refunded.
+    event AssetRefunded(
+        // The amount that was requested to be sent
+        uint256 amount,
+        // The associated request commitment
+        bytes32 commitment,
+        // The beneficiary of the funds
+        address indexed beneficiary,
+        // The provided assetId
+        bytes32 indexed assetId
+    );
 
-	// @dev Unexpected zero address
-	error ZeroAddress();
+    // @dev Unexpected zero address
+    error ZeroAddress();
 
-	// @dev Provided amount was invalid
-	error InvalidAmount();
+    // @dev Provided amount was invalid
+    error InvalidAmount();
 
-	// @dev Provided token was unknown
-	error UnknownAsset();
+    // @dev Provided token was unknown
+    error UnknownAsset();
 
-	// @dev Protocol invariant violated
-	error InconsistentState();
+    // @dev Protocol invariant violated
+    error InconsistentState();
 
-	/**
-	 * @dev Read the protocol parameters
-	 */
-	function params() external view returns (TokenGatewayParams memory);
+    /**
+     * @dev Read the protocol parameters
+     */
+    function params() external view returns (TokenGatewayParams memory);
 
-	/**
-	 * @dev Fetch the address for an ERC20 asset
-	 */
-	function erc20(bytes32 assetId) external view returns (address);
+    /**
+     * @dev Fetch the address for an ERC20 asset
+     */
+    function erc20(bytes32 assetId) external view returns (address);
 
-	/**
-	 * @dev Fetch the address for a hyper-fungible asset
-	 */
-	function erc6160(bytes32 assetId) external view returns (address);
+    /**
+     * @dev Fetch the address for a hyper-fungible asset
+     */
+    function erc6160(bytes32 assetId) external view returns (address);
 
-	/**
-	 * @dev Fetch the TokenGateway instance for a destination.
-	 */
-	function instance(bytes calldata destination) external view returns (address);
+    /**
+     * @dev Fetch the TokenGateway instance for a destination.
+     */
+    function instance(bytes calldata destination) external view returns (address);
 
-	/**
-	 * @dev Teleports a local ERC20/hyper-fungible asset to the destination chain. Allows users to pay
-	 * the Hyperbridge fees in the native token or `IIsmpHost.feeToken`
-	 *
-	 * @notice If a request times out, users can request a refund permissionlessly through
-	 * `HandlerV1.handlePostRequestTimeouts`.
-	 */
-	function teleport(TeleportParams calldata teleportParams) external payable;
+    /**
+     * @dev Teleports a local ERC20/hyper-fungible asset to the destination chain. Allows users to pay
+     * the Hyperbridge fees in the native token or `IIsmpHost.feeToken`
+     *
+     * @notice If a request times out, users can request a refund permissionlessly through
+     * `HandlerV1.handlePostRequestTimeouts`.
+     */
+    function teleport(TeleportParams calldata teleportParams) external payable;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperbridge/core",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Hyperbridge Solidity SDK for dispatching & receiving cross-chain messages",
   "author": "Polytope Labs <hello@polytope.technology>",
   "license": "Apache-2.0",