Classes

Actor

Generic Fabric Actor.

Aggregator

Aggregates a set of balances (inputs).

App ⇐ Service

Web-friendly application framework for building single-page applications with Fabric-based networking and storage.

Chain

Chain.

Channel

The Channel is a encrypted connection with a member of your Peer group, with some amount of $BTC bonded and paid for each correctly-validated message.

Channels in Fabric are powerful tools for application development, as they can empower users with income opportunities in exchange for delivering service to the network.

Circuit

The Circuit is the mechanism through which Fabric operates, a computable directed graph describing a network of Peer components and their interactions (side effects). See also Swarm for deeper *inspection of Machine mechanics.

CLI

Provides a Command Line Interface (CLI) for interacting with the Fabric network using a terminal emulator.

Collection

The Collection type maintains an ordered list of State items.

Compiler : Actor

Compilers build interfaces for users of Fabric applications.

Consensus

Provides various network-specific rules.

Entity : Object

Live instance of an ARC in Fabric.

Environment

Interact with the user's Environment.

Fabric

Reliable decentralized infrastructure.

Federation

Create and manage sets of signers with the Federation class.

Filesystem

Interact with a local filesystem.

Hash256

Simple interaction with 256-bit spaces.

HKDF

Provides an HMAC-based Extract-and-Expand Key Derivation Function (HKDF), compatible with RFC 5869. Defaults to 32 byte output, matching Bitcoin's implementaton.

Identity

Manage a network identity.

Interface ⇐ EventEmitter

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.

Key

Represents a cryptographic key.

Keystore

Provides an encrypted datastore for generic object storage.

Ledger ⇐ Scribe

An ordered stack of pages.

Logger ⇐ Actor

A basic logger that writes logs to the local file system

Machine

General-purpose state machine with Vector-based instructions.

Mempool

Stores a list of Transaction elements.

Message : Object

The Message type defines the Application Messaging Protocol, or AMP. Each Actor in the network receives and broadcasts messages, selectively disclosing new routes to peers which may have open circuits.

Node

Full definition of a Fabric node.

Oracle ⇐ Store

An Oracle manages one or more collections, using a mempool for transitive state.

Path

A Path is a Fabric-native link to a Document within the network.

Peer

An in-memory representation of a node in our network.

Reader

Read from a byte stream, seeking valid Fabric messages.

Remote : Remote

Interact with a remote Resource. This is currently the only HTTP-related code that should remain in @fabric/core — all else must be moved to @fabric/http before final release!

Resource

Generic interface for collections of digital objects.

Router ⇐ Scribe

Process incoming messages.

Scribe ⇐ State

Simple tag-based recordkeeper.

Script

Service

The "Service" is a simple model for processing messages in a distributed system. Service instances are public interfaces for outside systems, and typically advertise their presence to the network.

To implement a Service, you will typically need to implement all methods from this prototype. In general, connect and send are the highest-priority jobs, and by default the fabric property will serve as an I/O stream using familiar semantics.

Session

The Session type describes a connection between Peer objects, and includes its own lifecycle.

Signer ⇐ Actor

Generic Fabric Signer.

Snapshot

A type of message to be expected from a Service.

Stack

Manage stacks of data.

State ⇐ EventEmitter

The State is the core of most User-facing interactions. To interact with the User, simply propose a change in the state by committing to the outcome. This workflow keeps app design quite simple!

Store

Long-term storage.

Swap : Object

The Swap contract executes a set of transactions on two distinct Chain components, utilizing a secret-reveal mechanism to atomically execute either the full set or none.

Swarm : String

Orchestrates a network of peers.

Transition

The Transition type reflects a change from one finite State to another.

Tree

Class implementing a Merkle Tree.

Value

Number-like type.

Vector

Walker

Wallet : Object

Manage keys and track their balances.

Worker

Workers are arbitrary containers for processing data. They can be thought of almost like "threads", as they run asynchronously over the duration of a contract's lifetime as "fulfillment conditions" for its closure.

Bitcoin ⇐ Service

Manages interaction with the Bitcoin network.

Exchange

Implements a basic Exchange.

Lightning

Manage a Lightning node.

Redis

Connect and subscribe to ZeroMQ servers.

ZMQ

Connect and subscribe to ZeroMQ publishers.

HTTPServer

Deprecated 2021-10-16.

Scribe

Deprecated 2021-11-06.

Stash

Deprecated 2021-11-06.

Actor

Generic Fabric Actor.

Kind: global class
Emits: event:message Fabric {@link Message} objects.
Access: protected
Properties

• Actor
  • new Actor([actor])
  • instance
    • .adopt(changes) ⇒ Actor
    • .commit() ⇒ String
    • .export() ⇒ Object
    • .get(path) ⇒ Object
    • .set(path, value) ⇒ Object
    • .toBuffer() ⇒ Buffer
    • .toGenericMessage() ⇒ Object
    • .toObject() ⇒ Object
    • .pause() ⇒ Actor
    • .serialize() ⇒ String
    • .sign() ⇒ Actor
    • .unpause() ⇒ Actor
    • .value([format]) ⇒ Object
    • ._readObject(input) ⇒ Object
  • static
    • .fromAny(input) ⇒ Actor
    • .randomBytes([count]) ⇒ Buffer

new Actor([actor])

Creates an Actor, which emits messages for other Actors to subscribe to. You can supply certain parameters for the actor, including key material [!!!] — be mindful of what you share with others!

Returns: Actor - Instance of the Actor. Call sign to emit a Signature.

actor.adopt(changes) ⇒ Actor

Explicitly adopt a set of JSONPatch-encoded changes.

Kind: instance method of Actor
Returns: Actor - Instance of the Actor.

actor.commit() ⇒ String

Resolve the current state to a commitment.

Kind: instance method of Actor
Returns: String - 32-byte ID

actor.export() ⇒ Object

Export the Actor's state to a standard Object.

Kind: instance method of Actor
Returns: Object - Standard object.

actor.get(path) ⇒ Object

Retrieve a value from the Actor's state by JSONPointer path.

Kind: instance method of Actor
Returns: Object - Value of the path in the Actor's state.

actor.set(path, value) ⇒ Object

Set a value in the Actor's state by JSONPointer path.

Kind: instance method of Actor
Returns: Object - Value of the path in the Actor's state.

actor.toBuffer() ⇒ Buffer

Casts the Actor to a normalized Buffer.

Kind: instance method of Actor

actor.toGenericMessage() ⇒ Object

Casts the Actor to a generic message.

Kind: instance method of Actor
Returns: Object - Generic message object.

actor.toObject() ⇒ Object

Returns the Actor's current state as an Object.

Kind: instance method of Actor

actor.pause() ⇒ Actor

Toggles status property to paused.

Kind: instance method of Actor
Returns: Actor - Instance of the Actor.

actor.serialize() ⇒ String

Serialize the Actor's current state into a JSON-formatted string.

Kind: instance method of Actor

actor.sign() ⇒ Actor

Signs the Actor.

Kind: instance method of Actor

actor.unpause() ⇒ Actor

Toggles status property to unpaused.

Kind: instance method of Actor
Returns: Actor - Instance of the Actor.

actor.value([format]) ⇒ Object

Get the inner value of the Actor with an optional cast type.

