From 73ec1fd23269c4c80ce3feccb0aaecb9e6239854 Mon Sep 17 00:00:00 2001 From: Benjamin Bollen Date: Tue, 6 Feb 2024 15:38:38 +0000 Subject: [PATCH] (Hub): inviteHuman doc --- src/multitoken-graph/Hub.sol | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/multitoken-graph/Hub.sol b/src/multitoken-graph/Hub.sol index 9898c1c..f4d0ee2 100644 --- a/src/multitoken-graph/Hub.sol +++ b/src/multitoken-graph/Hub.sol @@ -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