@@ -4,36 +4,103 @@ weight = 9
44template = "doc.html"
55+++
66
7−If you're a star owner, you have the ability to create **invite pools**. These invite pools let you give your friends a piece of the network in the form of planets. This document will give you an explanation of how to create an invite pool and how to share it with your friends using our tool [Bridge](https://bridge.urbit.org).
7+If you're a star owner, you have the ability to create **invite pools**. These
8+invite pools let you give your friends a piece of the network in the form of a
9+planet. This document will give you an explanation of how to create an invite
10+pool and how to share it with your friends using our tool
11+[Bridge](https://bridge.urbit.org).
812
9−For more general tips on using your star, check out the [Star and Galaxy Operations page](https://urbit.org/using/operations/stars-and-galaxies/).
13+For more general tips on using your star, check out the [Star and Galaxy
14+Operations page](https://urbit.org/using/operations/stars-and-galaxies/).
1015
1116## Anatomy of an Invite Pool
1217
13−An invite pool is a set of planet invites that can be distributed via email; each invite is worth one planet when redeemed. An invite pool can be as big as you'd like, providing that you have enough planets left to spawn. All invite pools must be created by a star, but they must be given to a planet. If you're interested in how this works technically, take a look at the [DelegatedSending.sol contract](https://github.com/urbit/azimuth/blob/master/contracts/DelegatedSending.sol).
18+An invite pool is a set of planet invites that can be distributed via email or
19+URL; each invite is worth one planet when redeemed. An invite pool can be as big
20+as you'd like, providing that you have enough planets left to spawn. All invite
21+pools must be created by a star, but they must be given to a planet. If you're
22+interested in how this works technically, take a look at the
23+[DelegatedSending.sol
24+contract](https://github.com/urbit/azimuth/blob/master/contracts/DelegatedSending.sol).
1425
15−Keep in mind that all planets will have access to the invite pool until the invite pool is exhausted.
26+Keep in mind that all planets will have access to the invite pool until the
27+invite pool is exhausted.
1628
17−For example: As `~marzod`, I spawn `~wicdev-wisryt` and give it an invite pool of 100 planets. `~wicdev-wisryt` can now send an invite to a friend at galen@tlon.io. When Galen claims his planet (`~ravmel-ropdyl`), `~ravmel-ropdyl` can now invite his friend — or 99 of them.
29+For example: As `~marzod`, I spawn `~wicdev-wisryt` and give it an invite pool
30+of 100 planets. `~wicdev-wisryt` can now send an invite to a friend at
31+galen@tlon.io. When Galen claims his planet (`~ravmel-ropdyl`), `~ravmel-ropdyl`
32+can now invite his friend — or 99 of them. `~wicdev-wisryt` may also continue to
33+use the invite pool, as can anybody they invite.
1834
19−## How to Invite Friends
35+## How To Create an Invite Pool
2036
21−Giving your friends a piece of Urbit only takes a few minutes: send an invite pool to a planet, and then that planet can email an invite to a friend (or friends)
37+Giving your friends a piece of Urbit only takes a few minutes: send an invite
38+pool to a planet, and then that planet can email an invite to a friend (or
39+friends)
2240
23411. Log into Bridge using your ownership address for your star.
2442
25−2. Get the name (like `~poldec-tonteg`) of the planet to whom you'd like to give invites, it can be one you control or a friend's.
43+2. Change the spawn proxy of your star to
44+ `0xF7908Ab1F1e352F83c5ebc75051c0565AEaea5FB`. This is a contract address that
45+ will handle the spawning of planets for invitees.
2646
27−3. Click "Manage Invite Pools" to assign an invite pool to the planet. You may receive a notification that you need to assign your spawn proxy to the address of the Delegated Sending contract. This is so that the contract can send invites on your behalf when the recipient claims them.
47+3. Get the `@p` (like `~poldec-tonteg`) of the planet to whom you'd like to give
48+ access to the invite pool. It can be one you control or a friend's. It does
49+ not have to be a planet sponsored by your star.
50+
51+3. Click "Manage Invite Pools" to assign an invite pool to the planet. You may
52+ receive a notification that you need to assign your spawn proxy to the
53+ address of the Delegated Sending contract. This is so that the contract can
54+ send invites on your behalf when the recipient claims them. This address is
55+ `0xF7908Ab1F1e352F83c5ebc75051c0565AEaea5FB`, which is also displayed in Bridge.
2856
2957
3058
31−4. Enter the planet name and the number of invites you'd like to assign them.
59+4. Enter the `@p` of the planet and the number of invites you'd like to assign to them.
3260
3361
3462
35−5. If you control the planet that you gave the invite pool to, it should be accessible from the Bridge homepage. Click the Planet, then "Invite" to create invites for your friends.
63+Once the transaction is complete, the planet will have access to the invite pool.
64+
65+## How to Send an Invite
66+
67+1. Log into Bridge using the planet assigned an invite pool above using the
68+ planet's Master Ticket or ownership address.
69+
70+2. Under "Invite Group", click "Add Members" to unroll the invitation UI.
71+
72+3. Select either "Email" or "URL".
73+
74+4. If you selected "Email", enter the email address(es) of those you wish to
75+ invite to the dialog box. You may add more than one email address. Click "Add to
76+ Invite Group" when finished, and wait for the transaction to complete. Your
77+ friend(s) will get an email shortly with your gift of an identity for life!
78+
79+ If you selected "URL", click "Generate Invite URL" to create an invitation URL
80+ that you can then share.
81+
82+## FAQ
83+
84+Q. What happens if the spawn proxy address is changed away from
85+`0xF7908Ab1F1e352F83c5ebc75051c0565AEaea5FB` after an invite pool has been
86+created? Will outstanding invite pool(s) still function?
87+A. They won't. Existing balances will remain, but Bridge (and `azimuth-js`) won't
88+consider any of the invites from that star usable, and trying to send one of
89+their planets anyway will result in a failed transaction.
90+
91+Q. Can a star create more than one invite pool at a time?
92+A. Yes, a star can allow any given planet to send any number of invites
93+independently from one another.
94+
95+Q. Can an invite pool be revoked?
96+A. Yes, this may be done by assigning zero invites to a planet that had been
97+previously been given access to an invite pool.
3698
37−
99+Q. Can a delegated planet have more than one invite pool assigned to it?
100+A. Yes, as a planet, multiple stars can give you invites to use.
38101
39−Your friend will get an email shortly with your gift of an identity for life!
102+Q. What can you do if you send an invite to an email address by mistake?
103+A. Planets that have been sent but not yet claimed live at the
104+ownership address of the star that created the invite pool. Log into Bridge
105+using the ownership address for the star and you will be able to cancel the
106+pending invite. Once an invite has been accepted, nothing can be done!