Kind: instance method of Actor
Returns: Object - Inner value of the Actor as an Object, or cast to the requested format.

actor._readObject(input) ⇒ Object

Parse an Object into a corresponding Fabric state.

Kind: instance method of Actor
Returns: Object - Fabric state.

Actor.fromAny(input) ⇒ Actor

Create an Actor from a variety of formats.

Kind: static method of Actor
Returns: Actor - Instance of the Actor.

Actor.randomBytes([count]) ⇒ Buffer

Get a number of random bytes from the runtime environment.

Kind: static method of Actor
Returns: Buffer - The random bytes.

Aggregator

Aggregates a set of balances (inputs).

Kind: global class

• Aggregator
  • new Aggregator([settings])
  • ._importBalances(list) ⇒ AnchorBalance
  • ._computeBalances() ⇒ AnchorBalance
  • .commit() ⇒ AggregatorCommit
  • "commit"

new Aggregator([settings])

Create a new Aggregator.

Returns: Aggregator - Instance of the Aggregator.

aggregator._importBalances(list) ⇒ AnchorBalance

Import a list of AnchorBalance instances.

Kind: instance method of Aggregator
Returns: AnchorBalance - Summary of resulting balances.

aggregator._computeBalances() ⇒ AnchorBalance

Updates the state to reflect balances from current inputs.

Kind: instance method of Aggregator
Returns: AnchorBalance - Summary of balances.

aggregator.commit() ⇒ AggregatorCommit

Commits the balance of all input.

Kind: instance method of Aggregator
Returns: AggregatorCommit - Commit instance.
Emits: commit

"commit"

Commit event.

Kind: event emitted by Aggregator
Properties

App ⇐ Service

Web-friendly application framework for building single-page applications with Fabric-based networking and storage.

Kind: global class
Extends: Service
Properties

• App ⇐ Service
  • new App(definition)
  • .start() ⇒ Promise
  • .stop() ⇒ Promise
  • .define(name, structure) ⇒ Object
  • .defer(authority) ⇒ App
  • .attach(element) ⇒ App
  • .consume(resources) ⇒ App
  • .envelop(selector) ⇒ App
  • .use(name, definition) ⇒ App
  • .render() ⇒ String
  • ._registerService(name, Service) ⇒ Service
  • .init()
  • .tick() ⇒ Number
  • .beat() ⇒ Service
  • .get(path) ⇒ Mixed
  • .set(path) ⇒ Mixed
  • .trust(source) ⇒ Service
  • .handler(message) ⇒ Service
  • .lock([duration]) ⇒ Boolean
  • .route(msg) ⇒ Promise
  • ._GET(path) ⇒ Promise
  • ._PUT(path, value, [commit]) ⇒ Promise
  • .connect(notify) ⇒ Promise
  • .send(channel, message) ⇒ Service
  • ._registerActor(actor) ⇒ Promise
  • ._send(message)

new App(definition)

Generic bundle for building Fabric applications.

Returns: App - Returns an instance of App.

app.start() ⇒ Promise

Start the program.

Kind: instance method of App
Overrides: start

app.stop() ⇒ Promise

Stop the program.

Kind: instance method of App

app.define(name, structure) ⇒ Object

Define a Resource, or "Type", used by the application.

Kind: instance method of App
Returns: Object - [description]

app.defer(authority) ⇒ App

Defer control of this application to an outside authority.

Kind: instance method of App
Returns: App - The configured application as deferred to authority.

app.attach(element) ⇒ App

Configure the Application to use a specific element.

Kind: instance method of App
Returns: App - Configured instance of the Application.

app.consume(resources) ⇒ App

Define the Application's resources from an existing resource map.

Kind: instance method of App
Returns: App - Configured instance of the Application.

app.envelop(selector) ⇒ App

Use a CSS selector to find an element in the current document's tree and bind to it as the render target.

Kind: instance method of App
Returns: App - Instance of app with bound element.

app.use(name, definition) ⇒ App

Define a named Resource.

Kind: instance method of App
Returns: App - Configurated instance of the App.

app.render() ⇒ String

Get the output of our program.

Kind: instance method of App
Returns: String - Output of the program.

app._registerService(name, Service) ⇒ Service

Registers a named Service with the application. Services are standardized interfaces for Fabric contracts, emitting Message events with a predictable lifecycle.

Kind: instance method of App
Returns: Service - The registered service instance.
Internal:

app.init()

Called by Web Components. TODO: move to @fabric/http/types/spa

Kind: instance method of App
Overrides: init

app.tick() ⇒ Number

Move forward one clock cycle.

Kind: instance method of App
Overrides: tick

app.beat() ⇒ Service

Compute latest state.

Kind: instance method of App
Overrides: beat
Emits: Message#event:beat

app.get(path) ⇒ Mixed

Retrieve a key from the State.

Kind: instance method of App
Overrides: get

app.set(path) ⇒ Mixed

Set a key in the State to a particular value.

Kind: instance method of App
Overrides: set

app.trust(source) ⇒ Service

Explicitly trust all events from a known source.

Kind: instance method of App
Overrides: trust
Returns: Service - Instance of Service after binding events.

app.handler(message) ⇒ Service

Default route handler for an incoming message. Follows the Activity Streams 2.0 spec: https://www.w3.org/TR/activitystreams-core/

Kind: instance method of App
Overrides: handler
Returns: Service - Chainable method.

app.lock([duration]) ⇒ Boolean

Attempt to acquire a lock for duration seconds.

Kind: instance method of App
Overrides: lock
Returns: Boolean - true if locked, false if unable to lock.

app.route(msg) ⇒ Promise

Resolve a State from a particular Message object.

Kind: instance method of App
Overrides: route
Returns: Promise - Resolves with resulting State.

app._GET(path) ⇒ Promise

Retrieve a value from the Service's state.

Kind: instance method of App
Overrides: _GET
Returns: Promise - Resolves with the result.

app._PUT(path, value, [commit]) ⇒ Promise

Store a value in the Service's state.

Kind: instance method of App
Overrides: _PUT
Returns: Promise - Resolves with with stored document.

app.connect(notify) ⇒ Promise

Attach to network.

Kind: instance method of App
Overrides: connect
Returns: Promise - Resolves to Fabric.

app.send(channel, message) ⇒ Service

Send a message to a channel.

Kind: instance method of App
Overrides: send
Returns: Service - Chainable method.

app._registerActor(actor) ⇒ Promise

Register an Actor with the Service.

Kind: instance method of App
Overrides: _registerActor
Returns: Promise - Resolves upon successful registration.

app._send(message)

Sends a message.

Kind: instance method of App
Overrides: _send

Chain

Chain.

Kind: global class
Properties

new Chain(genesis)

Holds an immutable chain of events.

Channel

The Channel is a encrypted connection with a member of your Peer group, with some amount of $BTC bonded and paid for each correctly-validated message.

Channels in Fabric are powerful tools for application development, as they can empower users with income opportunities in exchange for delivering service to the network.

Kind: global class

• Channel
  • new Channel([settings])
  • .add(amount)
  • .fund(input)
  • .open(channel)

new Channel([settings])

Creates a channel between two peers. of many transactions over time, to be settled on-chain later.

channel.add(amount)

Add an amount to the channel's balance.

Kind: instance method of Channel

