> 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/goodreservecdai.md). # GoodReserveCDai The contract also acts as the GoodDollar liquidity pool and AMM (Automatic Market Maker) and enables methods to buy and sell G$s. ### Events #### UBIMinted Emitted when new G$ tokens are minted.
Parameter nameAnnotation
dayEpoch of UBI.
interestTokenThe token paid as interest.
interestReceivedWei amount of interest paid in interestToken.
gdInterestMintedAmount of G$ tokens that was added to the supply as result of mintInterest function.
gdExpansionMintedAmount of G$ tokens that was added to the supply as a result of mintExpansion function.
gdUbiTransferredAmount of G$ tokens that was minted to the ubiCollector contract.
``` event UBIMinted( uint256 indexed day, address indexed interestToken, uint256 interestReceived, uint256 gdInterestMinted, uint256 gdExpansionMinted, uint256 gdUbiTransferred ); ``` #### TokenPurchased Emitted when G$ tokens are purchased from the reserve.
Parameter nameAnnotation
callerThe initiate person of the event.
inputTokenThe convertible token address which the G$ tokens were purchased with.
inputAmountReserve tokens amount.
actualReturnActual return of the tokens after the conversion.
receiverAddressThe address of the receiver of tokens.
``` event TokenPurchased( address indexed caller, address indexed inputToken, uint256 inputAmount, uint256 actualReturn, address indexed receiverAddress ); ``` #### TokenSold Emitted when G$ tokens are sold to the reserve.
Parameter nameAnnotation
callerThe initiate person of the event.
outputTokenThe convertible token address which the G$ tokens were sold to.
gdAmountReserve tokens amount.
contributionAmountActual return of the tokens after the conversion.
actualReturnThe address of the receiver of tokens.
receiverAddressThe address of the receiver of the tokens.
``` event TokenSold( address indexed caller, address indexed outputToken, uint256 gdAmount, uint256 contributionAmount, uint256 actualReturn, address indexed receiverAddress ); ``` ### buy Converts cDai tokens to GD tokens and updates the bonding curve params. The `buy` occurs only if the G$ return is above the given minimum. It is possible to buy only with cDAI and when the contract is set to active. MUST call to cDAI `approve` prior this action to allow this contract to accomplish the conversion. | Parameter name | Annotation | | --------------- | ---------------------------------------------------------------- | | \_tokenAmount | The amount of cDAI tokens that should be converted to G$ tokens. | | \_minReturn | The minimum allowed return in G$ tokens. | | \_targetAddress | Address of G$ and GOOD recipient if different than `msg.sender`. | Returns: How much G$ tokens were transferred. ``` function buy( uint256 _tokenAmount, uint256 _minReturn, address _targetAddress ) external returns (uint256); ``` ### sell The `sell` helper function burns G$ tokens and update the bonding curve params. The `sell` occurs only if the token return is above the given minimum. Notice that there is a contribution amount from the given GD that remains in the reserve.
Parameter nameAnnotation
_gdAmountThe amount of GD tokens that should be converted to cDAI tokens.
_minReturnThe minimum allowed amount of cDAI tokens to return.
_targetAddress of the receiver of cDAI when sell G$.
_sellerAddress of the seller when using helper contract.
Returns: The tuple of two: cDAI received amount and G$ exit contribution. ``` function sell( uint256 _gdAmount, uint256 _minReturn, address _target, address _seller ) external returns (uint256, uint256); ``` ### mintRewardFromRR Mint rewards for staking contracts in G$ and update RR requires minting permissions which is enforced by [`_mintGoodDollars`](https://github.com/GoodDollar/GoodProtocol/blob/master/contracts/reserve/GoodReserveCDai.sol#L305) function.
Parameter nameAnnotation
_tokenThe amount of GD tokens that should be converted to cDAI tokens.
_toThe minimum allowed amount of cDAI tokens to return.
_amountAddress of the receiver of cDAI when sell G$.
Returns: The tuple of two: cDAI received amount and G$ exit contribution. ``` function mintRewardFromRR( address _token, address _to, uint256 _amount ) public; ``` ### mintUBI Only FundManager or other with mint G$ permission can call this to trigger minting. Reserve sends UBI + interest to FundManager.
Parameter nameAnnotation
_daiToConvertDAI amount to convert cDAI.
_startingCDAIBalanceInitial cDAI balance before staking collect process start.
_interestTokenThe token that was transfered to the reserve.
Returns: The tuple of two: how much GD UBI was minted and how much cDAI collected from staking contracts. ``` function mintUBI( uint256 _daiToConvert, uint256 _startingCDAIBalance, ERC20 _interestToken ) public returns (uint256, 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/goodreservecdai.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.