A simple module for signing Ethereum transactions.
Branch: master
Clone or download
Latest commit 8739b3e Nov 5, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github version 0.1.0 -- basic coverage, docs, builds, config Dec 9, 2016
dist version 0.1.1 -- remove ethjs-sha3 for js-sha3 Dec 17, 2016
docs version 0.1.1 -- remove ethjs-sha3 for js-sha3 Dec 17, 2016
internals/webpack version 0.1.0 -- basic coverage, docs, builds, config Dec 9, 2016
src version 0.1.1 -- remove ethjs-sha3 for js-sha3 Dec 17, 2016
.editorconfig version 0.1.0 -- basic coverage, docs, builds, config Dec 9, 2016
.gitattributes version 0.1.0 -- basic coverage, docs, builds, config Dec 9, 2016
.gitignore version 0.1.0 -- basic coverage, docs, builds, config Dec 9, 2016
.travis.yml
CHANGELOG.md version 0.1.1 -- remove ethjs-sha3 for js-sha3 Dec 17, 2016
CODE_OF_CONDUCT.md version 0.1.0 -- basic coverage, docs, builds, config Dec 9, 2016
LICENSE Update LICENSE Nov 5, 2017
README.md Update README.md Nov 5, 2017
package.json version 0.1.1 -- remove ethjs-sha3 for js-sha3 Dec 17, 2016

README.md

ethjs-signer


A simple Ethereum signing and recovery utility.

WARNING: This module does not have EIP155 replay protection, do not use until it is upgraded.

Install

npm install --save ethjs-signer

Usage

const HttpProvider = require('ethjs-provider-http');
const Eth = require('ethjs-query');
const eth = new Eth(new HttpProvider('http://localhost:8545'));
const sign = require('ethjs-signer').sign;
const BN = require('bignumber.js');

const address = '0x0F6af8F8D7AAD198a7607C96fb74Ffa02C5eD86B';
const privateKey = '0xecbcd9838f7f2afa6e809df8d7cdae69aa5dfc14d563ee98e97effd3f6a652f2';

eth.getTransactionCount(address).then((nonce) => {
  eth.sendRawTransaction(sign({
    to: '0xce31a19193d4b23f4e9d6163d7247243bAF801c3',
    value: 300000,
    gas: new BN('43092000'),
    // when sending a raw transactions it's necessary to set the gas price, currently 0.00000002 ETH
    gasPrice: new BN('20000000000'),
    nonce: nonce,
  }, privateKey)).then((txHash) => {
    console.log('Transaction Hash', txHash);
  });
});

Note, that address and private key are a valid address and private key. Only use this example address for local testing and setup. You will loose your Ether if you send it to this address.

About

This module is meant to help sign and recover Ethereum transactions. You can either sign the transaction and have it return a serilized hex payload (the default), or return the raw array of Buffer values.

Method API

sign     <Function  (Object, String [, Boolean]) : (String|Array)>
recover  <Function  (Object|String, Number, Object, Object) : (Object)>

Contributing

Please help better the ecosystem by submitting issues and pull requests to ethjs-signer. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard and the unix philosophy.

Guides

You'll find more detailed information on using ethjs-signer and tailoring it to your needs in our guides:

  • User guide - Usage, configuration, FAQ and complementary tools.
  • Developer guide - Contributing to ethjs-signer and writing your own code and coverage.

Help out

There is always a lot of work to do, and will have many rules to maintain. So please help out in any way that you can:

  • Create, enhance, and debug ethjs rules (see our guide to "Working on rules").
  • Improve documentation.
  • Chime in on any open issue or pull request.
  • Open new issues about your ideas for making ethjs-signer better, and pull requests to show us how your idea works.
  • Add new tests to absolutely anything.
  • Create or contribute to ecosystem tools.
  • Spread the word!

Please consult our Code of Conduct docs before helping out.

We communicate via issues and pull requests.

Important documents

Licence

This project is licensed under the MIT license, Copyright (c) 2016 Nick Dodson. For more information see LICENSE.md.

The MIT License (MIT)
 
Copyright (c) 2016 Nick Dodson
Copyright (c) 2014 Richard Moore
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.