channel.fund(input)

Fund the channel.

Kind: instance method of Channel

channel.open(channel)

Opens a Channel with a Peer.

Kind: instance method of Channel

Circuit

The Circuit is the mechanism through which Fabric operates, a computable directed graph describing a network of Peer components and their interactions (side effects). See also Swarm for deeper *inspection of Machine mechanics.

Kind: global class

CLI

Provides a Command Line Interface (CLI) for interacting with the Fabric network using a terminal emulator.

Kind: global class

• CLI
  • new CLI([settings])
  • .start()
  • .stop()

new CLI([settings])

Create a terminal-based interface for a User.

clI.start()

Starts (and renders) the CLI.

Kind: instance method of CLI

clI.stop()

Disconnect all interfaces and exit the process.

Kind: instance method of CLI

Collection

The Collection type maintains an ordered list of State items.

Kind: global class
Properties

• Collection
  • new Collection([configuration])
  • .asMerkleTree() ⇒ MerkleTree
  • ._setKey(name)
  • .getByID(id)
  • .getLatest()
  • .findByField(name, value)
  • .findByName(name)
  • .findBySymbol(symbol)
  • ._patchTarget(path, patches)
  • .push(data) ⇒ Number
  • .get(path) ⇒ Mixed
  • .set(path) ⇒ Mixed
  • .list() ⇒ Array
  • .toTypedArray()
  • .map() ⇒ Array
  • .create(entity) ⇒ Promise
  • .import(state, commit)

new Collection([configuration])

Create a list of Entity-like objects for later retrieval.

Returns: Collection - Configured instance of the the Collection.

collection.asMerkleTree() ⇒ MerkleTree

Current elements of the collection as a MerkleTree.

Kind: instance method of Collection

collection._setKey(name)

Sets the key property of collection settings.

Kind: instance method of Collection

collection.getByID(id)

Retrieve an element from the collection by ID.

Kind: instance method of Collection

collection.getLatest()

Retrieve the most recent element in the collection.

Kind: instance method of Collection

collection.findByField(name, value)

Find a document by specific field.

Kind: instance method of Collection

collection.findByName(name)

Find a document by the "name" field.

Kind: instance method of Collection

collection.findBySymbol(symbol)

Find a document by the "symbol" field.

Kind: instance method of Collection

collection._patchTarget(path, patches)

Modify a target document using an array of atomic updates.

Kind: instance method of Collection

collection.push(data) ⇒ Number

Adds an Entity to the Collection.

Kind: instance method of Collection
Returns: Number - Length of the collection.

collection.get(path) ⇒ Mixed

Retrieve a key from the State.

Kind: instance method of Collection

collection.set(path) ⇒ Mixed

Set a key in the State to a particular value.

Kind: instance method of Collection

collection.list() ⇒ Array

Deprecated

Generate a list of elements in the collection.

Kind: instance method of Collection

collection.toTypedArray()

Provides the Collection as an Array of typed elements. The type of these elments are defined by the collection's type, supplied in the constructor.

Kind: instance method of Collection

collection.map() ⇒ Array

Generate a hashtable of elements in the collection.

Kind: instance method of Collection

collection.create(entity) ⇒ Promise

Create an instance of an Entity.

Kind: instance method of Collection
Returns: Promise - Resolves with instantiated Entity.

collection.import(state, commit)

Loads State into memory.

Kind: instance method of Collection
Emits: event:message Will emit one {@link Snapshot} message.

Compiler : Actor

Compilers build interfaces for users of Fabric applications.

Kind: global class
Properties

• Compiler : Actor
  • new Compiler(settings)
  • instance
    • ._getJavaScriptAST(input) ⇒ AST
  • static
    • ._fromJavaScript(body) ⇒

new Compiler(settings)

Create a new Compiler.

Returns: Compiler - Instance of the compiler.

compiler._getJavaScriptAST(input) ⇒ AST

Parse a Buffer of JavaScript into an Abstract Syntax Tree (AST).

Kind: instance method of Compiler

Compiler._fromJavaScript(body) ⇒

Creates a new Compiler instance from a JavaScript contract.

Kind: static method of Compiler
Returns: Compiler

Consensus

Provides various network-specific rules.

Kind: global class

new Consensus([settings])

Create an instance of a Consensus verifier.

Entity : Object

Live instance of an ARC in Fabric.

Kind: global class

• Entity : Object
  • new Entity([data])
  • .toJSON() ⇒ String
  • .toRaw() ⇒ Buffer
  • ._downsample([input])

new Entity([data])

Generic template for virtual objects.

Returns: Entity - Instance of the Entity.

entity.toJSON() ⇒ String

Produces a string of JSON, representing the entity.

Kind: instance method of Entity
Returns: String - JSON-encoded object.

entity.toRaw() ⇒ Buffer

As a Buffer.

Kind: instance method of Entity
Returns: Buffer - Slice of memory.

entity._downsample([input])

Return a Fabric-labeled Object for this Entity.

Kind: instance method of Entity

Environment

Interact with the user's Environment.

Kind: global class

• Environment
  • new Environment([settings])
  • .readVariable(name) ⇒ String
  • .setWallet(wallet, force) ⇒ Environment
  • .start() ⇒ Environment

new Environment([settings])

Create an instance of Environment.

Returns: Environment - Instance of the Environment.

environment.readVariable(name) ⇒ String

Read a variable from the environment.

Kind: instance method of Environment
Returns: String - Value of the variable (or an empty string).

environment.setWallet(wallet, force) ⇒ Environment

Configure the Environment to use a Fabric Wallet.

Kind: instance method of Environment
Returns: Environment - The Fabric Environment.

environment.start() ⇒ Environment

Start the Environment.

Kind: instance method of Environment
Returns: Environment - The Fabric Environment.

Fabric

Reliable decentralized infrastructure.

Kind: global class
Emits: Fabric#event:thread, Fabric#event:step Emitted on a `compute` step.

• Fabric
  • new Fabric(config)
  • .register(service)
  • .push(value) ⇒ Stack
  • .trust(source) ⇒ Fabric
  • .compute() ⇒ Fabric

new Fabric(config)

The Fabric type implements a peer-to-peer protocol for establishing and settling of mutually-agreed upon proofs of work. Contract execution takes place in the local node first, then is optionally shared with the network.

Utilizing

fabric.register(service)

Register an available Service using an ES6 Class.

Kind: instance method of Fabric

fabric.push(value) ⇒ Stack

Push an instruction onto the stack.

Kind: instance method of Fabric

fabric.trust(source) ⇒ Fabric

Blindly consume messages from a Source, relying on this.chain to verify results.

Kind: instance method of Fabric
Returns: Fabric - Returns itself.

fabric.compute() ⇒ Fabric

Process the current stack.

Kind: instance method of Fabric
Returns: Fabric - Resulting instance of the stack.

Federation

Create and manage sets of signers with the Federation class.

Kind: global class

• Federation
  • new Federation([settings])
  • .start() ⇒ Federation

new Federation([settings])

Create an instance of a federation.

Returns: Federation - Instance of the federation.

federation.start() ⇒ Federation

Start tracking state (i.e., ready to receive events).

Kind: instance method of Federation
Returns: Federation - Instance of the Federation.

Filesystem

Interact with a local filesystem.

