> For the complete documentation index, see [llms.txt](https://docs.gooddollar.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gooddollar.org/previous-protocol-versions/protocol-v3/core-contracts-and-api/exchangehelper.md). # ExchangeHelper ### Events #### TokenPurchased Emitted when G$ tokens are purchased.
Parameter nameAnnotation
callerThe address who initiated the action.
inputTokenThe convertible token address which the G$ tokens were purchased with.
inputAmountReserve tokens amount.
actualReturnActual return after the conversion.
receiverAddressAddress of the receiver of the tokens.
``` event TokenPurchased( address indexed caller, address indexed inputToken, uint256 inputAmount, uint256 actualReturn, address indexed receiverAddress ); ``` #### TokenSold Emitted when G$ tokens are sold.
Parameter nameAnnotation
callerThe address who initiated the action.
outputTokenThe convertible token address which the G$ tokens were sold to.
gdAmountThe G$ tokens amount.
contributionAmountThe amount of G$ tokens that was contributed during the conversion.
actualReturnActual return after the conversion.
receiverAddressAddress of the receiver of tokens.
``` event TokenSold( address indexed caller, address indexed outputToken, uint256 gdAmount, uint256 contributionAmount, uint256 actualReturn, address indexed receiverAddress ); ``` ### buy The function converts any "buyWith" tokens to DAI. Then call to reserve's buy function is occured. It is to convert the tokens to G$ tokens.
Parameter nameAnnotation
_buyPathThe tokens swap path in order to buy G$ if initial token is not DAI or cDAI. The end of the path must be set to DAI.
_tokenAmountThe amount of "buyWith" tokens that should be converted to G$ tokens.
_minReturnThe minimum allowed return in G$ tokens.
_minDAIAmountThe minimum DAI out amount from Exchange swap function.
_targetAddressThe address of G$ and GDX recipient if different than msg.sender.
Returns: how much G$ tokens were transferred. ``` function buy( address[] memory _buyPath, uint256 _tokenAmount, uint256 _minReturn, uint256 _minDAIAmount, address _targetAddress ) public payable returns (uint256); ``` ### sell The function converts G$ tokens to cDAI through reserve then it makes further transactions according to desired `_sellTo` token. The user could either send cDAI or DAI directly or desired token through Uniswap V2.
Parameter nameAnnotation
_sellPathThe tokens swap path in order to sell G$ to target token. If target token is not DAI or cDAI then first element of the path must be DAI.
_gdAmountThe amount of G$ tokens that should be converted to "_sellTo" tokens.
_minReturnThe minimum allowed "sellTo" tokens return.
_minTokenReturnThe mininmum DAI out amount from Exchange swap function.
_targetAddressThe address of "_sellTo" token recipient if different than msg.sender.
Returns: how much "sellTo" tokens were transferred. ``` function sell( address[] memory _sellPath, uint256 _gdAmount, uint256 _minReturn, uint256 _minTokenReturn, address _targetAddress ) public returns (uint256); ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.gooddollar.org/previous-protocol-versions/protocol-v3/core-contracts-and-api/exchangehelper.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.