Skip to content

Commit

Permalink
(Hub): inviteHuman doc
Browse files Browse the repository at this point in the history
  • Loading branch information
benjaminbollen committed Feb 6, 2024
1 parent e9e8a6a commit 73ec1fd
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/multitoken-graph/Hub.sol
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,14 @@ contract Hub is Circles {
_trust(msg.sender, msg.sender, INDEFINITELY);
}

/**
* Invite human allows to register another human avatar.
* The inviter must burn twice the welcome bonus of their own Circles,
* and the invited human receives the welcome bonus in their personal Circles.
* The inviter is set to trust the invited avatar.
* @param _human avatar of the human to invite
*/
function inviteHuman(address _human) external {
// todo: if groups invite, we need to handle the burn of collateral properly.
require(isHuman(msg.sender), "Only humans can invite.");

// insert avatar into linked list; reverts if it already exists
Expand Down

0 comments on commit 73ec1fd

Please sign in to comment.