> 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/invites.md). # Invites ### Events #### InviteeJoined Emitted when user is joined.
Parameter nameAnnotation
inviterThe address of the user who invited.
inviteehe address of the user who is being invited.
``` event InviteeJoined(address indexed inviter, address indexed invitee); ``` #### InviterBounty Emitted when inviter bounty is paid.
Parameter nameAnnotation
inviterThe address of the user who invited.
inviteeThe address of the user who is being invited.
bountyPaidThe amount of bounty.
inviterLevelThe inviter level.
earnedLevelThe level which the inviter is earned.
``` event InviterBounty( address indexed inviter, address indexed invitee, uint256 bountyPaid, uint256 inviterLevel, bool earnedLevel ); ``` ### join The function is to be called by the user to join.
Parameter nameAnnotation
_myCodeThe users invitation code.
_inviterCodeThe inviters invitation code.
``` function join(bytes32 _myCode, bytes32 _inviterCode) public; ``` ### canCollectBountyFor The function is to clarify for the user who invited someone if he can claim bounty for the user who was being invited.
Parameter nameAnnotation
_inviteeThe user who was being invited.
``` function canCollectBountyFor(address _invitee) public view returns (bool); ``` ### getInvitees The function is to be called to get the list of the invitees of the `_inviter`.
Parameter nameAnnotation
_inviterThe inviter address.
Returns: list of the invitees of the particular inviter. ``` function getInvitees(address _inviter) public view returns (address[] memory); ``` ### getPendingInvitees The function is to be called to get the list of the pending invitees of the `_inviter`.
Parameter nameAnnotation
_inviterThe inviter address.
Returns: list of the pending invitees of the particular inviter. ``` function getPendingInvitees(address _inviter) public view returns (address[] memory); ``` ### getPendingBounties The function is to be called to get the list of the pending bounties of the `_inviter`.
Parameter nameAnnotation
_inviterThe inviter address.
Returns: list of the pending bounties of the particular inviter. ``` function getPendingBounties(address _inviter) public view returns (uint256); ``` ### bountyFor The function is to be called to pay bounty for the inviter of `_invitee`.
Parameter nameAnnotation
_inviteeThe invitee address.
``` function bountyFor(address _invitee) public; ``` ### collectBounties The function collects bounties for invitees by `msg.sender` that are now whitelisted. ``` function collectBounties() public; ``` ### bountyFor The function is to be called to pay bounty for the inviter of `_invitee`.
Parameter nameAnnotation
_inviteeThe invitee address.
``` function bountyFor(address _invitee) public; ``` --- # 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/invites.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.