blockchain_proof

blockchain_proof

BlockchainProof - JavaScript client for blockchain_proof The Blockchain Proof API is an easy to prove existence of (binary) data at a certain point in time. Behinde the scenes it stores entries using the Factom (bitcoin) blockchain by means of our generic blockchain API. The flow is generally as follows: 1. Make sure a Proof chain has been created using the /chain POST endpoint beforehand. Normally you only need one or a handful of chains, during the entiry lifetime of your proof solution. This is a relative expensive operation in terms of money. 2. Store proof entries on the proof chain from step 1. The entries will contain the content and metadata you want to store forever on the specified chain. 3. Retrieve an existing entry from the chain to verify or retrieve data Interactive testing: A web based test console is available in the <a href="https://store.sphereon.com\">Sphereon API Store This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.0
• Package version: 0.1.0
• Build date: 2016-11-09T04:32:41.106+01:00
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://sphereon.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install blockchain_proof --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var BlockchainProof = require('blockchain_proof');

var defaultClient = BlockchainProof.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new BlockchainProof.ProofOfExistenceApi()

var request = new BlockchainProof.CreateChainRequest(); // {CreateChainRequest} Create a new Proof of Existence chain using the provided existence settings


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createChain(request, callback);

Documentation for API Endpoints

All URIs are relative to https://gw.api.cloud.sphereon.com/

Class	Method	HTTP request	Description
BlockchainProof.ProofOfExistenceApi	createChain	POST /blockchain/proof/0.1.0/existence	Create a new existence chain
BlockchainProof.ProofOfExistenceApi	registerContent	POST /blockchain/proof/0.1.0/existence/{chainId}	Register content
BlockchainProof.ProofOfExistenceApi	registerStream	POST /blockchain/proof/0.1.0/existence/{chainId}/stream	Register content using a bytestream/file
BlockchainProof.ProofOfExistenceApi	verifyContent	GET /blockchain/proof/0.1.0/existence/{chainId}	Verify content
BlockchainProof.ProofOfExistenceApi	verifyContentByHash	GET /blockchain/proof/0.1.0/existence/{chainId}/{hash}	Verify content by hash
BlockchainProof.ProofOfExistenceApi	verifyStream	GET /blockchain/proof/0.1.0/existence/{chainId}/stream	Verify content using a bytestream/file

Documentation for Models

• BlockchainProof.CommittedChain
• BlockchainProof.ContentRequest
• BlockchainProof.CreateChainRequest
• BlockchainProof.CreateChainResponse
• BlockchainProof.Link
• BlockchainProof.RegisterContentResponse
• BlockchainProof.Settings
• BlockchainProof.VerifyContentResponse
• BlockchainProof.VndError
• BlockchainProof.VndErrors

Documentation for Authorization

oauth2schema

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
  • global: accessEverything