Typescript implementation of the PeerAssets Data Audit Protocol (PADAP)
Clone or download
peerchemist Merge pull request #2 from kazzkiq/patch-1
Adding syntax highlight to README
Latest commit 05e9496 Jan 18, 2019

README.md

perpera

usage

The browser bundle is built by running npm run bundle. The resulting dist/bundle.js file should be referenced using a <script> tag, which exposes the library interface through a global perpera object.

Available networks are accessible through the perpera.networks object: the keys are names and the values are instances of the perpera.Network class.

The central concept is the document.

const tag = 'foo';     // unique identifier of the document
const net = perpera.networks['peercoin'];     // the blockchain used to store the document's history
const doc = new perpera.Document(tag, net);
doc.sync().then(() => {
  // the document is now loaded from the underlying blockchain
});

After the promise returned by the sync() method is fulfilled, the document's transitions property may be inspected. It is an array of transitions, which make up the document's history. Refer to the src/model.ts file to understand the structure of these objects.

In order to modify a document, specially crafted transactions are inserted into the blockchain. Funds spent on these transactions are handled using instances of perpera.Spender.

const wif = '...';     // private key in WIF (wallet interchange format)
const spender = perpera.Spender.fromWIF(wif, 'peercoin');     // or perpera.Network instance
spender.sync().then(() => {
  // the UTXOs are now loaded into the spender instance
});

The document's content is updated by providing a collection of hash digests:

const hash = {
  'sha2-256': 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
};
doc.updateContent(hash, spender).then(() => {
  // the transactions have been sent to the network
});

This should only be performed after both the document and the spender have been synced. If the spender is not the current owner of the document, an error is thrown without broadcasting any transactions.

It is possible to attach URIs to a document:

doc.addUri('https://example.com/foo.txt', spender).then(() => {
  // the transactions have been sent to the network
});

If the given URI is too long to fit into a transaction, an error is thrown.