Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Auth

description

This class contains the implementation of the authentication contract which is used to discover operations of log-in in the dApp.

Use this class whenever you are interpreting an operation of log-in for your dApp. Also, an instance of this class is created using Factory.createFromJSON given a contract signature that matches: /:auth$/ (ends with).

Parameters

Following inputs apply to the Auth contract class:

Input Type Required? Description
dappIdentifier string Required The dApp identifier, e.g. "elevate".
challenge string Required The authentication challenge used for this log-in operation, e.g. "abcdef12".
refCode string Optional An optional referral code, e.g. "ELEVATE2022".



example

Using the Auth contract class

// creating an authentication contract
const contract: Auth = new Auth({
  dappIdentifier: "elevate",
  challenge: "abcdef12",
  refCode: "ELEVATE2022",
});



Other links

AuthParameters | Contract | Factory

since

v0.3.0

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Construct an authentication contract. Note that some of the inputs are required.

    The authentication contract requires inputs including the dappIdentifier and challenge, refer to the above parameters description for more details.

    access

    public

    Parameters

    • inputs: AuthParameters

      The inputs that are used during execution ("arguments").

    • version: number = 1

      (Optional) The contract version number (defaults to 1).

    • parameters: NetworkParameters = ...

      (Optional) The network parameters ("connection").

    Returns Auth

Properties

inputs

inputs: AuthParameters

parameters

parameters: NetworkParameters = ...

Readonly version

version: number = 1

Accessors

body

  • This method should return an ObjectLiteral that consists of the body of the contract, e.g. in the Auth contract the body contains a challenge.

    In the authentication contract, we always include the challenge and optionally include the refCode field if it is non-empty.

    Note that by modifying the required fields of a contract's body, you must also update the version of the contract to prevent inconsistencies in operations.

    access

    public

    abstract

    Returns ObjectLiteral

    An object that consists of custom fields related to the scope of the contract.

Private dApp

  • get dApp(): string

  • This getter method transforms the provided dappIdentifier input into a slug. The characters set for valid slugs includes: lowercase alpha-numerical characters, underscores and hyphens. Additionally, multiple hyphens in a series are replaced for single hyphens.

    This method is used internally to determine a dapp identifier that is compliant to a strict characters set.

    access

    private

    Returns string

    A slugified dApp identifier as present on-chain.

header

  • This getter method prepares the contract header. The header consists of the contract signature and version of the contract.

    The contract header is always attached to contracts using the toJSON method.

    access

    public

    Returns ObjectLiteral

    An object that consists of the contract signature and version.

identifier

  • get identifier(): string

  • This method should return a string that is used as the identifier of the contract being executed.

    This identifier will be concatenated with the dApp identifier to form the contract signature.

    This method should return an identifier that is unique across one dApp, i.e. it is OK to re-define an earn contract in a different dApp than elevate.

    access

    public

    abstract

    Returns string

    A contract identifier as present on-chain in the contract signature.

payload

  • This getter method returns the contract payload as it is attached inside transfer transaction messages.

    This method is used internally to determine a contract payload that is used to produce JSON in toJSON.

    access

    public

    Returns ObjectLiteral

    A full contract payload (with "contract" and "version").

signature

  • get signature(): string

  • This getter method returns the contract signature as it is attached inside contracts' JSON payloads.

    This method is used internally to determine a contract signature that is included in the contract header.

    access

    public

    Returns string

    A contract signature, e.g. "elevate:auth".

Methods

Protected getRecipientAddress

  • Helper method that creates an Address instance out of transaction parameters. Parameters may include a recipientPublicKey or a recipientAddress. If both are provided, the recipientAddress takes precedence.

    Note that in the case of providing a `recipientPublicKey, this method uses the internal Contract.parameters to determine the network identifier.

    Parameters

    • parameters: TransactionParameters

      A configuration object that is passed to the creation process of the dHealth Network Transaction.

    Returns Address

    A dHealth Network Account Address from @dhealth/sdk.

toJSON

  • toJSON(): string

  • This method creates a JSON payload using the contract header and the custom body fields, as defined in child classes.

    Note that the resulting string is attached as is to the transfer transaction on dHealth Network.

    access

    public

    Returns string

    A JSON payload that can be attached to transfer transactions.

toTransaction

  • This method should return a prepared Transaction object from @dhealth/sdk. This transaction will not be broadcast or signed yet and this method can be called without requiring an internet connection ("off-line").

    Note that by modifying the transaction that is created when executing a contract, you must also update the version of the contract to prevent inconsistencies in operations.

    access

    public

    abstract

    Parameters

    • parameters: TransactionParameters

      A configuration object that is passed to the creation process of the dHealth Network Transaction.

    Returns TransferTransaction

    A prepared (but unsigned) dHealth Network Transaction.

Static fromTransaction

  • This method uses a Transaction child class from which it reads the contract JSON payload.

    Invalid JSON errors will trigger the InvalidContractError exception to be thrown.

    This method is used internally to transform a Transaction object into an ObjectLiteral by making sure that the JSON payload uses valid JSON formatting rules and lives inside either of: the transfer transaction message or the aggregate bundle's first transfer transaction's message.

    access

    protected

    throws

    {InvalidContractError} Given no contract JSON payload is found or given a contract JSON payload that contains invalid JSON and could not get parsed into a contract.

    Parameters

    • transaction: Transaction

      A transaction object that contains the full definition of the executed contract.

    Returns ObjectLiteral

    A parsed contract consists of an object of type ObjectLiteral.

Generated using TypeDoc