Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HandshakeParameters

interface

HandshakeParameters

description

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

Use this interface whenever you are using the Handshake contract.

Following inputs apply to the Handshake contract class:

Input Type Required? Description
dappIdentifier string Required The dApp identifier, e.g. "folio".
issuer string Required This field should contain the public key of the issuer of the handshake, i.e. the account that initiates the handshake operation.
recipient string Required This field should contain the public key of the recipient of the handshake, i.e. the account of the second participant in the handshake operation.
operation string Required The transaction hash of the confirmed AggregateComplete transaction that contains a handshake operation and encryption keys.



example

Using the HandshakeParameters class

// creating handshake contract inputs
const inputs = {
  dappIdentifier: "my-cool-dapp",
  issuer: "ISSUER_PUBLIC_KEY",
  recipient: "RECIPIENT_PUBLIC_KEY",
  operation: "HANDSHAKE_TRANSACTION_HASH"
} as HandshakeParameters;



Other links

Handshake | Contract | Factory

since

v1.0.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}

issuer

issuer: string

This field should contain the public key of the issuer of the handshake, i.e. the account that initiates the handshake operation.

access

public

example

"71BC0DB348A25D163290C44EF863B031FD5251D4E3674DCE37D78FE6C5F8E0FE"

var

{string}

operation

operation: string

Contains the transaction hash of the confirmed AggregateComplete transaction that contains a handshake operation and encryption keys.

Note that handshake contracts are only valid given that they refer to the transaction hash of a confirmed transaction on dHealth Network.

access

public

example

"..."

var

{string}

recipient

recipient: string

This field should contain the public key of the recipient of the handshake, i.e. the account of the second participant in the handshake operation.

access

public

example

"71BC0DB348A25D163290C44EF863B031FD5251D4E3674DCE37D78FE6C5F8E0FE"

var

{string}

Generated using TypeDoc