Kind: global class

• Filesystem
  • new Filesystem([settings])
  • .ls() ⇒ Array
  • .readFile(name) ⇒ Buffer
  • .writeFile(name, content) ⇒ Boolean
  • ._loadFromDisk() ⇒ Promise
  • .sync() ⇒ Filesystem

new Filesystem([settings])

Synchronize an Actor with a local filesystem.

Returns: Filesystem - Instance of the Fabric filesystem.

filesystem.ls() ⇒ Array

Get the list of files.

Kind: instance method of Filesystem
Returns: Array - List of files.

filesystem.readFile(name) ⇒ Buffer

Read a file by name.

Kind: instance method of Filesystem
Returns: Buffer - Contents of the file.

filesystem.writeFile(name, content) ⇒ Boolean

Write a file by name.

Kind: instance method of Filesystem
Returns: Boolean - true if the write succeeded, false if it did not.

filesystem._loadFromDisk() ⇒ Promise

Load Filesystem state from disk.

Kind: instance method of Filesystem
Returns: Promise - Resolves with Filesystem instance.

filesystem.sync() ⇒ Filesystem

Syncronize state from the local filesystem.

Kind: instance method of Filesystem
Returns: Filesystem - Instance of the Fabric filesystem.

Hash256

Simple interaction with 256-bit spaces.

Kind: global class

• Hash256
  • new Hash256(settings)
  • .digest(input) ⇒ String
  • .reverse()

new Hash256(settings)

Create an instance of a Hash256 object by calling new Hash256(), where settings can be provided to supply a particular input object.

If the settings is not a string, input must be provided.

Hash256.digest(input) ⇒ String

Produce a SHA256 digest of some input data.

Kind: static method of Hash256
Returns: String - SHA256(input) as a hexadecimal string.

Hash256.reverse()

Reverses the bytes of the digest.

Kind: static method of Hash256

HKDF

Provides an HMAC-based Extract-and-Expand Key Derivation Function (HKDF), compatible with RFC 5869. Defaults to 32 byte output, matching Bitcoin's implementaton.

Kind: global class

• HKDF
  • new HKDF(settings)
  • .derive([info], [size])

new HKDF(settings)

Create an HKDF instance.

hkdF.derive([info], [size])

Derive a new output.

Kind: instance method of HKDF

Identity

Manage a network identity.

Kind: global class

• Identity
  • new Identity([settings])
  • .sign(data) ⇒ Signature
  • .toString() ⇒ String

new Identity([settings])

Create an instance of an Identity.

Returns: Identity - Instance of the identity.

identity.sign(data) ⇒ Signature

Sign a buffer of data using BIP 340: https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki

Kind: instance method of Identity
Returns: Signature - Resulting signature (64 bytes).

identity.toString() ⇒ String

Retrieve the bech32m-encoded identity.

Kind: instance method of Identity
Returns: String - Public identity.

Interface ⇐ EventEmitter

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.

Kind: global class
Extends: EventEmitter
Properties

• Interface ⇐ EventEmitter
  • new Interface(settings)
  • .log(...inputs)
  • .now() ⇒ Number
  • .start()
  • .stop()
  • .cycle(val)

new Interface(settings)

Define an Interface by creating an instance of this class.

Returns: Interface - Instance of the Interface.

interface.log(...inputs)

Log some output to the console.

Kind: instance method of Interface

interface.now() ⇒ Number

Returns current timestamp.

Kind: instance method of Interface

interface.start()

Start the Interface.

Kind: instance method of Interface

interface.stop()

Stop the Interface.

Kind: instance method of Interface

interface.cycle(val)

Ticks the clock with a named Cycle.

Kind: instance method of Interface

Key

Represents a cryptographic key.

Kind: global class

new Key([settings])

Create an instance of a Fabric Key, either restoring from some known values or from prior knowledge. For instance, you can call new Key() to create a fresh keypair, or new Key({ public: 'deadbeef...' }) to create it from a known public key.

Keystore

Provides an encrypted datastore for generic object storage.

Kind: global class

• Keystore
  • new Keystore([configuration])
  • ._setState(state) ⇒ Actor

new Keystore([configuration])

Create an instance of the Store.

Returns: Keystore - Instance of the store.

keystore._setState(state) ⇒ Actor

Saves an Object to the store.

Kind: instance method of Keystore
Returns: Actor - The local instance of the provided State's Actor.

Ledger ⇐ Scribe

An ordered stack of pages.

Kind: global class
Extends: Scribe
Properties

• Ledger ⇐ Scribe
  • .append(item) ⇒ Promise
  • .now() ⇒ Number
  • .trust(source) ⇒ Scribe
  • .inherits(scribe) ⇒ Scribe
  • .toHTML()
  • .toString() ⇒ String
  • .serialize([input]) ⇒ Buffer
  • .deserialize(input) ⇒ State
  • .fork() ⇒ State
  • .get(path) ⇒ Mixed
  • .set(path) ⇒ Mixed
  • .commit()
  • .render() ⇒ String

ledger.append(item) ⇒ Promise

Attempts to append a Page to the ledger.

Kind: instance method of Ledger
Returns: Promise - Resolves after the change has been committed.

ledger.now() ⇒ Number

Retrives the current timestamp, in milliseconds.

Kind: instance method of Ledger
Overrides: now
Returns: Number - Number representation of the millisecond Integer value.

ledger.trust(source) ⇒ Scribe

Blindly bind event handlers to the Source.

Kind: instance method of Ledger
Overrides: trust
Returns: Scribe - Instance of the Scribe.

ledger.inherits(scribe) ⇒ Scribe

Use an existing Scribe instance as a parent.

Kind: instance method of Ledger
Overrides: inherits
Returns: Scribe - The configured instance of the Scribe.

ledger.toHTML()

Converts the State to an HTML document.

Kind: instance method of Ledger
Overrides: toHTML

ledger.toString() ⇒ String

Unmarshall an existing state to an instance of a Blob.

Kind: instance method of Ledger
Overrides: toString
Returns: String - Serialized Blob.

ledger.serialize([input]) ⇒ Buffer

Convert to Buffer.

Kind: instance method of Ledger
Overrides: serialize
Returns: Buffer - Store-able blob.

ledger.deserialize(input) ⇒ State

Take a hex-encoded input and convert to a State object.

Kind: instance method of Ledger
Overrides: deserialize
Returns: State - [description]

ledger.fork() ⇒ State

Creates a new child State, with @parent set to the current State by immutable identifier.

Kind: instance method of Ledger
Overrides: fork

ledger.get(path) ⇒ Mixed

Retrieve a key from the State.

Kind: instance method of Ledger
Overrides: get

ledger.set(path) ⇒ Mixed

Set a key in the State to a particular value.

Kind: instance method of Ledger
Overrides: set

ledger.commit()

Increment the vector clock, broadcast all changes as a transaction.

Kind: instance method of Ledger
Overrides: commit

ledger.render() ⇒ String

Compose a JSON string for network consumption.

Kind: instance method of Ledger
Overrides: render
Returns: String - JSON-encoded String.

Logger ⇐ Actor

A basic logger that writes logs to the local file system

Kind: global class
Extends: Actor

