Goodswap should support invites

[sirpy]

We want to have invites also on goodswap similar to the wallet Challenges:

• multi chains, if we have invite rewards contracts on multiple chains
  • how can we make sure the user can claim bonus only once
  • how do we make sure that the invitee claims on the correct chain where the inviter intended
• UX - the invitee needs to sign multiple TXs to participate

To solve the challenges we will have some changes in the contracts and UX

• the Identity contract will now also keep track on which chain the user requested to get whitelisted on
• we will no longer use short invite codes but rather simply the inviter wallet address so everyone have the same invite code across chains.
• we will also encode in the invite code the target chain invitee is expected to register at
• since we just use the inviter wallet address, we no longer need the first TX to register an invite code, so that can simplify the UX to just 1 TX

SDK

implement one or many hooks based on useInvites.js in the wallet. SDK should support the following

• parse invite link: if user arrived with invite code in url, decode the code into chainId+inviter address. save in local storage the details/code. if already stored in localstorage do not parse url but return existing. this should be called when user opens goodswap.
• join: calls the join(invitee, inviter) method on the Invites contract.
  • read inviter code from localstorage.
  • this should be called once invitee is whitelisted, so this method will also claim the invite reward
  • notice that invitee/inviter address should be encoded as bytes32
• get invites data: how many user has invited, pending invites etc..
• collectBounties: in rare cases, mostly if some interaction happened outside our UI via contracts directly, the bounty could not be collected. This hook should execute the collect bounties on the contract
• get invite link: return a link with the invite code (user wallet address) encoded together with the chainId.

Flows

• when user opens goodswap with invitecode the code should be stored
• when user first claims (ie gets whitelisted) or if user is already whitelisted, bounty collection should be triggered (if has inviter code stored)
• user should be able to copy his invite link. do we want to display the invite link to non whitelisted users? (they and the invited users do not get the reward until they are whitelisted)
• optional: user should see list of wallets he invited. there probably wouldn't be any pending invites since users will call "join" only once they are whitelisted and not at the moment they login like on the wallet.
• optional: do we support invite on goodswap for multiple chains? or just Celo? that means that
  • invite link is encoded with chainId, and a different link is displayed based on the current connected network on goodswap
  • if user arrives with invite link, he needs to be notified that he needs to get whitelisted on the chain of his inviter

[L03TJ3]

@decentralauren considering the succes-rate (right?) whenever we run campaigns. could be interesting to re-evaluate

[decentralauren]

@sirpy -

• has this already been built to support bringing Invite Rewards to GW2?
• If so, is there additional work to be done to bring it into GoodDapp (beyond basic UI work)?

[sirpy]

GW2 doesnt require anything special. This feature UI should be built for both GW2 and gooddapp to save work.

[decentralauren]

Thanks @sirpy, I agree. Have Sune and Alex started building Invite Rewards for GW2? If so, how can we track the in-progress work? If not this is work we should begin asap.