Class: Interface

Interface(settings) → {Interface}

Interfaces compile abstract contract code into Chain-executable transactions, or "chaincode". For example, the "Bitcoin" interface might compile a Swap contract into Script, preparing a valid Bitcoin transaction for broadcast which executes the swap contract.

Constructor

new Interface(settings) → {Interface}

Define an Interface by creating an instance of this class.
Parameters:
Name Type Description
settings Object Configuration values.
Properties:
Name Type Description
status String Human-friendly value representing the Interface's current State.
Source:
Returns:
Instance of the Interface.
Type
Interface

Extends

  • EventEmitter

Methods

(async) cycle(val)

Ticks the clock with a named Cycle.
Parameters:
Name Type Description
val String Name of cycle to scribe.
Source:

log(…inputs)

Log some output to the console.
Parameters:
Name Type Attributes Description
inputs any <repeatable>
 Components of the message to long. Can be a single {@link} String, many String objects, or anything else.
Source:

now() → {Number}

Returns current timestamp.
Source:
Returns:
Type
Number

(async) start()

Start the Interface.
Source:

(async) stop()

Stop the Interface.
Source: