Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
170 Commits
7 Branches
138 Tags
74 MiB
Python 99.2%
Mako 0.5%
Makefile 0.1%
 
 
 
Go to file
jMyles 0e5c192f01 [KMS-ETH]- PopulusContract -=> Contract 2018-04-08 20:50:20 -07:00
nkms_eth [KMS-ETH]- PopulusContract -=> Contract 2018-04-08 20:50:20 -07:00
scripts [KMS-ETH]- Fixed high gas consumption in PolicyManager; Deprecate token module. 2018-03-29 09:48:12 -07:00
tests [KMS-ETH]- PopulusContract -=> Contract 2018-04-08 20:50:20 -07:00
.gitignore [KMS-ETH]- Threadlocal blockchain class to interface with populus and local chains. 2018-02-24 12:37:39 -08:00
Pipfile [KMS-ETH]- Ports deps to pipenv: system deps, pipenv, and solc install run from bash installer. 2018-02-24 12:35:48 -08:00
Pipfile.lock [KMS-ETH]- Ports deps to pipenv: system deps, pipenv, and solc install run from bash installer. 2018-02-24 12:35:48 -08:00
README.md [KMS-ETH]- Added events for contracts and tests for them 2018-03-06 13:14:26 +03:00
setup.py [KMS-ETH]- Ports deps to pipenv: system deps, pipenv, and solc install run from bash installer. 2018-02-24 12:35:48 -08:00

README.md

NuCypher KMS Ethereum

Ethereum (solidity) code for nucypher-kms, consists contracts and python classes for miners and clients. Part of contracts was copied from OpenZeppelin repo. The basis is built on the Populus framework.

Install

TBD

Periods structure

Most of the function in contracts works by periods. For example, stake in the contract Escrow is discretely unlocked by periods. Period is calculating using block.timestamp in getCurrentPeriod() function (Miner.sol). Each period is 24 hours. So result of getting locked tokens in one day will be the same.

Main contracts

  • Token contract
    NuCypherKMSToken contract is ERC20 token with additional function - burn own tokens (only for owners)
  • Miner contract
    MinersEscrow contract holds stake from miners, store information about miners activity and assigns a reward for participating in NuCypher KMS network
  • Client contract
    PolicyManager contract holds policies fee and distributes fee by periods
  • User escrow contract
    UserEscrow contract locks tokens for some time. In that period tokens are lineraly unlocked and all tokens can be used as stake in MinersEscrow contract

Python client

TBD

Solidity libraries

  • LinkedList library is structure of linked list for address data type
  • Dispatcher contract is proxy which used for updating versions of any contract. See README.MD