> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/eco/eco-routes/llms.txt > Use this file to discover all available pages before exploring further. # IntentSource > Contract for managing cross-chain intents and rewards on the source chain ## Overview IntentSource is an abstract contract containing all core intent functionality for EVM chains. It manages the lifecycle of cross-chain intents and their associated rewards on the source chain. **Contract Location:** `contracts/IntentSource.sol` **Inherits:** OriginSettler, IIntentSource ## State Variables ### Status Enum ```solidity theme={null} enum Status { Initial, Funded, Withdrawn, Refunded } ``` Tracks the lifecycle status of each intent's rewards. ## View Functions ### getRewardStatus ```solidity theme={null} function getRewardStatus(bytes32 intentHash) public view returns (Status status) ``` Retrieves reward status for a given intent hash. Hash of the intent to query Current status of the intent (Initial, Funded, Withdrawn, or Refunded) *** ### getIntentHash (Intent) ```solidity theme={null} function getIntentHash( Intent memory intent ) public pure returns ( bytes32 intentHash, bytes32 routeHash, bytes32 rewardHash ) ``` Calculates the hash of an intent and its components. The intent to hash Combined hash of route and reward Hash of the route component Hash of the reward component *** ### getIntentHash (Destination, Route, Reward) ```solidity theme={null} function getIntentHash( uint64 destination, bytes memory route, Reward memory reward ) public pure returns ( bytes32 intentHash, bytes32 routeHash, bytes32 rewardHash ) ``` Calculates the hash of an intent and its components using encoded route data. Destination chain ID for the intent Encoded route data for the intent as bytes for cross-VM compatibility Reward structure containing distribution details Combined hash of route and reward Hash of the route component Hash of the reward component *** ### getIntentHash (Route Hash) ```solidity theme={null} function getIntentHash( uint64 destination, bytes32 _routeHash, Reward memory reward ) public pure returns ( bytes32 intentHash, bytes32 routeHash, bytes32 rewardHash ) ``` Calculates intent hash from pre-computed route hash and reward components. Destination chain ID for the intent Pre-computed hash of the route component Reward structure containing distribution details Combined hash of route and reward Hash of the route component (passed through) Hash of the reward component *** ### intentVaultAddress (Intent) ```solidity theme={null} function intentVaultAddress(Intent calldata intent) public view returns (address) ``` Calculates the deterministic address of the intent vault. Intent to calculate vault address for Address of the intent vault *** ### intentVaultAddress (Destination, Route, Reward) ```solidity theme={null} function intentVaultAddress( uint64 destination, bytes memory route, Reward calldata reward ) public view returns (address) ``` Calculates the deterministic address of the intent vault using universal format. Destination chain ID for the intent Encoded route data for the intent as bytes The reward structure containing distribution details Address of the intent vault *** ### isIntentFunded (Intent) ```solidity theme={null} function isIntentFunded(Intent calldata intent) public view returns (bool) ``` Checks if an intent is completely funded. Intent to validate True if intent is completely funded, false otherwise *** ### isIntentFunded (Destination, Route, Reward) ```solidity theme={null} function isIntentFunded( uint64 destination, bytes memory route, Reward calldata reward ) public view returns (bool) ``` Checks if an intent is fully funded using universal format. Destination chain ID for the intent Encoded route data for the intent as bytes The reward structure containing distribution details True if intent is completely funded, false otherwise ## State-Changing Functions ### publish (Intent) ```solidity theme={null} function publish( Intent calldata intent ) public returns ( bytes32 intentHash, address vault ) ``` Creates an intent without funding. The complete intent struct to be published Hash of the created intent Address of the created vault *** ### publish (Destination, Route, Reward) ```solidity theme={null} function publish( uint64 destination, bytes memory route, Reward memory reward ) public returns ( bytes32 intentHash, address vault ) ``` Creates an intent without funding using universal format. Destination chain ID for the intent Encoded route data for the intent as bytes The reward structure containing distribution details Hash of the created intent Address of the created vault *** ### publishAndFund (Intent) ```solidity theme={null} function publishAndFund( Intent calldata intent, bool allowPartial ) public payable returns ( bytes32 intentHash, address vault ) ``` Creates and funds an intent in a single transaction. The complete intent struct to be published and funded Whether to allow partial funding Hash of the created and funded intent Address of the created vault This function is payable to accept native token (ETH) for funding. *** ### publishAndFund (Destination, Route, Reward) ```solidity theme={null} function publishAndFund( uint64 destination, bytes memory route, Reward calldata reward, bool allowPartial ) public payable returns ( bytes32 intentHash, address vault ) ``` Creates and funds an intent in a single transaction using universal format. Destination chain ID for the intent Encoded route data for the intent as bytes The reward structure containing distribution details Whether to allow partial funding Hash of the created and funded intent Address of the created vault *** ### fund ```solidity theme={null} function fund( uint64 destination, bytes32 routeHash, Reward calldata reward, bool allowPartial ) external payable returns (bytes32 intentHash) ``` Funds an existing intent. Destination chain ID for the intent Hash of the route component Reward structure containing distribution details Whether to allow partial funding Hash of the funded intent Prevents funding of intents that are already withdrawn or refunded. Allows funding of Initial or Funded status intents for partial funding. *** ### fundFor ```solidity theme={null} function fundFor( uint64 destination, bytes32 routeHash, Reward calldata reward, bool allowPartial, address funder, address permitContract ) external payable returns (bytes32 intentHash) ``` Funds an intent for a user with permit/allowance. Destination chain ID for the intent Hash of the route component Reward structure containing distribution details Whether to allow partial funding Address to fund the intent from Address of the permitContract instance Hash of the funded intent *** ### publishAndFundFor (Intent) ```solidity theme={null} function publishAndFundFor( Intent calldata intent, bool allowPartial, address funder, address permitContract ) public payable returns ( bytes32 intentHash, address vault ) ``` Creates and funds an intent using permit/allowance. The complete intent struct Whether to allow partial funding Address to fund the intent from Address of the permitContract instance Hash of the created and funded intent Address of the created vault *** ### publishAndFundFor (Destination, Route, Reward) ```solidity theme={null} function publishAndFundFor( uint64 destination, bytes memory route, Reward calldata reward, bool allowPartial, address funder, address permitContract ) public payable returns ( bytes32 intentHash, address vault ) ``` Creates and funds an intent on behalf of another address using universal format. Destination chain ID for the intent Encoded route data for the intent as bytes The reward structure containing distribution details Whether to accept partial funding The address providing the funding The permit contract for token approvals Hash of the created and funded intent Address of the created vault *** ### withdraw ```solidity theme={null} function withdraw( uint64 destination, bytes32 routeHash, Reward calldata reward ) public ``` Withdraws rewards associated with an intent to its claimant. Destination chain ID for the intent Hash of the intent's route Reward structure of the intent If the intent has been proven on a different chain, this function will challenge the proof instead of withdrawing. *** ### batchWithdraw ```solidity theme={null} function batchWithdraw( uint64[] calldata destinations, bytes32[] calldata routeHashes, Reward[] calldata rewards ) external ``` Batch withdraws multiple intents. Array of destination chain IDs for the intents Array of route hashes for the intents Array of reward structures for the intents All arrays must have the same length, or the function will revert with ArrayLengthMismatch. *** ### refund ```solidity theme={null} function refund( uint64 destination, bytes32 routeHash, Reward calldata reward ) external ``` Refunds rewards to the intent creator. Destination chain ID for the intent Hash of the intent's route Reward structure of the intent Can only be called after the reward deadline has passed, and only if the intent has not been proven/claimed. *** ### refundTo ```solidity theme={null} function refundTo( uint64 destination, bytes32 routeHash, Reward calldata reward, address refundee ) external ``` Refunds rewards to a specified address (only callable by reward creator). Destination chain ID for the intent Hash of the intent's route Reward structure of the intent Address to receive the refunded rewards Only the reward creator (reward.creator) can call this function. *** ### recoverToken ```solidity theme={null} function recoverToken( uint64 destination, bytes32 routeHash, Reward calldata reward, address token ) external ``` Recover tokens that were sent to the intent vault by mistake. Destination chain ID for the intent Hash of the intent's route Reward structure of the intent Token address for handling incorrect vault transfers The token must not be among the intent's reward tokens. This function is for recovering tokens sent to the vault by mistake. ## Events ### IntentPublished ```solidity theme={null} event IntentPublished( bytes32 indexed intentHash, uint64 indexed destination, bytes route, address creator, address prover, uint64 deadline, uint256 nativeAmount, TokenAmount[] tokens ) ``` Emitted when a new intent is published. ### IntentFunded ```solidity theme={null} event IntentFunded( bytes32 indexed intentHash, address indexed funder, bool fullyFunded ) ``` Emitted when an intent is funded (fully or partially). ### IntentWithdrawn ```solidity theme={null} event IntentWithdrawn( bytes32 indexed intentHash, address indexed claimant ) ``` Emitted when rewards are withdrawn to a claimant. ### IntentRefunded ```solidity theme={null} event IntentRefunded( bytes32 indexed intentHash, address indexed refundee ) ``` Emitted when rewards are refunded. ### IntentTokenRecovered ```solidity theme={null} event IntentTokenRecovered( bytes32 indexed intentHash, address indexed creator, address token ) ``` Emitted when tokens are recovered from a vault.