Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WelcomeParameters

interface

WelcomeParameters

description

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

Use this interface whenever you are using the Welcome contract.

Following inputs apply to the Welcome contract class:

Input Type Required? Description
dappIdentifier string Required The dApp identifier, e.g. "elevate".
message string Optional An optional welcome message or a greeting.



example

Using the WelcomeParameters class

// creating authentication contract inputs
const inputs = {
  dappIdentifier: "my-cool-dapp",
  message: "Welcome to my cool dApp!",
} as WelcomeParameters;



Other links

Welcome | 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}

Optional message

message?: string

An optional welcome message that is attached to a contract operation. Welcome message are merely a way to greet new users and currently do not fill any other purpose.

Note that the welcome message is optional in the Welcome contract and may be omitted.

access

public

example

"Welcome to my cool dApp!"

var

{string}

Generated using TypeDoc