• Logger ⇐ Actor
  • .path ⇒ String
  • .log(msg) ⇒ Boolean
  • .start() ⇒ Promise
  • .stop() ⇒ Promise
  • .adopt(changes) ⇒ Actor
  • .commit() ⇒ String
  • .export() ⇒ Object
  • .get(path) ⇒ Object
  • .set(path, value) ⇒ Object
  • .toBuffer() ⇒ Buffer
  • .toGenericMessage() ⇒ Object
  • .toObject() ⇒ Object
  • .pause() ⇒ Actor
  • .serialize() ⇒ String
  • .sign() ⇒ Actor
  • .unpause() ⇒ Actor
  • .value([format]) ⇒ Object
  • ._readObject(input) ⇒ Object

logger.path ⇒ String

Returns the path to the log file

Kind: instance property of Logger

logger.log(msg) ⇒ Boolean

Writes the specified log to the log file

Kind: instance method of Logger
Returns: Boolean - true, if msg was successfully written; false otherwise

logger.start() ⇒ Promise

Starts the logger

This method creates the required directories for writing the log file.

Kind: instance method of Logger

logger.stop() ⇒ Promise

Stops the logger

This method closes the log file and returns after it has been closed. Any errors on close would cause the return promise to be rejected.

Kind: instance method of Logger

logger.adopt(changes) ⇒ Actor

Explicitly adopt a set of JSONPatch-encoded changes.

Kind: instance method of Logger
Overrides: adopt
Returns: Actor - Instance of the Actor.

logger.commit() ⇒ String

Resolve the current state to a commitment.

Kind: instance method of Logger
Overrides: commit
Returns: String - 32-byte ID

logger.export() ⇒ Object

Export the Actor's state to a standard Object.

Kind: instance method of Logger
Overrides: export
Returns: Object - Standard object.

logger.get(path) ⇒ Object

Retrieve a value from the Actor's state by JSONPointer path.

Kind: instance method of Logger
Overrides: get
Returns: Object - Value of the path in the Actor's state.

logger.set(path, value) ⇒ Object

Set a value in the Actor's state by JSONPointer path.

Kind: instance method of Logger
Overrides: set
Returns: Object - Value of the path in the Actor's state.

logger.toBuffer() ⇒ Buffer

Casts the Actor to a normalized Buffer.

Kind: instance method of Logger
Overrides: toBuffer

logger.toGenericMessage() ⇒ Object

Casts the Actor to a generic message.

Kind: instance method of Logger
Overrides: toGenericMessage
Returns: Object - Generic message object.

logger.toObject() ⇒ Object

Returns the Actor's current state as an Object.

Kind: instance method of Logger
Overrides: toObject

logger.pause() ⇒ Actor

Toggles status property to paused.

Kind: instance method of Logger
Overrides: pause
Returns: Actor - Instance of the Actor.

logger.serialize() ⇒ String

Serialize the Actor's current state into a JSON-formatted string.

Kind: instance method of Logger
Overrides: serialize

logger.sign() ⇒ Actor

Signs the Actor.

Kind: instance method of Logger
Overrides: sign

logger.unpause() ⇒ Actor

Toggles status property to unpaused.

Kind: instance method of Logger
Overrides: unpause
Returns: Actor - Instance of the Actor.

logger.value([format]) ⇒ Object

Get the inner value of the Actor with an optional cast type.

Kind: instance method of Logger
Overrides: value
Returns: Object - Inner value of the Actor as an Object, or cast to the requested format.

logger._readObject(input) ⇒ Object

Parse an Object into a corresponding Fabric state.

Kind: instance method of Logger
Overrides: _readObject
Returns: Object - Fabric state.

Machine

General-purpose state machine with Vector-based instructions.

Kind: global class

• Machine
  • new Machine(settings)
  • .sip([n]) ⇒ Number
  • .slurp([n]) ⇒ Number
  • .compute(input) ⇒ Machine

new Machine(settings)

Create a Machine.

machine.sip([n]) ⇒ Number

Get n bits of deterministic random data.

Kind: instance method of Machine
Returns: Number - Random bits from Generator.

machine.slurp([n]) ⇒ Number

Get n bytes of deterministic random data.

Kind: instance method of Machine
Returns: Number - Random bytes from Generator.

machine.compute(input) ⇒ Machine

Computes the next "step" for our current Vector. Analagous to sum. The top item on the stack is always the memory held at current position, so counts should always begin with 0.

Kind: instance method of Machine
Returns: Machine - Instance of the resulting machine.

Mempool

Stores a list of Transaction elements.

Kind: global class
Emits: event:{Message} confirmed Emitted when the Mempool has dropped a transaction.

new Mempool(settings)

Creates an instance of a Mempool Service.

Message : Object

The Message type defines the Application Messaging Protocol, or AMP. Each Actor in the network receives and broadcasts messages, selectively disclosing new routes to peers which may have open circuits.

Kind: global class

• Message : Object
  • new Message(message)
  • .asRaw() ⇒ Buffer
  • .sign() ⇒ Message
  • .verify() ⇒ Boolean
  • ._setSigner(signer) ⇒ Message

new Message(message)

The Message type is standardized in Fabric as a Array, which can be added to any other vector to compute a resulting state.

Returns: Message - Instance of the message.

message.asRaw() ⇒ Buffer

Returns a Buffer of the complete message.

Kind: instance method of Message
Returns: Buffer - Buffer of the encoded Message.

message.sign() ⇒ Message

Signs the message using the associated signer.

Kind: instance method of Message
Returns: Message - Signed message.

message.verify() ⇒ Boolean

Verify a message's signature.

Kind: instance method of Message
Returns: Boolean - true if the signature is valid, false if not.

message._setSigner(signer) ⇒ Message

Sets the signer for the message.

Kind: instance method of Message
Returns: Message - Instance of the Message with associated signer.

Node

Full definition of a Fabric node.

Kind: global class

• Node
  • new Node(settings)
  • .trust(source, settings)

new Node(settings)

Manage a Fabric service.

Returns: Node - Instance of the managed service.

node.trust(source, settings)

Explicitly trusts an EventEmitter.

Kind: instance method of Node

Oracle ⇐ Store

An Oracle manages one or more collections, using a mempool for transitive state.

Kind: global class
Extends: Store

• Oracle ⇐ Store
  • new Oracle(initial)
  • .broadcast(msg) ⇒ Boolean
  • ._REGISTER(obj) ⇒ Vector
  • ._POST(key, value) ⇒ Promise
  • .get(key) ⇒ Promise
  • .set(key, value)
  • .trust(source) ⇒ Store
  • .del(key)
  • .flush()
  • .start() ⇒ Promise

new Oracle(initial)

Trusted point-of-reference for external services.

oracle.broadcast(msg) ⇒ Boolean

Core messaging function for interacting with this object in system-time.

Kind: instance method of Oracle
Returns: Boolean - Returns true on success, false on failure.

oracle._REGISTER(obj) ⇒ Vector

Registers an Actor. Necessary to store in a collection.

Kind: instance method of Oracle
Overrides: _REGISTER
Returns: Vector - Returned from storage.set

oracle._POST(key, value) ⇒ Promise

Insert something into a collection.

Kind: instance method of Oracle
Overrides: _POST
Returns: Promise - Resolves on success with a String pointer.

oracle.get(key) ⇒ Promise

Barebones getter.

