Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BurnParameters

interface

BurnParameters

description

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

Use this interface whenever you are using the Burn contract.

Following inputs apply to the Burn contract class:

Input Type Required? Description
dappIdentifier string Required The dApp identifier, e.g. "elevate".
asset string Required The identifier of the asset attached to this operation, e.g. "4ADBC6CEF9393B90".
amount number Required The amount of asset(s) attached to this operation, e.g. 1.
proof string Required The transaction hash of the confirmed MosaicSupplyChange transaction that contains an on-chain burn event.



example

Using the BurnParameters class

// creating burn contract inputs
const inputs = {
  dappIdentifier: "my-cool-dapp",
  asset: "4ADBC6CEF9393B90", ("FIT")
  amount: 1234,
  proof: "..."
} as BurnParameters;



Other links

Burn | Contract | Factory

since

v0.3.0

Hierarchy

Index

Properties

Properties

amount

amount: number

Contains the amount of asset(s) attached to this operations, i.e. this corresponds to the mosaic amount as presented in the resulting transfer transaction's mosaics field.

access

public

example

1

var

{number}

asset

asset: string

Contains the identifier of the asset attached to this operations, i.e. this corresponds to the mosaic identifier as presented in the resulting transfer transaction's mosaics field.

For the purpose of backwards compatibility, the asset input may be empty because previous versions of this contract (v0) did not include an amount of rewarded assets.

access

public

example

"4ADBC6CEF9393B90"

var

{string}

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}

proof

proof: string

Contains the transaction hash of the confirmed MosaicSupplyChange transaction that executes an on-chain burn event for said asset and amount.

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

access

public

example

"..."

var

{string}

Generated using TypeDoc