Add makefiles, update readme

Makefile

@@ -0,0 +1,12 @@
+all: python solidity doc
+python:
+	make -C python
+solidity:
+	make -C solidity
+doc:
+	make -C doc/texinfo
+readme:
+	make -C doc/texinfo readme
+	pandoc -f docbook -t gfm doc/texinfo/build/docbook.xml > README.md
+
+

README.md

@@ -1,131 +1,404 @@
-# RedistributedDemurrageToken
+# Overview
 
-## Use Case
+    de-mur-rage
-* Vouchers
+
-  * A Publisher may publish a RedistributedDemurrageToken (Voucher) representing a credit obligation of an Issuer or Association of Issuers that can be redeemed as payment for the products of the Issuer. The Issuer is the entity legally obligated to redeem the voucher as payment.
+    1: the detention of a ship by the freighter beyond the time allowed for loading, unloading, or sailing
-  * Decay: The Publisher can specify an decay rate such as 2% as well as a redistribution period. After the redistribution period such as a month. Assuming an account holder has not had any transfers they will have a new balance of their original balance*2%. Note that the numeric decay will happen continuously by the minute.
+
-  * Redistribution: The missing (demurraged) balances will be added to the balance of the SINK address. So once a redistribution period (e.g. once a month) the total supply of all holders including the SINK will return to the minted supply.
+    2: a charge for detaining a ship, freight car, or truck
-  * This is meant to result as a disincentivization to hold (hodl) the Voucher without causing price inflation, as the total supply is stable.
+
-  * Example 
+This ERC20 smart contract implementation for the EVM imposes a demurrage
-    -  With a demurrage of 2% (and redistribution period of 1 month) - If there are 10 users all with balances of 100 Vouchers (and only 2 of them trade that month (assume they trade back and forth with no net balance change)). 
+on all held token balances.
-    - Then the resulting balances after one redistribution period of ALL users (regardless of their trading) would be 98 Vouchers and 20 Voucher would be the balance of the SINK address. Assuming the SINK address is redistributed (as a Community Fund) back to users, it’s balance would again reach 20 the next redistribution period. 
+
-    - Note that after the redistribution the total of all balances will equal the total minted amount. 
+The demurrage is a continuous value *decay*, subtracted from all
-    - Note that all accounts holding such Vouchers are effected by demurrage.
+balances every minute.
+
+Also. a time period is defined at contract creation time at which the
+difference between held balances and the demurrage can be withdrawn to a
+pre-selected address, which in turn can redistribute that token value.
+
+In short: Everyone is taxed a little something every minute, and every
+so often a decision is made on how to redistribute that tax.
+
+## Features
+
+- Continuous decay of all balances.
+
+- Capture and redistribution of decayed balances.
+
+- Per-minute decay resolution.
+
+- Minting and burning of vouchers.
+
+- Grant and revoke access to mint and burn vouchers.
+
+- Voucher expiration (modifiable anytime after publishing).
+
+- Supply cap (modifiable anytime after publishing).
+
+- Constant gas usage across exponential calculations.
 
 ## Nomenclature
 
-* `Demurrage` aka Decay amount: A percentage of token supply that will gradually be removed over a redstribution period and then redistributed to the SINK account.
+‘`Demurrage`’  
-* Base balance: The inflated balance of each user is stored for bookkeeping.
+A percentage of token supply that will continuously be removed.
-* Sink Token Address: Rounding errors and if no one trades the tax goes to this address
-* Demurrage Period (minutes)- aka `period`: The number of minutes over which a user must be _active_ to receive tax-redistibution. 
 
+‘`Demurrage Period`’  
+A period of time denominated in minutes after which demurraged amounts
+are available for redistribution.
 
-## Ownership
+‘`Sink Account`’  
+The intermediate beneficiary of the demurraged amount, which may or may
+not redistribute value.
 
-* Contract creator is owner
+‘`Base balance`’  
-* Ownership can be transferred
+The inflated balance of each used which is stored for bookkeeping.
 
+# Use Case
 
-## Mint
+The use-case inspiring this implementation is in the context of issuance
+of a *voucher* representing a credit obligation of an *Issuer* or
+*Association of Issuers*.
 
