chaintool/funga
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Base classes for signers
49 Commits 2 Branches 1 Tag 290 KiB
Python 97.9%
Shell 2.1%
cdd1c58c51
Go to file
nolash cdd1c58c51
More typo in middleware ipc check
2020-10-17 15:08:33 +02:00
config No middleware if no ipc, add prefix env var 2020-10-17 14:47:01 +02:00
crypto_dev_signer More typo in middleware ipc check 2020-10-17 15:08:33 +02:00
scripts No middleware if no ipc, add prefix env var 2020-10-17 14:47:01 +02:00
test Return new address on method 'new' 2020-09-20 10:15:48 +02:00
.gitignore Add keystore interface previously omitted, middleware req 2020-08-06 14:11:43 +02:00
CHANGELOG No middleware if no ipc, add prefix env var 2020-10-17 14:47:01 +02:00
LICENSE.txt Add metadata license, url 2020-08-08 12:07:39 +02:00
middleware_requirements.txt Add keystore interface previously omitted, middleware req 2020-08-06 14:11:43 +02:00
README.md update README 2020-08-08 12:11:02 +02:00
requirements.txt Update requirements 2020-08-05 20:00:47 +02:00
setup.cfg Add configs 2020-10-17 02:44:25 +02:00
setup.py No middleware if no ipc, add prefix env var 2020-10-17 14:47:01 +02:00

README.md

CIC PLATFORM SIGNER

This package is written because at the time no good solution seemed to exist for solving the following combined requirements and issues:

  • A service has custody of its users' private keys.
  • The are a large number of private keys involved (tens of thousands minimum).
  • Need to sign transactions conforming to EIP-155, with the ability to arbitrarily specify the "chain id".
  • Do not want to store the keys inside an ethereum node, especially not the one connected to the network.
  • Want to use the "standard" web3 JSON-RPC interface, so that the component can be easily replaced later.
  • Multiple providers don't work on either web3.js and/or web3.py.
  • As a bonus, provide a practical keystore solution for testing in general for web3 projects.

TECHNICAL OVERVIEW

Scripts

Two scripts are currently available:

crypto-dev-daemon.py

An Unix socket IPC server implementing the following web3 json-rpc methods:

  • web3.eth.personal.newAccount
  • web3.eth.personal.signTransaction
  • web3.eth.signTransaction

web3_middleware.py

Demonstrates use of the IPC server as middleware for handling calls to the web3 json-rpc methods provided by the daemon.

Classes

The classes and packages provided are:

keystore

  • Keystore: Interface definition
  • ReferenceKeystore: Implements the Keystore interface, with a postgresql backend expecting sql schema as defined in ReferenceKeystore.schema

transaction

  • Transaction: Interface definition.
  • EIP155Transaction: Creates transaction serializations appropriate for EIP155 replay protected signatures. Accepts a web3 format transaction dict as constructor argument together with nonce and optional chainId.

signer

  • Signer: Interface definition. Its signTransaction method expects an object implementing the Transaction interface.
  • ReferenceSigner Implements Signer, accepting a single argument of type Keystore interface.

VERSION

This software is in alpha state and very brittle.

Current version is 0.1.0

LICENSE

GPLv3

LEGAL MUMBO-JUMBO

No responsibility assumed for any use of this software. You're on your own, as usual.