Core Partner functionality

• The notion of a partner can be configured in the Dashboard using Referrer Profiles.

• Partner mode is enabled when the user accesses the Dashboard site via a url containing referrer profile ID.

• In partner mode the site retains the referrer ID in a cookie:

  • No profile (legacy reg site) setting disabled in Partner Profile

    • For a period of 30 days and the site configuration considers the reflects the partner profile (even if the user leaves the site and comes back within 30 days).

    • When a user creates an account while in partner mode the referrer ID and the site configuration considers above indefinitely, even if cookies are deleted. Meaning every time a user logs in the site should reinsert referrer ID in a cookie which never expires and consider site configuration above indefinitely.

  • No profile (legacy reg site) setting enabled in Partner Profile

    • For a period of session only

• Conflict resolution

  • When a user has one referrer ID stored and accesses the site using another referrer ID, the last referrer ID should be active.

  • If a user creates an account with a specific referrer ID, that ID takes precedents over referrer ID passed in the url.

    • Example 1:

      • User A access the site with referrer ID R

      • User A creates an account

      • User A deletes cookies

      • User A access the landing page with referrer S

      • User logs in = referrer R is inserted in cookie

    • Example 2:

      • User A access the site with referrer ID R

      • User A access the landing page with referrer S

      • User A creates an account

      • Referrer S is inserted in cookie

    • Example 3:

      • User A access the site without referrer

      • User A creates an account

      • User A access the landing page with referrer R

      • User A logs in - no referrer is inserted in cookie

Referrer Profiles

• Referrer profiles are configs loaded manually by developer to the Dashboard site to enable custom behavior. They contain the following settings:

  • Referrer type

    • Partner

    • Affiliate

  • Referrer name

  • Referrer ID - uniquely identifies profile

  • Logo

  • TPID - this TPID is inserted info all FIO Chain transactions

  • Redirect URL - optional. If not passed the contained flow terminates when the action is completed (user is redirected to same page they would have gone through if contain flow was not enabled) and full navigation and functionality is restored.

  • List of domains allowed for registration and their priority - determines which domains will show up in pull-down for domain list for FIO Address Registration.

  • Landing page text

    • Regular

    • Sign NFT

    • Registration

Referrer Profile Values are set in Admin | Partners

Inbound URL Structure

https://www.someurl.com/ref/{id}

• https://www.someurl.com/?ref={id}

Where {id} is referrer profile ID

Contained Flow

Contained flow is different from Partner functionality, but can be used together. See Contained Flow

No Profile Flow

No Profile Flow can be enabled in Partner Profile. For more information see: https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/754188289

Branding

Header

Open

Footer

Open

• If Partner branded is enabled, all pages of the site are branded with partner logo (scaled logo from Partner Profile):

  • Partner logo is shown on header on all pages of the

  • Power by FIO logo is shown in footer

Standard Landing Page

Same as Gated registration except for this block:

• Partner landing page is build dynamically based on the following partner profile values:

  • List of domains allowed for registration

  • A default pre-selected domain

    • If only one domain - always default to the single domain

    • If more than one domain, allow for specification of which domain to be pre-selected

  • Allow custom domain registration

  • Logo

    • Logo measurement maximums (should not exceed this baseline whether that is width or height)

      • Height: 125px

      • Width: 450px

  • Landing Page text

  • Link back to partner site

• Path

  • https://www.someurl.com/ref/{id}

    • {id} - referrer profile ID

Priorities of displaying the content on Partner Landing Page

1. Title

   1. Logo

   2. Ref title (SIGNNFT, REG)

   3. Default title

2. Subtitle/Action Text (Optional & Can be hidden)

   1. Ref contained flow subtitle/action

   2. Default Contained flow subtitle/action

   3. Ref subtitle/action

   4. Default subtitle/action

Gated Registration Landing Page

• Description

  • Gated Registration is a flavor of landing page which requires that the user confirms that they are holding the required NFT or Token in order to be able to register a FIO Handle.

  • It is controlled by Admin selectors on Admin | Edit Partner

• Variables

  • Logo, Title, Sub-title

    • Same as Partner Profile

  • “Registration of FIO Handles on the @apes domain is reserved only for holders of Bored Ape NFTs. Connect your Metamask wallet to complete validation and register your FIO Handle.”

    • @apes - domain from Partner Profile. If multiple, show first.

    • Bored Ape NFTs - Partner Profile Name

  • “Verifying NFT holdings"

    • “Verifying Token holdings"

  • Example FIO Handles

    • “Use the domain from partner profile, e.g. bob@apes”

    • “Use the @apes handle in over 75 leading crypto applications.”

• Validation

  • Initially the entry box is grayed out

  • When user clicks Connect Metamask

    • Connect to Metamask and require the user to sign in using Sign in with Ethereum | MetaMask developer documentation

  • Confirm the user is holding NFT or Token

    • NFT

      • Use https://docs.moralis.io/web3-data-api/evm/wallet-api/how-to-get-all-nfts-owned-by-an-address for public key connected to Metamask

      • Expect token_address in specified as specified in Admin | Edit Partner to exist in result

    • Token

      • Use https://docs.moralis.io/web3-data-api/evm/wallet-api/how-to-get-all-erc20-tokens-owned-by-an-address for public key connected to Metamask

      • Expect balance for token_address as specified in Admin | Edit Partner to be > 0