Kind: instance method of Oracle
Overrides: get
Returns: Promise - Resolves on complete. null if not found.

oracle.set(key, value)

Set a key to a specific value.

Kind: instance method of Oracle
Overrides: set

oracle.trust(source) ⇒ Store

Implicitly trust an Event source.

Kind: instance method of Oracle
Overrides: trust
Returns: Store - Resulting instance of Store with new trust.

oracle.del(key)

Remove a Value by Path.

Kind: instance method of Oracle
Overrides: del

oracle.flush()

Wipes the storage.

Kind: instance method of Oracle
Overrides: flush

oracle.start() ⇒ Promise

Start running the process.

Kind: instance method of Oracle
Overrides: start
Returns: Promise - Resolves on complete.

Path

A Path is a Fabric-native link to a Document within the network.

Kind: global class

• Path
  • new Path(input)
  • .isValid() ⇒ Boolean

new Path(input)

Create a new Path.

path.isValid() ⇒ Boolean

Kind: instance method of Path
Returns: Boolean - Whether or not the Path is valid.

Peer

An in-memory representation of a node in our network.

Kind: global class

• Peer
  • new Peer([config])
  • .address
  • .start()
  • .stop()
  • .listen() ⇒ Peer

new Peer([config])

Create an instance of Peer.

peer.address

Deprecated

Kind: instance property of Peer

peer.start()

Start the Peer.

Kind: instance method of Peer

peer.stop()

Stop the peer.

Kind: instance method of Peer

peer.listen() ⇒ Peer

Start listening for connections.

Kind: instance method of Peer
Returns: Peer - Chainable method.

Reader

Read from a byte stream, seeking valid Fabric messages.

Kind: global class

new Reader(settings)

Create an instance of a Reader, which can listen to a byte stream for valid Fabric messages.

Remote : Remote

Interact with a remote Resource. This is currently the only HTTP-related code that should remain in @fabric/core — all else must be moved to @fabric/http before final release!

Kind: global class
Properties

• Remote : Remote
  • new Remote(target)
  • .enumerate() ⇒ Configuration
  • .request(type, path, [params]) ⇒ FabricHTTPResult
  • ._PUT(path, body) ⇒ FabricHTTPResult | String
  • ._GET(path, params) ⇒ FabricHTTPResult | String
  • ._POST(path, params) ⇒ FabricHTTPResult | String
  • ._OPTIONS(path, params) ⇒ Object
  • ._PATCH(path, body) ⇒ Object
  • ._DELETE(path, params) ⇒ Object

new Remote(target)

An in-memory representation of a node in our network.

remote.enumerate() ⇒ Configuration

Enumerate the available Resources on the remote host.

Kind: instance method of Remote
Returns: Configuration - An object with enumerable key/value pairs for the Application Resource Contract.

remote.request(type, path, [params]) ⇒ FabricHTTPResult

Make an HTTP request to the configured authority.

Kind: instance method of Remote

remote._PUT(path, body) ⇒ FabricHTTPResult | String

HTTP PUT against the configured Authority.

Kind: instance method of Remote
Returns: FabricHTTPResult | String - Result of request.

remote._GET(path, params) ⇒ FabricHTTPResult | String

HTTP GET against the configured Authority.

Kind: instance method of Remote
Returns: FabricHTTPResult | String - Result of request.

remote._POST(path, params) ⇒ FabricHTTPResult | String

HTTP POST against the configured Authority.

Kind: instance method of Remote
Returns: FabricHTTPResult | String - Result of request.

remote._OPTIONS(path, params) ⇒ Object

HTTP OPTIONS on the configured Authority.

Kind: instance method of Remote
Returns: Object - - Full description of remote resource.

remote._PATCH(path, body) ⇒ Object

HTTP PATCH on the configured Authority.

Kind: instance method of Remote
Returns: Object - - Full description of remote resource.

remote._DELETE(path, params) ⇒ Object

HTTP DELETE on the configured Authority.

Kind: instance method of Remote
Returns: Object - - Full description of remote resource.

Resource

Generic interface for collections of digital objects.

Kind: global class

• Resource
  • new Resource(definition)
  • .create(obj) ⇒ Vector
  • .update(id, update) ⇒ Vector

new Resource(definition)

resource.create(obj) ⇒ Vector

Create an instance of the Resource's type.

Kind: instance method of Resource
Returns: Vector - Resulting Vector with deterministic identifier.

resource.update(id, update) ⇒ Vector

Modify an existing instance of a Resource by its unique identifier. Produces a new instance.

Kind: instance method of Resource
Returns: Vector - Resulting Vector instance with updated identifier.

Router ⇐ Scribe

Process incoming messages.

Kind: global class
Extends: Scribe

• Router ⇐ Scribe
  • new Router(map)
  • .route(msg) ⇒ Array
  • .use(plugin, name) ⇒ Router
  • .now() ⇒ Number
  • .trust(source) ⇒ Scribe
  • .inherits(scribe) ⇒ Scribe
  • .toHTML()
  • .toString() ⇒ String
  • .serialize([input]) ⇒ Buffer
  • .deserialize(input) ⇒ State
  • .fork() ⇒ State
  • .get(path) ⇒ Mixed
  • .set(path) ⇒ Mixed
  • .commit()
  • .render() ⇒ String

new Router(map)

Maintains a list of triggers ("commands") and their behaviors.

router.route(msg) ⇒ Array

Assembles a list of possible responses to the incoming request.

Kind: instance method of Router
Returns: Array - List of outputs generated from the input string.

router.use(plugin, name) ⇒ Router

Attaches a new handler to the router.

Kind: instance method of Router
Returns: Router - Configured instance of the router.

router.now() ⇒ Number

Retrives the current timestamp, in milliseconds.

Kind: instance method of Router
Overrides: now
Returns: Number - Number representation of the millisecond Integer value.

router.trust(source) ⇒ Scribe

Blindly bind event handlers to the Source.

Kind: instance method of Router
Overrides: trust
Returns: Scribe - Instance of the Scribe.

router.inherits(scribe) ⇒ Scribe

Use an existing Scribe instance as a parent.

Kind: instance method of Router
Overrides: inherits
Returns: Scribe - The configured instance of the Scribe.

router.toHTML()

Converts the State to an HTML document.

Kind: instance method of Router
Overrides: toHTML

router.toString() ⇒ String

Unmarshall an existing state to an instance of a Blob.

Kind: instance method of Router
Overrides: toString
Returns: String - Serialized Blob.

router.serialize([input]) ⇒ Buffer

Convert to Buffer.

Kind: instance method of Router
Overrides: serialize
Returns: Buffer - Store-able blob.

router.deserialize(input) ⇒ State

Take a hex-encoded input and convert to a State object.

Kind: instance method of Router
Overrides: deserialize
Returns: State - [description]

router.fork() ⇒ State

Creates a new child State, with @parent set to the current State by immutable identifier.

Kind: instance method of Router
Overrides: fork

router.get(path) ⇒ Mixed

Retrieve a key from the State.

Kind: instance method of Router
Overrides: get

router.set(path) ⇒ Mixed

Set a key in the State to a particular value.

Kind: instance method of Router
Overrides: set

router.commit()

Increment the vector clock, broadcast all changes as a transaction.

