use std :: hash; use std :: string; use sui :: event; use sui :: package; use sui :: table; use sage_admin :: admin; Explore this module further in the Mover Registry: @sage/user
Structs InviteAn invitation to join the protocol.
public struct Invite has copy , drop , store hash : vector < u8 >, user : address InviteConfigManages whether invites are required.
public struct InviteConfig has key id : sui :: object :: UID , required : bool UserInviteRegistryCollection of all outstanding invitations.
public struct UserInviteRegistry has key id : sui :: object :: UID , registry : sui :: table :: Table < std :: string :: String , Invite > Events InviteDeletedFires when an Invite is deleted.
public struct InviteDeleted has copy , drop invite_key : std :: string :: String Constants Error code thrown when an Invite does not exist.
const EInviteDoesNotExist : u64 = 370 ; Error code thrown when an Invite is not valid.
const EInviteInvalid : u64 = 371 ; Error code thrown when Invites are not required.
const EInviteNotAllowed : u64 = 372 ; Functions assert_invite_existsAborts with EInviteDoesNotExist if the registry does not contain the invite key.
public fun assert_invite_exists ( user_invite_registry : & UserInviteRegistry , invite_key : String ) public fun assert_invite_exists ( user_invite_registry : & UserInviteRegistry , invite_key : String ) { let has_record = has_record ( user_invite_registry , invite_key ); assert! ( has_record , EInviteDoesNotExist ); } assert_invite_not_requiredAborts with EInviteNotAllowed if invites are required.
public fun assert_invite_not_required ( invite_config : & InviteConfig ) public fun assert_invite_not_required ( invite_config : & InviteConfig ) { let is_invite_required = is_invite_required ( invite_config ); assert! ( ! is_invite_required , EInviteNotAllowed ); } assert_invite_is_validAborts with EInviteInvalid if the Invite is not valid.
public fun assert_invite_is_valid ( invite_code : String , invite_key : String , invite_hash : vector < u8 >) public fun assert_invite_is_valid ( invite_code : String , invite_key : String , invite_hash : vector < u8 > ) { let is_invite_valid = is_invite_valid ( invite_code , invite_key , invite_hash ); assert! ( is_invite_valid , EInviteInvalid ); } get_destructured_inviteReturns the stored hash and user wallet info.
public fun get_destructured_invite ( user_invite_registry : & UserInviteRegistry , invite_key : String ) : ( vector < u8 >, address ) public fun get_destructured_invite ( user_invite_registry : & UserInviteRegistry , invite_key : String ) : ( vector < u8 >, address ) { let invite = * user_invite_registry . registry . borrow ( invite_key ); let Invite { hash , user } = invite ; ( hash , user ) } has_recordReturns true or false based on whether the invite exists in the registry.
public fun has_record ( user_invite_registry : & UserInviteRegistry , invite_key : String ) : bool public fun has_record ( user_invite_registry : & UserInviteRegistry , invite_key : String ) : bool { user_invite_registry . registry . contains ( invite_key ) } is_invite_requiredReturns true or false based on whether invites are required.
public fun is_invite_required ( invite_config : & InviteConfig ) : bool public fun is_invite_required ( invite_config : & InviteConfig ) : bool { invite_config . required } is_invite_validReturns true or false depending on whether the Invite is valid.
public fun is_invite_valid ( invite_code : String , invite_key : String , invite_hash : vector < u8 >) : bool public fun is_invite_valid ( invite_code : String , invite_key : String , invite_hash : vector < u8 > ) : bool { let mut combined = utf8 ( b"" ); combined . append ( invite_code ); combined . append ( invite_key ); let bytes = into_bytes ( combined ); let computed_hash_bytes = sha3_256 ( bytes ); let computed_length = computed_hash_bytes . length (); let provided_length = invite_hash . length (); if ( computed_length != provided_length ) { return false }; let mut index = 0 ; while ( index < computed_length ) { if ( computed_hash_bytes [ index ] != invite_hash [ index ]) { return false }; index = index + 1 ; }; true } 
