diff --git a/python/README.md b/python/README.md index 339f066..56ec896 100644 --- a/python/README.md +++ b/python/README.md @@ -1,6 +1,6 @@ # Okota -Okota implements smart contract registries for the CIC network with the Address Declarator backend. +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. @@ -14,11 +14,20 @@ For every entry added to the registry, a declaration is added aswell. | TokenRegistry.registry(token\_address) | sender | token\_address | sha256(token symbol) | +## Using the CLI + +In the below, all in hex: + +* `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 + ## Query the declarator with CLI -`eth-accounts-index-view -e -a ` +`eth-accounts-index-view -e -a ` ## Add arbitrary other proofs with CLI -`eth-accounts-index-add -e -y -a <256 bit proof in hex>` +`eth-accounts-index-add -e -y -a `