Add throttle interface

Signed-off-by: lash <dev@holbrook.no>

Makefile

@@ -45,7 +45,10 @@ readme:
 	pandoc -f docbook -t gfm doc/texinfo/build/docbook.xml > README.md
 	cp -v README.md python/README.md
 
-python:
+python: outs
+	mkdir -vp python/cic_contracts/data
+	cp -v solidity/*.interface python/cic_contracts/data
+	cp -v solidity/*.json python/cic_contracts/data
 	make -C python
 
 .PHONY: clean install

README.md

@@ -47,6 +47,27 @@ in CIC native interfaces.
 
 ## Native interfaces
 
+### ACL
+
+A simple Access Control List definition that returns true of false
+depending on whether an signatory (address) is allowed to operate in a
+given context.
+
+#### ERC165 Interface identifier
+
+3ef25013
+
+#### Solidity interface definition
+
+    interface IACL {
+        // Returns true if the address has permission to operate in the given context.
+        function have(address _address) external view returns(bool);
+    }
+
+#### Example implementation
+
+<git://holbrook.no/eth-accounts-index.git>
+
 ### Accounts Index
 
 Append-only list of addresses. Typically used for access control lists.
@@ -61,10 +82,12 @@ matching `address(0x00)` should be skipped, and not counted towards
 
 May optionally record time when account was added.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 b7bca625
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IAccountsIndex {
         // Address added to store, index in array.
         event AddressAdded(uint256 indexed _idx, address _account);
@@ -81,6 +104,7 @@ Solidity interface definition
         function add(address) external returns (bool);
 
         // Verify that the entry exists in the index.
+        // Implements ACL
         function have(address) external view returns (bool);
 
         // Retrieve the timestamp when account was added.
@@ -88,7 +112,8 @@ Solidity interface definition
         function time(address) external view returns (uint256);
     }
 
-Reference implementation  
+#### Reference implementation
+
 <git://holbrook.no/eth-accounts-index.git> (v0.5.1)
 
 ### Accounts Index Mutable
@@ -99,10 +124,12 @@ address list.
 Addresses may be *added*, *removed*, aswell as *deactivated* and
 *activated*. Deactivated accounts still count towards the `entryCount`.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 9479f0ae
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IAccountsIndexMutable {
         // Active status of address changed, and by whom changed.
         event AddressActive(address indexed _account, bool _active);
@@ -123,7 +150,8 @@ Solidity interface definition
         function isActive(address) external view returns (bool);
     }
 
-Reference implementation  
+#### Reference implementation
+
 <git://holbrook.no/eth-accounts-index.git> (v0.5.1)
 
 ### Burner
@@ -132,10 +160,12 @@ Attached to `ERC20` and `ERC721` tokens that may be *burned*.
 
 Implements the `burn(...)` part of `ERC5679` for interoperability.
 
-ERC165 Interface identifier  
-bc4babdd
+#### ERC165 Interface identifier
+
+b1110c1b
+
+#### Solidity interface definition
 
-Solidity interface definition  
     interface IBurner {
         // Token(s) successfully burned; by who and how much.
         event Burn(address indexed _burner, uint256 _burned);
@@ -144,10 +174,11 @@ Solidity interface definition
         function burn(address _from, uint256 _amount, bytes calldata _data) external;
 
         // Burn given amount of tokens held by signer.
-        function burn(uint256 _burn) external returns (bool);
+        function burn(uint256 _amount) external returns (bool);
 
         // Burn all tokens held by signer.
-        function burn() external returns (bool);
+        // Returns the amount of tokens burned.
+        function burn() external returns (uint256);
 
         // Total amount of tokens that have been burned.
         function totalBurned() external returns (uint256);
@@ -157,7 +188,8 @@ Solidity interface definition
         function totalMinted() external returns (uint256);
     }
 
-Example implementation  
+#### Example implementation
+
 <https://git.grassecon.net/cicnet/erc20-demurrage-token.git>
 
 ### Chrono
@@ -166,17 +198,20 @@ Define a creation time for a resource.
 
 Complements `ERC5007`.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 4db1ccd4
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IChrono {
         // Returns the timestamp of when a resource corresponding to _idx was first created.
         // int64 chosen as return value for simpler interoperability with ERC5007.
         function createTime(uint256 _idx) external returns(int64);
     }
 
-Example implementation  
+#### Example implementation
+
 <https://git.defalsify.org/eth-erc721> (BadgeToken contract)
 
 ### Declarator
@@ -196,10 +231,12 @@ Any number of claims can be made about an address under any number of
 topics. All claims must be stored, and returned in the order which they
 were added.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 21b7493b
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IDeclarator {
         event DeclarationAdded(address indexed _declarator, address indexed _subject, bytes32 indexed _topic, bytes32 _proof);
         
@@ -228,7 +265,8 @@ Solidity interface definition
         function declaratorCount(address _subject) external view returns ( uint256 );
     }
 
-Reference implementation  
+#### Reference implementation
+
 <git://holbrook.no/eth-address-index.git>
 
 ### Digest
@@ -241,10 +279,12 @@ Primary use-case is the abstraction of self-describing
 A default encoding *must* always be defined, and the encoding of a valid
 digest *must* succeed with the default encoding.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 982ab05d
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IDigest {
         // Returns the default digest encoding used by the contract instance.
         function defaultDigestEncoding() external view returns (uint256 _encoding);
@@ -263,21 +303,24 @@ Solidity interface definition
         function encodeDigest(bytes memory _data) external view returns (bytes memory);
     }
 
-Example implementation  
+#### Example implementation
+
 <git://holbrook.no/eth-event-msg.git>
 
 ### Expire
 
-Defines an expiry time after which token balances or supply *cannot
+Defines an expiry time after which token balances and supply *cannot
 change*.
 
 A contract defining an expiry *must not* allow changing the expiration
 time to a time in the past.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 841a0e94
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IExpire {
         // Contract has expired.
         event Expired(uint256 _timestamp);
@@ -296,7 +339,8 @@ Solidity interface definition
         function applyExpiry() external returns(uint8);
     }
 
-Example implementation  
+#### Example implementation
+
 <https://git.grassecon.net/cicnet/erc20-demurrage-token.git>
 
 ### Faucet
@@ -331,10 +375,12 @@ amount to dispense.
 The *check(address)* contract call *must* evaluate all four criteria,
 and *must* return `false` if any of the criteria are not met.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 1a3ac634
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IFaucet {
         // Tokens were given to an address
         event Give(address indexed _recipient, address indexed _token, uint256 _value);
@@ -369,7 +415,8 @@ Solidity interface definition
         function nextBalance(address _recipient) external returns (uint256);
     }
 
-Reference implementations  
+#### Reference implementations
+
 - <git://holbrook.no/erc20-faucet.git>
 
 - <git://holbrook.no/eth-faucet.git>
@@ -388,10 +435,12 @@ the content address.
 Furthermore, it *should* be possible to refer to a resource by a
 fully-qualified location on the web or an overlay network (e.g. tor).
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 ed75b333
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface ILocator {
         // URI that may or may not point to a specific resource location.
         function toURI(bytes memory _data) external view returns (string memory);
@@ -400,10 +449,11 @@ Solidity interface definition
         function toURL(bytes memory _data) external view returns(string memory);
     }
 
-Example implementation  
+#### Example implementation
+
 <git://holbrook.no/eth-event-msg.git>
 
-#### Expressing locators in terms of numetic token id
+#### Expressing locators in terms of numeric token id
 
 Given the numeric token id `1234567890987654321` (`0x112210f4b16c1cb1`
 hex), and a base url `https://contentgateway.grassecon.net`, the result
@@ -462,14 +512,19 @@ Attached to `ERC20` and `ERC721` tokens that may be minted.
 Implements the `mint(...)` and `safeMint(...)` parts of `ERC5679` for
 interoperability.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 5878bcf4
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IMinter {
         // Tokens are successfully minted; by who, to whom and how much
         event Mint(address indexed _minter, address indexed _beneficiary, uint256 value);
 
+        // The given token has been successfully minted; by who, to whom and how much
+        event Mint(address indexed _minter, address indexed _beneficiary, address indexed _token, uint256 value);
+
         // Mint the specified value of tokens to the specified recipient
         function mintTo(address _beneficiary, uint256 value) external returns (bool);
 
@@ -480,7 +535,8 @@ Solidity interface definition
         function safeMint(address _beneficiary, uint256 value, bytes calldata _data) external;
     }
 
-Example implementation  
+#### Example implementation
+
 <https://git.grassecon.net/cicnet/erc20-demurrage-token.git>
 
 ### Msg
@@ -493,10 +549,12 @@ The reference may or may not be mutable.
 The interface complements `Locator` and `MultiHash` to generate locators
 for how to resolve the reference.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 a3002595
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IMsg {
         // Emitted when a new message digest has been set
         // Should not be emitted if the digest set is identical to the previous
@@ -506,7 +564,8 @@ Solidity interface definition
         function getMsg() external view returns(bytes memory);
     }
 
-Example implementation  
+#### Example implementation
+
 <git://holbrook.no/eth-event-msg.git>
 
 ### Registry
@@ -520,10 +579,12 @@ It currently has two distinct uses in the CIC context:
 
 2.  Unique (ERC20) token symbol resolver.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 effbf671
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IRegistryClient {
         // Address added to store with the given key
         event AddressKey(bytes32 indexed _key, address _address);
@@ -538,10 +599,12 @@ Solidity interface definition
         function identifierCount() external view returns (uint256);
     }
 
-Contract registry implementation  
+#### Contract registry implementation
+
 <git://holbrook.no/eth-contract-registry.git>
 
-Token index implementation  
+#### Token index implementation
+
 <git://holbrook.no/eth-contract-registry.git>
 
 ### Seal
@@ -570,10 +633,12 @@ Use cases of sealing include:
 
 - The expiry time of a token (see `Expire`)
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 0d7491f8
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface ISeal {
         // Seal state has changed.
         event SealStateChange(bool indexed _final, uint256 _sealState);
@@ -585,40 +650,202 @@ Solidity interface definition
         function maxSealState() external view returns(uint256);
     }
 
-Example implementation  
+#### Example implementation
+
 <https://git.grassecon.net/cicnet/erc20-demurrage-token.git>
 
-### TokenVend
+### Throttle
 
-This interface defines the mechanism for which a specific ERC20 token
-may be exchanged for a different ERC20 token.
+An backend contract to limit access to a resource by time.
 
-A typical use-case is generation of voting tokens based on a momentary
-voucher balance. This is especially useful if the original ERC20 token
-is subject to decay (demurrage).
+The smart contract managing the resource calls ‘have(address)‘ on this
+contract to check if it can be made use of at the current point in time.
+This also implements [ACL](#acl).
 
-The tokens used for exchange **SHOULD** be locked for the full duration
-of holding the vended tokens.
+When the resource is made use of, it calls ‘poke(address)‘ method to
+register when it has been made use of.
 
-The withdrawal function may or may not allow partial withdrawals.
+#### ERC165 Interface identifier
 
-ERC165 Interface identifier  
-8a13249c
+8f5bc7bf
 
-Solidity interface definition  
-    interface ITokenVend {
-        // A new vended token has been created.
-        event TokenCreated(uint256 indexed _tokenIdx, uint256 indexed _supply, address _token);
+#### Solidity interface definition
 
-        // Create corresponding vended tokens for the control token balance of the caller.  
-        function getFor(address _token) external returns (uint256);
+    interface IThrottle {
+        // Returns true if the given address is authorized to make use of the resource at the current moment.
+        // Implements ACL
+        function have(address _address) external view returns(bool);
 
-        // Recover control tokens that were used to retrieve the corresponding vended tokens.
-        function withdrawFor(address _token) external returns (uint256);
+        // Must be called when the resource is being used.
+        function poke(address _address) external returns(bool);
     }
 
-Reference implementations  
-- <git://holbrook.no/erc20-vend.git>
+#### Reference implementation
+
+<git://holbrook.no/eth-faucet.git> (PeriodSimple contract)
+
+### TokenLimit
+
+Define limits of value amounts of tokens that individual addresses can
+hold.
+
+Limits are inclusive; a limit for 42 means transfer resulting in a token
+balance *higher* than 42 should be rejected.
+
+A return value of 0 indicates that the token is categorically not
+accepted by the holder.
+
+#### ERC165 Interface identifier
+
+23778613
+
+#### Solidity interface definition
+
+    interface ITokenLimit {
+        // Returns limit of total value a holder will accept of a specific token.
+        // The value limit returned is inclusive; A limit of 42 means any operation resulting in a balance OVER 42 should be rejected.
+        // A value of 0 means that no value of the token is accepted.
+        function limitOf(address _token, address _holder) external view returns(uint256);
+    }
+
+#### Reference implementations
+
+- <git://holbrook.no/erc20-limiter.git>
+
+### TokenQuote
+
+Quote an output token value for a given value of input tokens.
+
+Both input and output value is denominated in the smallest available
+unit of respective tokens.
+
+#### ERC165 Interface identifier
+
+dbb21d40
+
+#### Solidity interface definition
+
+    interface ITokenQuote {
+        // Returns, within a current context, what value of outTokens the given value of inTokens translates to.
+        // The values are given in smallest unit of each respective token.
+        function valueFor(address _outToken, address _inToken, uint256 value) external view returns (uint256);
+    }
+
+#### Example implementation
+
+- <git://holbrook.no/erc20-limiter.git>
+
+### TokenRateChange
+
+Enables detection of properties for CIC tokens that change value over
+time, e.g. through demurrage.
+
+It allows defining the granularity of the rate of change, aswell as a
+frequency for which the rate of change is applied.
+
+A method for canonical value change calculations is also provided.
+
+#### ERC165 Interface identifier
+
+b716af03
+
+#### Solidity interface definition
+
+    interface ITokenChangeRate {
+        // Time unit resolution for rate of change.
+        // A value of 0 indicates no rate of change,
+        function changeTimeUnit() external view returns(uint256);
+
+        // Rate of change per changeTimeUnit(), signed integer.
+        // An effective value of 0 indicates no rate of change.
+        function changeRate() external view returns (int256);
+
+        // Number of decimals with which the changeRate is defined.
+            // changeRate() should be divided by 10 ** changeRateDecimals() to obtain effective value
+        function changeRateDecimals() external view returns(uint8);
+
+        // Timestamp from when rate of change should be applied.
+        // A value of 0 indicates no rate of change,
+        function changeStartTime() external view returns(uint256);
+
+        // Calculate value with change rate applied for given amount of time units.
+        // Will calculate compounded change over the given amount of time units
+        function applyChange(int256 _value, uint256 _changeTimeUnits) external view returns(int256);
+    }
+
+#### Reference implementations
+
+- <git://holbrook.no/erc20-demurrage-token.git>
+
+### TokenSwap
+
+Token swap interface that can fit token escrow purposes aswell as token
+swap contracts.
+
+Optionally may define a `defaultToken`, that may among other things be
+used for `withdraw()` calls without an `inToken`.
+
+An explicit *ERC20 approval* of the balance to be transacted will
+usually be required for the implementing contract.
+
+If the value 0 is passed as argument to `deposit` or `withdraw`,
+implementers can choose one of two possible outcomes:
+
+- Noop. 0 *must* be returned.
+
+- Use *balance* or the max available *allowance*. The actual (spent)
+  value *must* be returned.
+
+#### ERC165 Interface identifier
+
+4146b765
+
+#### Solidity interface definition
+
+    interface ITokenSwap {
+        // Emitted when a new deposit has been made.
+        event Deposit(address indexed _token, uint256 _value);
+
+        // Default token used to access the token swap.
+        // Returns zero-address if no default token is defined.
+        function defaultToken() external returns (address);
+
+        // Add inToken liquidity to the tune of given value. 
+        // Requires token approval for the corresponding value.
+        // If value is 0, up to the full approval MAY be used for the transfer.
+        function deposit(address _inToken, uint256 _value) external returns (uint256);
+
+        // Withdraw pending outToken balance of given value in the pool for the sender.
+        // May require token approval for defaultToken if used by contract as exchange for the withdrawal.
+        // If value is 0, up to the full approval value MAY be used for the transfer.
+        function withdraw(address _outToken, uint256 _value) external returns (uint256);
+
+        // Exchange inToken equalling given value for outToken.
+        // Requires token approval for the value of inToken.
+        // If value is 0, up to the full approval value MAY be used for the transfer.
+        function withdraw(address _outToken, address _inToken, uint256 _value) external returns (uint256);
+    }
+
+#### Reference implementations
+
+- <git://holbrook.no/erc20-pool.git>
+
+#### Handling deposits
+
+The implementation is free to decide whether deposits can be recovered
+directly, or if they will be locked in the smart contract - temporarily
+or permanently.
+
+For the duration deposits are locked, they are part of the smart
+contract’s swap liquidity. During this time, locked deposits may only be
+withdrawn in exchange for other tokens accepted by the contract.
+
+Deposits that are not locked should be withdrawable using the
+`withdraw(address,uint256)` (`0xf3fef3a3`) method signature.
+
+Of course, as with most swap contracts, the tokens available for
+withdrawal by the holder may not necessarily match the tokens that were
+deposited by the holder.
 
 ### TokenVote
 
@@ -632,10 +859,12 @@ Voted tokens **SHOULD** be locked until the voting has finalized.
 
 Finalization of voting should be callable by anyone.
 
-ERC165 Interface identifier  
-28091366
+#### ERC165 Interface identifier
+
+f2e0bfeb
+
+#### Solidity interface definition
 
-Solidity interface definition  
     interface ITokenVote {
 
         // A new proposal has been created.
@@ -655,8 +884,8 @@ Solidity interface definition
         // * _blockWait blocks from now.
         function propose(bytes32 _description, uint256 _blockWait, uint24 _targetVotePpm) external returns (uint256);
 
-        // Same as propose(...), but provide options to vote on.
-        function proposeMulti(bytes32 _description, bytes32[] memory _options, uint256 _blockWait, uint24 _targetVotePpm) external returns (uint256);
+        // Add a voting option to a proposal
+        function addOption(uint256 _proposalIdx, bytes32 _description) external;
 
         // Get number of options available for the proposal.
         // This decides the boundary of the index that can be used with voteOptions(...)
@@ -691,7 +920,8 @@ Solidity interface definition
         function finalize() external returns (bool);
     }
 
-Reference implementations  
+#### Reference implementations
+
 - <git://holbrook.no/evm-tokenvote.git>
 
 ### Writer
@@ -716,10 +946,12 @@ Some use-case examples of super-user actions include:
 
 - Edit access control lists.
 
-ERC165 Interface identifier  
+#### ERC165 Interface identifier
+
 abe1f1f5
 
-Solidity interface definition  
+#### Solidity interface definition
+
     interface IWriter {
         // A writer has been added by _executor
         event WriterAdded(address _writer);
@@ -737,5 +969,6 @@ Solidity interface definition
         function isWriter(address _writer) external view returns (bool);
     }
 
-Example implementation  
+#### Example implementation
+
 <https://git.grassecon.net/cicnet/erc20-demurrage-token.git>

doc/texinfo/accountsindex.sol.texi

@@ -9,14 +9,17 @@ The @code{entry} method is used to iterate the account list. The order of which
 May optionally record time when account was added.
 
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/AccountsIndex.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_AccountsIndex.texi
-@item Reference implementation
+
+@subsubsection Reference implementation
+
 @uref{git://holbrook.no/eth-accounts-index.git,} (v0.5.1)
-@end table
 
 
 @subsection Accounts Index Mutable
@@ -26,11 +29,14 @@ Extends the functionality of @code{Accounts Index} to allow changes to the addre
 Addresses may be @emph{added}, @emph{removed}, aswell as @emph{deactivated} and @emph{activated}. Deactivated accounts still count towards the @code{entryCount}.
 
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/AccountsIndexMutable.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_AccountsIndexMutable.texi
-@item Reference implementation
+
+@subsubsection Reference implementation
+
 @uref{git://holbrook.no/eth-accounts-index.git,} (v0.5.1)
-@end table

doc/texinfo/acl.sol.texi

@@ -0,0 +1,18 @@
+@anchor{acl}
+@subsection ACL
+
+A simple Access Control List definition that returns true of false depending on whether an signatory (address) is allowed to operate in a given context.
+
+@subsubsection ERC165 Interface identifier
+
+@include ../../build/ACL.interface
+
+@subsubsection Solidity interface definition
+
+@include ../../build/contract_ACL.texi
+
+@subsubsection Example implementation
+
+@uref{git://holbrook.no/eth-accounts-index.git,}
+
+

doc/texinfo/burner.sol.texi

@@ -4,11 +4,14 @@ Attached to @code{ERC20} and @code{ERC721} tokens that may be @emph{burned}.
 
 Implements the @code{burn(...)} part of @code{ERC5679} for interoperability.
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Burner.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Burner.texi
-@item Example implementation
+
+@subsubsection Example implementation
+
 @uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
-@end table

doc/texinfo/chrono.sol.texi

@@ -5,11 +5,14 @@ Define a creation time for a resource.
 Complements @code{ERC5007}.
 
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Chrono.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Chrono.texi
-@item Example implementation
+
+@subsubsection Example implementation
+
 @uref{https://git.defalsify.org/eth-erc721} (BadgeToken contract)
-@end table

doc/texinfo/declarator.sol.texi

@@ -10,11 +10,14 @@ Claims may be made with or without topics. A missing topic is synonymous with a
 
 Any number of claims can be made about an address under any number of topics. All claims must be stored, and returned in the order which they were added.
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Declarator.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Declarator.texi
-@item Reference implementation
+
+@subsubsection Reference implementation
+
 @uref{git://holbrook.no/eth-address-index.git,}
-@end table

doc/texinfo/digest.sol.texi

@@ -7,11 +7,14 @@ Primary use-case is the abstraction of self-describing @uref{https://multiformat
 A default encoding @emph{must} always be defined, and the encoding of a valid digest @emph{must} succeed with the default encoding.
 
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Digest.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Digest.texi
-@item Example implementation
+
+@subsubsection Example implementation
+
 @uref{git://holbrook.no/eth-event-msg.git}
-@end table

doc/texinfo/expire.sol.texi

@@ -1,15 +1,18 @@
 @subsection Expire
 
-Defines an expiry time after which token balances or supply @emph{cannot change}.
+Defines an expiry time after which token balances and supply @emph{cannot change}.
 
 A contract defining an expiry @emph{must not} allow changing the expiration time to a time in the past.
 
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Expire.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Expire.texi
-@item Example implementation
+
+@subsubsection Example implementation
+
 @uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
-@end table

doc/texinfo/faucet.sol.texi

@@ -24,16 +24,19 @@ The contract has sufficient token funds to dispense the current defined amount t
 The @emph{check(address)} contract call @emph{must} evaluate all four criteria, and @emph{must} return @code{false} if any of the criteria are not met.
 
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Faucet.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Faucet.texi
-@item Reference implementations
+
+@subsubsection Reference implementations
+
 @itemize
 @item
 @uref{git://holbrook.no/erc20-faucet.git,}
 @item
 @uref{git://holbrook.no/eth-faucet.git,}
 @end itemize
-@end table

doc/texinfo/locator.sol.texi

@@ -8,17 +8,20 @@ It @emph{must} be possible to refer to all off-chain resources directly by the c
 
 Furthermore, it @emph{should} be possible to refer to a resource by a fully-qualified location on the web or an overlay network (e.g. tor).
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Locator.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Locator.texi
-@item Example implementation
+
+@subsubsection Example implementation
+
 @uref{git://holbrook.no/eth-event-msg.git}
-@end table
 
 
-@subsubsection Expressing locators in terms of numetic token id
+@subsubsection Expressing locators in terms of numeric token id
 
 Given the numeric token id @code{1234567890987654321} (@code{0x112210f4b16c1cb1} hex), and a base url @code{https://contentgateway.grassecon.net}, the result of the methods may be as follows:
 

doc/texinfo/minter.sol.texi

@@ -4,11 +4,14 @@ Attached to @code{ERC20} and @code{ERC721} tokens that may be minted.
 
 Implements the @code{mint(...)} and @code{safeMint(...)} parts of @code{ERC5679} for interoperability.
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Minter.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Minter.texi
-@item Example implementation
+
+@subsubsection Example implementation
+
 @uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
-@end table

doc/texinfo/msg.sol.texi

@@ -7,11 +7,14 @@ The reference may or may not be mutable.
 The interface complements @code{Locator} and @code{MultiHash} to generate locators for how to resolve the reference.
 
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Msg.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Msg.texi
-@item Example implementation
+
+@subsubsection Example implementation
+
 @uref{git://holbrook.no/eth-event-msg.git}
-@end table

doc/texinfo/overview.texi

@@ -50,6 +50,8 @@ The following well-known solidity interfaces are partially implemented in CIC na
 
 @section Native interfaces
 
+@include acl.sol.texi
+
 @include accountsindex.sol.texi
 
 @include burner.sol.texi
@@ -74,7 +76,15 @@ The following well-known solidity interfaces are partially implemented in CIC na
 
 @include seal.sol.texi
 
-@include tokenvend.sol.texi
+@include throttle.sol.texi
+
+@include tokenlimit.sol.texi
+
+@include tokenquote.sol.texi
+
+@include tokenratechange.sol.texi
+
+@include tokenswap.sol.texi
 
 @include tokenvote.sol.texi
 

doc/texinfo/registry.sol.texi

@@ -11,13 +11,18 @@ Entry-point to discover all relevant contracts of CIC networks.
 Unique (ERC20) token symbol resolver.
 @end enumerate
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/RegistryClient.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_RegistryClient.texi
-@item Contract registry implementation
+
+@subsubsection Contract registry implementation
+
 @uref{git://holbrook.no/eth-contract-registry.git,}
-@item Token index implementation
+
+@subsubsection Token index implementation
+
 @uref{git://holbrook.no/eth-contract-registry.git,}
-@end table

doc/texinfo/seal.sol.texi

@@ -21,11 +21,14 @@ Allow ownership of a contract to be transferred
 The expiry time of a token (see @code{Expire})
 @end itemize
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Seal.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Seal.texi
-@item Example implementation
+
+@subsubsection Example implementation
+
 @uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
-@end table

doc/texinfo/throttle.sol.texi

@@ -0,0 +1,20 @@
+@subsection Throttle
+
+An backend contract to limit access to a resource by time.
+
+The smart contract managing the resource calls `have(address)` on this contract to check if it can be made use of at the current point in time. This also implements @ref{acl, ACL}.
+
+When the resource is made use of, it calls `poke(address)` method to register when it has been made use of.
+
+
+@subsubsection ERC165 Interface identifier
+
+@include ../../build/Throttle.interface
+
+@subsubsection Solidity interface definition
+
+@include ../../build/contract_Throttle.texi
+
+@subsubsection Reference implementation
+
+@uref{git://holbrook.no/eth-faucet.git,} (PeriodSimple contract)

doc/texinfo/tokenlimit.sol.texi

@@ -0,0 +1,22 @@
+@subsection TokenLimit
+
+Define limits of value amounts of tokens that individual addresses can hold.
+
+Limits are inclusive; a limit for 42 means transfer resulting in a token balance @emph{higher} than 42 should be rejected.
+
+A return value of 0 indicates that the token is categorically not accepted by the holder.
+
+@subsubsection ERC165 Interface identifier
+
+@include ../../build/TokenLimit.interface
+
+@subsubsection Solidity interface definition
+
+@include ../../build/contract_TokenLimit.texi
+
+@subsubsection Reference implementations
+
+@itemize
+@item
+@uref{git://holbrook.no/erc20-limiter.git,}
+@end itemize

doc/texinfo/tokenquote.sol.texi

@@ -0,0 +1,20 @@
+@subsection TokenQuote
+
+Quote an output token value for a given value of input tokens.
+
+Both input and output value is denominated in the smallest available unit of respective tokens.
+
+@subsubsection ERC165 Interface identifier
+
+@include ../../build/TokenQuote.interface
+
+@subsubsection Solidity interface definition
+
+@include ../../build/contract_TokenQuote.texi
+
+@subsubsection Example implementation
+
+@itemize
+@item
+@uref{git://holbrook.no/erc20-limiter.git,}
+@end itemize

doc/texinfo/tokenratechange.sol.texi

@@ -0,0 +1,22 @@
+@subsection TokenRateChange
+
+Enables detection of properties for CIC tokens that change value over time, e.g. through demurrage.
+
+It allows defining the granularity of the rate of change, aswell as a frequency for which the rate of change is applied.
+
+A method for canonical value change calculations is also provided.
+
+@subsubsection ERC165 Interface identifier
+
+@include ../../build/TokenRateChange.interface
+
+@subsubsection Solidity interface definition
+
+@include ../../build/contract_TokenRateChange.texi
+
+@subsubsection Reference implementations
+
+@itemize
+@item
+@uref{git://holbrook.no/erc20-demurrage-token.git,}
+@end itemize

doc/texinfo/tokenswap.sol.texi

@@ -0,0 +1,40 @@
+@subsection TokenSwap
+
+Token swap interface that can fit token escrow purposes aswell as token swap contracts.
+
+Optionally may define a @code{defaultToken}, that may among other things be used for @code{withdraw()} calls without an @code{inToken}.
+
+An explicit @emph{ERC20 approval} of the balance to be transacted will usually be required for the implementing contract.
+
+If the value 0 is passed as argument to @code{deposit} or @code{withdraw}, implementers can choose one of two possible outcomes:
+
+@itemize
+@item Noop. 0 @emph{must} be returned.
+@item Use @emph{balance} or the max available @emph{allowance}. The actual (spent) value @emph{must} be returned.
+@end itemize
+
+@subsubsection ERC165 Interface identifier
+
+@include ../../build/TokenSwap.interface
+
+@subsubsection Solidity interface definition
+
+@include ../../build/contract_TokenSwap.texi
+
+@subsubsection Reference implementations
+
+@itemize
+@item
+@uref{git://holbrook.no/erc20-pool.git,}
+@end itemize
+
+
+@subsubsection Handling deposits
+
+The implementation is free to decide whether deposits can be recovered directly, or if they will be locked in the smart contract - temporarily or permanently.
+
+For the duration deposits are locked, they are part of the smart contract's swap liquidity. During this time, locked deposits may only be withdrawn in exchange for other tokens accepted by the contract.
+
+Deposits that are not locked should be withdrawable using the @code{withdraw(address,uint256)} (@code{0xf3fef3a3}) method signature.
+
+Of course, as with most swap contracts, the tokens available for withdrawal by the holder may not necessarily match the tokens that were deposited by the holder.

doc/texinfo/tokenvote.sol.texi

@@ -10,14 +10,16 @@ Voted tokens @strong{SHOULD} be locked until the voting has finalized.
 Finalization of voting should be callable by anyone.
 
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/TokenVote.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_TokenVote.texi
-@item Reference implementations
+
+@subsubsection Reference implementations
 @itemize
 @item
 @uref{git://holbrook.no/evm-tokenvote.git,}
 @end itemize
-@end table

doc/texinfo/writer.sol.texi

@@ -19,11 +19,14 @@ Change the amount dispensed by the faucet.
 Edit access control lists.
 @end itemize
 
-@table @dfn
-@item ERC165 Interface identifier
+@subsubsection ERC165 Interface identifier
+
 @include ../../build/Writer.interface
-@item Solidity interface definition
+
+@subsubsection Solidity interface definition
+
 @include ../../build/contract_Writer.texi
-@item Example implementation
+
+@subsubsection Example implementation
+
 @uref{https://git.grassecon.net/cicnet/erc20-demurrage-token.git}
-@end table

python/MANIFEST.in

@@ -1 +1 @@
-include *requirements.txt solidity/* LICENSE README* 
+include *requirements.txt solidity/* LICENSE README* cic_contracts/unittest/solidity/* cic_contracts/data/*

python/Makefile

@@ -1,7 +1,7 @@
-INPUTS = $(wildcard solidity/*.sol)
+INPUTS = $(wildcard cic_contracts/unittest/solidity/*.sol)
 OUTPUTS = $(patsubst %.sol, %.bin, $(INPUTS))
 
-all: outs readme package
+all: outs package
 
 .SUFFIXES: .sol .bin
 

python/README.md

@@ -0,0 +1,974 @@
+# Smart contract interfaces
+
+## Technology
+
+CIC smart contracts are implemented using the *solidity* programming
+language for the (Ethereum Virtual Machine (EVM).
+
+## Adopted standards
+
+### Signing
+
+### ERC - Direct use
+
+The following well-known solidity interfaces are used directly.
+
+- [ERC20 - Token Standard](https://eips.ethereum.org/EIPS/eip-20)
+
+- [ERC165 - Standard Interface
+  Detection](https://eips.ethereum.org/EIPS/eip-165)
+
+- [ERC173 - Contract Ownership
+  Standard](https://eips.ethereum.org/EIPS/eip-173)
+
+- [ERC191 - Signed Data
+  Standard](https://eips.ethereum.org/EIPS/eip-191)
+
+- [ERC712 - Typed structured data hashing and
+  signing](https://eips.ethereum.org/EIPS/eip-712)
+
+- [ERC721 - Non-Fungible Token
+  Standard](https://eips.ethereum.org/EIPS/eip-721)
+
+- [ERC5007 - Time NFT (EIP-721 Time
+  Extension)](https://eips.ethereum.org/EIPS/eip-5007)
+
+- [ERC5192 - Minimal Soulbound
+  NFTs](https://eips.ethereum.org/EIPS/eip-5192)
+
+### ERCs Partial use
+
+The following well-known solidity interfaces are partially implemented
+in CIC native interfaces.
+
+- [ERC5679 - Token Minting and
+  Burning](https://eips.ethereum.org/EIPS/eip-5679) (See `Minter`,
+  `Burner`)
+
+## Native interfaces
+
+### ACL
+
+A simple Access Control List definition that returns true of false
+depending on whether an signatory (address) is allowed to operate in a
+given context.
+
+#### ERC165 Interface identifier
+
+3ef25013
+
+#### Solidity interface definition
+
+    interface IACL {
+        // Returns true if the address has permission to operate in the given context.
+        function have(address _address) external view returns(bool);
+    }
+
+#### Example implementation
+
+<git://holbrook.no/eth-accounts-index.git>
+
+### Accounts Index
+
+Append-only list of addresses. Typically used for access control lists.
+
+Addresses may be *added*, *removed*, aswell as *deactivated* and
+*activated*. Deactivated accounts still count towards the `entryCount`.
+
+The `entry` method is used to iterate the account list. The order of
+which accounts are returned is not guaranteed. Any returned value
+matching `address(0x00)` should be skipped, and not counted towards
+`entryCount`.
+
+May optionally record time when account was added.
+
+#### ERC165 Interface identifier
+
+b7bca625
+
+#### Solidity interface definition
+
+    interface IAccountsIndex {
+        // Address added to store, index in array.
+        event AddressAdded(uint256 indexed _idx, address _account);
+
+        // Return number of entries in index.
+        function entryCount() external view returns (uint256);
+
+        // Return entry at the spceificed index.
+        // Will revert if index is beyond array length.
+        // An entry result of 0 means the entry should be skipped, and not count towards entry count.
+        function entry(uint256) external view returns (address);
+
+        // Add an entry to the index. Incresases the entry count.
+        function add(address) external returns (bool);
+
+        // Verify that the entry exists in the index.
+        // Implements ACL
+        function have(address) external view returns (bool);
+
+        // Retrieve the timestamp when account was added.
+        // If time is not being tracked, a value of 0 should be returned.
+        function time(address) external view returns (uint256);
+    }
+
+#### Reference implementation
+
+<git://holbrook.no/eth-accounts-index.git> (v0.5.1)
+
+### Accounts Index Mutable
+
+Extends the functionality of `Accounts Index` to allow changes to the
+address list.
+
+Addresses may be *added*, *removed*, aswell as *deactivated* and
+*activated*. Deactivated accounts still count towards the `entryCount`.
+
+#### ERC165 Interface identifier
+
+9479f0ae
+
+#### Solidity interface definition
+
+    interface IAccountsIndexMutable {
+        // Active status of address changed, and by whom changed.
+        event AddressActive(address indexed _account, bool _active);
+
+        // Address removed from store, and by whom removed.
+        event AddressRemoved(address _account);
+
+        // Remove an entry from the index. Reduces the entry count.
+        function remove(address) external returns (bool);
+
+        // Deactivate account but keep in index. Does not affect entry count.
+        function deactivate(address) external returns (bool);
+
+        // Activate previously deactivated account. Does not affect entry count.
+        function activate(address) external returns (bool);
+
+        // Check if account exists and is active;
+        function isActive(address) external view returns (bool);
+    }
+
+#### Reference implementation
+
+<git://holbrook.no/eth-accounts-index.git> (v0.5.1)
+
+### Burner
+
+Attached to `ERC20` and `ERC721` tokens that may be *burned*.
+
+Implements the `burn(...)` part of `ERC5679` for interoperability.
+
+#### ERC165 Interface identifier
+
+b1110c1b
+
+#### Solidity interface definition
+
+    interface IBurner {
+        // Token(s) successfully burned; by who and how much.
+        event Burn(address indexed _burner, uint256 _burned);
+
+        // Satisfies ERC 5679
+        function burn(address _from, uint256 _amount, bytes calldata _data) external;
+
+        // Burn given amount of tokens held by signer.
+        function burn(uint256 _amount) external returns (bool);
+
+        // Burn all tokens held by signer.
+        // Returns the amount of tokens burned.
+        function burn() external returns (uint256);
+
+        // Total amount of tokens that have been burned.
+        function totalBurned() external returns (uint256);
+
+        // Total amount of tokens ever minted.
+        // If totalSupply() is available (ERC20, ERC721 Enumerable), this equals totalSupply() + totalBurned().
+        function totalMinted() external returns (uint256);
+    }
+
+#### Example implementation
+
+<https://git.grassecon.net/cicnet/erc20-demurrage-token.git>
+
+### Chrono
+
+Define a creation time for a resource.
+
+Complements `ERC5007`.
+
+#### ERC165 Interface identifier
+
+4db1ccd4
+
+#### Solidity interface definition
+
+    interface IChrono {
+        // Returns the timestamp of when a resource corresponding to _idx was first created.
+        // int64 chosen as return value for simpler interoperability with ERC5007.
+        function createTime(uint256 _idx) external returns(int64);
+    }
+
+#### Example implementation
+
+<https://git.defalsify.org/eth-erc721> (BadgeToken contract)
+
+### Declarator
+
+Permissionless store of signed claims made by an address about other
+addresses, or addresses about themselves.
+
+It is used to declare or respond to certifications of vouchers, NFT,
+voucher members.
+
+Addresses may be Externally Owned Accounts or smart contracts.
+
+Claims may be made with or without topics. A missing topic is synonymous
+with a topic value of `bytes32(0x00)`.
+
+Any number of claims can be made about an address under any number of
+topics. All claims must be stored, and returned in the order which they
+were added.
+
+#### ERC165 Interface identifier
+
+21b7493b
+
+#### Solidity interface definition
+
+    interface IDeclarator {
+        event DeclarationAdded(address indexed _declarator, address indexed _subject, bytes32 indexed _topic, bytes32 _proof);
+        
+        // Get all declarations for a subject (without topic) signed by a declarator
+        function declaration(address _declarator, address _subject) external view returns ( bytes32[] memory );
+
+        // Get all declarations for a subject for the given topic signed by a declarator
+        function declaration(address _declarator, address _subject, bytes32 _topic) external view returns ( bytes32[] memory );
+
+        // Get number of declarations the declarator has ever signed
+        function declarationCount(address _declarator) external view returns ( uint256 );
+
+        // Get the subject of a declarator's declarations at the specific index
+        function declarationAddressAt(address _declarator, uint256 _idx) external view returns ( address );
+
+        // Add a declaration for the subject
+        function addDeclaration(address _subject, bytes32 _proof) external returns ( bool );
+
+        // Add a declaration with topic for the subject
+        function addDeclaration(address _subject, bytes32 _proof, bytes32 _topic) external returns ( bool );
+
+        // Get the declarator that signed a declaration at the specificed index for a subject
+        function declaratorAddressAt(address _subject, uint256 _idx) external view returns ( address );
+
+        // Get the number of declarators that have signed for a subject
+        function declaratorCount(address _subject) external view returns ( uint256 );
+    }
+
+#### Reference implementation
+
+<git://holbrook.no/eth-address-index.git>
+
+### Digest
+
+Allows encoding of digests according to a specific encoding scheme.
+
+Primary use-case is the abstraction of self-describing
+[Multhash](https://multiformats.io/multihash/) encoding.
+
+A default encoding *must* always be defined, and the encoding of a valid
+digest *must* succeed with the default encoding.
+
+#### ERC165 Interface identifier
+
+982ab05d
+
+#### Solidity interface definition
+
+    interface IDigest {
+        // Returns the default digest encoding used by the contract instance.
+        function defaultDigestEncoding() external view returns (uint256 _encoding);
+
+        // Check if the given encoding has been implemented in the contract instance.
+        function haveDigestEncoding(uint256 _codec) external view returns(bool);
+
+        // Verify and encode the given digest for a specific hashing algorithm.
+        // Returns a zero-length byte array if digest is invalid.
+        // Must succeed if called with the defaultDigestEncoding and a valid digest.
+        function encodeDigest(bytes memory _data, uint256 _encoding) external view returns (bytes memory);
+
+        // Encodes the digest using the default digest encoding.
+        // Returns a zero-length byte array if digest is invalid.
+        // Must succeed with a valid digest.
+        function encodeDigest(bytes memory _data) external view returns (bytes memory);
+    }
+
+#### Example implementation
+
+<git://holbrook.no/eth-event-msg.git>
+
+### Expire
+
+Defines an expiry time after which token balances and supply *cannot
+change*.
+
+A contract defining an expiry *must not* allow changing the expiration
+time to a time in the past.
+
+#### ERC165 Interface identifier
+
+841a0e94
+
+#### Solidity interface definition
+
+    interface IExpire {
+        // Contract has expired.
+        event Expired(uint256 _timestamp);
+
+        // Expiry time has changed.
+        event ExpiryChange(uint256 indexed _oldTimestamp, uint256 _newTimestamp);
+
+        // The current expiration timestamp.
+        function expires() external returns (uint256);
+
+        // Check expiry and apply expiration if expired.
+        // Return values must be:
+        // 0: not yet expired.
+        // 1: already expired.
+        // >1: expiry executed.
+        function applyExpiry() external returns(uint8);
+    }
+
+#### Example implementation
+
+<https://git.grassecon.net/cicnet/erc20-demurrage-token.git>
+
+### Faucet
+
+Used for dispensing tokens to any address.
+
+It can be used for gas tokens and *ERC20* alike.
+
+The interface is the same whether the faucet is dispensing from existing
+balance or minting new tokens.
+
+The value dispersed *must* be the same for all addresses.
+
+In general, four criteria are expected to exist in any combination for
+limiting access to the faucet:
+
+Time  
+A recipient may only use the faucet again after some time has passed.
+
+Balance threshold  
+A recipient may only use the faucet after its balance is below a certain
+amount.
+
+Membership  
+A recipient may only use the faucet if it has been added to an access
+control list.
+
+Capacity  
+The contract has sufficient token funds to dispense the current defined
+amount to dispense.
+
+The *check(address)* contract call *must* evaluate all four criteria,
+and *must* return `false` if any of the criteria are not met.
+
+#### ERC165 Interface identifier
+
+1a3ac634
+
+#### Solidity interface definition
+
+    interface IFaucet {
+        // Tokens were given to an address
+        event Give(address indexed _recipient, address indexed _token, uint256 _value);
+
+        // The amount that the faucet disperses has changed
+        event FaucetAmountChange(uint256 _value);
+
+        // Address of token the faucet represents
+        // The faucet will return gas tokens with the zero-address is returned.
+        function token() external returns (address);
+
+        // Amount of tokens the faucet gives out
+        function tokenAmount() external returns (uint256);
+
+        // Give tokens to the given recipient. Returns amount of tokens given.
+        function giveTo(address _recipient) external returns (uint256);
+
+        // Give tokens to yourself. Returns amount of tokens given.
+        function gimme() external returns (uint256);
+
+        // Check if faucet may be used in the current contract state by _recipient
+        function check(address _recipient) external view returns (bool);
+
+        // Returns timestamp when faucet may be used again by _recipient
+        // If 0 is returned, the address has not yet been used.
+        // A return value of max(uint256) indicates that the faucet may not be used again.
+        function nextTime(address _recipient) external returns (uint256);
+
+        // Returns the token balance under which faucet may be used again by _recipient
+        // A return value of max(uint256) indicates that the faucet may be used regardless
+        //   of the token balance of _recipient
+        function nextBalance(address _recipient) external returns (uint256);
+    }
+
+#### Reference implementations
+
+- <git://holbrook.no/erc20-faucet.git>
+
+- <git://holbrook.no/eth-faucet.git>
+
+### Locator
+
+This interface supports `ERC721 Metadata`, in particular the
+`tokenURI(uint256)` call.
+
+Off-chain resources in the CIC network *must* be defined in terms of
+content addressed strings.
+
+It *must* be possible to refer to all off-chain resources directly by
+the content address.
+
+Furthermore, it *should* be possible to refer to a resource by a
+fully-qualified location on the web or an overlay network (e.g. tor).
+
+#### ERC165 Interface identifier
+
+ed75b333
+
+#### Solidity interface definition
+
+    interface ILocator {
+        // URI that may or may not point to a specific resource location.
+        function toURI(bytes memory _data) external view returns (string memory);
+
+        // URL pointing to a specific resource location.
+        function toURL(bytes memory _data) external view returns(string memory);
+    }
+
+#### Example implementation
+
+<git://holbrook.no/eth-event-msg.git>
+
+#### Expressing locators in terms of numeric token id
+
+Given the numeric token id `1234567890987654321` (`0x112210f4b16c1cb1`
+hex), and a base url `https://contentgateway.grassecon.net`, the result
+of the methods may be as follows:
+
+`toURI(toHex(1234567890987654321))`  
+-\>
+`https://contentgateway.grassecon.net/000000000000000000000000000000000000000000000000112210f4b16c1cb1`
+
+`toURL(toHex(1234567890987654321))`  
+-\>
+`https://contentgateway.grassecon.net/000000000000000000000000000000000000000000000000112210f4b16c1cb1`
+
+`tokenURI(1234567890987654321)`  
+-\>
+`https://contentgateway.grassecon.net/000000000000000000000000000000000000000000000000112210f4b16c1cb1`
+
+#### Expressing locators in terms of a digest
+
+Given the data `foo`, the digest algorithm `sha256` and a base url
+`https://contentgateway.grassecon.net`, the result of the methods may be
+as follows:
+
+`toURI(sha256(foo))`  
+-\>
+`"sha256:2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"`
+
+`toURL(sha256(foo))`  
+-\>
+`"https://contentgateway.grassecon.net/2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"`
+
+`tokenURI(toUint(sha256(foo)))`  
+-\>
+`"https://contentgateway.grassecon.net/2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"`
+
+#### Locator without URL
+
+Given the data `foo`, the digest algorithm `sha256` and no base url, the
+result of the methods may be as follows:
+
+`toURI(sha256(foo))`  
+-\>
+`"sha256:2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"`
+
+`toURL(sha256(foo))`  
+-\> `""`
+
+`tokenURI(toUint(sha256(foo)))`  
+-\>
+`"sha256:2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"`
+
+### Minter
+
+Attached to `ERC20` and `ERC721` tokens that may be minted.
+
+Implements the `mint(...)` and `safeMint(...)` parts of `ERC5679` for
+interoperability.
+
+#### ERC165 Interface identifier
+
+5878bcf4
+
+#### Solidity interface definition
+
+    interface IMinter {
+        // Tokens are successfully minted; by who, to whom and how much
+        event Mint(address indexed _minter, address indexed _beneficiary, uint256 value);
+
+        // The given token has been successfully minted; by who, to whom and how much
+        event Mint(address indexed _minter, address indexed _beneficiary, address indexed _token, uint256 value);
+
+        // Mint the specified value of tokens to the specified recipient
+        function mintTo(address _beneficiary, uint256 value) external returns (bool);
+
+        // Satisfies ERC5679 for ERC20
+        function mint(address _beneficiary, uint256 value, bytes calldata _data) external;
+
+        // Satisfies ERC5679 for ERC721
+        function safeMint(address _beneficiary, uint256 value, bytes calldata _data) external;
+    }
+
+#### Example implementation
+
+<https://git.grassecon.net/cicnet/erc20-demurrage-token.git>
+
+### Msg
+
+Enables a reference "message" to describe the contract using an
+off-chain resource.
+
+The reference may or may not be mutable.
+
+The interface complements `Locator` and `MultiHash` to generate locators
+for how to resolve the reference.
+
+#### ERC165 Interface identifier
+
+a3002595
+
+#### Solidity interface definition
+
+    interface IMsg {
+        // Emitted when a new message digest has been set
+        // Should not be emitted if the digest set is identical to the previous
+        event Msg(bytes _msgDigest);
+
+        // Get the current message content hash
+        function getMsg() external view returns(bytes memory);
+    }
+
+#### Example implementation
+
+<git://holbrook.no/eth-event-msg.git>
+
+### Registry
+
+The Registry interface is a key-value store resolving well-known
+contract identifier names to contract addresses.
+
+It currently has two distinct uses in the CIC context:
+
+1.  Entry-point to discover all relevant contracts of CIC networks.
+
+2.  Unique (ERC20) token symbol resolver.
+
+#### ERC165 Interface identifier
+
+effbf671
+
+#### Solidity interface definition
+
+    interface IRegistryClient {
+        // Address added to store with the given key
+        event AddressKey(bytes32 indexed _key, address _address);
+
+        // Return the address of the contract identified by the given byte string
+        function addressOf(bytes32) external view returns (address);
+
+        // Indexed accessor for the full list of registred identifiers
+        function identifier(uint256) external view returns (bytes32);
+
+        // Number of registered interfaces
+        function identifierCount() external view returns (uint256);
+    }
+
+#### Contract registry implementation
+
+<git://holbrook.no/eth-contract-registry.git>
+
+#### Token index implementation
+
+<git://holbrook.no/eth-contract-registry.git>
+
+### Seal
+
+Some smart contract parameters may need to be mutable over part of a
+smart contract’s lifetime.
+
+This interface provides a method to explicitly signal when certain
+parameters have been rendered immutable.
+
+The value of `sealState()` *must not* decrease, and must not exceed
+`maxSealState`.
+
+`maxSealState` is used to define that *all mutable parameters* have been
+rendered immutable. The practical implications of this will vary between
+contracts.
+
+The implementer is encouraged to use simple, descriptive names in the
+source code to describe the applicable seal states.
+
+Use cases of sealing include:
+
+- Whether more tokens can be minted
+
+- Allow ownership of a contract to be transferred
+
+- The expiry time of a token (see `Expire`)
+
+#### ERC165 Interface identifier
+
+0d7491f8
+
+#### Solidity interface definition
+
+    interface ISeal {
+        // Seal state has changed.
+        event SealStateChange(bool indexed _final, uint256 _sealState);
+
+        // The current seal state.
+        function sealState() external view returns(uint256);
+
+        // The numeric seal state in everything sealable has been sealed.
+        function maxSealState() external view returns(uint256);
+    }
+
+#### Example implementation
+
+<https://git.grassecon.net/cicnet/erc20-demurrage-token.git>
+
+### Throttle
+
+An backend contract to limit access to a resource by time.
+
+The smart contract managing the resource calls ‘have(address)‘ on this
+contract to check if it can be made use of at the current point in time.
+This also implements [ACL](#acl).
+
+When the resource is made use of, it calls ‘poke(address)‘ method to
+register when it has been made use of.
+
+#### ERC165 Interface identifier
+
+8f5bc7bf
+
+#### Solidity interface definition
+
+    interface IThrottle {
+        // Returns true if the given address is authorized to make use of the resource at the current moment.
+        // Implements ACL
+        function have(address _address) external view returns(bool);
+
+        // Must be called when the resource is being used.
+        function poke(address _address) external returns(bool);
+    }
+
+#### Reference implementation
+
+<git://holbrook.no/eth-faucet.git> (PeriodSimple contract)
+
+### TokenLimit
+
+Define limits of value amounts of tokens that individual addresses can
+hold.
+
+Limits are inclusive; a limit for 42 means transfer resulting in a token
+balance *higher* than 42 should be rejected.
+
+A return value of 0 indicates that the token is categorically not
+accepted by the holder.
+
+#### ERC165 Interface identifier
+
+23778613
+
+#### Solidity interface definition
+
+    interface ITokenLimit {
+        // Returns limit of total value a holder will accept of a specific token.
+        // The value limit returned is inclusive; A limit of 42 means any operation resulting in a balance OVER 42 should be rejected.
+        // A value of 0 means that no value of the token is accepted.
+        function limitOf(address _token, address _holder) external view returns(uint256);
+    }
+
+#### Reference implementations
+
+- <git://holbrook.no/erc20-limiter.git>
+
+### TokenQuote
+
+Quote an output token value for a given value of input tokens.
+
+Both input and output value is denominated in the smallest available
+unit of respective tokens.
+
+#### ERC165 Interface identifier
+
+dbb21d40
+
+#### Solidity interface definition
+
+    interface ITokenQuote {
+        // Returns, within a current context, what value of outTokens the given value of inTokens translates to.
+        // The values are given in smallest unit of each respective token.
+        function valueFor(address _outToken, address _inToken, uint256 value) external view returns (uint256);
+    }
+
+#### Example implementation
+
+- <git://holbrook.no/erc20-limiter.git>
+
+### TokenRateChange
+
+Enables detection of properties for CIC tokens that change value over
+time, e.g. through demurrage.
+
+It allows defining the granularity of the rate of change, aswell as a
+frequency for which the rate of change is applied.
+
+A method for canonical value change calculations is also provided.
+
+#### ERC165 Interface identifier
+
+b716af03
+
+#### Solidity interface definition
+
+    interface ITokenChangeRate {
+        // Time unit resolution for rate of change.
+        // A value of 0 indicates no rate of change,
+        function changeTimeUnit() external view returns(uint256);
+
+        // Rate of change per changeTimeUnit(), signed integer.
+        // An effective value of 0 indicates no rate of change.
+        function changeRate() external view returns (int256);
+
+        // Number of decimals with which the changeRate is defined.
+            // changeRate() should be divided by 10 ** changeRateDecimals() to obtain effective value
+        function changeRateDecimals() external view returns(uint8);
+
+        // Timestamp from when rate of change should be applied.
+        // A value of 0 indicates no rate of change,
+        function changeStartTime() external view returns(uint256);
+
+        // Calculate value with change rate applied for given amount of time units.
+        // Will calculate compounded change over the given amount of time units
+        function applyChange(int256 _value, uint256 _changeTimeUnits) external view returns(int256);
+    }
+
+#### Reference implementations
+
+- <git://holbrook.no/erc20-demurrage-token.git>
+
+### TokenSwap
+
+Token swap interface that can fit token escrow purposes aswell as token
+swap contracts.
+
+Optionally may define a `defaultToken`, that may among other things be
+used for `withdraw()` calls without an `inToken`.
+
+An explicit *ERC20 approval* of the balance to be transacted will
+usually be required for the implementing contract.
+
+If the value 0 is passed as argument to `deposit` or `withdraw`,
+implementers can choose one of two possible outcomes:
+
+- Noop. 0 *must* be returned.
+
+- Use *balance* or the max available *allowance*. The actual (spent)
+  value *must* be returned.
+
+#### ERC165 Interface identifier
+
+4146b765
+
+#### Solidity interface definition
+
+    interface ITokenSwap {
+        // Emitted when a new deposit has been made.
+        event Deposit(address indexed _token, uint256 _value);
+
+        // Default token used to access the token swap.
+        // Returns zero-address if no default token is defined.
+        function defaultToken() external returns (address);
+
+        // Add inToken liquidity to the tune of given value. 
+        // Requires token approval for the corresponding value.
+        // If value is 0, up to the full approval MAY be used for the transfer.
+        function deposit(address _inToken, uint256 _value) external returns (uint256);
+
+        // Withdraw pending outToken balance of given value in the pool for the sender.
+        // May require token approval for defaultToken if used by contract as exchange for the withdrawal.
+        // If value is 0, up to the full approval value MAY be used for the transfer.
+        function withdraw(address _outToken, uint256 _value) external returns (uint256);
+
+        // Exchange inToken equalling given value for outToken.
+        // Requires token approval for the value of inToken.
+        // If value is 0, up to the full approval value MAY be used for the transfer.
+        function withdraw(address _outToken, address _inToken, uint256 _value) external returns (uint256);
+    }
+
+#### Reference implementations
+
+- <git://holbrook.no/erc20-pool.git>
+
+#### Handling deposits
+
+The implementation is free to decide whether deposits can be recovered
+directly, or if they will be locked in the smart contract - temporarily
+or permanently.
+
+For the duration deposits are locked, they are part of the smart
+contract’s swap liquidity. During this time, locked deposits may only be
+withdrawn in exchange for other tokens accepted by the contract.
+
+Deposits that are not locked should be withdrawable using the
+`withdraw(address,uint256)` (`0xf3fef3a3`) method signature.
+
+Of course, as with most swap contracts, the tokens available for
+withdrawal by the holder may not necessarily match the tokens that were
+deposited by the holder.
+
+### TokenVote
+
+Execute elections with granular ERC20 token votes.
+
+A proposal submitted for vote may or may not contain multiple options.
+If multiple options are available, an ERC20 token holder may distribute
+its vote among the options with the granularity of the token balance.
+
+Voted tokens **SHOULD** be locked until the voting has finalized.
+
+Finalization of voting should be callable by anyone.
+
+#### ERC165 Interface identifier
+
+f2e0bfeb
+
+#### Solidity interface definition
+
+    interface ITokenVote {
+
+        // A new proposal has been created.
+        event ProposalAdded(uint256 indexed _blockDeadline, uint256 indexed voteTargetPpm, uint256 indexed _proposalIdx);
+
+        // A proposal vote has been completed.
+        // The proposal is identified by the serial number in _proposalIdx. It is up to the implementer to define how the proposal should be retrieved by index.
+        // The proposal result may be in one of three states:
+        // * Ratified (_cancelled == false, _insufficient == false)
+        // * Cancelled (_cancelled == true, _insufficient == false)
+        // * Not reached quorum (_cancelled == false, _insufficient == true)
+        event ProposalCompleted(uint256 indexed _proposalIdx, bool indexed _cancelled, bool indexed _insufficient, uint256 _totalVote);
+
+        // Propose a new vote.
+        // Voting is active until one of:
+        // * total cancel vote reach quorum (_targetVotePpm, ppm = parts-per-million).
+        // * _blockWait blocks from now.
+        function propose(bytes32 _description, uint256 _blockWait, uint24 _targetVotePpm) external returns (uint256);
+
+        // Add a voting option to a proposal
+        function addOption(uint256 _proposalIdx, bytes32 _description) external;
+
+        // Get number of options available for the proposal.
+        // This decides the boundary of the index that can be used with voteOptions(...)
+        // If the result is 0, vote(...) can be used aswell.
+        function optionCount(uint256 _proposalIdx) external view returns(uint256);
+
+        // Get proposal option. Assumes that proposal was created with proposeMulti(...)
+        function getOption(uint256 _proposalIdx, uint256 _optionIdx) external view returns (bytes32);
+
+        // Get vote count for the given option.
+        // If proposal has no options, it should be called with _optionIdx = 0
+        function voteCount(uint256 _proposalIdx, uint256 _optionIdx) external view returns(uint256);
+
+        // Vote on a proposal without options.
+        // Assumes that proposal was created with propose(...) and will fail otherwise.
+        function vote(uint256 _value) external returns (bool);
+
+        // Vote on a proposal option. Assumes that proposal was created with proposeMulti(...).
+        // Must work with a non-option proposal if _optionIndex is 0.
+        function voteOption(uint256 _optionIndex, uint256 _value) external returns (bool);
+
+        // Vote to cancel a proposal.
+        // If cancel has the majority:
+        // * A vote without options will have rejected the proposal description.
+        // * A vote with options will have rejected the proposal description as well as all option descriptions.
+        function voteCancel(uint256 _value) external returns (bool);
+
+        // Finalize the vote for a proposal.
+        // May be called if deadline has been passed, or if:
+            // * quorum has been reached with cancel votes.
+        // * quorum has been reached and proposal has no/only one option.
+        function finalize() external returns (bool);
+    }
+
+#### Reference implementations
+
+- <git://holbrook.no/evm-tokenvote.git>
+
+### Writer
+
+A complement to ERC173, which allows definition of a class of
+super-users for a contract.
+
+A super-user address may perform *more* actions than a "normal" address,
+aswell as *some* actions normally limited to the *contract owner*.
+
+If an *contract owner* is defined, No super-user should be able to
+perform actions that *contract owner* cannot perform.
+
+Typically, only the *contract owner*, if it is defined, can add or
+remove a super-user.
+
+Some use-case examples of super-user actions include:
+
+- Mint new tokens.
+
+- Change the amount dispensed by the faucet.
+
+- Edit access control lists.
+
+#### ERC165 Interface identifier
+
+abe1f1f5
+
+#### Solidity interface definition
+
+    interface IWriter {
+        // A writer has been added by _executor
+        event WriterAdded(address _writer);
+
+        // A writer has been removed by _executor
+        event WriterDeleted(address _writer);
+
+        // Add a new writer to the contract.
+        function addWriter(address _writer) external returns (bool);
+
+        // Remove existing writer from the contract.
+        function deleteWriter(address _writer) external returns (bool);
+
+        // Check whether the given address is a writer.
+        function isWriter(address _writer) external view returns (bool);
+    }
+
+#### Example implementation
+
+<https://git.grassecon.net/cicnet/erc20-demurrage-token.git>

python/cic_contracts/__init__.py

@@ -0,0 +1,8 @@
+# local imports
+from cic_contracts.search import search
+from cic_contracts.names import Name
+
+erc165_for = search
+
+def abi(v):
+    return search(v, ext='json')

python/cic_contracts/data/AccountsIndex.interface

@@ -0,0 +1 @@
+b7bca625

python/cic_contracts/data/AccountsIndex.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"_idx","type":"uint256"},{"indexed":false,"internalType":"address","name":"_account","type":"address"}],"name":"AddressAdded","type":"event"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"add","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"entry","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"entryCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"have","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"time","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/AccountsIndexMutable.interface

@@ -0,0 +1 @@
+9479f0ae

python/cic_contracts/data/AccountsIndexMutable.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_account","type":"address"},{"indexed":false,"internalType":"bool","name":"_active","type":"bool"}],"name":"AddressActive","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"_account","type":"address"}],"name":"AddressRemoved","type":"event"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"activate","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"deactivate","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"isActive","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"remove","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/Burner.interface

@@ -0,0 +1 @@
+b1110c1b

python/cic_contracts/data/Burner.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_burner","type":"address"},{"indexed":false,"internalType":"uint256","name":"_burned","type":"uint256"}],"name":"Burn","type":"event"},{"inputs":[{"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"burn","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"uint256","name":"_amount","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"burn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"burn","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"totalBurned","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"totalMinted","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/Capped.interface

@@ -0,0 +1 @@
+869f7594

python/cic_contracts/data/Capped.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"_oldCap","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"_newCap","type":"uint256"}],"name":"Cap","type":"event"},{"inputs":[],"name":"maxSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/Chrono.interface

@@ -0,0 +1 @@
+4db1ccd4

python/cic_contracts/data/Chrono.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"uint256","name":"_idx","type":"uint256"}],"name":"createTime","outputs":[{"internalType":"int64","name":"","type":"int64"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/Declarator.interface

@@ -0,0 +1 @@
+21b7493b

python/cic_contracts/data/Declarator.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_declarator","type":"address"},{"indexed":true,"internalType":"address","name":"_subject","type":"address"},{"indexed":true,"internalType":"bytes32","name":"_topic","type":"bytes32"},{"indexed":false,"internalType":"bytes32","name":"_proof","type":"bytes32"}],"name":"DeclarationAdded","type":"event"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"},{"internalType":"bytes32","name":"_proof","type":"bytes32"},{"internalType":"bytes32","name":"_topic","type":"bytes32"}],"name":"addDeclaration","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"},{"internalType":"bytes32","name":"_proof","type":"bytes32"}],"name":"addDeclaration","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_declarator","type":"address"},{"internalType":"address","name":"_subject","type":"address"}],"name":"declaration","outputs":[{"internalType":"bytes32[]","name":"","type":"bytes32[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_declarator","type":"address"},{"internalType":"address","name":"_subject","type":"address"},{"internalType":"bytes32","name":"_topic","type":"bytes32"}],"name":"declaration","outputs":[{"internalType":"bytes32[]","name":"","type":"bytes32[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_declarator","type":"address"},{"internalType":"uint256","name":"_idx","type":"uint256"}],"name":"declarationAddressAt","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_declarator","type":"address"}],"name":"declarationCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"},{"internalType":"uint256","name":"_idx","type":"uint256"}],"name":"declaratorAddressAt","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_subject","type":"address"}],"name":"declaratorCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/Digest.interface

@@ -0,0 +1 @@
+982ab05d

python/cic_contracts/data/Digest.json

@@ -0,0 +1 @@
+[{"inputs":[],"name":"defaultDigestEncoding","outputs":[{"internalType":"uint256","name":"_encoding","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"encodeDigest","outputs":[{"internalType":"bytes","name":"","type":"bytes"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes","name":"_data","type":"bytes"},{"internalType":"uint256","name":"_encoding","type":"uint256"}],"name":"encodeDigest","outputs":[{"internalType":"bytes","name":"","type":"bytes"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_codec","type":"uint256"}],"name":"haveDigestEncoding","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/ERC165.interface

@@ -0,0 +1 @@
+01ffc9a7

python/cic_contracts/data/ERC165.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"bytes4","name":"_sum","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"pure","type":"function"}]

python/cic_contracts/data/ERC173.interface

@@ -0,0 +1 @@
+9493f8b2

python/cic_contracts/data/ERC173.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_newOwner","type":"address"}],"name":"transferOwnership","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/ERC20.interface

@@ -0,0 +1 @@
+b61bc941

python/cic_contracts/data/ERC20.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_owner","type":"address"},{"indexed":true,"internalType":"address","name":"_spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Transfer","type":"event"},{"inputs":[{"internalType":"address","name":"_owner","type":"address"},{"internalType":"address","name":"_spender","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_spender","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_holder","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/ERC5007.interface

@@ -0,0 +1 @@
+7a0cdf92

python/cic_contracts/data/ERC5007.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"endTime","outputs":[{"internalType":"int64","name":"","type":"int64"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"startTime","outputs":[{"internalType":"int64","name":"","type":"int64"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/ERC5192.interface

@@ -0,0 +1 @@
+b45a3c0e

python/cic_contracts/data/ERC5192.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Locked","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Unlocked","type":"event"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"locked","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/ERC5679Ext20.interface

@@ -0,0 +1 @@
+d0017968

python/cic_contracts/data/ERC5679Ext20.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"uint256","name":"_amount","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"burn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_amount","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"mint","outputs":[],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/ERC5679Ext721.interface

@@ -0,0 +1 @@
+cce39764

python/cic_contracts/data/ERC5679Ext721.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"uint256","name":"_id","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"burn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_id","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"safeMint","outputs":[],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/ERC721.interface

@@ -0,0 +1 @@
+c22876c3

python/cic_contracts/data/ERC721.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_owner","type":"address"},{"indexed":true,"internalType":"address","name":"_approved","type":"address"},{"indexed":true,"internalType":"uint256","name":"_tokenId","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_owner","type":"address"},{"indexed":true,"internalType":"address","name":"_operator","type":"address"},{"indexed":false,"internalType":"bool","name":"_approved","type":"bool"}],"name":"ApprovalForAll","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_from","type":"address"},{"indexed":true,"internalType":"address","name":"_to","type":"address"},{"indexed":true,"internalType":"uint256","name":"_tokenId","type":"uint256"}],"name":"Transfer","type":"event"},{"inputs":[{"internalType":"address","name":"_approved","type":"address"},{"internalType":"uint256","name":"_tokenId","type":"uint256"}],"name":"approve","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"_owner","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_tokenId","type":"uint256"}],"name":"getApproved","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_owner","type":"address"},{"internalType":"address","name":"_operator","type":"address"}],"name":"isApprovedForAll","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_tokenId","type":"uint256"}],"name":"ownerOf","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_tokenId","type":"uint256"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_tokenId","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"_operator","type":"address"},{"internalType":"bool","name":"_approved","type":"bool"}],"name":"setApprovalForAll","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_from","type":"address"},{"internalType":"address","name":"_to","type":"address"},{"internalType":"uint256","name":"_tokenId","type":"uint256"}],"name":"transferFrom","outputs":[],"stateMutability":"payable","type":"function"}]

python/cic_contracts/data/ERC721Enumerable.interface

@@ -0,0 +1 @@
+dd9d2087

python/cic_contracts/data/ERC721Enumerable.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"uint256","name":"_index","type":"uint256"}],"name":"tokenByIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_owner","type":"address"},{"internalType":"uint256","name":"_index","type":"uint256"}],"name":"tokenOfOwnerByIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/ERC721Metadata.interface

@@ -0,0 +1 @@
+d283ef1d

python/cic_contracts/data/ERC721Metadata.json

@@ -0,0 +1 @@
+[{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"_name","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"_symbol","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_tokenId","type":"uint256"}],"name":"tokenURI","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/ERC721Receiver.interface

@@ -0,0 +1 @@
+150b7a02

python/cic_contracts/data/ERC721Receiver.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"address","name":"_operator","type":"address"},{"internalType":"address","name":"_from","type":"address"},{"internalType":"uint256","name":"_tokenId","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"onERC721Received","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/Expire.interface

@@ -0,0 +1 @@
+841a0e94

python/cic_contracts/data/Expire.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_timestamp","type":"uint256"}],"name":"Expired","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"_oldTimestamp","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"_newTimestamp","type":"uint256"}],"name":"ExpiryChange","type":"event"},{"inputs":[],"name":"applyExpiry","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"expires","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/Faucet.interface

@@ -0,0 +1 @@
+1a3ac634

python/cic_contracts/data/Faucet.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"FaucetAmountChange","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_recipient","type":"address"},{"indexed":true,"internalType":"address","name":"_token","type":"address"},{"indexed":false,"internalType":"uint256","name":"_value","type":"uint256"}],"name":"Give","type":"event"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"check","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"gimme","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"giveTo","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"nextBalance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_recipient","type":"address"}],"name":"nextTime","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"token","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"tokenAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/Locator.interface

@@ -0,0 +1 @@
+ed75b333

python/cic_contracts/data/Locator.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"toURI","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"toURL","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/Minter.interface

@@ -0,0 +1 @@
+5878bcf4

python/cic_contracts/data/Minter.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"_minter","type":"address"},{"indexed":true,"internalType":"address","name":"_beneficiary","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Mint","type":"event"},{"inputs":[{"internalType":"address","name":"_beneficiary","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"mint","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_beneficiary","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"mintTo","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_beneficiary","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"safeMint","outputs":[],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/Msg.interface

@@ -0,0 +1 @@
+a3002595

python/cic_contracts/data/Msg.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":false,"internalType":"bytes","name":"_msgDigest","type":"bytes"}],"name":"Msg","type":"event"},{"inputs":[],"name":"getMsg","outputs":[{"internalType":"bytes","name":"","type":"bytes"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/MultiHash.interface

@@ -0,0 +1 @@
+cd8391b0

python/cic_contracts/data/MultiHash.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"uint256","name":"_codec","type":"uint256"}],"name":"digestCodec","outputs":[{"components":[{"internalType":"uint8","name":"l","type":"uint8"},{"internalType":"uint8","name":"codecRLength","type":"uint8"},{"internalType":"uint8","name":"prefixRLength","type":"uint8"},{"internalType":"bytes16","name":"prefix","type":"bytes16"},{"internalType":"bytes8","name":"codec","type":"bytes8"}],"internalType":"struct IMultiHash.MultiHash","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_codec","type":"uint256"},{"internalType":"bytes","name":"_digest","type":"bytes"}],"name":"encodeDigest","outputs":[{"internalType":"bytes","name":"","type":"bytes"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_codec","type":"uint256"}],"name":"haveDigestEncoding","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/Offline.interface

@@ -0,0 +1 @@
+52e86958

python/cic_contracts/data/Offline.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"bytes","name":"_data","type":"bytes"},{"internalType":"bytes","name":"_signature","type":"bytes"}],"name":"executeOfflineRequest","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_signer","type":"address"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"isOfflineValid","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes","name":"_data","type":"bytes"},{"internalType":"bytes","name":"_signature","type":"bytes"}],"name":"verifyOfflineRequest","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/OwnedAccepter.interface

@@ -0,0 +1 @@
+37a47be4

python/cic_contracts/data/OwnedAccepter.json

@@ -0,0 +1 @@
+[{"inputs":[],"name":"acceptOwnership","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/OwnedTaker.interface

@@ -0,0 +1 @@
+6b578339

python/cic_contracts/data/OwnedTaker.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"_result","type":"address"}],"name":"OwnershipTaken","type":"event"},{"inputs":[{"internalType":"address","name":"_target","type":"address"}],"name":"takeOwnership","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/Registry.interface

@@ -0,0 +1 @@
+d719b0cc

python/cic_contracts/data/Registry.json

@@ -0,0 +1 @@
+[{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"},{"internalType":"bytes32","name":"","type":"bytes32"}],"name":"bind","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"},{"internalType":"address","name":"","type":"address"}],"name":"set","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/RegistryClient.interface

@@ -0,0 +1 @@
+effbf671

python/cic_contracts/data/RegistryClient.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"_key","type":"bytes32"},{"indexed":false,"internalType":"address","name":"_address","type":"address"}],"name":"AddressKey","type":"event"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"name":"addressOf","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"identifier","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"identifierCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/Seal.interface

@@ -0,0 +1 @@
+0d7491f8

python/cic_contracts/data/Seal.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bool","name":"_final","type":"bool"},{"indexed":false,"internalType":"uint256","name":"_sealState","type":"uint256"}],"name":"SealStateChange","type":"event"},{"inputs":[],"name":"maxSealState","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"sealState","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/TokenVend.interface

@@ -0,0 +1 @@
+8a13249c

python/cic_contracts/data/TokenVend.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"_tokenIdx","type":"uint256"},{"indexed":true,"internalType":"uint256","name":"_supply","type":"uint256"},{"indexed":false,"internalType":"address","name":"_token","type":"address"}],"name":"TokenCreated","type":"event"},{"inputs":[{"internalType":"address","name":"_token","type":"address"}],"name":"getFor","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_token","type":"address"}],"name":"withdrawFor","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/TokenVote.interface

@@ -0,0 +1 @@
+ac3142f7

python/cic_contracts/data/TokenVote.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"_blockDeadline","type":"uint256"},{"indexed":true,"internalType":"uint256","name":"voteTargetPpm","type":"uint256"},{"indexed":true,"internalType":"uint256","name":"_proposalIdx","type":"uint256"}],"name":"ProposalAdded","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"_proposalIdx","type":"uint256"},{"indexed":true,"internalType":"bool","name":"_cancelled","type":"bool"},{"indexed":true,"internalType":"bool","name":"_insufficient","type":"bool"},{"indexed":false,"internalType":"uint256","name":"_totalVote","type":"uint256"}],"name":"ProposalCompleted","type":"event"},{"inputs":[],"name":"finalize","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_proposalIdx","type":"uint256"},{"internalType":"uint256","name":"_optionIdx","type":"uint256"}],"name":"getOption","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_proposalIdx","type":"uint256"}],"name":"optionCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"_description","type":"bytes32"},{"internalType":"uint256","name":"_blockWait","type":"uint256"},{"internalType":"uint24","name":"_targetVotePpm","type":"uint24"}],"name":"propose","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"_description","type":"bytes32"},{"internalType":"bytes32[]","name":"_options","type":"bytes32[]"},{"internalType":"uint256","name":"_blockWait","type":"uint256"},{"internalType":"uint24","name":"_targetVotePpm","type":"uint24"}],"name":"proposeMulti","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"vote","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"voteCancel","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_proposalIdx","type":"uint256"},{"internalType":"uint256","name":"_optionIdx","type":"uint256"}],"name":"voteCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_optionIndex","type":"uint256"},{"internalType":"uint256","name":"_value","type":"uint256"}],"name":"voteOption","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}]

python/cic_contracts/data/Writer.interface

@@ -0,0 +1 @@
+abe1f1f5

python/cic_contracts/data/Writer.json

@@ -0,0 +1 @@
+[{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"_writer","type":"address"}],"name":"WriterAdded","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"_writer","type":"address"}],"name":"WriterDeleted","type":"event"},{"inputs":[{"internalType":"address","name":"_writer","type":"address"}],"name":"addWriter","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_writer","type":"address"}],"name":"deleteWriter","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_writer","type":"address"}],"name":"isWriter","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]

python/cic_contracts/data/__init__.py

@@ -0,0 +1,4 @@
+# standard imports
+import os
+
+data_dir = os.path.dirname(os.path.realpath(__file__))

python/cic_contracts/names.py

@@ -0,0 +1,10 @@
+# standard imports
+import enum
+
+class Name(enum.Enum):
+    WRITER = "Writer"
+    EXPIRE = "Expire"
+    SEAL = "Seal"
+    CAPPED = "Capped"
+    MINTER = "Minter"
+    BURNER = "Burner"

python/cic_contracts/search.py

@@ -0,0 +1,16 @@
+# standard imports
+import os
+
+# local imports
+from cic_contracts.data import data_dir
+from cic_contracts.names import Name
+
+
+def search(v, ext='interface', search_dir=data_dir):
+    if isinstance(v, Name):
+        v = v.value
+    fp = os.path.join(search_dir, v + '.' + ext)
+    f = open(fp, 'r')
+    r = f.read()
+    f.close()
+    return r.rstrip()

python/cic_contracts/unittest/__init__.py

@@ -0,0 +1,17 @@
+# standard imports
+import os
+
+# local imports
+from cic_contracts.search import search
+from cic_contracts import Name
+
+cic_unittest_dir = os.path.dirname(os.path.realpath(__file__))
+contracts_dir = os.path.join(cic_unittest_dir, 'solidity')
+
+
+def bytecode(v):
+    if isinstance(v, Name):
+        v = v.value
+    return search(v + 'Test', ext='bin', search_dir=contracts_dir)
+
+    

python/cic_contracts/unittest/owned.py

@@ -0,0 +1,22 @@
+# external imports
+from hexathon import strip_0x
+from hexathon import same as same_hex
+from chainlib.eth.nonce import RPCNonceOracle
+from chainlib.eth.address import to_checksum_address
+from eth_owned import Owned
+
+
+class TestInterface:
+
+    def __owned_check(self):
+        self.owner == to_checksum_address(self.owner)
+
+
+    def test_owner(self):
+        self.__owned_check()
+       
+        c = Owned(self.chain_spec)
+        o = c.owner(self.address, sender_address=self.accounts[0])
+        r = self.rpc.do(o)
+        owner_address = c.parse_owner(r)
+        self.assertTrue(same_hex(self.owner, owner_address))

python/cic_contracts/unittest/solidity/BurnerTest.bin

@@ -1 +1 @@
-608060405234801561001057600080fd5b5060405161070438038061070483398181016040528101906100329190610081565b8060008190555080600281905550506100ae565b600080fd5b6000819050919050565b61005e8161004b565b811461006957600080fd5b50565b60008151905061007b81610055565b92915050565b60006020828403121561009757610096610046565b5b60006100a58482850161006c565b91505092915050565b610647806100bd6000396000f3fe608060405234801561001057600080fd5b506004361061007f576000357c01000000000000000000000000000000000000000000000000000000009004806301ffc9a71461008457806342966c68146100b457806344d17187146100e457806344df8e7014610100578063a2309ff81461011e578063d89135cd1461013c575b600080fd5b61009e60048036038101906100999190610353565b61015a565b6040516100ab919061039b565b60405180910390f35b6100ce60048036038101906100c991906103ec565b61020a565b6040516100db919061039b565b60405180910390f35b6100fe60048036038101906100f991906104dc565b61021f565b005b61010861022f565b604051610115919061055f565b60405180910390f35b610126610241565b604051610133919061055f565b60405180910390f35b610144610247565b604051610151919061055f565b60405180910390f35b60006301ffc9a77c010000000000000000000000000000000000000000000000000000000002827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916036101ae5760019050610205565b63bc4babdd7c010000000000000000000000000000000000000000000000000000000002827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916036102005760019050610205565b600090505b919050565b60006102158261024d565b5060019050919050565b6102288361020a565b5050505050565b600061023c60005461024d565b905090565b60005481565b60015481565b6000808260025461025e91906105a9565b101561026957600080fd5b816001600082825461027b91906105dd565b92505081905550816002600082825461029491906105a9565b925050819055503373ffffffffffffffffffffffffffffffffffffffff167fcc16f5dbb4873280815c1ee09dbd06736cffcc184412cf7a71a0fdb75d397ca5836040516102e1919061055f565b60405180910390a2819050919050565b600080fd5b600080fd5b60007fffffffff0000000000000000000000000000000000000000000000000000000082169050919050565b610330816102fb565b811461033b57600080fd5b50565b60008135905061034d81610327565b92915050565b600060208284031215610369576103686102f1565b5b60006103778482850161033e565b91505092915050565b60008115159050919050565b61039581610380565b82525050565b60006020820190506103b0600083018461038c565b92915050565b6000819050919050565b6103c9816103b6565b81146103d457600080fd5b50565b6000813590506103e6816103c0565b92915050565b600060208284031215610402576104016102f1565b5b6000610410848285016103d7565b91505092915050565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b600061044482610419565b9050919050565b61045481610439565b811461045f57600080fd5b50565b6000813590506104718161044b565b92915050565b600080fd5b600080fd5b600080fd5b60008083601f84011261049c5761049b610477565b5b8235905067ffffffffffffffff8111156104b9576104b861047c565b5b6020830191508360018202830111156104d5576104d4610481565b5b9250929050565b600080600080606085870312156104f6576104f56102f1565b5b600061050487828801610462565b9450506020610515878288016103d7565b935050604085013567ffffffffffffffff811115610536576105356102f6565b5b61054287828801610486565b925092505092959194509250565b610559816103b6565b82525050565b60006020820190506105746000830184610550565b92915050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b60006105b4826103b6565b91506105bf836103b6565b92508282039050818111156105d7576105d661057a565b5b92915050565b60006105e8826103b6565b91506105f3836103b6565b925082820190508082111561060b5761060a61057a565b5b9291505056fea2646970667358221220cf04ca2f9a9ef1aee6a7109799862035ae01e772554ee9c71f0ca5243159197164736f6c63430008130033
+608060405234801561001057600080fd5b5060405161070438038061070483398181016040528101906100329190610081565b8060008190555080600281905550506100ae565b600080fd5b6000819050919050565b61005e8161004b565b811461006957600080fd5b50565b60008151905061007b81610055565b92915050565b60006020828403121561009757610096610046565b5b60006100a58482850161006c565b91505092915050565b610647806100bd6000396000f3fe608060405234801561001057600080fd5b506004361061007f576000357c01000000000000000000000000000000000000000000000000000000009004806301ffc9a71461008457806342966c68146100b457806344d17187146100e457806344df8e7014610100578063a2309ff81461011e578063d89135cd1461013c575b600080fd5b61009e60048036038101906100999190610353565b61015a565b6040516100ab919061039b565b60405180910390f35b6100ce60048036038101906100c991906103ec565b61020a565b6040516100db919061039b565b60405180910390f35b6100fe60048036038101906100f991906104dc565b61021f565b005b61010861022f565b604051610115919061055f565b60405180910390f35b610126610241565b604051610133919061055f565b60405180910390f35b610144610247565b604051610151919061055f565b60405180910390f35b60006301ffc9a77c010000000000000000000000000000000000000000000000000000000002827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916036101ae5760019050610205565b63bc4babdd7c010000000000000000000000000000000000000000000000000000000002827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916036102005760019050610205565b600090505b919050565b60006102158261024d565b5060019050919050565b6102288361020a565b5050505050565b600061023c60005461024d565b905090565b60005481565b60015481565b6000808260025461025e91906105a9565b101561026957600080fd5b816001600082825461027b91906105dd565b92505081905550816002600082825461029491906105a9565b925050819055503373ffffffffffffffffffffffffffffffffffffffff167fcc16f5dbb4873280815c1ee09dbd06736cffcc184412cf7a71a0fdb75d397ca5836040516102e1919061055f565b60405180910390a2819050919050565b600080fd5b600080fd5b60007fffffffff0000000000000000000000000000000000000000000000000000000082169050919050565b610330816102fb565b811461033b57600080fd5b50565b60008135905061034d81610327565b92915050565b600060208284031215610369576103686102f1565b5b60006103778482850161033e565b91505092915050565b60008115159050919050565b61039581610380565b82525050565b60006020820190506103b0600083018461038c565b92915050565b6000819050919050565b6103c9816103b6565b81146103d457600080fd5b50565b6000813590506103e6816103c0565b92915050565b600060208284031215610402576104016102f1565b5b6000610410848285016103d7565b91505092915050565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b600061044482610419565b9050919050565b61045481610439565b811461045f57600080fd5b50565b6000813590506104718161044b565b92915050565b600080fd5b600080fd5b600080fd5b60008083601f84011261049c5761049b610477565b5b8235905067ffffffffffffffff8111156104b9576104b861047c565b5b6020830191508360018202830111156104d5576104d4610481565b5b9250929050565b600080600080606085870312156104f6576104f56102f1565b5b600061050487828801610462565b9450506020610515878288016103d7565b935050604085013567ffffffffffffffff811115610536576105356102f6565b5b61054287828801610486565b925092505092959194509250565b610559816103b6565b82525050565b60006020820190506105746000830184610550565b92915050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b60006105b4826103b6565b91506105bf836103b6565b92508282039050818111156105d7576105d661057a565b5b92915050565b60006105e8826103b6565b91506105f3836103b6565b925082820190508082111561060b5761060a61057a565b5b9291505056fea26469706673582212208cc8e912e94a09c49f6772a6a0bfcea389d65478dcee0b3e12fa669028b5567e64736f6c63430008130033