From f299d9921ae4479ccb2ff978feb9817e5fa8050a Mon Sep 17 00:00:00 2001 From: lash Date: Mon, 21 Feb 2022 16:13:42 +0000 Subject: [PATCH] Add readme --- python/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 python/README.md diff --git a/python/README.md b/python/README.md new file mode 100644 index 0000000..339f066 --- /dev/null +++ b/python/README.md @@ -0,0 +1,24 @@ +# Okota + +Okota implements smart contract registries for the CIC network with the Address Declarator backend. + +For every entry added to the registry, a declaration is added aswell. + + +## Contract declaration translations + +| registry call | declarator | 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 -a ` + + +## Add arbitrary other proofs with CLI + +`eth-accounts-index-add -e -y -a <256 bit proof in hex>`