Giter Site home page Giter Site logo

ethproof's Introduction

ethproof

NPM version NPM downloads CircleCI codecov

This module helps you publish Proof Of Existence transactions on the Ethereum blockchain. These create a permanent record of a document hash at a specific date and time, allowing you to prove when it was originally written.

For example, you may use this technique to document an invention or intellectual property to verify in the future the date at which you first created it. The only information about your data which is stored on the chain is the documents SHA256 hash.

Install

npm install --save ethproof

Usage

ES6

import {hashDocument, publishProof} from 'ethproof'

const privateKeyHex = '774a1dee2b3a3d6c64c0e47124d3ac7522ae5c57e1fef1c4abb1b3dd63bffee6';
const destinationAddress = '44241d4e6a0fd2acff819478a87b7cdfe7963468';
const document = Buffer.from('Hello Crypto! ' + Math.random().toString());

const documentHash = hashDocument(document);
const txHash = publishProof(privateKeyHex, destinationAddress, documentHash);

ES5

var ethproof = require('ethproof');

var privateKeyHex = '774a1dee2b3a3d6c64c0e47124d3ac7522ae5c57e1fef1c4abb1b3dd63bffee6';
var destinationAddress = '44241d4e6a0fd2acff819478a87b7cdfe7963468';
var document = Buffer.from('Hello Crypto! ' + Math.random().toString());

var documentHash = ethproof.hashDocument(document);
var txHash = ethproof.publishProof(privateKeyHex, destinationAddress, documentHash);

The above examples provide no JSON RPC URI to the publishProof(...) call. As such they default to localhost and default port. If you would like to use Infura or any other custom URI pass it as the final parameter. For example:

var txHash = publishProof(privateKeyHex, destinationAddress, documentHash, 'https://rinkeby.infura.io/');

If the transaction can not be sent, an error will be thrown and can be handled with try {...} catch (err) {...}

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Use npm test to run linting and tests.

Mining

If you need Ethereum to work with, consider Ethereum mining with WinEth

Author

ethproof © Stefan Gordon, Released under the MIT License.
Authored and maintained by Stefan Gordon with help from contributors (list).

github.com/stefangordon · GitHub @Stefan Gordon · Twitter @stefangordon

ethproof's People

Contributors

stefangordon avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.