Invitation

[bob2402]

A user who has joined Space can generate an invitation link. Then the user can share this link with others. Others can join Space by clicking on this link.

Invite Flow

graph TD;
  joined[Users who have joined the space] --> permission{invite permission?};
	permission -->|have| options[invite optionns];
	permission -->|haven't| none;
	options -->|expire time, limit count| url[send invite event and generate invite url];
	url --> onboarding[onboarding page with invite url];
	onboarding --> keyless[keyless user];
	onboarding --> not-logged[key user who is not logged in to the client];
	onboarding --> logged[key user who has logged in to the client];
	keyless --> generate[gennerate key];
	not-logged --> login[login to client];
	generate --> logged;
	login --> logged;
	logged --> join{Already joined?};
	join -->|yes| current[change current space to invited space];
	join -->|no| send[connect space with join event];
	send --> success{joining successful?};
	success -->|success| current;
  success -->|error| error[show error];

Loading

Optional

• Permission to generate invitation links：admin, allow list and joined user(kind 1 allow list)
• Invitation link options：expire time and limit count

URL

https://blowater.app/invite/[invite event id with hostnname]

The hostname or url is carried here so that the client knows which space to join

Invite Event

const inviteEvent = {
  id: "",
  sig: ""
  pubkey: "",
  kind: "invite"
  expired_on: "rfc3339 timestamp",
  limit_count: 5,
}

Join Event

const joinEvent = {
  id: "",
  sig: "",
  pubkey: "",
  kind: "join",
  invite_id: "invite event id",
}

Since there is currently no websocket connection, this event is included in the URL query when requesting a connection.

Revoke flow

Revoking the invitation invalidates the event, preventing new users from using the URL to join.

The client needs an additional management interface to manage URLs.