Kind: instance method of Router
Overrides: commit

router.render() ⇒ String

Compose a JSON string for network consumption.

Kind: instance method of Router
Overrides: render
Returns: String - JSON-encoded String.

Scribe ⇐ State

Simple tag-based recordkeeper.

Kind: global class
Extends: State
Properties

• Scribe ⇐ State
  • new Scribe(config)
  • .now() ⇒ Number
  • .trust(source) ⇒ Scribe
  • .inherits(scribe) ⇒ Scribe
  • .toHTML()
  • .toString() ⇒ String
  • .serialize([input]) ⇒ Buffer
  • .deserialize(input) ⇒ State
  • .fork() ⇒ State
  • .get(path) ⇒ Mixed
  • .set(path) ⇒ Mixed
  • .commit()
  • .render() ⇒ String

new Scribe(config)

The "Scribe" is a simple tag-based recordkeeper.

scribe.now() ⇒ Number

Retrives the current timestamp, in milliseconds.

Kind: instance method of Scribe
Returns: Number - Number representation of the millisecond Integer value.

scribe.trust(source) ⇒ Scribe

Blindly bind event handlers to the Source.

Kind: instance method of Scribe
Returns: Scribe - Instance of the Scribe.

scribe.inherits(scribe) ⇒ Scribe

Use an existing Scribe instance as a parent.

Kind: instance method of Scribe
Returns: Scribe - The configured instance of the Scribe.

scribe.toHTML()

Converts the State to an HTML document.

Kind: instance method of Scribe
Overrides: toHTML

scribe.toString() ⇒ String

Unmarshall an existing state to an instance of a Blob.

Kind: instance method of Scribe
Overrides: toString
Returns: String - Serialized Blob.

scribe.serialize([input]) ⇒ Buffer

Convert to Buffer.

Kind: instance method of Scribe
Overrides: serialize
Returns: Buffer - Store-able blob.

scribe.deserialize(input) ⇒ State

Take a hex-encoded input and convert to a State object.

Kind: instance method of Scribe
Overrides: deserialize
Returns: State - [description]

scribe.fork() ⇒ State

Creates a new child State, with @parent set to the current State by immutable identifier.

Kind: instance method of Scribe
Overrides: fork

scribe.get(path) ⇒ Mixed

Retrieve a key from the State.

Kind: instance method of Scribe
Overrides: get

scribe.set(path) ⇒ Mixed

Set a key in the State to a particular value.

Kind: instance method of Scribe
Overrides: set

scribe.commit()

Increment the vector clock, broadcast all changes as a transaction.

Kind: instance method of Scribe
Overrides: commit

scribe.render() ⇒ String

Compose a JSON string for network consumption.

Kind: instance method of Scribe
Overrides: render
Returns: String - JSON-encoded String.

Script

Kind: global class

new Script(config)

Compose a Script for inclusion within a Contract.

Returns: Script - Instance of the Script, ready for use.

Service

The "Service" is a simple model for processing messages in a distributed system. Service instances are public interfaces for outside systems, and typically advertise their presence to the network.

To implement a Service, you will typically need to implement all methods from this prototype. In general, connect and send are the highest-priority jobs, and by default the fabric property will serve as an I/O stream using familiar semantics.

Kind: global class
Access: protected
Properties

• Service
  • new Service(settings)
  • .init()
  • .tick() ⇒ Number
  • .beat() ⇒ Service
  • .get(path) ⇒ Mixed
  • .set(path) ⇒ Mixed
  • .trust(source) ⇒ Service
  • .handler(message) ⇒ Service
  • .lock([duration]) ⇒ Boolean
  • .route(msg) ⇒ Promise
  • .start()
  • ._GET(path) ⇒ Promise
  • ._PUT(path, value, [commit]) ⇒ Promise
  • .connect(notify) ⇒ Promise
  • .send(channel, message) ⇒ Service
  • ._registerActor(actor) ⇒ Promise
  • ._send(message)

new Service(settings)

Create an instance of a Service.

service.init()

Called by Web Components. TODO: move to @fabric/http/types/spa

Kind: instance method of Service

service.tick() ⇒ Number

Move forward one clock cycle.

Kind: instance method of Service

service.beat() ⇒ Service

Compute latest state.

Kind: instance method of Service
Emits: Message#event:beat

service.get(path) ⇒ Mixed

Retrieve a key from the State.

Kind: instance method of Service

service.set(path) ⇒ Mixed

Set a key in the State to a particular value.

Kind: instance method of Service

service.trust(source) ⇒ Service

Explicitly trust all events from a known source.

Kind: instance method of Service
Returns: Service - Instance of Service after binding events.

service.handler(message) ⇒ Service

Default route handler for an incoming message. Follows the Activity Streams 2.0 spec: https://www.w3.org/TR/activitystreams-core/

Kind: instance method of Service
Returns: Service - Chainable method.

service.lock([duration]) ⇒ Boolean

Attempt to acquire a lock for duration seconds.

Kind: instance method of Service
Returns: Boolean - true if locked, false if unable to lock.

service.route(msg) ⇒ Promise

Resolve a State from a particular Message object.

Kind: instance method of Service
Returns: Promise - Resolves with resulting State.

service.start()

Start the service, including the initiation of an outbound connection to any peers designated in the service's configuration.

Kind: instance method of Service

service._GET(path) ⇒ Promise

Retrieve a value from the Service's state.

Kind: instance method of Service
Returns: Promise - Resolves with the result.

service._PUT(path, value, [commit]) ⇒ Promise

Store a value in the Service's state.

Kind: instance method of Service
Returns: Promise - Resolves with with stored document.

service.connect(notify) ⇒ Promise

Attach to network.

Kind: instance method of Service
Returns: Promise - Resolves to Fabric.

service.send(channel, message) ⇒ Service

Send a message to a channel.

Kind: instance method of Service
Returns: Service - Chainable method.

service._registerActor(actor) ⇒ Promise

Register an Actor with the Service.

Kind: instance method of Service
Returns: Promise - Resolves upon successful registration.

service._send(message)

Sends a message.

Kind: instance method of Service

Session

The Session type describes a connection between Peer objects, and includes its own lifecycle.

Kind: global class

• Session
  • new Session(settings)
  • .start()
  • .stop()

new Session(settings)

Creates a new Session.

session.start()

Opens the Session for interaction.

Kind: instance method of Session

session.stop()

Closes the Session, preventing further interaction.

Kind: instance method of Session

Signer ⇐ Actor

Generic Fabric Signer.

Kind: global class
Extends: Actor
Emits: event:message Fabric {@link Message} objects.
Access: protected
Properties

• Signer ⇐ Actor
  • new Signer([actor])
  • .sign() ⇒ Signer
  • .adopt(changes) ⇒ Actor
  • .commit() ⇒ String
  • .export() ⇒ Object
  • .get(path) ⇒ Object
  • .set(path, value) ⇒ Object
  • .toBuffer() ⇒ Buffer
  • .toGenericMessage() ⇒ Object
  • .toObject() ⇒ Object
  • .pause() ⇒ Actor
  • .serialize() ⇒ String
  • .unpause() ⇒ Actor
  • .value([format]) ⇒ Object
  • ._readObject(input) ⇒ Object

new Signer([actor])