-* Minters are called writers. Contract owner can add and remove writers.
+This voucher can be redeemed as payment for the products of the Issuer.
-* A writer can remove itself
-* The interface says the amount and is at the caller's discretion per contract call. _validation_ is outside of this contract.
-* Writers can mint any amount. If supply cap is set, minting will be limited to this cap.
 
+The Issuer is the entity legally obligated to redeem the voucher as
+payment.
 
-## Input parameters
+Introducing demurrage on this vehicle discourages *withholding* the
+voucher, for example for speculative advantage.
 
-The redistrbution period is passed to the contract in minutes. E.g. a redistribution period of one month would be approximately 43200 minutes.
+This also encourages increased *velocity* of voucher use.
 
-The demurrage level specified as the percentage of continuous growth per minute:
+## Example
 
-`(1 - percentage) ^ (1 / period)`
+Given:
 
-E.g. A demurrage of 2% monthly would be defined as:
+- 10 voucher holders.
 
-`(1 - 0.02) ^ (1 / 43200) ~ 0.99999953234484737109`
+- A total supply of 1000 tokens.
 
-The number must be provided to the contract as a 64x64 bit fixed-point number (where the integer part is 0).
+- Demurrage of 2% per 30 days (43200 minutes).
 
-A script is included in the python package to publish the contract which takes the input as a percentage as parts-per-million and converts the correct input argument for the contract. The calculation can be found in the function `process_config_local` in `python/erc20_demurrage_token/runnable/publish.py`. It uses the python module [dexif](https://pypi.org/project/dexif/) to perform the fixed-point conversion.
+- Redistribution period of 30 days (43200 minutes).
 
+If no trades are made, the resulting balances after one redistribution
+period of every user would be 98 Vouchers.
 
-## Demurrage calculation
+The Sink Address will have a balance of 20 vouchers after the same
+period.
 
-The demurrage calculation inside the contract is done by the following formula, where `demurrageLevel` is the demurrage level input parameter of the contract:
+Note that after the redistribution the total of all balances will equal
+the total minted amount.
 
-`newDemurrageModifier = currentDemurrageModifier * (e ^ (ln(demurrageLevel) * minutes))`
+Note that all accounts holding such vouchers are effected by demurrage
+(even the Sink Account, pending redistribution).
 
-Holding Tax (`demurrage`) is applied when a **mint** or **transfer**; (it can also be triggered explicitly)
+# Smart contract
-- Note that the token supply _stays the same_ but a virtual _balance output_ is created.
-- Updates `demurrageModifier` which represents the accumulated tax value and is an exponential decay step (of size `demurrage`) for each minute that has passed.
 
+## Common interfaces
 
-All client-facing values (_balance output_ , _transfer inputs_) are adjusted with `demurrageModifier`.
+The smart contract is written in solidity, compatible with 0.8.x.
 
-e.g. `_balance output_ = user_balance - user_balance * demurrageModifier`
+It implements a number of interfaces both from the Ethereum (ERC)
+standards aswell as the Community Inclusion Currency contract interface
+suite.
 
+### ERC standard interfaces
 
-## Redistribution
+- [ERC20 - Token Standard](https://eips.ethereum.org/EIPS/eip-20)
 
-* One redistribution entry is added to storage for each `period`;
+- [ERC165 - Standard Interface
-* When `mint` is triggered, the new totalsupply is stored to the entry
+  Detection](https://eips.ethereum.org/EIPS/eip-165)
-* When `transfer` is triggered, and the account did not yet participate in the `period`, the entry's participant count is incremented. 
-* Redistributed tokens are added to the balance of the _sink address_ given when the contract is published.
-* _sink address_ may be changed.
 
+- [ERC173 - Contract Ownership
+  Standard](https://eips.ethereum.org/EIPS/eip-173)
 
-## Data representation
+- [ERC5679 - Token Minting and Burning (as part of CIC.Minter and
+  CIC.Burner)](https://eips.ethereum.org/EIPS/eip-5679)
 
-Token parameters are truncated when calculating demurrage and redistribution:
+### CIC interfaces
 
-* Redistribution period: 32 bits
+- [Burner](https://git.grassecon.net/cicnet/cic-contracts/src/branch/master/solidity/Burner.sol)
-* Token supply: 72 bits
-* Demurrage modifier: 64 bits
 
+- [Expire](https://git.grassecon.net/cicnet/cic-contracts/src/branch/master/solidity/Expire.sol)
 
-## Expiration
+- [Minter](https://git.grassecon.net/cicnet/cic-contracts/src/branch/master/solidity/Minter.sol)
 
-A token may set to expire at a certain point in time. After the expiry, no more transfers may be executed. From that point on, balances are frozen and demurrage is halted.
+- [Seal](https://git.grassecon.net/cicnet/cic-contracts/src/branch/master/solidity/Seal.sol)
 
-Expiration may be set in terms of redistribution periods.
+- [Writer](https://git.grassecon.net/cicnet/cic-contracts/src/branch/master/solidity/Writer.sol)
 
-Unless sealed (see below), expiration may be changed at any time to any future redistribution period. However, once expired, expiration may not be changed further.
+## Dependencies
 
+The token contract uses the
+[ADBKMath](https://github.com/abdk-consulting/abdk-libraries-solidity/blob/master/ABDKMath64x64.sol)
+library to calculate exponentials.
 
-## Supply
+## Permissions
 
-Unless sealed (see below), Supply limit may be set and change at any time. Supply may never be directly set to less than the current supply. However, contract _writers_ may burn tokens in their possession using the `burn()` method, which will effectively reduce the supply.
+The smart contract defines three levels of access.
 
+1.  Voucher contract owner
 
-## Mutability
+2.  Voucher minter
 
-The following parameters may not be changed after contract is published:
+3.  Voucher holder
 
-* Demurrage level
+### Contract owner
-* Redistribution period
 
-The contract provides a sealing feature which prohibits further changes to parameters that can initially be edited. These include:
+When the contract is published to the network, the signer account of the
+publishing transaction will be the contract owner.
 
-* Adding and removing writers (addresses that may mint tokens)
+Contract ownership can be changed by the owner using the **ERC173**
-* Sink addres
+standard interface.
-* Expiry period
-* Supply limit
 
+### Minter
+
+A minter has access to mint vouchers, and to burn vouchers from its own
+balance.
+
+Only the contract owner may mint, and may add and remove minters.
+Minters may be added and removed using the **CIC Writer** interface, as
+long as the `WRITER_STATE` seal is not set. See [Sealing the
+contract](#seal_005fstate) for further details.
+
+The contract owner is automatically a minter.
+
+### Holder
+
+Any address may hold vouchers, and transfer vouchers from their balance.
+
+Minters and the contract owner are automatically token holders.
+
+All token holders are subject to demurrage.
+
+## Publishing the contract
+
+The contract is published with the following arguments:
+
+‘`name`’  
+ERC20 voucher name
+
+‘`symbol`’  
+ERC20 voucher symbol
+
+‘`decimals`’  
+ERC20 decimal count
+
+‘`decayLevel`’  
+Level of decay per minute. See [Specifying
+demurrage](#specifying_005fdemurrage) below for further details.
+
+‘`periodMinutes`’  
+Number of minutes between each time the demurraged value can be
+withdrawn to the *Sink Account*. See [Withdrawing demurraged
+value](#withdrawing) below for further details. The period may not be
+altered.
+
+‘`defaultSinkAddress`’  
+The initial *Sink Address*. The address may be altered as long as the
+`SINK_STATE` seal has not been set. See [Sealing the
+contract](#seal_005fstate) for further details.
+
+### Specifying demurrage
+
+The *input parameter* to the contract is a 128-bit positive fixed-point
+number, where the most significant 64 bits represent the integer part,
+and the lower 64 bits represents the decimals part, each consecutive
+lesser bit halving the value of the previous bit.
+
+For example, The byte value `00000000 00000002 a0000000 00000000`,
+representing a zero-stripped binary value of $10.101$, translates to the
+(base 10) decimal value $2.625$.
+
+#### Calculating the demurrage parameter
+
+The minute granularity of the demurrage value is calculating using the
+continuous decay function.
+
+For example, for a demurrage of 2% per 30 days (43200 minutes), the
+input value will be:
+
+$(1-0.02)^(1/43200) ~ 0.99999953234484737109$
+
+The decimal part of the fixed-point representation of this value is:
+
+`fffff8276fb8cfff`
+
+The input parameter becomes:
+
+`0000000000000000ffffa957014dc7ff`
+
+See [Tools](#tools) for additional help generating the necessary values.
+
+Note that attempting to publish a voucher contract with no (zero)
+demurrage will fail (if demurrage is not needed, use another contract).
+
+## Using the contract
+
+### Withdrawing demurrage
+
+After each redistribution period, the demurraged value of that period
+can be withdrawn to the currently defined *Sink Account*.
+
+The demurrage is calculated as from the total supply of voucher at the
+end of the period.
+
+Withdrawal should happen implicitly duing normal operation of the
+contract. See [Side-effects in state changes](#sideeffects).
+
+To explicitly credit the *Sink Address* with the demurrage value after a
+period has been exceeded, the `changePeriod()` (`8f1df6bc`) method can
+be called.
+
+### Setting voucher expiry
+
+The effect of a voucher expiring is that all balances will be frozen,
+and all state changes affecting token balances will be blocked.
+
+Expiry is defined in terms of redistribution periods. For example, if
+the redistribution period is 30 days, and the expity is 3, then the
+voucher expires after 90 days.
+
+The expiry takes effect immediately when the redistribution period time
+has been exceeded.
+
+When the contract is published, no expiry is set.
+
+Expiry may be set after publishing using the `CIC.Expire` interface.
+
+If the `EXPIRE_STATE` seal has been set, expiry may not be changed
+further.
+
+### Capping voucher supply
+
+The effect of a voucher supply cap is that all `CIC.Minter` calls will
+fail if the total supply after minting exceeds the defined supply cap.
+
+The supply cap still allows vouchers to be minted after `CIC.Burn`
+calls, provided that the previous condition holds.
+
+To apply the supply cap, the method `setMaxSupply(uint256) (6f8b44b0)`
+is used.
+
+### Side-effects in state changes
+
+All state changes involving voucher values implicitly execute two core
+methods to ensure application of the demurrage and redistribution.
+
+The two methods are:
+
+`applyDemurrage() (731f237c)`  
+Calculates the demurrage modifier of all balances according to the
+current timestamp.
+
+`changePeriod() (8f1df6bc)`  
+If the previously executed period change does not match the current
+period, the period is changed, and the *Sink Address* is credited with
+the demurrage amount of the current total supply.
+
+Both of these methods are *noop* if no demurrage or withdrawal is
+pending, respectively.
+
+Examples of state changes that execute these methods include
+`ERC20.transfer(...)`, `ERC20.transferFrom(...)` and `CIC.mintTo(...)`.
+
+### Sealing the contract
+
+Certain mutable core parameters of the contract can be *sealed*, meaning
+prevented from being modifier further.
+
+Sealing is executed using the `CIC.Seal` interface.
+
+The sealing of parameters is irreversible.
+
+The sealable parameters are[^1]:
+
+`WRITER_STATE`  
+The `CIC.Writer` interface is blocked. The effect of this is that no
+more changes may be made to which accounts have minter permission.
+
+`SINK_STATE`  
+After setting this seal, the *Sink Address* may not be changed.
+
+`EXPIRY_STATE`  
+Prevents future changes to the voucher expiry date[^2].
+
+`CAP_STATE`  
+Immediately prevents future voucher minting, regardless of permissions.
 
 ## Gas usage
 
-The token contract uses the [ADBKMath](https://github.com/abdk-consulting/abdk-libraries-solidity/blob/master/ABDKMath64x64.sol) library to calculate exponentials.
+Gas usage is constant regardless of the amount of time passed between
+each execution of demurrage and redistribution period calculations.
 
-Gas usage is constant regardless of the amount of time passed between each execution of demurrage and redistribution period calculations.
+## Caveats
 
+A `ERC20.transferFrom(...)` following an `ERC20.approve(...)` call, when
+called across period thresholds, may fail if margin to demurraged amount
+is insufficient.
 
-## QA
+# Tools
 
-* Tests are implemented using the `chaintool` python package suite.
+When installed as a python package, `erc20-demurrage-token` installs the
+`erc20-demurrage-token-publish` executable script, which can be used to
+publish smart contract instances.
 
+While the man page for the tool can be referred to for general
+information of the tool usage, two argument flags warrant special
+mention in the context of this documentation.
 
-## Known issues
+`--demurrage-level`  
+The percentage of demurrage in terms of the redistribution period,
+defined as parts-per-million.
 
-* A `transferFrom` following an `approve` call, when called across period thresholds, may fail if margin to demurraged amount is insufficient.
+`--redistribution-period`  
+A numeric value denominated in *minutes* to define the redistribution
+period of the voucher demurrage.
+
+For example, to define a 2% demurrage value for a redistribution period
+of 30 days (43200 minutes), the argument to the argument flags would be:
+
+    erc20-demurrage-token-publish --demurrage-level 20000 --redistribution-period 43200 ...
+
+## Calculating fixed-point values
+
+The `erc20-demurrage-token` package installs the python package `dexif`
+as part of its dependencies.
+
+This package in turn provides an epinymous command-line tool (`dexif`)
+which converts decimal values to a 128-bit fixed-point value expected by
+the contract constructor.
+
+An example:
+
+    $ dexif 123.456
+    7b74bc6a7ef9db23ff
+
+    $ dexif -x 7b74bc6a7ef9db23ff
+    123.456
+
+## Contract interaction with chainlib-eth
+
+All smart contract tests are implementing using
+[chainlib-eth](https://git.defalsify.org/chainlib-eth) from the
+chaintool suite.
+
+The `eth-encode` tool from the `chainlib-eth` python package may be a
+convenient way to interact with contract features.
+
+Some examples include:
+
+    # explicitly call changePeriod()
+    $ eth-encode --mode tx --signature changePeriod -e <contract_address> -y <key_file> ...
+
+    # Set the sink address seal (The integer value of the SINK_STATE flag is 2 at the time of writing)
+    $ eth-encode --mode tx --signature seal  -e <contract_address> -y <key_file> ... u:2
+
+    # Query current sink address of contract
+    $ eth-encode --mode call --signature sinkAddress -e <contract_address> ...
+
+[^1]: Please refer to the contract source code for the numeric values of
+    the state flags
+
+[^2]: The `EXPIRY_STATE` is implicitly set after expiration.

doc/texinfo/Makefile

@@ -0,0 +1,4 @@
+doc:
+	makeinfo --html -o build index.texi
+readme:
+	makeinfo --docbook -o build/docbook.xml index.texi

doc/texinfo/contract.texi

@@ -123,7 +123,7 @@ The input parameter becomes:
 
 @code{0000000000000000ffffa957014dc7ff}
 
-@xref{tools, Useful tools} for additional help generating the necessary values.
+@xref{tools, Tools} for additional help generating the necessary values.
 
 Note that attempting to publish a voucher contract with no (zero) demurrage will fail (if demurrage is not needed, use another contract).
 
@@ -135,7 +135,9 @@ Note that attempting to publish a voucher contract with no (zero) demurrage will
 
 After each redistribution period, the demurraged value of that period can be withdrawn to the currently defined @emph{Sink Account}.
 
-The demurrage is calculated as from the total supply of voucher at the end of the period. @xref{sideeffects, Side-effects in state changes}.
+The demurrage is calculated as from the total supply of voucher at the end of the period.
+
+Withdrawal should happen implicitly duing normal operation of the contract. @xref{sideeffects, Side-effects in state changes}.
 
 To explicitly credit the @emph{Sink Address} with the demurrage value after a period has been exceeded, the @code{changePeriod()} (@code{8f1df6bc}) method can be called.
 
@@ -163,7 +165,7 @@ The effect of a voucher supply cap is that all @code{CIC.Minter} calls will fail
 
 The supply cap still allows vouchers to be minted after @code{CIC.Burn} calls, provided that the previous condition holds.
 
-To apply the supply cap, the method @code{maxSupply(uint256) (869f7594)} is used.
+To apply the supply cap, the method @code{setMaxSupply(uint256) (6f8b44b0)} is used.
 
 
 @node sideeffects
@@ -180,6 +182,8 @@ Calculates the demurrage modifier of all balances according to the current times
 If the previously executed period change does not match the current period, the period is changed, and the @emph{Sink Address} is credited with the demurrage amount of the current total supply.
 @end table
 
+Both of these methods are @emph{noop} if no demurrage or withdrawal is pending, respectively.
+
 Examples of state changes that execute these methods include @code{ERC20.transfer(...)}, @code{ERC20.transferFrom(...)} and @code{CIC.mintTo(...)}.
 
 

python/Makefile

@@ -0,0 +1,2 @@
+all:
+	python setup.py sdist