chainscript

Chainscript Javascript Client

Example

Creating a new script

var Chainscript = require('chainscript-client');

// You pass the initial script
new Chainscript({document: {content: {name: 'My Document'}}})
  // Add a snapshot command
  .snapshot()
  // Add a notarize command
  .notarize()
  // Add a send mail command
  .email('[e-mail]')
  // Run the script (returns a promise)
  .run()
  .then(function(script) {
    console.log(script.toJSON());
  })
  .fail(function(err) {
    console.error(err.message);
  });

Starting from an existing script

var Chainscript = require('chainscript-client');

Chainscript.load('chainscript:document:3940c155-d17d-421a-b34e-8bf5a458299e')
  .then(function(script) {
    console.log(script.toJSON());
    // You can add commands to the loaded script and run the script
    return script
      .email('[e-mail]')
      .run();
  }).then(function(script) {
    // New script executed with added commands
    console.log(script.toJSON());
  })
  .fail(function(err) {
    console.error(err.message);
  });

API

Chainscript

new Chainscript(script, immutable = true)

Creates a new Chainscript from a JSON object.

If immutable is true, THE INSTANCE IS IMMUTABLE. It is never modified after initialization. Adding commands to a script returns a new instance.

Chainscript.load(uuid, immutable = true)

Loads an existing script. Returns a promise that resolves with an instance of Chainscript.

Chainscript#get(path)

Returns the value at specified path, or undefined if the path doesn't exist.

Ex:

var value = new Chainscript({document: {content: {name: 'My Document'}}})
  .get('document.content.name'));

console.log(value); // My Document

Chainscript#snapshot()

Adds a snapshot command to a script. Returns a new instance of Chainscript if immutable, otherwise returns the instance.

Chainscript#update(updates)

Adds an update command to a script. Returns a new instance of Chainscript if immutable, otherwise returns the instance.

Chainscript#notarize()

Adds a notarize command to a script. Returns a new instance of Chainscript if immutable, otherwise returns the instance.

Chainscript#email(to)

Adds a send_email command to a script. Returns a new instance of Chainscript if immutable, otherwise returns the instance.

Chainscript#change(fn)

Adds an update command to a script that applies granular updates to the document. Returns a new instance of Chainscript if immutable, otherwise returns the instance.

Ex:

new Chainscript({document: {content: {name: 'My Document', val: true}}})
  .change(function(doc) {
    delete doc.val;
    doc.name += ' V2';
    doc.meta = {
      author: 'Stephan Florquin',
      time: Date.now()
    };
  })
  .run()
  .then(function(script) {
    console.log(script.get('document.content'));
  })
  .fail(function(err) {
    console.error(err.message);
  });

Chainscript#delta(document)

Adds an update command to a script that applies the necessary changes to update the current document to the given document. Returns a new instance of Chainscript if immutable, otherwise returns the instance.

Ex:

var doc = {
  name: 'My Document'
};

var script = new Chainscript({document: {content: doc}});

doc.name = 'My Document V2';
doc.meta = {
  author: 'Stephan Florquin',
  time: Date.now()
};

script.delta(doc).run().then(function(s) {
  script = s;
  console.log(script.get('document.content'));
});

Chainscript#toJSON()

Returns the script as a JSON object.

Chainscript#run()

Runs the Chainscript. Returns a promise that resolves with a new instance of Chainscript if immutable, otherwise with the instance.

Chainscript#clone()

Clones Chainscript. Returns a new instance of Chainscript.

Mutable extensions

This only applies when immutable is false.

You can change the document directly, and an update command will be issued when you call run.

var script = new Chainscript(
  {document: {content: {name: 'My Document'}}},
  false
);

script.content.name += ' V2';
script.content.meta = {
  author: 'Stephan Florquin',
  time: Date.now()
};

script
  .run()
  .then(function() {
    console.log(script.toJSON());
  });