Creates an Signer, which emits messages for other Signers to subscribe to. You can supply certain parameters for the actor, including key material [!!!] — be mindful of what you share with others!

Returns: Signer - Instance of the Signer. Call sign to emit a Signature.

signer.sign() ⇒ Signer

Signs some data.

Kind: instance method of Signer
Overrides: sign

signer.adopt(changes) ⇒ Actor

Explicitly adopt a set of JSONPatch-encoded changes.

Kind: instance method of Signer
Overrides: adopt
Returns: Actor - Instance of the Actor.

signer.commit() ⇒ String

Resolve the current state to a commitment.

Kind: instance method of Signer
Overrides: commit
Returns: String - 32-byte ID

signer.export() ⇒ Object

Export the Actor's state to a standard Object.

Kind: instance method of Signer
Overrides: export
Returns: Object - Standard object.

signer.get(path) ⇒ Object

Retrieve a value from the Actor's state by JSONPointer path.

Kind: instance method of Signer
Overrides: get
Returns: Object - Value of the path in the Actor's state.

signer.set(path, value) ⇒ Object

Set a value in the Actor's state by JSONPointer path.

Kind: instance method of Signer
Overrides: set
Returns: Object - Value of the path in the Actor's state.

signer.toBuffer() ⇒ Buffer

Casts the Actor to a normalized Buffer.

Kind: instance method of Signer
Overrides: toBuffer

signer.toGenericMessage() ⇒ Object

Casts the Actor to a generic message.

Kind: instance method of Signer
Overrides: toGenericMessage
Returns: Object - Generic message object.

signer.toObject() ⇒ Object

Returns the Actor's current state as an Object.

Kind: instance method of Signer
Overrides: toObject

signer.pause() ⇒ Actor

Toggles status property to paused.

Kind: instance method of Signer
Overrides: pause
Returns: Actor - Instance of the Actor.

signer.serialize() ⇒ String

Serialize the Actor's current state into a JSON-formatted string.

Kind: instance method of Signer
Overrides: serialize

signer.unpause() ⇒ Actor

Toggles status property to unpaused.

Kind: instance method of Signer
Overrides: unpause
Returns: Actor - Instance of the Actor.

signer.value([format]) ⇒ Object

Get the inner value of the Actor with an optional cast type.

Kind: instance method of Signer
Overrides: value
Returns: Object - Inner value of the Actor as an Object, or cast to the requested format.

signer._readObject(input) ⇒ Object

Parse an Object into a corresponding Fabric state.

Kind: instance method of Signer
Overrides: _readObject
Returns: Object - Fabric state.

Snapshot

A type of message to be expected from a Service.

Kind: global class

• Snapshot
  • new Snapshot(settings)
  • .commit()

new Snapshot(settings)

Creates an instance of a Snapshot.

snapshot.commit()

Retrieves the sha256 fingerprint for the Snapshot state.

Kind: instance method of Snapshot

Stack

Manage stacks of data.

Kind: global class

• Stack
  • new Stack([list])
  • .push(data) ⇒ Number

new Stack([list])

Create a Stack instance.

Returns: Stack - Instance of the Stack.

stack.push(data) ⇒ Number

Push data onto the stack. Changes the Stack#frame and Stack#id.

Kind: instance method of Stack
Returns: Number - Resulting size of the stack.

State ⇐ EventEmitter

The State is the core of most User-facing interactions. To interact with the User, simply propose a change in the state by committing to the outcome. This workflow keeps app design quite simple!

Kind: global class
Extends: EventEmitter
Access: protected
Properties

• State ⇐ EventEmitter
  • new State(data)
  • instance
    • .toHTML()
    • .toString() ⇒ String
    • .serialize([input]) ⇒ Buffer
    • .deserialize(input) ⇒ State
    • .fork() ⇒ State
    • .get(path) ⇒ Mixed
    • .set(path) ⇒ Mixed
    • .commit()
    • .render() ⇒ String
  • static
    • .fromJSON(input) ⇒ State

new State(data)

Creates a snapshot of some information.

Returns: State - Resulting state.

state.toHTML()

Converts the State to an HTML document.

Kind: instance method of State

state.toString() ⇒ String

Unmarshall an existing state to an instance of a Blob.

Kind: instance method of State
Returns: String - Serialized Blob.

state.serialize([input]) ⇒ Buffer

Convert to Buffer.

Kind: instance method of State
Returns: Buffer - Store-able blob.

state.deserialize(input) ⇒ State

Take a hex-encoded input and convert to a State object.

Kind: instance method of State
Returns: State - [description]

state.fork() ⇒ State

Creates a new child State, with @parent set to the current State by immutable identifier.

Kind: instance method of State

state.get(path) ⇒ Mixed

Retrieve a key from the State.

Kind: instance method of State

state.set(path) ⇒ Mixed

Set a key in the State to a particular value.

Kind: instance method of State

state.commit()

Increment the vector clock, broadcast all changes as a transaction.

Kind: instance method of State

state.render() ⇒ String

Compose a JSON string for network consumption.

Kind: instance method of State
Returns: String - JSON-encoded String.

State.fromJSON(input) ⇒ State

Marshall an input into an instance of a State. States have absolute authority over their own domain, so choose your States wisely.

Kind: static method of State
Returns: State - Resulting instance of the State.

Store

Long-term storage.

Kind: global class
Properties

• Store
  • new Store([settings])
  • ._REGISTER(obj) ⇒ Vector
  • ._POST(key, value) ⇒ Promise
  • .get(key) ⇒ Promise
  • .set(key, value)
  • .trust(source) ⇒ Store
  • .del(key)
  • .flush()
  • .start() ⇒ Promise

new Store([settings])

Create an instance of a Store to manage long-term storage, which is particularly useful when building a user-facing Product.

Returns: Store - Instance of the Store, ready to start.

store._REGISTER(obj) ⇒ Vector

Registers an Actor. Necessary to store in a collection.

Kind: instance method of Store
Returns: Vector - Returned from storage.set

store._POST(key, value) ⇒ Promise

Insert something into a collection.

Kind: instance method of Store
Returns: Promise - Resolves on success with a String pointer.

store.get(key) ⇒ Promise

Barebones getter.

Kind: instance method of Store
Returns: Promise - Resolves on complete. null if not found.

store.set(key, value)

Set a key to a specific value.

Kind: instance method of Store

store.trust(source) ⇒ Store

Implicitly trust an Event source.

Kind: instance method of Store
Returns: Store - Resulting instance of Store with new trust.

store.del(key)

Remove a Value by Path.

Kind: instance method of Store

store.flush()

Wipes the storage.

Kind: instance method of Store

store.start() ⇒ Promise

Start running the process.

Kind: instance method of Store
Returns: Promise - Resolves on complete.

Swap : Object

The Swap contract executes a set of transactions on two distinct Chain components, utilizing a secret-reveal mechanism to atomically execute either the full set or none.

Kind: global class

• Swap : Object
  • new Swap([settings])
  • .extractSecret(tx, address) ⇒ Mixed

new Swap([settings])

Atomically execute a set of transactions across two Chain components.

swap.extractSecret(tx, address) ⇒ Mixed

Find an input from the provided transaction which spends from the target P2SH address.

Kind: instance method of Swap
Returns: Mixed - False on failure, secret value on success.