Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReferralParameters

interface

ReferralParameters

description

This interface defines the requirements for objects passed as inputs to Referral instances.

Use this interface whenever you are using the Referral contract.

Following inputs apply to the Referral contract class:

Input Type Required? Description
dappIdentifier string Required The dApp identifier, e.g. "elevate".
refCode string Required The referral code for this referral operation, e.g. "ELEVATE2022".



example

Using the ReferralParameters class

// creating authentication contract inputs
const inputs = {
  dappIdentifier: "my-cool-dapp",
  refCode: "ELEVATE2022",
} as ReferralParameters;



Other links

Referral | Contract | Factory

since

v0.3.0

Hierarchy

Index

Properties

Properties

dappIdentifier

dappIdentifier: string

A human-readable dApp identifier, e.g. "ELEVATE".

Note that this field will be slugified using the Contract.dApp method before it is attached to the transfer transaction message.

access

public

example

"My Cool dApp"

var

{string}

refCode

refCode: string

The referral code input that is linked to another end-user of the dApp. Referral codes permit the dApp to keep track of new users invitations.

This referral code is required and you can assume that it is always present in the Referral contract.

access

public

example

"ELEVATE2022"

var

{string}

Generated using TypeDoc