Skip to main content
Explore this module further in the Mover Registry: @sage/user

Structs

Invite

An invitation to join the protocol.

InviteConfig

Manages whether invites are required.

UserInviteRegistry

Collection of all outstanding invitations.

Events

InviteDeleted

Fires when an Invite is deleted.

Constants

Error code thrown when an Invite does not exist.
Error code thrown when an Invite is not valid.
Error code thrown when Invites are not required.

Functions

assert_invite_exists

Aborts with EInviteDoesNotExist if the registry does not contain the invite key.

assert_invite_not_required

Aborts with EInviteNotAllowed if invites are required.

assert_invite_is_valid

Aborts with EInviteInvalid if the Invite is not valid.

get_destructured_invite

Returns the stored hash and user wallet info.

has_record

Returns true or false based on whether the invite exists in the registry.

is_invite_required

Returns true or false based on whether invites are required.

is_invite_valid

Returns true or false depending on whether the Invite is valid.