Compare commits

...

4 Commits

Author SHA1 Message Date
lash 179a6d4e03
Upgrade deps 2022-04-20 22:01:28 +00:00
lash f3f69c937f
Mo better docs 2022-02-21 16:24:18 +00:00
lash 5413295dc7
Clearer docs 2022-02-21 16:22:26 +00:00
lash f299d9921a
Add readme 2022-02-21 16:13:42 +00:00
3 changed files with 41 additions and 10 deletions

31
python/README.md Normal file
View File

@ -0,0 +1,31 @@
# Okota
Okota implements smart contract registries for the CIC network with the [Address Declarator](https://gitlab.com/cicnet/eth-address-index) backend.
For every entry added to the registry, a declaration is added aswell.
In all the below:
* `contract_address` is the address of the deployed Address Declarator contract.
* `subject_address` is the address a declaration is being made about.
* `declarer` is the entity making a declaration about the `subject_address`.
* `proof` a 256-bit proof
## Contract declaration translations
| registry call | declarer | subject | proof |
|---|---|---|---|
| ContractRegistry.set(registry\_identifier, contract\_address) | sender | contract\_address | registry\_identifier |
| AccountsIndex.register(wallet\_address) | sender | wallet\_address | token address of accounts index |
| TokenRegistry.registry(token\_address) | sender | token\_address | sha256(token symbol) |
## Query the declarator with CLI
`eth-accounts-index-view -e <contract_address> -a <declarer_address> <subject_address>`
## Add arbitrary other proofs with CLI
`eth-accounts-index-add -e <contract_address> -y <declarer_keyfile> -a <subject_address> <proof>`

View File

@ -1,9 +1,9 @@
confini~=0.5.3
funga-eth~=0.5.1
chainlib-eth~=0.0.15
eth_erc20~=0.1.5
eth-address-index~=0.3.0
eth-accounts-index~=0.1.2
eth-token-index~=0.2.4
eth-contract-registry~=0.7.2
cic-contracts~=0.0.5
confini~=0.6.0
funga-eth~=0.6.0
chainlib-eth>=0.1.0b1,<0.2.0
eth_erc20~=0.3.0
eth-address-index~=0.5.0
eth-accounts-index~=0.2.0
#eth-token-index~=0.3.0
eth-contract-registry~=0.8.0
cic-contracts~=0.1.0

View File

@ -1,6 +1,6 @@
[metadata]
name = okota
version = 0.3.0
version = 0.4.0
description = Registries for CIC using the eth-address-index backend
author = Louis Holbrook
author_email = dev@holbrook.no